From b7ba90d67b53071a9bce472b4ebc5f988d0c16da Mon Sep 17 00:00:00 2001
From: TheCatLady <52870424+TheCatLady@users.noreply.github.com>
Date: Sat, 9 Oct 2021 19:29:27 -0400
Subject: [PATCH] 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
---
 docs/extending-overseerr/reverse-proxy.md |   3 +-
 docs/extending-overseerr/third-party.md   |   1 +
 docs/getting-started/installation.md      | 103 +++++++++++++---------
 3 files changed, 62 insertions(+), 45 deletions(-)

diff --git a/docs/extending-overseerr/reverse-proxy.md b/docs/extending-overseerr/reverse-proxy.md
index 1ebb4b469..5aa6fd462 100644
--- a/docs/extending-overseerr/reverse-proxy.md
+++ b/docs/extending-overseerr/reverse-proxy.md
@@ -145,8 +145,7 @@ location ^~ /overseerr {
     sub_filter '/android-' '/$app/android-';
     sub_filter '/apple-' '/$app/apple-';
     sub_filter '/favicon' '/$app/favicon';
-    sub_filter '/logo_full.svg' '/$app/logo_full.svg';
-    sub_filter '/logo_stacked.svg' '/$app/logo_stacked.svg';
+    sub_filter '/logo_' '/$app/logo_';
     sub_filter '/site.webmanifest' '/$app/site.webmanifest';
 }
 ```
diff --git a/docs/extending-overseerr/third-party.md b/docs/extending-overseerr/third-party.md
index c7d57fd4f..cf2946d91 100644
--- a/docs/extending-overseerr/third-party.md
+++ b/docs/extending-overseerr/third-party.md
@@ -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
 - [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
+- [Doplarr](https://github.com/kiranshila/Doplarr), a Discord request bot
 - [ha-overseerr](https://github.com/vaparr/ha-overseerr), a custom Home Assistant component
 - [OverCLIrr](https://github.com/WillFantom/OverCLIrr), a command-line tool
 - [Overseerr Exporter](https://github.com/WillFantom/overseerr-exporter), a Prometheus exporter
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
index 205aa99f7..f3dce15f4 100644
--- a/docs/getting-started/installation.md
+++ b/docs/getting-started/installation.md
@@ -10,8 +10,18 @@ After running Overseerr for the first time, configure it by visiting the web UI
 
 ## 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 %}
-{% 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
 docker run -d \
@@ -24,11 +34,41 @@ docker run -d \
   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 %}
 
-{% 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
 ---
@@ -48,47 +88,29 @@ services:
     restart: unless-stopped
 ```
 
-{% endtab %}
-
-{% tab title="UID/GID" %}
+Then, start all services defined in the your Compose file:
 
-```text
-docker run -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
+```bash
+docker-compose up -d
 ```
 
-{% endtab %}
+**Updating:**
 
-{% tab title="Manual Update" %}
+Pull the latest image:
 
 ```bash
-# Stop the Overseerr container
-docker stop overseerr
-
-# Remove the Overseerr container
-docker rm overseerr
+docker-compose pull overseerr
+```
 
-# Pull the latest update
-docker pull sctx/overseerr
+Then, restart all services defined in the Compose file:
 
-# Run the Overseerr container with the same parameters as before
-docker run -d ...
+```bash
+docker-compose up -d
 ```
 
 {% endtab %}
 {% 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
 
 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).
 {% endhint %}
 
-**To install:**
+**Installation:**
 
 ```
 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:**
+
 Snap will keep Overseerr up-to-date automatically. You can force a refresh by using the following command.
 
-```
+```bash
 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
 
 {% tabs %}