Документация

Переменные окружения

Настройте проект через переменные окружения, чтобы включить все необходимые сторонние сервисы

Обзор системы переменных окружения

GolOps поддерживает два способа настройки переменных окружения:

  1. Через файлы переменных окружения - для значений, которые меняются редко, например URL базы данных или секреты аутентификации.
  2. Через панель конфигурации в админке - для значений, которые меняются часто. GolOps предоставляет динамическую панель, где можно в любой момент менять такие параметры, как ключи платежей и настройки почтового сервера.

Настройка через файлы переменных окружения

Конфигурация URL сайта

ПеременнаяОписание
VITE_APP_URLURL сайта

База данных

Смотрите документацию по настройке базы данных для более подробных инструкций.

ПеременнаяОписание
DATABASE_URLURL подключения к базе данных

Аутентификация

Смотрите документацию по настройке аутентификации для более подробных инструкций.

ПеременнаяОписание
ADMIN_EMAILSEmail-адреса администраторов
BETTER_AUTH_SECRETСекретный ключ аутентификации
BETTER_AUTH_URLURL аутентификации

BETTER_AUTH_SECRET можно сгенерировать на сайте better-auth или нажать кнопку ниже:

Если вы хотите использовать OAuth (вход через GitHub или Google), настройте следующие переменные:

ПеременнаяОписание
GITHUB_CLIENT_IDID клиента GitHub OAuth
GITHUB_CLIENT_SECRETСекрет клиента GitHub OAuth
GOOGLE_CLIENT_IDID клиента Google OAuth
GOOGLE_CLIENT_SECRETСекрет клиента Google OAuth

TURNSTILE

GolOps использует TURNSTILE как сервис капчи для защиты сайта. Вам нужно зарегистрировать аккаунт на сайте TURNSTILE и создать сайт, чтобы получить site key. Более подробная инструкция есть в документации по капче.

ПеременнаяОписание
TURNSTILE_SECRET_KEYСекретный ключ TURNSTILE, его можно сгенерировать в Cloudflare Dashboard
VITE_TURNSTILE_SITE_KEYSite key TURNSTILE, его можно получить в Cloudflare Dashboard
VITE_TURNSTILE_CAPTCHA_ENABLEDВключает капчу TURNSTILE, true - включить, false - выключить

Почта

Вы можете использовать сервис Resend или собственный почтовый сервер. GolOps рекомендует Resend. Подробнее см. в документации по настройке почты.

Проверка email по умолчанию отключена. Настройте почтового провайдера, чтобы пользователи могли подтверждать аккаунт:

EMAIL_VERIFICATION_ENABLED=false

Для Resend нужно создать API-ключ на Resend.

ПеременнаяОписание
EMAIL_PROVIDERПочтовый провайдер, resend или custom
EMAIL_FROMEmail отправителя, например: GolOps <noreply@auth.vibeany.dev>
RESEND_API_KEYAPI-ключ Resend

Для собственного почтового сервера настройте следующие переменные. Подробности смотрите в документации вашего провайдера:

ПеременнаяОписание
EMAIL_HOSTХост почтового сервера
EMAIL_ADDRESSEmail отправителя
EMAIL_USERИмя пользователя отправителя
EMAIL_PASSWORDПароль отправителя

Платежи

Смотрите документацию по настройке платежей для более подробных инструкций.

Stripe

ПеременнаяОписание
VITE_STRIPE_PUBLISHABLE_KEYPublishable key Stripe
STRIPE_SECRET_KEYAPI secret key Stripe
STRIPE_WEBHOOK_SECRETWebhook secret Stripe
VITE_STRIPE_PRO_MONTHLY_PRICE_IDID ежемесячной цены Stripe Pro
VITE_STRIPE_PRO_YEARLY_PRICE_IDID годовой цены Stripe Pro
VITE_STRIPE_LIFETIME_PRICE_IDID пожизненной цены Stripe

Creem

ПеременнаяОписание
CREEM_X_API_KEYAPI-ключ Creem
CREEM_TEST_MODEТестовый режим Creem, true - включить, false - выключить
CREEM_WEBHOOK_SECRETWebhook secret Creem
VITE_CREEM_PRO_MONTHLY_PRODUCT_IDID ежемесячного продукта Creem Pro
VITE_CREEM_LIFETIME_PRODUCT_IDID пожизненного продукта Creem

Кредиты

Чтобы упростить настройку для разработчиков, GolOps интегрирует систему кредитов прямо в админку. Вы можете в любой момент менять конфигурацию кредитов в панели администрирования, например количество кредитов и срок их действия. Подробнее - в документации по кредитам.

Хранилище

Смотрите документацию по настройке хранилища для более подробных инструкций.

ПеременнаяОписание
STORAGE_PROVIDERПровайдер хранилища, s3 или custom
S3_ACCESS_KEYAccess key S3
S3_SECRET_KEYSecret key S3
S3_REGIONRegion S3
S3_BUCKETBucket S3

Настройка через админ-панель

GolOps предоставляет динамическую панель конфигурации, где можно менять следующие параметры без перезапуска сервиса.

Приоритет

Конфигурация из файлов переменных окружения имеет более высокий приоритет, чем настройки в админке: - Серверная конфигурация: если в .env задано STRIPE_SECRET_KEY=sk_xxx, значение payment_stripe_secret_key в админке будет проигнорировано - Клиентская конфигурация (префикс public_): если в .env задано VITE_CREDIT_ENABLE=true, значение public_credit_enable в админке будет проигнорировано

Environment Variables

Платежи

В админке можно выбрать провайдера платежей: stripe, creem, paypal, wechat, alipay

Stripe

ПараметрПеременная окружения
Stripe Secret KeySTRIPE_SECRET_KEY
Stripe Webhook SecretSTRIPE_WEBHOOK_SECRET

Creem

ПараметрПеременная окружения
Creem X API KeyCREEM_X_API_KEY
Creem Test ModeCREEM_TEST_MODE
Creem Webhook SecretCREEM_WEBHOOK_SECRET

PayPal

ПараметрПеременная окружения
PayPal Client IDPAYPAL_CLIENT_ID
PayPal Client SecretPAYPAL_CLIENT_SECRET
PayPal Webhook IDPAYPAL_WEBHOOK_ID
PayPal Sandbox ModePAYPAL_SANDBOX

WeChat Pay

ПараметрПеременная окружения
WeChat App IDWECHAT_APP_ID
WeChat Merchant IDWECHAT_MCH_ID
WeChat API KeyWECHAT_API_KEY
WeChat API v3 KeyWECHAT_API_V3_KEY
WeChat Certificate Serial NoWECHAT_SERIAL_NO
WeChat Private KeyWECHAT_PRIVATE_KEY

Alipay

ПараметрПеременная окружения
Alipay App IDALIPAY_APP_ID
Alipay App Private KeyALIPAY_PRIVATE_KEY
Alipay Public KeyALIPAY_PUBLIC_KEY
Alipay Sandbox ModeALIPAY_SANDBOX

Кредиты

Базовая конфигурация

ПараметрПеременная окруженияЗначение по умолчанию
Включить систему кредитовVITE_CREDIT_ENABLEfalse
Разрешить бесплатным пользователям покупатьVITE_CREDIT_ALLOW_FREE_USER_PURCHASEfalse

Бонус за регистрацию

ПараметрПеременная окруженияЗначение по умолчанию
Включить бонус за регистрациюVITE_CREDIT_SIGNUP_BONUS_ENABLEDfalse
Размер бонуса за регистрациюVITE_CREDIT_SIGNUP_BONUS_AMOUNT0
Срок действия бонуса (дней)VITE_CREDIT_SIGNUP_BONUS_EXPIRE_DAYS30

Ежедневный бонус

ПараметрПеременная окруженияЗначение по умолчанию
Включить ежедневный бонусVITE_CREDIT_DAILY_ENABLEDfalse
Размер ежедневного бонусаVITE_CREDIT_DAILY_AMOUNT0

Почта

ПараметрПеременная окруженияЗначение по умолчанию
Почтовый провайдерEMAIL_PROVIDERresend
Email отправителяEMAIL_FROM-
API Key ResendRESEND_API_KEY-

Хранилище

GolOps поддерживает S3-совместимые сервисы хранения, например AWS S3, Cloudflare R2 и MinIO.

ПараметрПеременная окруженияЗначение по умолчанию
Регион хранилищаSTORAGE_REGIONauto
Имя bucketSTORAGE_BUCKET_NAME-
Access Key IDSTORAGE_ACCESS_KEY_ID-
Secret Access KeySTORAGE_SECRET_ACCESS_KEY-
Endpoint хранилищаSTORAGE_ENDPOINT-
Публичный URL доступаSTORAGE_PUBLIC_URL-

Быстрый старт

Быстрое начало работы с GolOps

Настройка информации приложения и SEO

Базовые настройки имени, описания, логотипа и социальных ссылок

Содержание

Обзор системы переменных окруженияНастройка через файлы переменных окруженияКонфигурация URL сайтаБаза данныхАутентификацияTURNSTILEПочтаПлатежиStripeCreemКредитыХранилищеНастройка через админ-панельПлатежиStripeCreemPayPalWeChat PayAlipayКредитыБазовая конфигурацияБонус за регистрациюЕжедневный бонусПочтаХранилище