Skip to content

Installation

Giuseppe Barchetta edited this page Oct 24, 2024 · 6 revisions

System Requirements

  • Python: 3.x or Docker
  • APIs: Jellyfin or Plex, TMDb API, Jellyseer or Overseerr

Docker Installation

services:
  suggestarr:
    image: ciuse99/SuggestArr
    container_name: SuggestArr
    restart: always
    ports:
      - "5000:5000"
    volumes:
      - ./config_files:/app/config/config_files
  1. Run the Docker Compose without environment variables and configure the application via the web interface at http://localhost:5000.

  2. Start the container:

    docker-compose up --build
  3. You can now configure SuggestArr via the web interface. After configuring, the application will start fetching recommendations and downloading content based on your Jellyfin or Plex history.

Additional Configuration Options

  • You can now use Plex as an alternative to Jellyfin. The setup flow will change based on the media server you select.
  • Jellyseer and Overseerr are supported with a unified variable set for easy management.
  • You can monitor the application's behavior via logs: docker logs <container-name> or directly via the logs button in the web interface.

Local Installation

  1. Clone the repository:

    git clone https://github.com/giuseppe99barchetta/SuggestArr.git
  2. Install dependencies:

    pip install -r requirements.txt
  3. Install frontend dependencies:

    The frontend is built with Vue.js. To install the frontend dependencies:

    cd app/suggestarr-frontend
    npm install
    npm run build
    cd ..
  4. Run the application:

    Execute the following command to start the application:

    python app.py

    Alternatively, if you're using a production environment with supervisord, you can use the supervisor configuration included in the repository to manage Gunicorn and cron jobs:

    supervisord -c /etc/supervisor/conf.d/supervisord.conf
Clone this wiki locally