Skip to content

Update README/compose with environment variables#747

Merged
mxpv merged 1 commit intomxpv:mainfrom
garlic-hub:readme_docs
Jul 25, 2025
Merged

Update README/compose with environment variables#747
mxpv merged 1 commit intomxpv:mainfrom
garlic-hub:readme_docs

Conversation

@garlic-hub
Copy link
Contributor

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

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
| 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

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

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

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.

@mxpv
Copy link
Owner

mxpv commented Jul 25, 2025

@claude can you address comments in a separate PR?

@claude
Copy link
Contributor

claude bot commented Jul 25, 2025

Claude encountered an error —— View job

Failed with exit code 128

I'll analyze this and get back to you.

@mxpv mxpv merged commit 5d31bb3 into mxpv:main Jul 25, 2025
11 of 12 checks passed
@garlic-hub garlic-hub deleted the readme_docs branch July 25, 2025 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants