docs(docker): add healthcheck to documentation (#1748)
* docs(docker): add healthcheck to documentation Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr> * fix: update docker cli healthcheck --------- Signed-off-by: Ludovic Ortega <ludovic.ortega@adminafk.fr>
This commit is contained in:
@@ -33,20 +33,31 @@ docker run -d \
|
|||||||
--name jellyseerr \
|
--name jellyseerr \
|
||||||
-e LOG_LEVEL=debug \
|
-e LOG_LEVEL=debug \
|
||||||
-e TZ=Asia/Tashkent \
|
-e TZ=Asia/Tashkent \
|
||||||
-e PORT=5055 `#optional` \
|
-e PORT=5055 \
|
||||||
-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 \
|
||||||
fallenbagel/jellyseerr
|
fallenbagel/jellyseerr
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The argument `-e PORT=5055` is optional.
|
||||||
|
|
||||||
|
If you want to add a healthcheck to the above command, you can add the following flags :
|
||||||
|
```
|
||||||
|
--health-cmd "wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1" \
|
||||||
|
--health-start-period 20s \
|
||||||
|
--health-timeout 3s \
|
||||||
|
--health-interval 15s \
|
||||||
|
--health-retries 3 \
|
||||||
|
```
|
||||||
|
|
||||||
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.
|
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:
|
#### Updating:
|
||||||
|
|
||||||
Stop and remove the existing container:
|
Stop and remove the existing container:
|
||||||
```bash
|
```bash
|
||||||
docker stop jellyseerr && docker rm Jellyseerr
|
docker stop jellyseerr && docker rm jellyseerr
|
||||||
```
|
```
|
||||||
Pull the latest image:
|
Pull the latest image:
|
||||||
```bash
|
```bash
|
||||||
@@ -83,6 +94,12 @@ services:
|
|||||||
- 5055:5055
|
- 5055:5055
|
||||||
volumes:
|
volumes:
|
||||||
- /path/to/appdata/config:/app/config
|
- /path/to/appdata/config:/app/config
|
||||||
|
healthcheck:
|
||||||
|
test: wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1
|
||||||
|
start_period: 20s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
retries: 3
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -137,7 +154,26 @@ Then, create and start the Jellyseerr container:
|
|||||||
<Tabs groupId="docker-methods" queryString>
|
<Tabs groupId="docker-methods" queryString>
|
||||||
<TabItem value="docker-cli" label="Docker CLI">
|
<TabItem value="docker-cli" label="Docker CLI">
|
||||||
```bash
|
```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
|
docker run -d \
|
||||||
|
--name jellyseerr \
|
||||||
|
-e LOG_LEVEL=debug \
|
||||||
|
-e TZ=Asia/Tashkent \
|
||||||
|
-e PORT=5055 \
|
||||||
|
-p 5055:5055 \
|
||||||
|
-v jellyseerr-data:/app/config \
|
||||||
|
--restart unless-stopped \
|
||||||
|
fallenbagel/jellyseerr
|
||||||
|
```
|
||||||
|
|
||||||
|
The argument `-e PORT=5055` is optional.
|
||||||
|
|
||||||
|
If you want to add a healthcheck to the above command, you can add the following flags :
|
||||||
|
```
|
||||||
|
--health-cmd "wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1" \
|
||||||
|
--health-start-period 20s \
|
||||||
|
--health-timeout 3s \
|
||||||
|
--health-interval 15s \
|
||||||
|
--health-retries 3 \
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Updating:
|
#### Updating:
|
||||||
@@ -165,6 +201,12 @@ services:
|
|||||||
- 5055:5055
|
- 5055:5055
|
||||||
volumes:
|
volumes:
|
||||||
- jellyseerr-data:/app/config
|
- jellyseerr-data:/app/config
|
||||||
|
healthcheck:
|
||||||
|
test: wget --no-verbose --tries=1 --spider http://localhost:5055/api/v1/status || exit 1
|
||||||
|
start_period: 20s
|
||||||
|
timeout: 3s
|
||||||
|
interval: 15s
|
||||||
|
retries: 3
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
|
|||||||
Reference in New Issue
Block a user