Skip to main content

Installation

Agregarr runs in Docker. You'll need Docker installed and a running Plex Media Server. Plex Pass is required to promote Collections to the Home screen.

Create a docker-compose.yml file:

docker-compose.yaml
services:
  agregarr:
    image: agregarr/agregarr:latest
    container_name: agregarr
    volumes:
      - /path/to/config:/app/config # Change /path/to/config to your actual config path
      # Linux/Mac: - /mnt/serverdata/configs/agregarr:/app/config
      # Windows:   - C:\serverdata\configs\agregarr:/app/config

      # Optional: For Coming Soon/Placeholder feature
      - /path/to/placeholder/movies:/data/movies
      - /path/to/placeholder/tv:/data/tv
      # Linux/Mac:
      # - /mnt/media/movie-placeholders:/data/movies
      # - /mnt/media/tv-placeholders:/data/tv
      # Windows:
      # - E:\media\movie-placeholders:/data/movies
      # - E:\media\tv-placeholders:/data/tv

      # And then select your root folders in Settings -> Downloads
    environment:
      - TZ=Pacific/Auckland # Set to your local timezone for accurate poster overlay release dates/countdowns - see 'TZ Identifier' column here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
    ports:
      - 7171:7171
    restart: unless-stopped
Important

Change /path/to/config to your actual config directory, otherwise your settings won't persist after restarts!

Examples:

  • Linux/macOS: - /home/username/serverdata/configs/agregarr:/app/config
  • Windows: - C:\serverdata\configs\agregarr:/app/config

For further information on placeholder volume setup, see Placeholder Volumes

Save the file as docker-compose.yml, using our above examples:

  • Linux/macOS: - /home/username/serverdata/docker-compose.yml
  • Windows: - C:\serverdata\docker-compose.yml

Navigate to the directory where you have stored you docker-compose.yml file:

Linux​

cd
cd serverdata
docker-compose up -d

Windows​

See the below example to navigate to the directory, open command prompt, and run docker-compose.yml

Access Agregarr at http://localhost:7171

Docker Run​

If you prefer docker run instead of compose:

docker run -d \
  --name agregarr \
  -p 7171:7171 \
  -v /path/to/config:/app/config \
  --restart unless-stopped \
  agregarr/agregarr:latest

Updating​

Docker Compose​

docker-compose down
docker-compose pull
docker-compose up -d

Docker Run​

docker stop agregarr
docker rm agregarr
docker pull agregarr/agregarr:latest
# Run the docker run command again

Your settings/database persist in the config volume. If after restart Agregarr is reset, it is because your volume is not mounted correctly.