Add .env.example

This commit is contained in:
heboba
2026-02-26 20:33:50 +00:00
parent bd23a9da8a
commit 756f53ef3b
2 changed files with 47 additions and 0 deletions

37
.env.example Normal file
View File

@@ -0,0 +1,37 @@
# Telegram
TELEGRAM_BOT_TOKEN=your_telegram_bot_token_here
# Spotify app credentials
SPOTIFY_CLIENT_ID=your_spotify_client_id
SPOTIFY_CLIENT_SECRET=your_spotify_client_secret
SPOTIFY_REDIRECT_URI=http://localhost:8000/auth/spotify/callback
SPOTIFY_DEFAULT_MARKET=NL
# Optional: improves recommendation quality
LASTFM_API_KEY=
# App / API
APP_ENV=dev
APP_BASE_URL=http://localhost:8000
APP_INTERNAL_URL=http://app:8000
APP_PORT=8000
APP_TIMEZONE=UTC
TZ=UTC
# Internal auth (used by optional cron -> internal endpoint)
INTERNAL_JOB_TOKEN=change-me-to-a-random-secret
# Storage
DB_PATH=/data/app.db
# Recommendation defaults
DEFAULT_PLAYLIST_SIZE=30
MIN_NEW_RATIO=0.8
RECENT_DAYS_WINDOW=5
PLAYLIST_VISIBILITY=private
# Optional cron (only if you start the cron profile)
CRON_SCHEDULE=15 2 * * *
# Optional Traefik label host (used by docker-compose labels)
TRAEFIK_HOSTNAME=spotify-vibe.example.com

View File

@@ -1,5 +1,7 @@
# Spotify Daily Vibe Bot (Telegram + Spotify + Docker) # Spotify Daily Vibe Bot (Telegram + Spotify + Docker)
Telegram bot: https://t.me/spotify_vibe_bot (`@spotify_vibe_bot`)
Ready-to-run backend service that: Ready-to-run backend service that:
- connects to your Spotify account - connects to your Spotify account
@@ -39,6 +41,14 @@ For better recommendation quality, adding `LASTFM_API_KEY` is recommended.
4. Copy `.env.example` to `.env` and fill in the values. 4. Copy `.env.example` to `.env` and fill in the values.
5. Start: 5. Start:
If you are using the provided `docker-compose.yml` as-is, create the external Docker network once (used by Traefik labels/network wiring):
```bash
docker network create web || true
```
Then start:
```bash ```bash
docker compose up -d --build docker compose up -d --build
``` ```