01. Installation

🛠️ Installation

This guide will walk you through the process of installing TGraph Bot using Docker Compose or the Unraid Community Application.

🐳 Docker Compose Installation

To get started with TGraph Bot using Docker Compose, follow these steps:

1. Create a Docker Compose file: Create a new file named docker-compose.yml and add the following content:

   services:
     tgraph-bot:
       container_name: tgraph-bot
       image: ghcr.io/engels74/tgraph-bot:latest
       environment:
         - PUID=1000
         - PGID=1000
         - UMASK=002
         - TZ=Etc/UTC
       volumes:
         - /<host_folder_config>:/config

   Replace /<host_folder_config> with the path to your desired configuration folder on the host machine.

2. Create the configuration file:

   • Download the config.yml.sample file:

     curl -o /<host_folder_config>/config.yml https://raw.githubusercontent.com/engels74/tgraph-bot-source/main/config/config.yml.sample

   • Edit the config.yml file and replace the placeholder values with your actual settings. (See the Configuration page for details)

3. Run the Docker container: In the same directory as your docker-compose.yml file, run:

   docker-compose up -d

🔧 Unraid Community Application Installation

TGraph Bot is available as an Unraid Community Application, making it easy to install and manage on Unraid systems:

1. Open the Unraid Apps tab.
2. Search for "TGraph Bot" in the available applications.
3. Click on the TGraph Bot application.
4. Click "Install" to add TGraph Bot to your Unraid system.
5. Configure the container settings as prompted, including the path to your configuration folder.

You can find the TGraph Bot application in the Unraid Community Applications here: TGraph Bot on Unraid Community Apps

⚙️ Configuration File Setup

Regardless of the installation method, you'll need to set up a config.yml file. Here's how:

1. If you haven't already, download the sample configuration file:

   curl -o /path/to/your/config/folder/config.yml https://raw.githubusercontent.com/engels74/tgraph-bot-source/main/config/config.yml.sample

2. Open the config.yml file in a text editor.

3. Update the values in the file with your specific settings. At a minimum, you'll need to set:

   • TAUTULLI_API_KEY: Your Tautulli API key
   • TAUTULLI_URL: The URL to your Tautulli instance
   • DISCORD_TOKEN: Your Discord bot token
   • CHANNEL_ID: The ID of the Discord channel where you want to post graphs

4. Save the file.

For a full list of configuration options and their descriptions, please refer to the Configuration page.

🔍 Verifying the Installation

After installation and configuration:

1. Check that the Docker container is running:

   docker ps

   You should see tgraph-bot in the list of running containers.

2. Check the logs for any errors:

   docker logs tgraph-bot

3. If everything is set up correctly, you should see TGraph Bot come online in your Discord server, and it should start posting graphs according to your configuration.

If you encounter any issues, please check the Troubleshooting page or reach out for support.