diff --git a/images/docker-doplarr.md b/images/docker-doplarr.md index 4f83ceeaa..3e1de810a 100755 --- a/images/docker-doplarr.md +++ b/images/docker-doplarr.md @@ -36,6 +36,8 @@ The architectures supported by this image are: 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. @@ -61,22 +63,22 @@ services: - PGID=1000 - TZ=America/New_York - 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= #optional + - DISCORD__ROLE_ID= #optional - DISCORD__REQUESTED_MSG_STYLE=:plain #optional - - SONARR__QUALITY_PROFILE= #optional - - RADARR__QUALITY_PROFILE= #optional - - SONARR__LANGUAGE_PROFILE= #optional - - OVERSEERR__DEFAULT_ID= #optional + - SONARR__QUALITY_PROFILE= #optional + - RADARR__QUALITY_PROFILE= #optional + - SONARR__LANGUAGE_PROFILE= #optional + - OVERSEERR__DEFAULT_ID= #optional - PARTIAL_SEASONS=true #optional - LOG_LEVEL=:info #optional - - JAVA_OPTS= #optional + - JAVA_OPTS= #optional volumes: - :/config restart: unless-stopped @@ -91,22 +93,22 @@ docker run -d \ -e PGID=1000 \ -e TZ=America/New_York \ -e DISCORD__TOKEN= \ - -e OVERSEERR__API= \ + -e OVERSEERR__API= \ -e OVERSEERR__URL=http://localhost:5055 \ - -e RADARR__API= \ + -e RADARR__API= \ -e RADARR__URL=http://localhost:7878 \ - -e SONARR__API= \ + -e SONARR__API= \ -e SONARR__URL=http://localhost:8989 \ -e DISCORD__MAX_RESULTS=25 `#optional` \ - -e DISCORD__ROLE_ID= `#optional` \ + -e DISCORD__ROLE_ID= `#optional` \ -e DISCORD__REQUESTED_MSG_STYLE=:plain `#optional` \ - -e SONARR__QUALITY_PROFILE= `#optional` \ - -e RADARR__QUALITY_PROFILE= `#optional` \ - -e SONARR__LANGUAGE_PROFILE= `#optional` \ - -e OVERSEERR__DEFAULT_ID= `#optional` \ + -e SONARR__QUALITY_PROFILE= `#optional` \ + -e RADARR__QUALITY_PROFILE= `#optional` \ + -e SONARR__LANGUAGE_PROFILE= `#optional` \ + -e OVERSEERR__DEFAULT_ID= `#optional` \ -e PARTIAL_SEASONS=true `#optional` \ -e LOG_LEVEL=:info `#optional` \ - -e JAVA_OPTS= `#optional` \ + -e JAVA_OPTS= `#optional` \ -v :/config \ --restart unless-stopped \ lscr.io/linuxserver/doplarr @@ -129,22 +131,22 @@ Docker images are configured using parameters passed at runtime (such as those a | `PGID=1000` | for GroupID - see below for explanation | | `TZ=America/New_York` | Specify a timezone to use EG America/New_York | | `DISCORD__TOKEN=` | Specify your discord bot token. | -| `OVERSEERR__API=` | Specify your Overseerr API key. Leave blank if using Radarr/Sonarr. | +| `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=` | Specify your Radarr API key. Leave blank if using Overseerr. | +| `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=` | Specify your Sonarr API key. Leave blank if using Overseerr. | +| `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=` | The discord role id for users of the bot (omitting this lets everyone on the server use the bot) | +| `DISCORD__ROLE_ID=` | 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=` | The name of the quality profile to use by default for Sonarr | -| `RADARR__QUALITY_PROFILE=` | The name of the quality profile to use by default for Radarr | -| `SONARR__LANGUAGE_PROFILE=` | The name of the language profile to use by default for Radarr | -| `OVERSEERR__DEFAULT_ID=` | The Overseerr user id to use by default if there is no associated discord account for the requester | +| `SONARR__QUALITY_PROFILE=` | The name of the quality profile to use by default for Sonarr | +| `RADARR__QUALITY_PROFILE=` | The name of the quality profile to use by default for Radarr | +| `SONARR__LANGUAGE_PROFILE=` | The name of the language profile to use by default for Radarr | +| `OVERSEERR__DEFAULT_ID=` | 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=` | For passing additional java options. | +| `JAVA_OPTS=` | For passing additional java options. | ### Volume Mappings (`-v`) @@ -206,4 +208,5 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **30.01.22:** - Variable adjustments. * **30.01.22:** - Initial Release.