Skip to content

Installation.md

Latest commit

 

History

History
116 lines (80 loc) · 3.28 KB

Installation.md

File metadata and controls

116 lines (80 loc) · 3.28 KB

PlexBot Installation Guide

Prerequisites

Installation

Step 1: Clone the Repository

git clone https://github.com/kalebbroo/PlexBot.git
cd PlexBot

Step 2: Configure Secrets

Copy the template and fill in your credentials:

cp RenameMe.env.txt .env

Edit .env with your values:

DISCORD_TOKEN=your_discord_bot_token
PLEX_URL=http://your-plex-ip:32400
PLEX_TOKEN=your_plex_token

These three are required. All other .env values have working defaults. See the Configuration Guide for the full list.

Step 3: Configure Application Settings (Optional)

config.fds is auto-created from the template with sensible defaults when the bot starts for the first time. You don't need to do anything for default settings.

To customize before first run, copy the template and edit it:

cp RenameMe.config.fds config.fds

Customize player style, progress bar, logging, etc. as needed. See the Configuration Guide for all options.

Step 4: Run the Install Script

Windows:

cd Install
win-install.bat

Linux:

chmod +x ./Install/linux-install.sh
./Install/linux-install.sh

The script will:

  1. Build the PlexBot Docker image (includes .NET 9 SDK, fonts, dependencies)
  2. Pull the Lavalink 4 image
  3. Start both containers on a shared Docker network

Step 5: Verify Installation

Check the logs to make sure the bot started successfully:

docker-compose logs -f

Or open Docker Desktop and click the PlexBot container group to see logs from both services.

You should see:

  • "Lavalink services initialized"
  • "Bot is ready"
  • The bot appearing online in your Discord server

Updating

Run the install script again — it pulls the latest code from GitHub and rebuilds the Docker image:

# Windows
cd Install && win-install.bat

# Linux
./Install/linux-install.sh

Troubleshooting

Bot Doesn't Start

  • Check the logs: docker-compose logs plexbot
  • Verify DISCORD_TOKEN is correct in .env
  • Verify .env exists at the project root (config.fds is auto-created if missing)

No Audio

  • Check Lavalink is running: docker-compose logs lavalink
  • Ensure the bot has Connect and Speak permissions in the voice channel
  • Verify Plex is reachable from the Docker host

No Text on Player Images

  • Rebuild the container to ensure fonts are installed: docker-compose up -d --build

For more detailed troubleshooting, see the Troubleshooting Guide.

Additional Resources