wiki:MovedToGitHub/EditConfigFiles

Version 21 (modified by charles, 12 years ago) (diff)

add notes about `preallocation' key

Editing Configuration Files

It's not always possible to set all configurations from the GUI, especially on the Daemon, or the Web Interface. This guide will try to give an overview of how and what you can change. For the location of these files, look at the Configuration Files page.

GTK / Daemon / CLI

Overview

GTK, CLI and Daemon (both on a Mac and Linux) use a JSON formatted file. Mainly because of it's human readability.
(Consult the JSON for detailed information)

Here is a sample of the three basic types, respectively Boolean, Number and String:

{
    "rpc-enabled": 1,
    "peer-port" : 9091,
    "rpc-whitelist": "127.0.0.*,192.168.*.*"
}

Options

Some keys are only valid for the current, or currently in development, version. Do scroll to the next section to check if the key you want to edit is listed there.

Location

  • download-dir: String

Bandwidth

  • download-limit: Number (kb/s, default = 100)
  • download-limit-enabled: Boolean (default = 0)
  • upload-limit: Number (kb/s, default = 100)
  • upload-limit-enabled: Boolean (default = 0)

Peer Port

  • peer-port: Number (default = 51413)
  • port-forwarding-enabled: Boolean (0-1)
  • peer-port-random-enabled: Boolean (default = 0)
  • peer-port-random-low: Number (default = 1024)
  • peer-port-random-high: Number (default = 65535)

Blocklists

  • blocklist-enabled: Boolean (default = 0)

RPC

  • rpc-enabled: Boolean (default = 1)
  • rpc-port: Number (default = 9091)
  • rpc-authentication-required: Boolean (default = 0)
  • rpc-username: String
  • rpc-password: String
  • rpc-whitelist-enabled: Boolean (default = 1)
  • rpc-whitelist: String (Comma-delimited list of IP addresses. Wildcards allowed using '*'. Example: "127.0.0.*,192.168.*.*", Default: "127.0.0.1" )

Peers

  • peer-limit-global: Number (default = 240)
  • peer-limit-per-torrent: Number (default = 60)

Advanced

  • pex-enabled: Boolean (default = 1)
  • encryption: Number (0 = Off, 1 = Preferred, 2 = Forced, default = 1)
  • preallocation: Number (0 = Off, 1 = Fast, 2 = Full (slower but reduces disk fragmentation), default = 1)
  • lazy-bitfield-enabled: Boolean (default = 1)
  • peer-socket-tos: Number (default = 8)
  • open-file-limit: Number (default = 32)

Proxy

  • proxy-enabled: Boolean (default = 0)
  • proxy: String
  • proxy-port: Number (default = 80)
  • proxy-type: Number (0 = HTTP, 1 = SOCKS4, 2 = SOCKS5, default = 0)
  • proxy-auth-enabled: Boolean (default = 0)
  • proxy-auth-username: String
  • proxy-auth-password: String

Legacy Options

Only keys that differ from above are listed here.

1.4x Options

Proxy
  • proxy-server: String
  • proxy-port: Number (default = 80)
  • proxy-server-enabled: Boolean (default = 0)
  • proxy-type: Number (0 = HTTP, 1 = SOCKS4, 2 = SOCKS5, default = 0)
  • proxy-authentication-required: Boolean (default = 0)
  • proxy-username: String
  • proxy-authentication String
Peers
  • max-peers-global: Number (default = 240)
  • max-peers-per-torrent: Number (default = 60)

1.3x Options

RPC
  • rpc-access-control-list: String (Comma-delimited list of IP addresses prefixed with "+" or "-". Wildcards allowed using '*'. Example: "+127.0.0.*,-192.168.*.*", Default: "+127.0.0.1" )

Mac OS X

Overview

Mac OS X has a standardized way of saving user preferences files using XML format. These files are called plist (short for property list) files. Usually there is no need to modify these files directly, since Apple provided a command-line tool to reliably change settings. You do need to restart Transmission before these have effect.

In short:

  • To set a key: defaults write org.m0k.transmission key value
  • To reset a key: defaults delete org.m0k.transmission key

Options

Nightly

When you check the "Include beta releases" checkbox, you'll update to the nightlies
Note: Nightlies are untested snapshots. Use them with care.

  • AppcastBeta:
    $ defaults write org.m0k.transmission AppcastBeta http://transmission.xpjets.com/ZIP/
    

Advanced

  • PeerSocketTOS: Number (Default = 8)

Legacy

Transmission 1.5x and earlier

Nightly
  • SUFeedURL:
    $ defaults write org.m0k.transmission SUFeedURL http://transmission.xpjets.com/ZIP/