Skip to content

Installation

Giuseppe Barchetta edited this page Feb 10, 2025 · 9 revisions

Requirements for Docker Installation

  • Docker
  • APIs: Jellyfin or Plex, TMDb API, Jellyseer or Overseerr

1. Docker Compose Configuration

services:
  suggestarr:
    image: ciuse99/SuggestArr:latest
    container_name: SuggestArr
    restart: always
    ports:
      - "5000:5000"
    volumes:
      - ./config_files:/app/config/config_files

2. Running the Docker Container

  • Run the Docker container with the following command:
    docker-compose up
  • Once the container is running, you can access the web interface for configuring SuggestArr at http://localhost:5000.

3. Configure SuggestArr

  • Use the web interface to set up your preferred media sources (Jellyfin, Plex, etc.).
  • The application will begin fetching recommendations and downloading content based on your media history.

Additional Configuration Options

  • Jellyfin/Plex/Emby Setup: You can choose between Jellyfin, Plex or Emby during configuration. The setup process will vary based on the chosen media server.
  • Jellyseer and Overseerr Integration: SuggestArr supports both of these services for a unified configuration. Ensure you input the necessary environment variables during setup.
  • Log Monitoring: You can check the container's logs for any issues:
    docker logs SuggestArr
    Or use the logs button in the web interface.

Running the Project Without Docker

Prerequisites

  • Python 3.8+ installed
  • Node.js 16+ and npm installed
  • pip and venv for virtual environment management
  • Administrator privileges (to configure the service)

1. Project Setup

1.1. Clone the repository

git clone <REPOSITORY_URL>
cd <PROJECT_DIRECTORY>

1.2. Set up the Python environment

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

1.3. Install frontend dependencies

cd client
npm install
cd ..

2. Running the Project

2.1. Start the backend

source venv/bin/activate
python -m flask run --host=0.0.0.0 --port=5000

2.2. Start the frontend

cd client
npm run serve

3. Running the Project as a Service

3.1. Create a systemd service for Flask (Linux)

Create a new service file in /etc/systemd/system/:

sudo nano /etc/systemd/system/suggestarr.service

Add the following content to the file:

[Unit]
Description=SuggestArr
After=network.target

[Service]
User=<YOUR_USER>
WorkingDirectory=<PROJECT_DIRECTORY>
ExecStart=<PROJECT_DIRECTORY>/venv/bin/python -m flask run --host=0.0.0.0 --port=5000
Environment="FLASK_APP=api_service/app.py"
Environment="FLASK_DEBUG=0"
Restart=always

[Install]
WantedBy=multi-user.target

3.2. Reload systemd and start the service

sudo systemctl daemon-reload
sudo systemctl start suggestarr.service
sudo systemctl enable suggestarr.service

3.3. Check the status of the service

sudo systemctl status suggestarr.service

4. Build the Project from Source

4.1. Set up the project as described above.

4.2. For the backend, ensure all Python dependencies are installed by running:

pip install -r requirements.txt

4.3. For the frontend, install the necessary Node.js packages:

cd client
npm install
cd ..

4.4. Run the project as described in Section 2.

Clone this wiki locally