docs: improve Docker documentation (#2109) [skip ci]

* docs: improve Docker documentation

* docs: suggested changes

* docs: minor formatting changes

* docs: add Doplarr to list of third-party integrations

* docs: rename docker run tab

* docs: add link to official Docker CLI docs

* docs: minor edits
pull/2189/head
TheCatLady 3 years ago committed by GitHub
parent 00ee535077
commit b7ba90d67b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -145,8 +145,7 @@ location ^~ /overseerr {
sub_filter '/android-' '/$app/android-'; sub_filter '/android-' '/$app/android-';
sub_filter '/apple-' '/$app/apple-'; sub_filter '/apple-' '/$app/apple-';
sub_filter '/favicon' '/$app/favicon'; sub_filter '/favicon' '/$app/favicon';
sub_filter '/logo_full.svg' '/$app/logo_full.svg'; sub_filter '/logo_' '/$app/logo_';
sub_filter '/logo_stacked.svg' '/$app/logo_stacked.svg';
sub_filter '/site.webmanifest' '/$app/site.webmanifest'; sub_filter '/site.webmanifest' '/$app/site.webmanifest';
} }
``` ```

@ -8,6 +8,7 @@ We do not officially support these third-party integrations. If you run into any
- [Heimdall](https://github.com/linuxserver/Heimdall), an application dashboard and launcher - [Heimdall](https://github.com/linuxserver/Heimdall), an application dashboard and launcher
- [LunaSea](https://docs.lunasea.app/modules/overseerr), a self-hosted controller for mobile and macOS - [LunaSea](https://docs.lunasea.app/modules/overseerr), a self-hosted controller for mobile and macOS
- [Requestrr](https://github.com/darkalfx/requestrr/wiki/Configuring-Overseerr), a Discord chatbot - [Requestrr](https://github.com/darkalfx/requestrr/wiki/Configuring-Overseerr), a Discord chatbot
- [Doplarr](https://github.com/kiranshila/Doplarr), a Discord request bot
- [ha-overseerr](https://github.com/vaparr/ha-overseerr), a custom Home Assistant component - [ha-overseerr](https://github.com/vaparr/ha-overseerr), a custom Home Assistant component
- [OverCLIrr](https://github.com/WillFantom/OverCLIrr), a command-line tool - [OverCLIrr](https://github.com/WillFantom/OverCLIrr), a command-line tool
- [Overseerr Exporter](https://github.com/WillFantom/overseerr-exporter), a Prometheus exporter - [Overseerr Exporter](https://github.com/WillFantom/overseerr-exporter), a Prometheus exporter

@ -10,8 +10,18 @@ After running Overseerr for the first time, configure it by visiting the web UI
## Docker ## 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 Overseerr 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your time zone!
{% endhint %}
{% tabs %} {% tabs %}
{% tab title="Basic" %} {% tab title="Docker CLI" %}
For details on the Docker CLI, please [review the official `docker run` documentation](https://docs.docker.com/engine/reference/run/).
**Installation:**
```bash ```bash
docker run -d \ docker run -d \
@ -24,11 +34,41 @@ docker run -d \
sctx/overseerr sctx/overseerr
``` ```
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:
```bash
docker stop overseerr && docker rm overseerr
```
Pull the latest image:
```bash
docker pull sctx/overseerr
```
Finally, run the container with the same parameters originally used to create the container:
```bash
docker run -d ...
```
{% hint style="info" %}
You may alternatively use a third-party updating mechanism, such as [Watchtower](https://github.com/containrrr/watchtower) or [Ouroboros](https://github.com/pyouroboros/ouroboros), to keep Overseerr up-to-date automatically.
{% endhint %}
{% endtab %} {% endtab %}
{% tab title="Compose" %} {% tab title="Docker Compose" %}
For details on how to use Docker Compose, please [review the official Compose documentation](https://docs.docker.com/compose/reference/).
**docker-compose.yml:** **Installation:**
Define the `overseerr` service in your `docker-compose.yml` as follows:
```yaml ```yaml
--- ---
@ -48,47 +88,29 @@ services:
restart: unless-stopped restart: unless-stopped
``` ```
{% endtab %} Then, start all services defined in the your Compose file:
{% tab title="UID/GID" %}
```text ```bash
docker run -d \ docker-compose up -d
--name overseerr \
--user=[ user | user:group | uid | uid:gid | user:gid | uid:group ] \
-e LOG_LEVEL=debug \
-e TZ=Asia/Tokyo \
-p 5055:5055 \
-v /path/to/appdata/config:/app/config \
--restart unless-stopped \
sctx/overseerr
``` ```
{% endtab %} **Updating:**
{% tab title="Manual Update" %} Pull the latest image:
```bash ```bash
# Stop the Overseerr container docker-compose pull overseerr
docker stop overseerr ```
# Remove the Overseerr container
docker rm overseerr
# Pull the latest update Then, restart all services defined in the Compose file:
docker pull sctx/overseerr
# Run the Overseerr container with the same parameters as before ```bash
docker run -d ... docker-compose up -d
``` ```
{% endtab %} {% endtab %}
{% endtabs %} {% endtabs %}
{% hint style="info" %}
Use a 3rd party updating mechanism such as [Watchtower](https://github.com/containrrr/watchtower) or [Ouroboros](https://github.com/pyouroboros/ouroboros) to keep Overseerr up-to-date automatically.
{% endhint %}
## Unraid ## Unraid
1. Ensure you have the **Community Applications** plugin installed. 1. Ensure you have the **Community Applications** plugin installed.
@ -144,29 +166,24 @@ The [Overseerr snap](https://snapcraft.io/overseerr) is the only officially supp
Currently, the listening port cannot be changed, so port `5055` will need to be available on your host. To install `snapd`, please refer to the [Snapcraft documentation](https://snapcraft.io/docs/installing-snapd). Currently, the listening port cannot be changed, so port `5055` will need to be available on your host. To install `snapd`, please refer to the [Snapcraft documentation](https://snapcraft.io/docs/installing-snapd).
{% endhint %} {% endhint %}
**To install:** **Installation:**
``` ```
sudo snap install overseerr sudo snap install overseerr
``` ```
{% hint style="danger" %}
To install the development build, add the `--edge` argument to the above command (i.e., `sudo snap install overseerr --edge`). However, note that this version can break any moment. Be prepared to troubleshoot any issues that arise!
{% endhint %}
**Updating:** **Updating:**
Snap will keep Overseerr up-to-date automatically. You can force a refresh by using the following command. Snap will keep Overseerr up-to-date automatically. You can force a refresh by using the following command.
``` ```bash
sudo snap refresh sudo snap refresh
``` ```
**To install the development build:**
```
sudo snap install overseerr --edge
```
{% hint style="danger" %}
This version can break any moment. Be prepared to troubleshoot any issues that arise!
{% endhint %}
## Third-Party ## Third-Party
{% tabs %} {% tabs %}

Loading…
Cancel
Save