1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2024-12-22 07:42:37 +00:00
transmission/docs/Environment-Variables.md
Charles Kerr 7e1ecf2f0f
refactor: remove useless TR_DEBUG_FD env var (#5681)
This feature was originally meant to redirect verbose logging to *any*
fd, but it now only supports writing to stdout or stderr, and defaults
to stderr.

Redirecting to stdout isn't very useful and complicates the code, so
just remove it and always use stderr.
2023-06-28 16:26:15 -05:00

2.4 KiB

Users can set environmental variables to override Transmission's default behavior and for debugging.

Transmission-Specific Variables

  • If TRANSMISSION_HOME is set, Transmission will look there for its settings instead of in the default location.
  • If TRANSMISSION_WEB_HOME is set, Transmission will look there for the Web Interface files, such as the JavaScript, HTML, and graphics files.
  • If TR_CURL_SSL_NO_VERIFY is set, Transmission will not validate SSL certificate for HTTPS connections when talking to trackers. See CURL's documentation (CURLOPT_SSL_VERIFYHOST and CURLOPT_SSL_VERIFYPEER) for more details.
  • If TR_CURL_VERBOSE is set, debugging information for libcurl will be enabled. More information about libcurl's debugging mode is available here.
  • If TR_DHT_VERBOSE is set, Transmission will log all of the DHT's activities in excruciating detail to standard error.

Standard Variables Used by Transmission

  • If TRANSMISSION_WEB_HOME is not set, non-Mac platforms will look for the Web Interface files in XDG_DATA_HOME and in XDG_DATA_DIRS as described in the XDG Base Directory Specification. XDG_DATA_HOME has a default value of $HOME/.local/share/.
  • If TRANSMISSION_HOME is not set, Unix-based versions of Transmission will look for their settings in $XDG_CONFIG_HOME/transmission/. XDG_CONFIG_HOME has a default value of $HOME/.config/.
  • If HOME is set, it is used in three ways:
    1. By the XDG variables, as described above.
    2. If TRANSMISSION_HOME is not set, Mac-based versions of Transmission will look for their settings in $HOME/Library/Application Support/Transmission.
    3. $HOME/Downloads is the default download directory.

Standard Variables Used by Other Tools

  • Transmission uses the libcurl library for HTTP- and HTTPS-based tracker announces and scrapes. Transmission does not support proxies, but libcurl itself honors a handful of environment variables to customize its proxy behavior.