Configuration

Introduction

This guide will help you configure SuggestArr to work with your media server (Jellyfin or Plex) and integrate with other APIs (TMDb, Jellyseer, Overseerr). You can configure SuggestArr either via environment variables or through the web interface after starting the application.

Configuration via Web Interface

After starting the Docker container or running the application locally, you can configure SuggestArr via the web interface.

1. Start the application:

   • If running locally:

     python app.py

   • If using Docker Compose:

     docker-compose up --build

2. Access the web interface: Navigate to http://localhost:5000 in your browser.

3. Follow the setup wizard: The setup wizard will guide you through the configuration process where you can input your TMDb API key, select your media server (Jellyfin or Plex), and provide the necessary API URLs and tokens.

4. Save the configuration: Once the setup is complete, your configuration will be saved, and SuggestArr will start fetching recommendations based on your media server's history.

Logs and Monitoring

You can monitor the application's behavior and debug any issues by checking the logs.

• Docker Logs: If running in Docker, use the following command to check logs:

  docker logs SuggestArr

• Log Files:

  • /var/log/cron.log: Logs for cron jobs.
  • /var/log/gunicorn.log: Logs for Gunicorn web server.
  • /var/log/gunicorn_error.log: Error logs for Gunicorn.

Updating the Configuration

You can update the configuration either by:

1. Editing the environment variables and restarting the application, or
2. Using the web interface to make changes, followed by a save.

Resetting the Configuration

If you need to reset the configuration, you can use the "Reset Configuration" button in the web interface, or delete the configuration files and restart the application.

For more information or troubleshooting, please visit the GitHub repository.