Skip to content

Configuration :: settings.py

Jump to bottom
Todd Roberts edited this page May 17, 2023 · 12 revisions

Searcharr Bot

  • searcharr_password
    • Used to authenticate as a regular user to add series/movies (/start <password>)
    • Type: string
    • Example: searcharr_password = "this is my secret password"
  • searcharr_admin_password
    • Used to authenticate as admin to manage users (/start <admin_password>)
    • Type: string
    • Example: searcharr_admin_password = "super secret admin password goes here"
  • searcharr_language (v2.1+)
    • Tells Searcharr what language to use when sending messages to end users
    • Type: string
    • Example: searcharr_language="en-us"
    • Example: searcharr_language="pt-br"
    • Note: See Language Translations for additional information
  • searcharr_start_command_aliases (v2.1+)
    • Set the command(s) the bot should honor for authentication
    • Type: list
    • Example: searcharr_start_command_aliases = ["start"]
    • Example: searcharr_start_command_aliases = ["comecar"]
    • Note: Telegram does not support diacritical characters for commands.
  • searcharr_help_command_aliases (v2.1+)
    • Set the command(s) the bot should honor for help
    • Type: list
    • Example: searcharr_help_command_aliases = ["help"]
    • Example: searcharr_help_command_aliases = ["ajuda"]
    • Note: Telegram does not support diacritical characters for commands.
  • searcharr_users_command_aliases (v2.1+)
    • Set the command(s) the bot should honor for user management
    • Type: list
    • Example: searcharr_users_command_aliases = ["users"]
    • Example: searcharr_users_command_aliases = ["usuarios"]
    • Note: Telegram does not support diacritical characters for commands.

Telegram

  • tgram_token
    • This is your Telegram bot token
    • Type: string
    • Example: tgram_token = "1000000000:ABCDEFGHIJKLMNOPQRSTUVWXYZ"

