diff --git a/starter/.env.example b/starter/.env.example index 60a3e4f..a192de3 100644 --- a/starter/.env.example +++ b/starter/.env.example @@ -1,6 +1,7 @@ # Скопируй этот файл в .env (без .example) и заполни. -# .env ДОЛЖЕН быть закоммичен в git — это конфиг деплоя, не секреты. -# (Секреты — отдельно, через Forgejo Actions secrets, см. RUNTIME_KEYS ниже.) +# .env коммитится в git. Всё, что тут (кроме служебных ключей DOMAIN/DEPLOY/BUILD_DIR/ +# APP_PORT/WWW/EXTRA_DOMAINS/TWITTER_URL/INSTALL_SH), автоматически уходит в контейнер +# как переменные окружения. Просто пиши сюда и пушь — ничего отдельно настраивать не надо. # Домен сайта. Обязательно. Платформа выпустит SSL (Let's Encrypt) и направит # домен на твой сайт. Заранее пропиши A-запись домена на IP сервера платформы. @@ -12,9 +13,8 @@ DOMAIN=mysite.com # TWITTER_URL= # Тип деплоя. По умолчанию авто-детект: -# static — фронт (Vite/CRA/Next static export). bun build → раздаётся как -# статика напрямую (без контейнера). Самый быстрый. Дефолт, если в -# корне НЕТ Dockerfile. +# static — фронт (Vite/CRA). bun build → раздаётся как статика напрямую (без +# контейнера). Самый быстрый. Дефолт, если в корне НЕТ Dockerfile. # docker — свой Dockerfile в корне: собирается образ и поднимается контейнер. # Дефолт, если Dockerfile ЕСТЬ. # docker-db — как docker + персистентная SQLite. Платформа монтирует named-volume @@ -22,7 +22,7 @@ DOMAIN=mysite.com # редеплои. Миграции — твой entrypoint (drizzle/prisma). # DEPLOY=static -# Папка со сборкой для static. Default: dist (Vite). CRA → build. Next export → out. +# Папка со сборкой для static. Default: dist (Vite). CRA → build. # BUILD_DIR=dist # Порт, который слушает твой контейнер (только docker/docker-db). Default: 80. @@ -38,22 +38,16 @@ DOMAIN=mysite.com # EXTRA_DOMAINS=mysite.io,app.mysite.com # EXTRA_DOMAINS= -# Kill-switch. Default true. Поставь false и push — контейнер/сайт удаляется, домен -# отдаёт 404. Убери строку (или true) и push — поднимается обратно. Данные (volume, -# секреты) сохраняются. -# ENABLED=false - -# Какие секреты прокинуть в контейнер (docker/docker-db). Список имён через запятую. -# Сами значения заведи в Forgejo: репа → Settings → Actions → Secrets → Add Secret, -# имя секрета = имя переменной окружения. Платформа возьмёт только перечисленные ключи. -# RUNTIME_KEYS=DATABASE_URL,JWT_SECRET -# → контейнер получит process.env.DATABASE_URL и process.env.JWT_SECRET. +# Переменные окружения для контейнера (docker/docker-db) — просто пиши их сюда, +# они попадут в process.env.* автоматически. Ничего в Forgejo заводить не надо. +# DATABASE_URL=postgres://user:pass@host/db +# JWT_SECRET=... +# API_KEY=... # Для DEPLOY=docker-db переменную DATABASE_URL НЕ указывай — она ставится автоматически. -# RUNTIME_KEYS= -# Инсталл-сабдомен для one-liner'а `curl get. | sh` (только static). -# Укажи имя файла-скрипта из своей СБОРКИ (положи его в public/, чтобы попал в dist/). -# Платформа сама поднимет get., выпустит SSL и будет отдавать этот файл как -# text/plain. От тебя: (1) public/install.sh в репе, (2) A-запись get. → IP -# сервера, (3) INSTALL_SH ниже. Убери строку → сабдомен снимется на следующем деплое. +# Инсталл-сабдомен для one-liner'а `curl get. | sh` (static или docker). +# Положи файл-скрипт в репу (в корень или в public/) и укажи его имя. Платформа сама +# поднимет get., выпустит SSL и будет отдавать файл как text/plain. От тебя: +# (1) файл в репе, (2) A-запись get. → IP сервера, (3) INSTALL_SH ниже. +# Убери строку → сабдомен снимется на следующем деплое. # INSTALL_SH=install.sh