Skip to main content

Installation

Step 1 - Clone the repository​

git clone https://github.com/stardarr/stardarr

Step 2 - Create the Docker Networks​

docker network create internal_network
docker network create web

A word about .env files​

Each service has a folder with a .env.example.

Make a copy of this file in the same folder and name it .env

Modify the .env file with your local paths, URLs, and other required items in each file.

For specific details on each environment variable. See the Services section of this documentation.

Step 3 - Start CloudflareDDNS​

cd CloudflareDDNS
cp .env.example .env # Copy the example environment file
nano .env # Edit the .env file with your configurations
docker compose up -d # Start the service

Step 4 - Start Traefik​

cd Traefik
cp .env.example .env
nano .env # Remember to replace the values with your own settings
docker compose up -d

Step 5 - Start Other Services​

After CloudflareDDNS and Traefik are running, you can start the rest of the services in any order you'd like.

The Services list in the sidebar is loosely ordered by importance and dependencies. It is recommended that you work you way down the list configuring each service one at a time. This will help to ensure that you have the right services running when they start to depend on each other for their configuration settings.

E.G. Sonarr & Radarr need a newsreader, so SABnzbd should be set up first.

For each service:

  • Ensure to create and modify the .env file.
  • Replace <Service Name> with the actual name of the service.
cd <Service Name>
cp .env.example .env
nano .env # Customize your configuration
docker compose up -d

See the Services section on the sidebar for more detailed service-specific documentation.

Step 6 - Configure the Services​

Most services will have a URL you can visit in order to configure it further. You can find the specific routes for each service in the Service URL List