githubEdit

Installation

circle-info

After running Streamarr for the first time, configure it by visiting the web UI at http://[address]:3000 and completing the setup steps.

Docker

circle-exclamation

For details on the Docker CLI, please review the official docker run documentationarrow-up-right.

Installation:

docker run -d \
  --name streamarr \
  -e LOG_LEVEL=debug \
  -e TZ=America/New_York \
  -p 3000:3000 \
  -v /path/to/appdata/config:/app/config \
  --restart unless-stopped \
  ghcr.io/nickelsh1ts/streamarr:latest

To run the container as a specific user/group, you may optionally add --user=[ user | user:group | uid | uid:gid | user:gid | uid:group ] to the above command.

Updating:

Stop and remove the existing container:

docker stop streamarr && docker rm streamarr

Pull the latest image:

docker pull ghcr.io/nickelsh1ts/streamarr:latest

Finally, run the container with the same parameters originally used to create the container:

docker run -d ...
circle-info

You may alternatively use a third-party updating mechanism, such as Watchtowerarrow-up-right or Ouroborosarrow-up-right, to keep Streamarr up-to-date automatically.

Environment Variables

Variable
Default
Description

CONFIG_DIRECTORY

/app/config

Override the configuration directory path

NODE_ENV

production

Set to development for development mode

LOG_LEVEL

debug

Winston log level (error, warn, info, debug)

TZ

UTC

Timezone for the container

Ports

Port
Description

3000

Main web interface and API

circle-info

Streamarr also runs an internal Python service on port 5005 for Plex invite operations. This service is called internally by the Streamarr API and does not need to be exposed publicly.

Volume Mounts

Path
Description

/app/config

Configuration files, database, cache, and logs

The config directory contains:

  • settings.json — Application settings

  • db/db.sqlite3 — SQLite database

  • cache/images/ — Cached images from TMDB and Plex

  • logs/ — Application logs (rotated daily)

First-Time Setup

After starting Streamarr for the first time:

  1. Navigate to http://[your-server-ip]:3000 in your browser

  2. Sign in with your Plex account (the first user becomes the admin)

  3. Configure your Plex server connection

  4. (Optional) Add your *Arr services (Radarr, Sonarr, etc.)

  5. (Optional) Configure notification agents

circle-info

The admin account is always user ID 1 and has full permissions. This user cannot be deleted.

Last updated

Was this helpful?