Doplarr¶
What is it?¶
Doplarr is a chatbot used to simplify using services like Sonarr/Radarr/Overseer via the use of chat. Current platform is Discord only.
Details | |||
---|---|---|---|
Project home | Docs | Github | Docker |
Setup Doplarr¶
1. Create Discord bot¶
- Create a new Application in Discord
- Go to the Bot tab and add a new bot
-
Copy the token and paste it in
/opt/sandbox/settings.yml
in thedoplarr.discord_token
field:/opt/sandbox/settings.yml... doplarr: discord_token: your_discord_bot_token overseerr_url: "http://overseerr:5055" overseerr_api: ...
-
Go to OAuth2 and under "OAuth2 URL Generator", enable
applications.commands
andbot
- Copy the resulting URL and open it in your browser in order to invite your bot to your discord channel.
2. Set up overseer parameters¶
-
In
/opt/sandbox/settings.yml
: set up the overseer url in the corresponding fielddoplarr.overseerr_url
according to your setings. If you have not customize saltbox settings, the default urlhttp://overseerr:5055
should be correct:/opt/sandbox/settings.yml... doplarr: discord_token: your_discord_bot_token overseerr_url: "http://overseerr:5055" overseerr_api: ...
-
In
/opt/sandbox/settings.yml
: set up the overseer API key in the corresponding fielddoplarr.overseerr_api
according to your overseer settings. You can get your api keys in your main setting page in overseer:https://overseerr._yourdomain.com_/settings
:/opt/sandbox/settings.yml... doplarr: discord_token: your_discord_bot_token overseerr_url: "http://overseerr:5055" overseerr_api: ...
3. Installation¶
sb install sandbox-doplarr
Note
📢 You may also override the default setting of Doplarr working with overseer, to work with Sonarr and Radarr.
The recommended way to customize these parameters is to use the inventory. You should edit /srv/git/saltbox/inventories/host_vars/localhost.yml
and add the following section.
doplarr_docker_envs_defaults:
SONARR__URL: # (1)!
RADARR__URL: # (2)!
SONARR__API: # (3)!
RADARR__API: # (4)!
DISCORD__TOKEN: # (5)!
- This line will set the Sonarr URL. Saltbox defaults to
"http://sonarr:8989"
. - This line will set the Radarr URL. Saltbox defaults to
"http://radarr:7878"
. - This line will set the Sonarr API key. Place your API key here. Wrap it in quotes.
- This line will set the Radarr API key. Place your API key here. Wrap it in quotes.
- This line will set the Discord token. Place your token here. Wrap it in quotes.