Skip to content

Commit

Permalink
Merge pull request #34 from nwithan8/docker
Browse files Browse the repository at this point in the history 
Add Docker environmental variables to README.md (thanks @Znomon)
  • Loading branch information
@nwithan8
nwithan8 authored Aug 31, 2022
2 parents 6fed1f9 + d52abd0 commit 8a7494d
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
View file
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

0 comments on commit 8a7494d

Please sign in to comment.