shpaq/sct-overseerr
1
0
Fork 0
mirror of https://github.com/sct/overseerr.git synced 2025-12-26 16:27:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add querystring support & admonitions to docker page (#860)

Browse Source 
* docs: add querystring support to docker methods

* docs: add query string support to the rest of the tabs

* docs: add admonition for named volumes and emby variable
This commit is contained in:
Fallenbagel
2024-07-06 05:45:46 +05:00
committed by GitHub
parent 31ca32df99
commit 9dd175bb2e
6 changed files with 26 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/getting-started/docker.mdx
View File

@@ -20,7 +20,7 @@ Be sure to replace `/path/to/appdata/config` in the below examples with a valid
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
<Tabs groupId="docker-methods">
<Tabs groupId="docker-methods" queryString>
<TabItem value="docker-cli" label="Docker CLI">
For details on the Docker CLI, please [review the official `docker run` documentation](https://docs.docker.com/engine/reference/run/).
@@ -37,6 +37,9 @@ docker run -d \
--restart unless-stopped \
fallenbagel/jellyseerr
```
:::info
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
:::
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.
@@ -83,6 +86,10 @@ services:
- /path/to/appdata/config:/app/config
restart: unless-stopped
```
:::info
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
:::
Then, start all services defined in the Compose file:
```bash
docker-compose up -d
@@ -97,7 +104,6 @@ Then, restart all services defined in the Compose file:
```bash
docker-compose up -d
```
:::tip
You may alternatively use a third-party mechanism like [dockge](https://github.com/louislam/dockge) to manage your docker compose files.
:::
@@ -133,7 +139,7 @@ or the Docker Desktop app:
4. Enter a name for the volume (example: `jellyseerr-data`) and hit "Create"
Then, create and start the Jellyseerr container:
<Tabs groupId="docker-methods">
<Tabs groupId="docker-methods" queryString>
<TabItem value="docker-cli" label="Docker CLI">
```bash
docker run -d --name jellyseerr -e LOG_LEVEL=debug -e TZ=Asia/Tashkent -p 5055:5055 -v "jellyseerr-data:/app/config" --restart unless-stopped fallenbagel/jellyseerr:latest
@@ -179,6 +185,12 @@ volumes:
</TabItem>
</Tabs>
:::tip
If you are using a named volume, then you can safely **ignore** the warning about the `/app/config` folder being incorrectly mounted.
If you are using emby, make sure to set the `JELLYFIN_TYPE` environment variable to `emby`.
:::
To access the files inside the volume created above, navigate to `\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\jellyseerr-data\_data` using File Explorer.
:::info