Expand .env.example with per-field comments and setup hints
This commit is contained in:
parent
e10df8dcbd
commit
2e5ef8e528
1 changed files with 72 additions and 15 deletions
87
.env.example
87
.env.example
|
|
@ -1,41 +1,98 @@
|
||||||
|
# =====================================================================
|
||||||
|
# MyYouTube — образец .env
|
||||||
|
# Скопируй в `.env` и заполни своими значениями.
|
||||||
|
# Сам `.env` в git НЕ попадает (в .gitignore) — не коммить его!
|
||||||
|
# =====================================================================
|
||||||
|
|
||||||
|
# ---------- Приложение ----------
|
||||||
|
|
||||||
|
# Окружение: production | development
|
||||||
APP_ENV=production
|
APP_ENV=production
|
||||||
APP_BASE_URL=https://testmyyoutube.vrubel.xyz
|
|
||||||
|
# Внешний адрес сервиса. Используется в OAuth-редиректе и для cookie.
|
||||||
|
# Локально — http://localhost:8080, в проде — https://твой-домен
|
||||||
|
APP_BASE_URL=http://localhost:8080
|
||||||
|
|
||||||
|
# Порт uvicorn внутри контейнера (наружу проброшен в compose.yml как 8080)
|
||||||
APP_PORT=8080
|
APP_PORT=8080
|
||||||
|
|
||||||
|
# Секрет для сессионных cookie. Любая длинная случайная строка, например:
|
||||||
|
# python3 -c "import secrets; print(secrets.token_urlsafe(48))"
|
||||||
APP_SECRET_KEY=CHANGE_ME
|
APP_SECRET_KEY=CHANGE_ME
|
||||||
|
|
||||||
|
# Ключ шифрования refresh-токена Google (хранится в БД). Fernet-ключ:
|
||||||
|
# python3 -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
|
||||||
|
# Генерируй один раз и не меняй (иначе старый токен не расшифруется).
|
||||||
TOKEN_ENCRYPTION_KEY=CHANGE_ME
|
TOKEN_ENCRYPTION_KEY=CHANGE_ME
|
||||||
|
|
||||||
|
# ---------- База данных ----------
|
||||||
|
|
||||||
|
# Пароль Postgres. Должен совпадать с POSTGRES_PASSWORD у сервиса postgres в compose.yml
|
||||||
POSTGRES_PASSWORD=CHANGE_ME
|
POSTGRES_PASSWORD=CHANGE_ME
|
||||||
|
|
||||||
|
# URL базы. `postgres` — имя сервиса внутри docker-сети; при запуске без docker замени на localhost
|
||||||
DATABASE_URL=postgresql+psycopg://youtube_app:CHANGE_ME@postgres:5432/youtube_app
|
DATABASE_URL=postgresql+psycopg://youtube_app:CHANGE_ME@postgres:5432/youtube_app
|
||||||
|
|
||||||
|
# ---------- Google OAuth (YouTube) ----------
|
||||||
|
|
||||||
|
# Google Cloud Console → APIs & Services → Credentials → Create credentials →
|
||||||
|
# OAuth client ID → Application type: Web application
|
||||||
GOOGLE_CLIENT_ID=
|
GOOGLE_CLIENT_ID=
|
||||||
GOOGLE_CLIENT_SECRET=
|
GOOGLE_CLIENT_SECRET=
|
||||||
GOOGLE_REDIRECT_URI=https://testmyyoutube.vrubel.xyz/api/auth/google/callback
|
|
||||||
|
# Тот же URI добавь в "Authorized redirect URIs" клиента в консоли.
|
||||||
|
# Всегда: {APP_BASE_URL}/api/auth/google/callback
|
||||||
|
GOOGLE_REDIRECT_URI=http://localhost:8080/api/auth/google/callback
|
||||||
|
|
||||||
|
# Gmail единственного пользователя, которому разрешён вход (single-user)
|
||||||
ALLOWED_GOOGLE_EMAIL=
|
ALLOWED_GOOGLE_EMAIL=
|
||||||
|
|
||||||
# Google/YouTube endpoints (необязательно, есть дефолты)
|
# Endpoint'ы Google/YouTube — НЕОБЯЗАТЕЛЬНО (в коде есть дефолты).
|
||||||
GOOGLE_AUTH_URI=https://accounts.google.com/o/oauth2/auth
|
# Раскомментируй, только если нужно их переопределить:
|
||||||
GOOGLE_TOKEN_URI=https://oauth2.googleapis.com/token
|
# GOOGLE_AUTH_URI=https://accounts.google.com/o/oauth2/auth
|
||||||
GOOGLE_USERINFO_URI=https://www.googleapis.com/oauth2/v3/userinfo
|
# GOOGLE_TOKEN_URI=https://oauth2.googleapis.com/token
|
||||||
GOOGLE_REVOKE_URI=https://oauth2.googleapis.com/revoke
|
# GOOGLE_USERINFO_URI=https://www.googleapis.com/oauth2/v3/userinfo
|
||||||
YOUTUBE_API_BASE_URL=https://www.googleapis.com/youtube/v3
|
# GOOGLE_REVOKE_URI=https://oauth2.googleapis.com/revoke
|
||||||
YOUTUBE_WATCH_URL_TEMPLATE=https://www.youtube.com/watch?v={video_id}
|
# YOUTUBE_API_BASE_URL=https://www.googleapis.com/youtube/v3
|
||||||
|
# YOUTUBE_WATCH_URL_TEMPLATE=https://www.youtube.com/watch?v={video_id}
|
||||||
|
|
||||||
|
# ---------- MeTube (скачивание) ----------
|
||||||
|
|
||||||
|
# API-адрес MeTube, куда backend ходит управлять загрузками
|
||||||
|
# (POST /add, /delete, GET /history, Socket.IO-события)
|
||||||
METUBE_API_BASE_URL=http://192.168.8.177:8081
|
METUBE_API_BASE_URL=http://192.168.8.177:8081
|
||||||
|
|
||||||
|
# Публичный адрес MeTube, с которого БРАУЗЕР стримит скачанные файлы
|
||||||
|
# (/download/...). Если MeTube за reverse-proxy — укажи его внешний URL.
|
||||||
METUBE_PUBLIC_BASE_URL=http://192.168.8.177:8081
|
METUBE_PUBLIC_BASE_URL=http://192.168.8.177:8081
|
||||||
|
|
||||||
|
# Каталог загрузок внутри контейнера MeTube (как в его настройках)
|
||||||
METUBE_CONTAINER_DOWNLOAD_DIR=/downloads
|
METUBE_CONTAINER_DOWNLOAD_DIR=/downloads
|
||||||
|
|
||||||
|
# Таймаут HTTP-запросов к MeTube/Google, секунды
|
||||||
METUBE_REQUEST_TIMEOUT_SECONDS=30
|
METUBE_REQUEST_TIMEOUT_SECONDS=30
|
||||||
|
|
||||||
|
# ---------- Синхронизация ----------
|
||||||
|
|
||||||
|
# Интервал планового синка подписок, часов
|
||||||
SUBSCRIPTIONS_SYNC_INTERVAL_HOURS=6
|
SUBSCRIPTIONS_SYNC_INTERVAL_HOURS=6
|
||||||
|
|
||||||
# Необязательные настройки
|
# Авто-синк видео запускается по активности: когда ты делаешь запрос к сервису,
|
||||||
# Авто-синк видео запускается по активности (запросы к API) после простоя
|
# а с последнего завершённого синка прошло больше этого числа часов
|
||||||
# в VIDEOS_SYNC_IDLE_HOURS с последнего завершённого синка.
|
|
||||||
VIDEOS_SYNC_IDLE_HOURS=2
|
VIDEOS_SYNC_IDLE_HOURS=2
|
||||||
# Максимум элементов плейлиста, рассматриваемых на канал за один синк.
|
|
||||||
|
# Глубина истории канала: максимум последних N видео на канал.
|
||||||
|
# Всё, что старше, намеренно не подтягивается.
|
||||||
VIDEOS_BACKFILL_CAP=200
|
VIDEOS_BACKFILL_CAP=200
|
||||||
# Остановить пагинацию плейлиста канала после стольких уже известных
|
|
||||||
# видео подряд (дальше — уже синхронизированная история).
|
# Остановить перелистывание плейлиста канала, когда подряд встретилось
|
||||||
|
# N уже известных видео (дальше — уже синхронизированная история)
|
||||||
VIDEOS_KNOWN_STOP_THRESHOLD=50
|
VIDEOS_KNOWN_STOP_THRESHOLD=50
|
||||||
|
|
||||||
|
# Окно «новых видео», дней. От него зависят бейджи «N новых» у каналов
|
||||||
|
# и в сайдбаре категорий, а также фильтр «только новые» по клику на число
|
||||||
NEW_VIDEOS_WINDOW_DAYS=2
|
NEW_VIDEOS_WINDOW_DAYS=2
|
||||||
|
|
||||||
|
# ---------- Логи ----------
|
||||||
|
|
||||||
LOG_LEVEL=INFO
|
LOG_LEVEL=INFO
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue