Skip to content

Latest commit

 

History

History
130 lines (87 loc) · 4.5 KB

File metadata and controls

130 lines (87 loc) · 4.5 KB

Configuration

torrra's behavior can be customized through a config.toml file, allowing you to set default paths, indexers, preferences, and other operational parameters.

Configuration File Location

The config.toml file is automatically created in your operating system's standard user configuration directory. This ensures torrra follows best practices for application data storage.

The precise location varies by OS:

  • Linux/macOS: ~/.config/torrra/config.toml
  • Windows: %APPDATA%\torrra\config.toml

The actual path is automatically resolved by torrra using the platformdirs Python library.

Example config.toml

Here's an example of what your config.toml might look like:

[general]
download_path = "/home/username/Downloads"    # The default folder where torrents will be saved
download_in_external_client = false           # If true, opens magnet links in an external torrent client instead of downloading the .torrent file.
theme = "textual-dark"                        # Theme for the application (e.g., "textual-dark", "textual-light", etc.).
timeout = 10                                  # The timeout in seconds for requests to indexers.
max_retries = 3                               # The maximum number of times to retry a request to an indexer if it times out.
use_cache = true                              # If true, search results will be cached to speed up subsequent searches.
cache_ttl = 300                               # The time in seconds that search results will be cached.
seed_ratio = 1.5                              # Target upload/download ratio. Seeding stops when reached. Omit or set None for infinite seeding.

[indexers]
default = "jackett"                           # The name of the default indexer to use if none is specified at runtime

[indexers.jackett]
url = "http://localhost:9117"                 # Base URL of the Jackett instance
api_key = "your-jackett-api-key"              # API key for authentication

[indexers.prowlarr]
url = "http://localhost:9696"                 # Base URL of the Prowlarr instance
api_key = "your-prowlarr-api-key"             # API key for authentication

You can create or edit this file manually with a text editor.

Theme Configuration

You can change the look and feel of torrra by setting the theme option in the [general] section of your config.toml.

The available themes are:

  • catppuccin-latte
  • catppuccin-mocha
  • dracula
  • flexoki
  • gruvbox
  • monokai
  • nord
  • solarized-light
  • textual-ansi
  • textual-dark (default)
  • textual-light
  • tokyo-night

To use a different theme (e.g., gruvbox), you can either edit your config.toml file:

[general]
theme = "gruvbox"

Or, you can set it directly from the command line:

torrra config set general.theme gruvbox

Indexer Selection

torrra supports configuring multiple torrent indexers (e.g., Jackett, Prowlarr) in the config file. At runtime, you can:

Use the default indexer by simply running:

torrra

Override the default by specifying the indexer name:

torrra jackett

This will use the configuration under [indexers.jackett]. If the selected indexer is not defined in the config file, torrra will show an error and exit.

Managing Your Configuration via CLI

torrra provides built-in command-line tools to inspect and modify your configuration settings without directly editing the config.toml file. This is particularly useful for scripting or quick adjustments.

Use the torrra config subcommand followed by get, set, or list.

Retrieving a Configuration Value

To get the value associated with a specific key:

torrra config get general.download_path

This command would output the currently configured download path.

Setting a Configuration Value

To set a configuration key to a new value:

torrra config set general.download_in_external_client true

This would change the download_in_external_client setting to false. Note that boolean values (true/false) should be provided as such, and strings should be enclosed in quotes if they contain spaces or special characters (though for simple paths, it might not always be necessary depending on your shell).

Listing All Configuration Values

To view all currently set configuration values in your config.toml file:

torrra config list

This command will display a comprehensive list of all configured settings and their current values, including general preferences and indexer-related entries.