shpaq/sct-overseerr
1
0
Fork 0
mirror of https://github.com/sct/overseerr.git synced 2025-09-17 17:24:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(installation): add PORT env variable to example commands (#3254) [skip ci]

Browse Source 
* docs(installation): add PORT env variable to Docker CLI & Docker Compose examples

* docs(installation): fix typo

* docs(installation): clarify hint about named volumes for windows installation example
This commit is contained in:
Danshil Kokil Mungur
2023-01-19 21:39:24 +04:00
committed by GitHub
parent 5940ff7f5f
commit d7bfc73727
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/getting-started/installation.md
View File

@@ -28,6 +28,7 @@ docker run -d \
--name overseerr \ --name overseerr \
-e LOG_LEVEL=debug \ -e LOG_LEVEL=debug \
-e TZ=Asia/Tokyo \ -e TZ=Asia/Tokyo \
-e PORT=5055 `#optional` \
-p 5055:5055 \ -p 5055:5055 \
-v /path/to/appdata/config:/app/config \ -v /path/to/appdata/config:/app/config \
--restart unless-stopped \ --restart unless-stopped \
@@ -81,6 +82,7 @@ services:
environment: environment:
- LOG_LEVEL=debug - LOG_LEVEL=debug
- TZ=Asia/Tokyo - TZ=Asia/Tokyo
- PORT=5055 #optional
ports: ports:
- 5055:5055 - 5055:5055
volumes: volumes:
@@ -88,7 +90,7 @@ services:
restart: unless-stopped restart: unless-stopped
``` ```
Then, start all services defined in the your Compose file: Then, start all services defined in the Compose file:
```bash ```bash
docker-compose up -d docker-compose up -d
@@ -146,8 +148,6 @@ Then, create and start the Overseerr container:
docker run -d --name overseerr -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr:latest docker run -d --name overseerr -e LOG_LEVEL=debug -e TZ=Asia/Tokyo -p 5055:5055 -v "overseerr-data:/app/config" --restart unless-stopped sctx/overseerr:latest
``` ```
If using a named volume like above, you can safely ignore the warning about the `/app/config` folder being incorrectly mounted on the setup page.
To access the files inside the volume created above, navigate to `\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\overseerr-data\_data` using File Explorer. To access the files inside the volume created above, navigate to `\\wsl$\docker-desktop-data\version-pack-data\community\docker\volumes\overseerr-data\_data` using File Explorer.
{% hint style="info" %} {% hint style="info" %}
@@ -155,7 +155,7 @@ Docker on Windows works differently than it does on Linux; it runs Docker inside
**If you must run Docker on Windows, you should put the `/app/config` directory mount inside the VM and not on the Windows host.** (This also applies to other containers with SQLite databases.) **If you must run Docker on Windows, you should put the `/app/config` directory mount inside the VM and not on the Windows host.** (This also applies to other containers with SQLite databases.)
Named volumes, like in the example commands above, are automatically mounted inside the VM. Named volumes, like in the example commands above, are automatically mounted inside the VM. Therefore the warning on the setup about the `/app/config` folder being incorrectly mounted page should be ignored.
{% endhint %} {% endhint %}
## Linux ## Linux