Skip to content
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

Add Docker environmental variables to README.md #34

Merged
merged 1 commit into from
Aug 31, 2022
Merged

Add Docker environmental variables to README.md #34

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
31 changes: 26 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,32 @@ Run the script with the following command:
python3 Tauticord.py

# Docker
You can also run Tauticord as a Docker container.

After copying and editing your ``config.py`` file, build the container with:
``docker build -t tauticord .``
Run the container with ``docker run tauticord``
You can also run Tauticord as a Docker container. The Dockerfile is included in this repository, or can be pulled from [Docker Hub](https://hub.docker.com/r/nwithan8/tauticord).

You will need to set the following environment variables:

| Environment Variable | Value | Example/Default |
|---------------------------------|----------------------------------------------------------------|--------------------------------------|
| TC_TAUTULLI_URL (required) | IP of your Tautulli server | http://192.168.1.x:8181 |
| TC_TAUTULLI_KEY (required) | API key for Tautulli server | abcd1234efgh5678ijkl9012mnop3456qrst |
| TC_PLEX_PASS | Enable PlexPass Features | "False" |
| TC_REFRESH_SECONDS | Seconds between updates | 15 |
| TC_TERMINATE_MESSAGE | Message sent to users when a stream is killed | "Your stream has ended." |
| TC_USE_24_HOUR_TIME | Whether to display times in 24-hour time | "False" |
| TC_VC_STREAM_COUNT | Whether to display current stream count in a voice channel | "False" |
| TC_VC_TRANSCODE_COUNT | Whether to display current transcode count in a voice channel | "False" |
| TC_VC_BANDWIDTH | Whether to display current bandwidth in a voice channel | "False" |
| TC_VC_LOCAL_BANDWIDTH | Whether to display current local bandwidth in a voice channel | "False" |
| TC_VC_REMOTE_BANDWIDTH | Whether to display current remote bandwidth in a voice channel | "False" |
| TC_VC_LIBRARY_STATS | Whether to display library statistics in voice channels | "False" |
| TC_VC_LIBRARY_NAMES | Comma-separated list of libraries to display statistics of | "Movies,TV Shows,Music" |
| TC_DISCORD_BOT_TOKEN (required) | Discord Bot Token | <key from DiscordApplication above > |
| TC_DISCORD_SERVER_ID (required) | Discord Server ID | <ID, right-click server> |
| TC_DISCORD_OWNER_ID | Your Discord ID for PlexPass Features | <ID, right-click profile> |
| TC_DISCORD_CHANNEL_NAME | Channel name for updates | "Tautulli Status" |
| TC_USE_EMBEDS | Use embedded messages rather than regular text chat | "True" |
| TC_ALLOW_ANALYTICS | Allow Anonymous Crash Analytics? | "True" | | |
| TZ | Timezone that your server is in | "America/New_York" |

# Analytics
Tauticord uses Google Analytics to collect statistics such as common errors that will help with future development.
Expand Down