Skip to content

Update README/compose with environment variables #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mxpv merged 1 commit into from
Jul 25, 2025
Merged

Update README/compose with environment variables #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,18 @@ hostname = "https://my.test.host:4443"

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

### 🌍 Environment Variables

Podsync supports the following environment variables for configuration and API keys:

| Variable Name | Description | Example Value(s) |
|------------------------------|-------------------------------------------------------------------------------------------|-----------------------------------------------|
| `PODSYNC_CONFIG_PATH` | Path to the configuration file (overrides `--config` CLI flag) | `/app/config.toml` |
| `PODSYNC_YOUTUBE_API_KEY` | YouTube API key(s), space-separated for rotation | `AIzaSyD4w2s-k79YNR98ABC` or `key1 key2 key3` |
Copy link
Owner

@mxpv mxpv Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if AIzaSyD4w2s-k79YNR98ABC is a real key (and if so, you'd probably want to revoke it :) ). Can we replace it with just key1 to not confuse anyone.
(same for vimeo)

Copy link
Contributor Author

@garlic-hub garlic-hub Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was copied from docs/how_to_get_youtube_api_key.md. Vimeo from it's respective file as well

Copy link
Owner

@mxpv mxpv Jul 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, we should remove from there as well.

| `PODSYNC_VIMEO_API_KEY` | Vimeo API key(s), space-separated for rotation | `ecd4d34b07bcb9509ABCD` or `key1 key2` |
| `PODSYNC_SOUNDCLOUD_API_KEY` | SoundCloud API key(s), space-separated for rotation | `soundcloud_key1 soundcloud_key2` |
| `PODSYNC_TWITCH_API_KEY` | Twitch API credentials in the format `CLIENT_ID:CLIENT_SECRET`, space-separated for multi | `id1:secret1 id2:secret2` |

## 🚀 How to run


Expand Down
9 changes: 6 additions & 3 deletions docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
version: '2.2'

services:
podsync:
container_name: podsync
image: mxpv/podsync:latest
restart: always
ports:
- 80:80
- 8080:8080
volumes:
- ./data:/app/data/
- ./db:/app/db/
- ./config.toml:/app/config.toml
# environment:
# - PODSYNC_YOUTUBE_API_KEY=${YOUTUBE_API_KEY}
# - PODSYNC_VIMEO_API_KEY=${VIMEO_API_KEY}
# - PODSYNC_SOUNDCLOUD_API_KEY=${SOUNDCLOUD_API_KEY}
# - PODSYNC_TWITCH_API_KEY=${TWITCH_API_KEY}
Loading