Skip to content

Commit 5c69799

Browse files
Bot Updating Documentation
1 parent 2be7d0d commit 5c69799

1 file changed

Lines changed: 330 additions & 0 deletions

File tree

docs/images/docker-doplarr_rs.md

Lines changed: 330 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,330 @@
1+
---
2+
title: doplarr_rs
3+
tags:
4+
- Media Requesters
5+
description: "[Doplarr_rs](https://github.com/activexray/doplarr_rs) is a Discord bot for requesting media through *arr backends, written in Rust."
6+
---
7+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
8+
<!-- Please read https://github.com/linuxserver/docker-doplarr_rs/blob/main/.github/CONTRIBUTING.md -->
9+
# [linuxserver/doplarr_rs](https://github.com/linuxserver/docker-doplarr_rs)
10+
11+
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fdoplarr_rs?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh)
12+
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-doplarr_rs.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-doplarr_rs)
13+
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-doplarr_rs.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-doplarr_rs/releases)
14+
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-doplarr_rs/packages)
15+
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-doplarr_rs/container_registry)
16+
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/doplarr_rs)
17+
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/doplarr_rs.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/doplarr_rs)
18+
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/doplarr_rs.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/doplarr_rs)
19+
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-doplarr_rs%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-doplarr_rs/job/main/)
20+
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fdoplarr_rs%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/doplarr_rs/latest/index.html)
21+
22+
[Doplarr_rs](https://github.com/activexray/doplarr_rs) is a Discord bot for requesting media through *arr backends, written in Rust.
23+
24+
[![doplarr_rs](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/doplarr_rs-logo.png)](https://github.com/activexray/doplarr_rs)
25+
26+
## Supported Architectures
27+
28+
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
29+
30+
Simply pulling `lscr.io/linuxserver/doplarr_rs:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
31+
32+
The architectures supported by this image are:
33+
34+
| Architecture | Available | Tag |
35+
| :----: | :----: | ---- |
36+
| x86-64 || amd64-\<version tag\> |
37+
| arm64 || arm64v8-\<version tag\> |
38+
39+
## Application Setup
40+
41+
Start by following the [Setup](https://github.com/activexray/doplarr_rs#setup) instructions from doplarr_rs's readme.
42+
43+
The `config.toml` file is created from `config.example.toml` on first run, so you can start the container with the default config file and then stop it to edit the generated `config.toml` file.
44+
45+
## Read-Only Operation
46+
47+
This image can be run with a read-only container filesystem. For details please [read the docs](https://docs.linuxserver.io/misc/read-only/).
48+
49+
## Non-Root Operation
50+
51+
This image can be run with a non-root user. For details please [read the docs](https://docs.linuxserver.io/misc/non-root/).
52+
53+
## Usage
54+
55+
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
56+
57+
!!! info
58+
59+
Unless a parameter is flagged as 'optional', it is *mandatory* and a value must be provided.
60+
61+
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
62+
63+
```yaml
64+
---
65+
services:
66+
doplarr_rs:
67+
image: lscr.io/linuxserver/doplarr_rs:latest
68+
container_name: doplarr_rs
69+
environment:
70+
- PUID=1000
71+
- PGID=1000
72+
- TZ=Etc/UTC
73+
volumes:
74+
- /path/to/doplarr_rs/config:/config
75+
restart: unless-stopped
76+
```
77+
78+
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
79+
80+
```bash
81+
docker run -d \
82+
--name=doplarr_rs \
83+
-e PUID=1000 \
84+
-e PGID=1000 \
85+
-e TZ=Etc/UTC \
86+
-v /path/to/doplarr_rs/config:/config \
87+
--restart unless-stopped \
88+
lscr.io/linuxserver/doplarr_rs:latest
89+
```
90+
91+
## Parameters
92+
93+
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
94+
95+
### Ports (`-p`)
96+
97+
| Parameter | Function |
98+
| :----: | --- |
99+
100+
### Environment Variables (`-e`)
101+
102+
| Env | Function |
103+
| :----: | --- |
104+
| `PUID=1000` | for UserID - see below for explanation |
105+
| `PGID=1000` | for GroupID - see below for explanation |
106+
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
107+
108+
### Volume Mappings (`-v`)
109+
110+
| Volume | Function |
111+
| :----: | --- |
112+
| `/config` | Persistent config files |
113+
114+
#### Miscellaneous Options
115+
116+
| Parameter | Function |
117+
| :-----: | --- |
118+
| `--read-only=true` | Run container with a read-only filesystem. Please [read the docs](https://docs.linuxserver.io/misc/read-only/). |
119+
| `--user=1000:1000` | Run container with a non-root user. Please [read the docs](https://docs.linuxserver.io/misc/non-root/). |
120+
121+
## Environment variables from files (Docker secrets)
122+
123+
You can set any environment variable from a file by using a special prepend `FILE__`.
124+
125+
As an example:
126+
127+
```bash
128+
-e FILE__MYVAR=/run/secrets/mysecretvariable
129+
```
130+
131+
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
132+
133+
## Umask for running applications
134+
135+
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
136+
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
137+
138+
## User / Group Identifiers
139+
140+
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
141+
142+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
143+
144+
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
145+
146+
```bash
147+
id your_user
148+
```
149+
150+
Example output:
151+
152+
```text
153+
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
154+
```
155+
156+
## Docker Mods
157+
158+
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=doplarr_rs&query=%24.mods%5B%27doplarr_rs%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=doplarr_rs "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
159+
160+
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
161+
162+
## Support Info
163+
164+
* Shell access whilst the container is running:
165+
166+
```bash
167+
docker exec -it doplarr_rs /bin/bash
168+
```
169+
170+
* To monitor the logs of the container in realtime:
171+
172+
```bash
173+
docker logs -f doplarr_rs
174+
```
175+
176+
* Container version number:
177+
178+
```bash
179+
docker inspect -f '{{ index .Config.Labels "build_version" }}' doplarr_rs
180+
```
181+
182+
* Image version number:
183+
184+
```bash
185+
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/doplarr_rs:latest
186+
```
187+
188+
## Updating Info
189+
190+
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
191+
192+
Below are the instructions for updating containers:
193+
194+
### Via Docker Compose
195+
196+
* Update images:
197+
* All images:
198+
199+
```bash
200+
docker-compose pull
201+
```
202+
203+
* Single image:
204+
205+
```bash
206+
docker-compose pull doplarr_rs
207+
```
208+
209+
* Update containers:
210+
* All containers:
211+
212+
```bash
213+
docker-compose up -d
214+
```
215+
216+
* Single container:
217+
218+
```bash
219+
docker-compose up -d doplarr_rs
220+
```
221+
222+
* You can also remove the old dangling images:
223+
224+
```bash
225+
docker image prune
226+
```
227+
228+
### Via Docker Run
229+
230+
* Update the image:
231+
232+
```bash
233+
docker pull lscr.io/linuxserver/doplarr_rs:latest
234+
```
235+
236+
* Stop the running container:
237+
238+
```bash
239+
docker stop doplarr_rs
240+
```
241+
242+
* Delete the container:
243+
244+
```bash
245+
docker rm doplarr_rs
246+
```
247+
248+
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
249+
* You can also remove the old dangling images:
250+
251+
```bash
252+
docker image prune
253+
```
254+
255+
### Image Update Notifications - Diun (Docker Image Update Notifier)
256+
257+
!!! tip
258+
259+
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
260+
261+
## Building locally
262+
263+
If you want to make local modifications to these images for development purposes or just to customize the logic:
264+
265+
```bash
266+
git clone https://github.com/linuxserver/docker-doplarr_rs.git
267+
cd docker-doplarr_rs
268+
docker build \
269+
--no-cache \
270+
--pull \
271+
-t lscr.io/linuxserver/doplarr_rs:latest .
272+
```
273+
274+
The ARM variants can be built on x86_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static`
275+
276+
```bash
277+
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
278+
```
279+
280+
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
281+
282+
To help with development, we generate this dependency graph.
283+
284+
??? info "Init dependency graph"
285+
286+
```d2
287+
"doplarr_rs:latest": {
288+
docker-mods
289+
base {
290+
fix-attr +\nlegacy cont-init
291+
}
292+
docker-mods -> base
293+
legacy-services
294+
custom services
295+
init-services -> legacy-services
296+
init-services -> custom services
297+
custom services -> legacy-services
298+
legacy-services -> ci-service-check
299+
init-migrations -> init-adduser
300+
init-os-end -> init-config
301+
init-config -> init-config-end
302+
init-crontab-config -> init-config-end
303+
init-doplarr_rs-config -> init-config-end
304+
init-config -> init-crontab-config
305+
init-mods-end -> init-custom-files
306+
init-adduser -> init-device-perms
307+
init-config -> init-doplarr_rs-config
308+
base -> init-envfile
309+
base -> init-migrations
310+
init-config-end -> init-mods
311+
init-mods-package-install -> init-mods-end
312+
init-mods -> init-mods-package-install
313+
init-adduser -> init-os-end
314+
init-device-perms -> init-os-end
315+
init-envfile -> init-os-end
316+
init-custom-files -> init-services
317+
init-services -> svc-cron
318+
svc-cron -> legacy-services
319+
init-services -> svc-doplarr_rs
320+
svc-doplarr_rs -> legacy-services
321+
}
322+
Base Images: {
323+
"baseimage-alpine:3.24"
324+
}
325+
"doplarr_rs:latest" <- Base Images
326+
```
327+
328+
## Versions
329+
330+
* **22.06.26:** - Initial Release.

0 commit comments

Comments
 (0)