Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/toddrob99/searcharr
Sonarr & Radarr & Readarr Telegram Bot
https://github.com/toddrob99/searcharr
Last synced: 2 days ago
JSON representation
Sonarr & Radarr & Readarr Telegram Bot
- Host: GitHub
- URL: https://github.com/toddrob99/searcharr
- Owner: toddrob99
- License: mit
- Created: 2020-10-18T02:23:10.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-21T19:17:41.000Z (about 1 year ago)
- Last Synced: 2025-02-05T21:14:40.402Z (9 days ago)
- Language: Python
- Homepage:
- Size: 1.1 MB
- Stars: 266
- Watchers: 12
- Forks: 65
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-arr - Searcharr - Sonarr & Radarr Telegram Bot. (Bots)
README
# Searcharr
[](https://hub.docker.com/r/toddrob/searcharr) [](https://github.com/toddrob99/searcharr/actions/workflows/release.yml) [](https://github.com/toddrob99/searcharr/actions/workflows/beta.yml)
### Sonarr & Radarr Telegram Bot
### By Todd Roberts
https://github.com/toddrob99/searcharr
This bot allows users to add movies to Radarr, series to Sonarr, and books to Readarr via Telegram messaging app.
## Setup & Run
### Configure
Rename `settings-sample.py` to `settings.py`, and edit the settings within the file as necessary.
Detailed descriptions of the available settings are available on the [wiki](https://github.com/toddrob99/searcharr/wiki/Configuration-::-settings.py).
You are required to update the following settings, at minimum:
* Searcharr Bot > Password
* Telegram Bot > Token (see [Telegram Bot Setup Instructions](https://core.telegram.org/bots#6-botfather))
* Sonarr > URL, API Key, Quality Profile ID
* Radarr > URL, API Key, Quality Profile ID
* Readarr > URL, API Key, Quality Profile ID, Metadata Profile ID
### Docker & Docker-Compose
Docker is the suggested method to run Searcharr. Be sure to map the following in your Docker container:
* Settings file to /app/settings.py
* Database folder to /app/data
* Log folder to /app/logs
A docker-compose.yml file is provided for your convenience. Update the volume mappings listed above, and then run `docker-compose up -d` to start Searcharr.
### Run from Source
If running from source, use Python 3.8.3+, install requirements using `python -m pip install -r requirements.txt`, and then run `searcharr.py`.
## Use
### Authenticate
Send a private message to your bot saying `/start ` where `` is the value of `searcharr_password` in `settings.py`. For admin access, instead say `/start ` where `` is the value of `searcharr_admin_password` in `settings.py`. An authenticated user can add admin access by re-authenticating using the admin password. Re-authenticating with the non-admin password will not remove a user's admin access. Admin access must be removed by an admin using the `/users` command, or manually in the database.
**Caution**: Authentication via `/start` command will work in a group chat, but then everyone else in the group will see the password. If not all group members should be allowed to use the bot, then be sure to authenticate in a private message.
**Double Caution**: Do not authenticate as an admin in a group chat. Always use a private message with your bot.
### Search & Add a Series to Sonarr, a Movie to Radarr, or a Book to Readarr
Send the bot a (private or group) message saying `/series `, `/movie `, or `/book ` (replace with custom command aliases, as configured in `settings.py`). The bot will reply with information about the first result, along with buttons to move forward and back within the search results, pop out to tvdb, TMDB, or IMDb, or Goodreads for books, add the current series/movie/book to Sonarr/Radarr/Readarr, or cancel the search. When you click the button to add the series/movie/book to Sonarr/Radarr/Readarr, the bot will ask what root folder to put the series/movie/book in, then what quality profile to use--unless you have only one root folder or quality profile enabled in Searcharr settings, in which case it will skip those steps and add the series/movie straight away.
### Manage Users
If you are authenticated as an admin, you can use the `/users` command to retrieve a list of users with buttons to remove all access and add/remove admin access (as applicable).
## Screenshots
Authenticate by saying `/start ` (or `/start@bot_username ` in a group with multiple bots)
Search for movie using `/movie ` or series using `/series ` (behavior is the same for series and movies) (use custom commands configured in `settings.py` if applicable). Buttons will appear to open the series/movie info in tvdb, IMDb, or TVDB when those ids are available.
If series/movie already exists in Sonarr/Radarr, the Add button will instead say "Already Added!":
If Searcharr has multiple root folders configured, you will be prompted to select a root folder:
If Searcharr has multiple quality profiles configured, you will be prompted to select a root folder after selecting a quality profile:
When the series/movie has been added, or you click Cancel, the search results will be removed:
