wizarr/docs/getting-started/installation.md

description

description
Install Wizarr using Docker or Compose

Installation

{% hint style="info" %} We have recently updated from V2 to V3, this has many improvements and features however V2 will always be available, however we won't be able to provide updates and support for V2, to use V2 visit it below.

View Documentation {% endhint %}

Docker

{% hint style="warning" %} Be sure to replace/path/to/appdata/config in the below examples with a valid host directory path. If this volume mount is not configured correctly, your Wizarr settings/data will not be persisted when the container is recreated (e.g., when updating the image or rebooting your machine).

The TZ environment variable value should also be set to the TZ database name of your time zone! {% endhint %}

{% tabs %} {% tab title="Docker Compose (recommended)" %} Installation:

Define the wizarr service in your docker-compose.yml as follows:

---
version: "3.8"
services:
  wizarr:
    container_name: wizarr
    image: ghcr.io/wizarrrr/wizarr
    ports:
      - 5690:5690
    volumes:
      - /path/to/appdata/config:/data/database

Then, start all services defined in the Compose file:

docker compose up -d or docker-compose up -d

Updating

Pull the latest image:

docker compose pull wizarr or docker-compose pull wizarr

Then, restart all services defined in the Compose file:

docker compose up -d or docker-compose up -d {% endtab %}

{% tab title="Docker CLI" %} Installation

docker run -d \
  --name wizarr \
  -p 5690:5690 \
  -v /path/to/appdata/config:/data/database \
  --restart unless-stopped \
  ghcr.io/wizarrrr/wizarr

Updating

Stop and remove the existing container:

docker stop wizarr && docker rm wizarr

Pull the latest image:

docker pull ghcr.io/wizarrrr/wizarr

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

docker run -d ...

{% endtab %} {% endtabs %}

Unraid

{% hint style="warning" %} NOT IMPLEMENTED YET {% endhint %}

1. Ensure you have the Community Applications plugin installed.
2. Inside the Community Applications app store, search for Wizarr.
3. Click the Install Button.
4. On the following Add Container screen, make changes to the Host Port and Host Path 1(Appdata) as needed, as well as the environment variables.
5. Click apply and access "Wizarr" at your <ServerIP:HostPort> in a web browser.