kopia lustrzana https://github.com/linuxserver/docker-documentation
213 wiersze
12 KiB
Markdown
Executable File
213 wiersze
12 KiB
Markdown
Executable File
---
|
|
title: doplarr
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read the https://github.com/linuxserver/docker-doplarr/blob/main/.github/CONTRIBUTING.md -->
|
|
|
|
# [linuxserver/doplarr](https://github.com/linuxserver/docker-doplarr)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fdoplarr)
|
|
[](https://github.com/linuxserver/docker-doplarr)
|
|
[](https://github.com/linuxserver/docker-doplarr/releases)
|
|
[](https://github.com/linuxserver/docker-doplarr/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-doplarr/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/doplarr)
|
|
[](https://hub.docker.com/r/linuxserver/doplarr)
|
|
[](https://hub.docker.com/r/linuxserver/doplarr)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-doplarr/job/main/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/doplarr/latest/index.html)
|
|
|
|
[Doplarr](https://github.com/kiranshila/Doplarr) is an *arr request bot for Discord."
|
|
|
|
## Supported Architectures
|
|
|
|
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/doplarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
|
|
|
The architectures supported by this image are:
|
|
|
|
| Architecture | Tag |
|
|
| :----: | --- |
|
|
| x86-64 | amd64-latest |
|
|
| arm64 | arm64v8-latest |
|
|
|
|
## Application Setup
|
|
|
|
Start by following the [Discord](https://github.com/kiranshila/Doplarr#discord) setup instructions from Doplarr's readme.
|
|
|
|
NOTE: The `DISCORD__TOKEN` environment variable is required to run the container!
|
|
|
|
- If you are using Overseerr, fill in the Overseerr API and URL variables, and leave the Radarr/Sonarr variables blank.
|
|
- If you are using Radarr/Sonarr (and not using Overseerr), fill in the Radarr/Sonarr API and URL variables, and leave the Overseerr variables blank.
|
|
|
|
Extra java options can be passed with the JAVA_OPTS environment variable, eg `-e JAVA_OPTS="-Xmx256m -Xms256m"`.
|
|
|
|
Review and adjust any [Optional Settings](https://github.com/kiranshila/Doplarr#optional-settings) from Doplarr's readme.
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
doplarr:
|
|
image: lscr.io/linuxserver/doplarr
|
|
container_name: doplarr
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=America/New_York
|
|
- DISCORD__TOKEN=<discord__token>
|
|
- OVERSEERR__API=<overseerr__api>
|
|
- OVERSEERR__URL=http://localhost:5055
|
|
- RADARR__API=<radarr__api>
|
|
- RADARR__URL=http://localhost:7878
|
|
- SONARR__API=<sonarr__api>
|
|
- SONARR__URL=http://localhost:8989
|
|
- DISCORD__MAX_RESULTS=25 #optional
|
|
- DISCORD__ROLE_ID=<not_set_by_default> #optional
|
|
- DISCORD__REQUESTED_MSG_STYLE=:plain #optional
|
|
- SONARR__QUALITY_PROFILE=<not_set_by_default> #optional
|
|
- RADARR__QUALITY_PROFILE=<not_set_by_default> #optional
|
|
- SONARR__LANGUAGE_PROFILE=<not_set_by_default> #optional
|
|
- OVERSEERR__DEFAULT_ID=<not_set_by_default> #optional
|
|
- PARTIAL_SEASONS=true #optional
|
|
- LOG_LEVEL=:info #optional
|
|
- JAVA_OPTS=<not_set_by_default> #optional
|
|
volumes:
|
|
- </path/to/appdata/config>:/config
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=doplarr \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=America/New_York \
|
|
-e DISCORD__TOKEN=<discord__token> \
|
|
-e OVERSEERR__API=<overseerr__api> \
|
|
-e OVERSEERR__URL=http://localhost:5055 \
|
|
-e RADARR__API=<radarr__api> \
|
|
-e RADARR__URL=http://localhost:7878 \
|
|
-e SONARR__API=<sonarr__api> \
|
|
-e SONARR__URL=http://localhost:8989 \
|
|
-e DISCORD__MAX_RESULTS=25 `#optional` \
|
|
-e DISCORD__ROLE_ID=<not_set_by_default> `#optional` \
|
|
-e DISCORD__REQUESTED_MSG_STYLE=:plain `#optional` \
|
|
-e SONARR__QUALITY_PROFILE=<not_set_by_default> `#optional` \
|
|
-e RADARR__QUALITY_PROFILE=<not_set_by_default> `#optional` \
|
|
-e SONARR__LANGUAGE_PROFILE=<not_set_by_default> `#optional` \
|
|
-e OVERSEERR__DEFAULT_ID=<not_set_by_default> `#optional` \
|
|
-e PARTIAL_SEASONS=true `#optional` \
|
|
-e LOG_LEVEL=:info `#optional` \
|
|
-e JAVA_OPTS=<not_set_by_default> `#optional` \
|
|
-v </path/to/appdata/config>:/config \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/doplarr
|
|
```
|
|
|
|
## Parameters
|
|
|
|
Docker images 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.
|
|
|
|
### Ports (`-p`)
|
|
|
|
| Parameter | Function |
|
|
| :----: | --- |
|
|
|
|
### Environment Variables (`-e`)
|
|
|
|
| Env | Function |
|
|
| :----: | --- |
|
|
| `PUID=1000` | for UserID - see below for explanation |
|
|
| `PGID=1000` | for GroupID - see below for explanation |
|
|
| `TZ=America/New_York` | Specify a timezone to use EG America/New_York |
|
|
| `DISCORD__TOKEN=<discord__token>` | Specify your discord bot token. |
|
|
| `OVERSEERR__API=<overseerr__api>` | Specify your Overseerr API key. Leave blank if using Radarr/Sonarr. |
|
|
| `OVERSEERR__URL=http://localhost:5055` | Specify your Overseerr URL. Leave blank if using Radarr/Sonarr. |
|
|
| `RADARR__API=<radarr__api>` | Specify your Radarr API key. Leave blank if using Overseerr. |
|
|
| `RADARR__URL=http://localhost:7878` | Specify your Radarr URL. Leave blank if using Overseerr. |
|
|
| `SONARR__API=<sonarr__api>` | Specify your Sonarr API key. Leave blank if using Overseerr. |
|
|
| `SONARR__URL=http://localhost:8989` | Specify your Sonarr URL. Leave blank if using Overseerr. |
|
|
| `DISCORD__MAX_RESULTS=25` | Sets the maximum size of the search results selection |
|
|
| `DISCORD__ROLE_ID=<not_set_by_default>` | The discord role id for users of the bot (omitting this lets everyone on the server use the bot) |
|
|
| `DISCORD__REQUESTED_MSG_STYLE=:plain` | Sets the style of the request alert message. One of `:plain` `:embed` `:none` |
|
|
| `SONARR__QUALITY_PROFILE=<not_set_by_default>` | The name of the quality profile to use by default for Sonarr |
|
|
| `RADARR__QUALITY_PROFILE=<not_set_by_default>` | The name of the quality profile to use by default for Radarr |
|
|
| `SONARR__LANGUAGE_PROFILE=<not_set_by_default>` | The name of the language profile to use by default for Radarr |
|
|
| `OVERSEERR__DEFAULT_ID=<not_set_by_default>` | The Overseerr user id to use by default if there is no associated discord account for the requester |
|
|
| `PARTIAL_SEASONS=true` | Sets whether users can request partial seasons. |
|
|
| `LOG_LEVEL=:info` | The log level for the logging backend. This can be changed for debugging purposes. One of trace `:debug` `:info` `:warn` `:error` `:fatal` `:report` |
|
|
| `JAVA_OPTS=<not_set_by_default>` | For passing additional java options. |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Contains all relevant configuration files. |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
|
```
|
|
|
|
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
|
|
|
|
## Umask for running applications
|
|
|
|
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.
|
|
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.
|
|
|
|
## User / Group Identifiers
|
|
|
|
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`.
|
|
|
|
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
|
|
|
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
|
|
|
```bash
|
|
$ id username
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=doplarr "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
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.
|
|
|
|
## Support Info
|
|
|
|
* Shell access whilst the container is running:
|
|
* `docker exec -it doplarr /bin/bash`
|
|
* To monitor the logs of the container in realtime:
|
|
* `docker logs -f doplarr`
|
|
* Container version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' doplarr`
|
|
* Image version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/doplarr`
|
|
|
|
## Versions
|
|
|
|
* **30.01.22:** - Variable adjustments.
|
|
* **30.01.22:** - Initial Release.
|