Sonarr

  • sonarr_enabled
    • Enable Sonarr integration in Searcharr
    • Type: boolean
    • Options: True or False
    • Example: sonarr_enabled = True
  • sonarr_url
    • The URL your Searcharr bot should use to connect to Sonarr
    • Type: string
    • Example: sonarr_url = "http://192.168.0.100:8989"
    • Example: sonarr_url = "http://192.168.0.100/sonarr"
  • sonarr_api_key
    • API key Searcharr should use to interact with the Sonarr API
    • Type: string
    • Example: sonarr_api_key = "9098576385d18446b7d2617b42e5cef1"
  • sonarr_quality_profile_id
    • Sonarr quality profile(s) to make available through Searcharr
    • Type: List (also allows a single string)
    • Example: sonarr_quality_profile_id = ["HD - 720p/1080p", "Ultra-HD", "Any"]
    • Note: You can use the exact profile name or profile id (or a mix)
    • Note: Include multiple profiles in the list to allow the user to choose
    • Note: Include only one profile in the list to prevent users from choosing
  • sonarr_add_monitored
    • Add series to Sonarr as "monitored"
    • Type: boolean
    • Options: True or False
    • Example: sonarr_add_monitored = True
  • sonarr_search_on_add
    • Tell Sonarr to start searching for each series when it's added
    • Type: boolean
    • Options: True or False
    • Example: sonarr_search_on_add = True
  • sonarr_tag_with_username
    • Add a tag to each series added to Sonarr, indicating which Telegram user added the series
    • Type: boolean
    • Options: True or False
    • Example: sonarr_tag_with_username = True
    • Note: Tag format will be searcharr-<username> if the user has a Telegram username, otherwise searcharr-<userid> (the user's numeric Telegram user id)
  • sonarr_forced_tags
    • Tags that Searcharr should add to every series
    • Type: list
    • Example: sonarr_forced_tags = ["searcharr", "friends-and-family"]
    • Example: sonarr_forced_tags = [] (to not force the addition of any tags)
  • sonarr_allow_user_to_select_tags
    • Allow the user to select one or more tags when adding a series
    • Type: bool
    • Example: sonarr_allow_user_to_select_tags = True
    • Example: sonarr_allow_user_to_select_tags = False
  • sonarr_user_selectable_tags
    • Tags to present to the user when adding a series
    • Type: list
    • Example: sonarr_user_selectable_tags = [] (to allow user to select from all tags that exist in Sonarr)
    • Example: sonarr_user_selectable_tags = ["tag-1", "tag-2"]
    • Note: Tags added to this list will be created in Sonarr if they don't already exist
    • Note: Leave the list empty to allow the user to select from all tags that exist in Sonarr
  • sonarr_series_command_aliases
    • Set the command(s) the bot should honor for adding series to Sonarr
    • Type: list
    • Example: sonarr_series_command_aliases = ["series"]
    • Example: sonarr_series_command_aliases = ["series", "tv"]
    • Example: sonarr_series_command_aliases = ["tv", "anime"]
    • Example: sonarr_series_command_aliases = ["anime"]
    • Note: Telegram does not support diacritical characters for commands.
  • sonarr_series_paths
    • Root folders users can pick from when adding a series to Sonarr
    • Type: list
    • Example: sonarr_series_paths = ["/tv", "/anime"]
    • Example: sonarr_series_paths = ["/tv"]
    • Note: You can use the root folder id or the full path, but the path must match exactly what's in Sonarr
    • Note: Leave the list empty to enable all root folders configured in Sonarr (e.g. sonarr_series_paths = [])
  • sonarr_season_monitor_prompt (v2.0+)
    • Allow user to monitor All, First, or Latest Season(s) when adding a series to Sonarr
    • Type: boolean
    • Options: True or False
    • Example: sonarr_season_monitor_prompt = True

Radarr

  • radarr_enabled
    • Enable Radarr integration in Searcharr
    • Type: boolean
    • Options: True or False
    • Example: radarr_enabled = True
  • radarr_url
    • The URL your Searcharr bot should use to connect to Radarr
    • Type: string
    • Example: radarr_url = "http://192.168.0.100:7878"
    • Example: radarr_url = "http://192.168.0.100/radarr"
  • radarr_api_key
    • API key Searcharr should use to interact with the Radarr API
    • Type: string
    • Example: radarr_api_key = "9098576385d18446b7d2617b42e5cef1"
  • radarr_quality_profile_id
    • Radarr quality profile(s) to make available through Searcharr
    • Type: List (also allows a single string)
    • Example: radarr_quality_profile_id = ["HD - 720p/1080p", "Ultra-HD", "Any"]
    • Note: You can use the exact profile name or profile id (or a mix)
    • Note: Include multiple profiles in the list to allow the user to choose
    • Note: Include only one profile in the list to prevent users from choosing
  • radarr_add_monitored
    • Add series to Radarr as "monitored"
    • Type: boolean
    • Options: True or False
    • Example: radarr_add_monitored = True
  • radarr_search_on_add
    • Tell Radarr to start searching for each movie when it's added
    • Type: boolean
    • Options: True or False
    • Example: radarr_add_monitored = True
  • radarr_tag_with_username
    • Add a tag to each movie added to Radarr, indicating which Telegram user added the movie
    • Type: boolean
    • Options: True or False
    • Example: radarr_tag_with_username = True
    • Note: Tag format will be searcharr-<username> if the user has a Telegram username, otherwise searcharr-<userid> (the user's numeric Telegram user id)
  • radarr_forced_tags
    • Tags that Searcharr should add to every movie
    • Type: list
    • Example: radarr_forced_tags = ["searcharr", "friends-and-family"]
    • Example: radarr_forced_tags = [] (to not force the addition of any tags)
  • radarr_allow_user_to_select_tags
    • Allow the user to select one or more tags when adding a movie
    • Type: bool
    • Example: radarr_allow_user_to_select_tags = True
    • Example: radarr_allow_user_to_select_tags = False
  • radarr_user_selectable_tags
    • Tags to present to the user when adding a movie
    • Type: list
    • Example: radarr_user_selectable_tags = [] (to allow user to select from all tags that exist in Radarr)
    • Example: radarr_user_selectable_tags = ["tag-1", "tag-2"]
    • Note: Tags added to this list will be created in Radarr if they don't already exist
    • Note: Leave the list empty to allow the user to select from all tags that exist in Radarr
  • radarr_min_availability
    • Configure the "minimum availability" for movies added to Radarr
    • Type: string
    • Options: "announced", "inCinemas", "released"
    • Example: radarr_min_availability = "released"
  • radarr_movie_command_aliases
    • Set the command(s) the bot should honor for adding movies to Radarr
    • Type: list
    • Example: radarr_movie_command_aliases = ["movie"]
    • Example: radarr_movie_command_aliases = ["movie", "m"]
    • Example: radarr_movie_command_aliases = ["m"]
    • Note: Telegram does not support diacritical characters for commands.
  • radarr_movie_paths
    • Root folders users can pick from when adding a movie to Radarr
    • Type: list
    • Example: radarr_movie_paths = ["/movies", "/other-movies"]
    • Example: radarr_movie_paths = ["/movies"]
    • Note: You can use the root folder id or the full path, but the path must match exactly what's in Radarr
    • Note: Leave the list empty to enable all root folders configured in Radarr (e.g. radarr_movie_paths = [])

Readarr (v3.0+)

  • readarr_enabled
    • Enable Readarr integration in Searcharr
    • Type: boolean
    • Options: True or False
    • Example: readarr_enabled = True
  • readarr_url
    • The URL your Searcharr bot should use to connect to Readarr
    • Type: string
    • Example: readarr_url = "http://192.168.0.100:8787"
    • Example: readarr_url = "http://192.168.0.100/readarr"
  • readarr_api_key
    • API key Searcharr should use to interact with the Readarr API
    • Type: string
    • Example: readarr_api_key = "9098576385d18446b7d2617b42e5cef1"
  • readarr_quality_profile_id
    • Readarr quality profile(s) to make available through Searcharr
    • Type: List (also allows a single string)
    • Example: readarr_quality_profile_id = ["eBook", "Spoken"]
    • Note: You can use the exact profile name or profile id (or a mix)
    • Note: Include multiple profiles in the list to allow the user to choose
    • Note: Include only one profile in the list to prevent users from choosing
  • readarr_metadata_profile_id
    • Readarr metadata profile(s) to make available through Searcharr
    • Type: List (also allows a single string)
    • Example: readarr_metadata_profile_id = ["Standard"]
    • Note: You can use the exact profile name or profile id (or a mix)
    • Note: Include multiple profiles in the list to allow the user to choose
    • Note: Include only one profile in the list to prevent users from choosing
  • readarr_add_monitored
    • Add series to Readarr as "monitored"
    • Type: boolean
    • Options: True or False
    • Example: readarr_add_monitored = True
  • readarr_search_on_add
    • Tell Readarr to start searching for each movie when it's added
    • Type: boolean
    • Options: True or False
    • Example: readarr_add_monitored = True
  • readarr_tag_with_username
    • Add a tag to each book added to Readarr, indicating which Telegram user added the book
    • Type: boolean
    • Options: True or False
    • Example: readarr_tag_with_username = True
    • Note: Tag format will be searcharr-<username> if the user has a Telegram username, otherwise searcharr-<userid> (the user's numeric Telegram user id)
  • readarr_forced_tags
    • Tags that Searcharr should add to every book
    • Type: list
    • Example: readarr_forced_tags = ["searcharr", "friends-and-family"]
    • Example: readarr_forced_tags = [] (to not force the addition of any tags)
  • readarr_allow_user_to_select_tags
    • Allow the user to select one or more tags when adding a book
    • Type: bool
    • Example: readarr_allow_user_to_select_tags = True
    • Example: readarr_allow_user_to_select_tags = False
  • readarr_user_selectable_tags
    • Tags to present to the user when adding a book
    • Type: list
    • Example: readarr_user_selectable_tags = [] (to allow user to select from all tags that exist in Radarr)
    • Example: readarr_user_selectable_tags = ["tag-1", "tag-2"]
    • Note: Tags added to this list will be created in Readarr if they don't already exist
    • Note: Leave the list empty to allow the user to select from all tags that exist in Readarr
  • readarr_book_command_aliases
    • Set the command(s) the bot should honor for adding books to Readarr
    • Type: list
    • Example: readarr_book_command_aliases = ["book"]
    • Example: readarr_book_command_aliases = ["book", "b"]
    • Example: readarr_book_command_aliases = ["b"]
    • Note: Telegram does not support diacritical characters for commands.
  • readarr_book_paths
    • Root folders users can pick from when adding a book to Readarr
    • Type: list
    • Example: readarr_book_paths = ["/books", "/other-books"]
    • Example: readarr_movie_paths = ["/books"]
    • Note: You can use the root folder id or the full path, but the path must match exactly what's in Readarr
    • Note: Leave the list empty to enable all root folders configured in Readarr (e.g. readarr_book_paths = [])
Clone this wiki locally