Перейти до вмісту
Onetime Secret Onetime Secret - Docs

Початок роботи

Цей посібник допоможе вам за лічені хвилини запустити власний екземпляр Onetime Secret.

Попередні вимоги

Section titled “Попередні вимоги”
  • 1ГБ+ оперативної пам’яті для оптимальної продуктивності
  • Примітка щодо сховища Redis: Залежно від конфігурації Redis, секрети можуть зберігатися повністю в пам’яті без запису на диск для підвищення безпеки

Метод 1: Docker (Рекомендовано)

Section titled “Метод 1: Docker (Рекомендовано)”

Найшвидший спосіб почати роботу використовує Docker з мінімальною конфігурацією.

1. Запустіть Redis

Section titled “1. Запустіть Redis”
Термінал
docker run -p 6379:6379 -d redis:bookworm

2. Згенеруйте секретний ключ

Section titled “2. Згенеруйте секретний ключ”
Термінал
# Згенеруйте та збережіть постійний секретний ключ
openssl rand -hex 32 > .ots_secret
chmod 600 .ots_secret
echo "Секретний ключ збережено в .ots_secret (зберігайте цей файл у безпеці!)"

3. Запустіть Onetime Secret

Section titled “3. Запустіть Onetime Secret”
Термінал
# Запустіть контейнер з секретним ключем
docker run -p 3000:3000 -d \
  -e REDIS_URL=redis://host.docker.internal:6379/0 \
  -e SECRET="$(cat .ots_secret)" \
  -e HOST=localhost:3000 \
  -e SSL=false \
  -e RACK_ENV=production \
  onetimesecret/onetimesecret:latest

4. Отримайте доступ до свого екземпляра

Section titled “4. Отримайте доступ до свого екземпляра”

Відкрийте браузер за адресою:

Метод 2: Ручне встановлення

Section titled “Метод 2: Ручне встановлення”

Для тих, хто віддає перевагу ручному налаштуванню, вам знадобиться:

  • Ruby 3.2+ (може бути недоступним у стандартних системних пакетах)
  • Redis 5+ або Valkey (альтернатива Redis)
  • Node.js 22+ та pnpm (потрібно лише для розробки та збирання фронтенд-ресурсів)

Вам потрібно буде зібрати фронтенд-ресурси за допомогою pnpm install && pnpm run build:local перед запуском додатку.

Перегляньте INSTALL.md для повних деталей ручного встановлення.

Перевірка

Section titled “Перевірка”
  1. Перейдіть за адресою http://localhost:3000
  2. Створіть тестовий секрет, щоб переконатися, що все працює
  3. Перевірте статус API за адресою http://localhost:3000/api/v2/status

Налаштування адміністратора

Section titled “Налаштування адміністратора”

Щоб створити користувача-адміністратора, додайте електронні адреси до розділу :colonels: у вашому конфігураційному файлі, а потім зареєструйтеся з однією з цих адрес, щоб автоматично отримати доступ адміністратора.

Примітка: Зона адміністратора наразі має обмежений функціонал - це тільки перегляд конфігурації в режимі читання без управління користувачами. Більше функцій запланована для майбутніх випусків.

Наступні кроки

Section titled “Наступні кроки”

Тепер, коли ваш екземпляр працює:

  1. Налаштуйте ваше розгортання для виробничого використання
  2. Перегляньте параметри конфігурації для налаштування

Отримання допомоги

Section titled “Отримання допомоги”