Skip to content

Commit 5d31bb3

Browse files
garlic-hubmxpv
authored andcommitted
Update README/compose with environment variables
Document the available environment variables in the README for better visibility. Also provide examples in the compose file. Other minor fixes: - Removed deprecated version string from compose file - Changed compose file ports to match readme and config.toml
1 parent e439f32 commit 5d31bb3

File tree

2 files changed

+18
-3
lines changed

2 files changed

+18
-3
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,18 @@ hostname = "https://my.test.host:4443"
104104

105105
Server will be accessible from `http://localhost:8080`, but episode links will point to `https://my.test.host:4443/ID1/...`
106106

107+
### 🌍 Environment Variables
108+
109+
Podsync supports the following environment variables for configuration and API keys:
110+
111+
| Variable Name | Description | Example Value(s) |
112+
|------------------------------|-------------------------------------------------------------------------------------------|-----------------------------------------------|
113+
| `PODSYNC_CONFIG_PATH` | Path to the configuration file (overrides `--config` CLI flag) | `/app/config.toml` |
114+
| `PODSYNC_YOUTUBE_API_KEY` | YouTube API key(s), space-separated for rotation | `AIzaSyD4w2s-k79YNR98ABC` or `key1 key2 key3` |
115+
| `PODSYNC_VIMEO_API_KEY` | Vimeo API key(s), space-separated for rotation | `ecd4d34b07bcb9509ABCD` or `key1 key2` |
116+
| `PODSYNC_SOUNDCLOUD_API_KEY` | SoundCloud API key(s), space-separated for rotation | `soundcloud_key1 soundcloud_key2` |
117+
| `PODSYNC_TWITCH_API_KEY` | Twitch API credentials in the format `CLIENT_ID:CLIENT_SECRET`, space-separated for multi | `id1:secret1 id2:secret2` |
118+
107119
## 🚀 How to run
108120

109121

docker-compose.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
1-
version: '2.2'
2-
31
services:
42
podsync:
53
container_name: podsync
64
image: mxpv/podsync:latest
75
restart: always
86
ports:
9-
- 80:80
7+
- 8080:8080
108
volumes:
119
- ./data:/app/data/
1210
- ./db:/app/db/
1311
- ./config.toml:/app/config.toml
12+
# environment:
13+
# - PODSYNC_YOUTUBE_API_KEY=${YOUTUBE_API_KEY}
14+
# - PODSYNC_VIMEO_API_KEY=${VIMEO_API_KEY}
15+
# - PODSYNC_SOUNDCLOUD_API_KEY=${SOUNDCLOUD_API_KEY}
16+
# - PODSYNC_TWITCH_API_KEY=${TWITCH_API_KEY}

0 commit comments

Comments
 (0)