Type Alias Preferences

Possible fields:

type Preferences = {
    locale?: string;
    create_subfolder_enabled?: boolean;
    start_paused_enabled?: boolean;
    auto_delete_mode?: number;
    preallocate_all?: boolean;
    incomplete_files_ext?: boolean;
    auto_tmm_enabled?: boolean;
    torrent_changed_tmm_enabled?: boolean;
    save_path_changed_tmm_enabled?: boolean;
    category_changed_tmm_enabled?: boolean;
    save_path?: string;
    temp_path_enabled?: boolean;
    temp_path?: string;
    scan_dirs?: { [key: string]: string | 0 | 1 };
    export_dir?: string;
    export_dir_fin?: string;
    mail_notification_enabled?: boolean;
    mail_notification_sender?: string;
    mail_notification_email?: string;
    mail_notification_smtp?: string;
    mail_notification_ssl_enabled?: boolean;
    mail_notification_auth_enabled?: boolean;
    mail_notification_username?: string;
    mail_notification_password?: string;
    autorun_enabled?: boolean;
    autorun_program?: string;
    queueing_enabled?: boolean;
    max_active_downloads?: number;
    max_active_torrents?: number;
    max_active_uploads?: number;
    dont_count_slow_torrents?: boolean;
    slow_torrent_dl_rate_threshold?: number;
    slow_torrent_ul_rate_threshold?: number;
    slow_torrent_inactive_timer?: number;
    max_ratio_enabled?: boolean;
    max_ratio?: number;
    max_ratio_act?: 0 | 1;
    listen_port?: number;
    upnp?: boolean;
    random_port?: boolean;
    dl_limit?: number;
    up_limit?: number;
    max_connec?: number;
    max_connec_per_torrent?: number;
    max_uploads?: number;
    max_uploads_per_torrent?: number;
    stop_tracker_timeout?: number;
    enable_piece_extent_affinity?: boolean;
    bittorrent_protocol?: 0 | 1 | 2;
    limit_utp_rate?: boolean;
    limit_tcp_overhead?: boolean;
    limit_lan_peers?: boolean;
    alt_dl_limit?: number;
    alt_up_limit?: number;
    scheduler_enabled?: boolean;
    schedule_from_hour?: number;
    schedule_from_min?: number;
    schedule_to_hour?: number;
    schedule_to_min?: number;
    scheduler_days?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
    dht?: boolean;
    pex?: boolean;
    lsd?: boolean;
    encryption?: 0 | 1 | 2;
    anonymous_mode?: boolean;
    proxy_type?: -1 | 0 | 1 | 2 | 3 | 4 | 5;
    proxy_ip?: string;
    proxy_port?: number;
    proxy_peer_connections?: boolean;
    proxy_auth_enabled?: boolean;
    proxy_username?: string;
    proxy_password?: string;
    proxy_torrents_only?: boolean;
    ip_filter_enabled?: boolean;
    ip_filter_path?: string;
    ip_filter_trackers?: boolean;
    web_ui_domain_list?: string[];
    web_ui_address?: string;
    web_ui_port?: number;
    web_ui_upnp?: boolean;
    web_ui_username?: string;
    web_ui_csrf_protection_enabled?: boolean;
    web_ui_clickjacking_protection_enabled?: boolean;
    web_ui_secure_cookie_enabled?: boolean;
    web_ui_max_auth_fail_count?: number;
    web_ui_ban_duration?: number;
    web_ui_session_timeout?: number;
    web_ui_host_header_validation_enabled?: boolean;
    bypass_local_auth?: boolean;
    bypass_auth_subnet_whitelist_enabled?: boolean;
    bypass_auth_subnet_whitelist?: string[];
    alternative_webui_enabled?: boolean;
    alternative_webui_path?: string;
    use_https?: boolean;
    ssl_key?: string;
    ssl_cert?: string;
    web_ui_https_key_path?: string;
    web_ui_https_cert_path?: string;
    dyndns_enabled?: boolean;
    dyndns_service?: 0 | 1;
    dyndns_username?: string;
    dyndns_password?: string;
    dyndns_domain?: string;
    rss_refresh_interval?: number;
    rss_max_articles_per_feed?: number;
    rss_processing_enabled?: boolean;
    rss_auto_downloading_enabled?: boolean;
    rss_download_repack_proper_episodes?: boolean;
    rss_smart_episode_filters?: string;
    add_trackers_enabled?: boolean;
    add_trackers?: string;
    web_ui_use_custom_http_headers_enabled?: boolean;
    web_ui_custom_http_headers?: string;
    max_seeding_time_enabled?: boolean;
    max_seeding_time?: number;
    announce_ip?: string;
    announce_to_all_tiers?: boolean;
    announce_to_all_trackers?: boolean;
    async_io_threads?: number;
    banned_IPs?: string;
    checking_memory_use?: number;
    current_interface_address?: string;
    current_network_interface?: string;
    disk_cache?: number;
    disk_cache_ttl?: number;
    embedded_tracker_port?: number;
    enable_coalesce_read_write?: boolean;
    enable_embedded_tracker?: boolean;
    enable_multi_connections_from_same_ip?: boolean;
    enable_os_cache?: boolean;
    enable_upload_suggestions?: boolean;
    file_pool_size?: number;
    outgoing_ports_max?: number;
    outgoing_ports_min?: number;
    recheck_completed_torrents?: boolean;
    resolve_peer_countries?: boolean;
    save_resume_data_interval?: number;
    send_buffer_low_watermark?: number;
    send_buffer_watermark?: number;
    send_buffer_watermark_factor?: number;
    socket_backlog_size?: number;
    upload_choking_algorithm?: 0 | 1 | 2;
    upload_slots_behavior?: 0 | 1;
    upnp_lease_duration?: number;
    utp_tcp_mixed_mode?: 0 | 1;
    [key: string]: unknown;
}

Indexable

[key: string]: unknown

Index

Properties

locale? create_subfolder_enabled? start_paused_enabled? auto_delete_mode? preallocate_all? incomplete_files_ext? auto_tmm_enabled? torrent_changed_tmm_enabled? save_path_changed_tmm_enabled? category_changed_tmm_enabled? save_path? temp_path_enabled? temp_path? scan_dirs? export_dir? export_dir_fin? mail_notification_enabled? mail_notification_sender? mail_notification_email? mail_notification_smtp? mail_notification_ssl_enabled? mail_notification_auth_enabled? mail_notification_username? mail_notification_password? autorun_enabled? autorun_program? queueing_enabled? max_active_downloads? max_active_torrents? max_active_uploads? dont_count_slow_torrents? slow_torrent_dl_rate_threshold? slow_torrent_ul_rate_threshold? slow_torrent_inactive_timer? max_ratio_enabled? max_ratio? max_ratio_act? listen_port? upnp? random_port? dl_limit? up_limit? max_connec? max_connec_per_torrent? max_uploads? max_uploads_per_torrent? stop_tracker_timeout? enable_piece_extent_affinity? bittorrent_protocol? limit_utp_rate? limit_tcp_overhead? limit_lan_peers? alt_dl_limit? alt_up_limit? scheduler_enabled? schedule_from_hour? schedule_from_min? schedule_to_hour? schedule_to_min? scheduler_days? dht? pex? lsd? encryption? anonymous_mode? proxy_type? proxy_ip? proxy_port? proxy_peer_connections? proxy_auth_enabled? proxy_username? proxy_password? proxy_torrents_only? ip_filter_enabled? ip_filter_path? ip_filter_trackers? web_ui_domain_list? web_ui_address? web_ui_port? web_ui_upnp? web_ui_username? web_ui_csrf_protection_enabled? web_ui_clickjacking_protection_enabled? web_ui_secure_cookie_enabled? web_ui_max_auth_fail_count? web_ui_ban_duration? web_ui_session_timeout? web_ui_host_header_validation_enabled? bypass_local_auth? bypass_auth_subnet_whitelist_enabled? bypass_auth_subnet_whitelist? alternative_webui_enabled? alternative_webui_path? use_https? ssl_key? ssl_cert? web_ui_https_key_path? web_ui_https_cert_path? dyndns_enabled? dyndns_service? dyndns_username? dyndns_password? dyndns_domain? rss_refresh_interval? rss_max_articles_per_feed? rss_processing_enabled? rss_auto_downloading_enabled? rss_download_repack_proper_episodes? rss_smart_episode_filters? add_trackers_enabled? add_trackers? web_ui_use_custom_http_headers_enabled? web_ui_custom_http_headers? max_seeding_time_enabled? max_seeding_time? announce_ip? announce_to_all_tiers? announce_to_all_trackers? async_io_threads? banned_IPs? checking_memory_use? current_interface_address? current_network_interface? disk_cache? disk_cache_ttl? embedded_tracker_port? enable_coalesce_read_write? enable_embedded_tracker? enable_multi_connections_from_same_ip? enable_os_cache? enable_upload_suggestions? file_pool_size? outgoing_ports_max? outgoing_ports_min? recheck_completed_torrents? resolve_peer_countries? save_resume_data_interval? send_buffer_low_watermark? send_buffer_watermark? send_buffer_watermark_factor? socket_backlog_size? upload_choking_algorithm? upload_slots_behavior? upnp_lease_duration? utp_tcp_mixed_mode?

Properties

`Optional`locale

locale?: string

Currently selected language (e.g. en_GB for English)

`Optional`create_subfolder_enabled

create_subfolder_enabled?: boolean

True if a subfolder should be created when adding a torrent

`Optional`start_paused_enabled

start_paused_enabled?: boolean

True if torrents should be added in a Paused state

`Optional`auto_delete_mode

auto_delete_mode?: number

TODO

`Optional`preallocate_all

preallocate_all?: boolean

True if disk space should be pre-allocated for all files

`Optional`incomplete_files_ext

incomplete_files_ext?: boolean

True if ".!qB" should be appended to incomplete files

`Optional`auto_tmm_enabled

auto_tmm_enabled?: boolean

True if Automatic Torrent Management is enabled by default

`Optional`torrent_changed_tmm_enabled

torrent_changed_tmm_enabled?: boolean

True if torrent should be relocated when its Category changes

`Optional`save_path_changed_tmm_enabled

save_path_changed_tmm_enabled?: boolean

True if torrent should be relocated when the default save path changes

`Optional`category_changed_tmm_enabled

category_changed_tmm_enabled?: boolean

True if torrent should be relocated when its Category's save path changes

`Optional`save_path

save_path?: string

Default save path for torrents, separated by slashes

`Optional`temp_path_enabled

temp_path_enabled?: boolean

True if folder for incomplete torrents is enabled

`Optional`temp_path

temp_path?: string

Path for incomplete torrents, separated by slashes

`Optional`scan_dirs

scan_dirs?: { [key: string]: string | 0 | 1 }

Property: directory to watch for torrent files, value: where torrents loaded from this directory should be downloaded to (see list of possible values below). Slashes are used as path separators; multiple key/value pairs can be specified

Value	Description
0	Download to the monitored folder
1	Download to the default save path
"/path/to/download/to"	Download to this path

`Optional`export_dir

export_dir?: string

Path to directory to copy .torrent files to. Slashes are used as path separators

`Optional`export_dir_fin

export_dir_fin?: string

Path to directory to copy .torrent files of completed downloads to. Slashes are used as path separators

`Optional`mail_notification_enabled

mail_notification_enabled?: boolean

True if e-mail notification should be enabled

`Optional`mail_notification_sender

mail_notification_sender?: string

e-mail where notifications should originate from

`Optional`mail_notification_email

mail_notification_email?: string

e-mail to send notifications to

`Optional`mail_notification_smtp

mail_notification_smtp?: string

smtp server for e-mail notifications

`Optional`mail_notification_ssl_enabled

mail_notification_ssl_enabled?: boolean

True if smtp server requires SSL connection

`Optional`mail_notification_auth_enabled

mail_notification_auth_enabled?: boolean

True if smtp server requires authentication

`Optional`mail_notification_username

mail_notification_username?: string

Username for smtp authentication

`Optional`mail_notification_password

mail_notification_password?: string

Password for smtp authentication

`Optional`autorun_enabled

autorun_enabled?: boolean

True if external program should be run after torrent has finished downloading

`Optional`autorun_program

autorun_program?: string

Program path/name/arguments to run if autorun_enabled is enabled; path is separated by slashes; you can use %f and %n arguments, which will be expanded by qBittorent as path_to_torrent_file and torrent_name (from the GUI; not the .torrent file name) respectively

`Optional`queueing_enabled

queueing_enabled?: boolean

True if torrent queuing is enabled

`Optional`max_active_downloads

max_active_downloads?: number

Maximum number of active simultaneous downloads

`Optional`max_active_torrents

max_active_torrents?: number

Maximum number of active simultaneous downloads and uploads

`Optional`max_active_uploads

max_active_uploads?: number

Maximum number of active simultaneous uploads

`Optional`dont_count_slow_torrents

dont_count_slow_torrents?: boolean

If true torrents w/o any activity (stalled ones) will not be counted towards max_active_* limits; see dont_count_slow_torrents for more information

`Optional`slow_torrent_dl_rate_threshold

slow_torrent_dl_rate_threshold?: number

Download rate in KiB/s for a torrent to be considered "slow"

`Optional`slow_torrent_ul_rate_threshold

slow_torrent_ul_rate_threshold?: number

Upload rate in KiB/s for a torrent to be considered "slow"

`Optional`slow_torrent_inactive_timer

slow_torrent_inactive_timer?: number

Seconds a torrent should be inactive before considered "slow"

`Optional`max_ratio_enabled

max_ratio_enabled?: boolean

True if share ratio limit is enabled

`Optional`max_ratio

max_ratio?: number

Get the global share ratio limit

`Optional`max_ratio_act

max_ratio_act?: 0 | 1

Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.

Value	Description
0	Pause torrent
1	Remove torrent

`Optional`listen_port

listen_port?: number

Port for incoming connections

`Optional`upnp

upnp?: boolean

True if UPnP/NAT-PMP is enabled

`Optional`random_port

random_port?: boolean

True if the port is randomly selected

`Optional`dl_limit

dl_limit?: number

Global download speed limit in KiB/s; -1 means no limit is applied

`Optional`up_limit

up_limit?: number

Global upload speed limit in KiB/s; -1 means no limit is applied

`Optional`max_connec

max_connec?: number

Maximum global number of simultaneous connections

`Optional`max_connec_per_torrent

max_connec_per_torrent?: number

Maximum number of simultaneous connections per torrent

`Optional`max_uploads

max_uploads?: number

Maximum number of upload slots

`Optional`max_uploads_per_torrent

max_uploads_per_torrent?: number

Maximum number of upload slots per torrent

`Optional`stop_tracker_timeout

stop_tracker_timeout?: number

Timeout in seconds for a stopped announce request to trackers

`Optional`enable_piece_extent_affinity

enable_piece_extent_affinity?: boolean

True if the advanced libtorrent option piece_extent_affinity is enabled

`Optional`bittorrent_protocol

bittorrent_protocol?: 0 | 1 | 2

Bittorrent Protocol to use (see list of possible values below)

Value	Description
0	TCP and μTP
1	TCP
2	μTP

`Optional`limit_utp_rate

limit_utp_rate?: boolean

True if [du]l_limit should be applied to uTP connections; this option is only available in qBittorent built against libtorrent version 0.16.X and higher

`Optional`limit_tcp_overhead

limit_tcp_overhead?: boolean

True if [du]l_limit should be applied to estimated TCP overhead (service data: e.g. packet headers)

`Optional`limit_lan_peers

limit_lan_peers?: boolean

True if [du]l_limit should be applied to peers on the LAN

`Optional`alt_dl_limit

alt_dl_limit?: number

Alternative global download speed limit in KiB/s

`Optional`alt_up_limit

alt_up_limit?: number

Alternative global upload speed limit in KiB/s

`Optional`scheduler_enabled

scheduler_enabled?: boolean

True if alternative limits should be applied according to schedule

`Optional`schedule_from_hour

schedule_from_hour?: number

Scheduler starting hour

`Optional`schedule_from_min

schedule_from_min?: number

Scheduler starting minute

`Optional`schedule_to_hour

schedule_to_hour?: number

Scheduler ending hour

`Optional`schedule_to_min

schedule_to_min?: number

Scheduler ending minute

`Optional`scheduler_days

scheduler_days?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

Scheduler days. See possible values here below

Value	Description
0	Every day
1	Every weekday
2	Every weekend
3	Every Monday
4	Every Tuesday
5	Every Wednesday
6	Every Thursday
7	Every Friday
8	Every Saturday
9	Every Sunday

`Optional`dht

dht?: boolean

True if DHT is enabled

`Optional`pex

pex?: boolean

True if PeX is enabled

`Optional`lsd

lsd?: boolean

True if LSD is enabled

`Optional`encryption

encryption?: 0 | 1 | 2

See list of possible values here below

Value	Description
0	Prefer encryption
1	Force encryption on
2	Force encryption off

`Optional`anonymous_mode

anonymous_mode?: boolean

If true anonymous mode will be enabled; read more here; this option is only available in qBittorent built against libtorrent version 0.16.X and higher

`Optional`proxy_type

proxy_type?: -1 | 0 | 1 | 2 | 3 | 4 | 5

See list of possible values here below

Value	Description
-1	Proxy is disabled
0	Prefer encryption
1	HTTP proxy without authentication
2	SOCKS5 proxy without authentication
3	HTTP proxy with authentication
4	SOCKS5 proxy with authentication
5	SOCKS4 proxy without authentication

`Optional`proxy_ip

proxy_ip?: string

Proxy IP address or domain name

`Optional`proxy_port

proxy_port?: number

Proxy port

`Optional`proxy_peer_connections

proxy_peer_connections?: boolean

True if peer and web seed connections should be proxified; this option will have any effect only in qBittorent built against libtorrent version 0.16.X and higher

`Optional`proxy_auth_enabled

proxy_auth_enabled?: boolean

True proxy requires authentication; doesn't apply to SOCKS4 proxies

`Optional`proxy_username

proxy_username?: string

Username for proxy authentication

`Optional`proxy_password

proxy_password?: string

Password for proxy authentication

`Optional`proxy_torrents_only

proxy_torrents_only?: boolean

True if proxy is only used for torrents

`Optional`ip_filter_enabled

ip_filter_enabled?: boolean

True if external IP filter should be enabled

`Optional`ip_filter_path

ip_filter_path?: string

Path to IP filter file (.dat, .p2p, .p2b files are supported); path is separated by slashes

`Optional`ip_filter_trackers

ip_filter_trackers?: boolean

True if IP filters are applied to trackers

`Optional`web_ui_domain_list

web_ui_domain_list?: string[]

Comma-separated list of domains to accept when performing Host header validation

`Optional`web_ui_address

web_ui_address?: string

IP address to use for the WebUI

`Optional`web_ui_port

web_ui_port?: number

WebUI port

`Optional`web_ui_upnp

web_ui_upnp?: boolean

True if UPnP is used for the WebUI port

`Optional`web_ui_username

web_ui_username?: string

WebUI username

`Optional`web_ui_csrf_protection_enabled

web_ui_csrf_protection_enabled?: boolean

True if WebUI CSRF protection is enabled

`Optional`web_ui_clickjacking_protection_enabled

web_ui_clickjacking_protection_enabled?: boolean

True if WebUI clickjacking protection is enabled

`Optional`web_ui_secure_cookie_enabled

web_ui_secure_cookie_enabled?: boolean

True if WebUI cookie Secure flag is enabled

`Optional`web_ui_max_auth_fail_count

web_ui_max_auth_fail_count?: number

Maximum number of authentication failures before WebUI access ban

`Optional`web_ui_ban_duration

web_ui_ban_duration?: number

WebUI access ban duration in seconds

`Optional`web_ui_session_timeout

web_ui_session_timeout?: number

Seconds until WebUI is automatically signed off

`Optional`web_ui_host_header_validation_enabled

web_ui_host_header_validation_enabled?: boolean

True if WebUI host header validation is enabled

`Optional`bypass_local_auth

bypass_local_auth?: boolean

True if authentication challenge for loopback address (127.0.0.1) should be disabled

`Optional`bypass_auth_subnet_whitelist_enabled

bypass_auth_subnet_whitelist_enabled?: boolean

True if webui authentication should be bypassed for clients whose ip resides within (at least) one of the subnets on the whitelist

`Optional`bypass_auth_subnet_whitelist

bypass_auth_subnet_whitelist?: string[]

(White)list of ipv4/ipv6 subnets for which webui authentication should be bypassed; list entries are separated by commas

`Optional`alternative_webui_enabled

alternative_webui_enabled?: boolean

True if an alternative WebUI should be used

`Optional`alternative_webui_path

alternative_webui_path?: string

File path to the alternative WebUI

`Optional`use_https

use_https?: boolean

True if WebUI HTTPS access is enabled

`Optional`ssl_key

ssl_key?: string

For API < v2.0.1: SSL keyfile contents (this is a not a path)

`Optional`ssl_cert

ssl_cert?: string

For API < v2.0.1: SSL certificate contents (this is a not a path)

`Optional`web_ui_https_key_path

web_ui_https_key_path?: string

For API ≥ v2.0.1: Path to SSL keyfile

`Optional`web_ui_https_cert_path

web_ui_https_cert_path?: string

For API ≥ v2.0.1: Path to SSL certificate

`Optional`dyndns_enabled

dyndns_enabled?: boolean

True if server DNS should be updated dynamically

`Optional`dyndns_service

dyndns_service?: 0 | 1

See list of possible values here below

Value	Description
0	Use DyDNS
1	Use NOIP

`Optional`dyndns_username

dyndns_username?: string

Username for DDNS service

`Optional`dyndns_password

dyndns_password?: string

Password for DDNS service

`Optional`dyndns_domain

dyndns_domain?: string

Your DDNS domain name

`Optional`rss_refresh_interval

rss_refresh_interval?: number

RSS refresh interval

`Optional`rss_max_articles_per_feed

rss_max_articles_per_feed?: number

Max stored articles per RSS feed

`Optional`rss_processing_enabled

rss_processing_enabled?: boolean

Enable processing of RSS feeds

`Optional`rss_auto_downloading_enabled

rss_auto_downloading_enabled?: boolean

Enable auto-downloading of torrents from the RSS feeds

`Optional`rss_download_repack_proper_episodes

rss_download_repack_proper_episodes?: boolean

For API ≥ v2.5.1: Enable downloading of repack/proper Episodes

`Optional`rss_smart_episode_filters

rss_smart_episode_filters?: string

For API ≥ v2.5.1: List of RSS Smart Episode Filters

`Optional`add_trackers_enabled

add_trackers_enabled?: boolean

Enable automatic adding of trackers to new torrents

`Optional`add_trackers

add_trackers?: string

List of trackers to add to new torrent

`Optional`web_ui_use_custom_http_headers_enabled

web_ui_use_custom_http_headers_enabled?: boolean

For API ≥ v2.5.1: Enable custom http headers

`Optional`web_ui_custom_http_headers

web_ui_custom_http_headers?: string

For API ≥ v2.5.1: List of custom http headers

`Optional`max_seeding_time_enabled

max_seeding_time_enabled?: boolean

True enables max seeding time

`Optional`max_seeding_time

max_seeding_time?: number

Number of minutes to seed a torrent

`Optional`announce_ip

announce_ip?: string

TODO

`Optional`announce_to_all_tiers

announce_to_all_tiers?: boolean

True always announce to all tiers

`Optional`announce_to_all_trackers

announce_to_all_trackers?: boolean

True always announce to all trackers in a tier

`Optional`async_io_threads

async_io_threads?: number

Number of asynchronous I/O threads

`Optional`banned_IPs

banned_IPs?: string

List of banned IPs

`Optional`checking_memory_use

checking_memory_use?: number

Outstanding memory when checking torrents in MiB

`Optional`current_interface_address

current_interface_address?: string

IP Address to bind to. Empty String means All addresses

`Optional`current_network_interface

current_network_interface?: string

Network Interface used

`Optional`disk_cache

disk_cache?: number

Disk cache used in MiB

`Optional`disk_cache_ttl

disk_cache_ttl?: number

Disk cache expiry interval in seconds

`Optional`embedded_tracker_port

embedded_tracker_port?: number

Port used for embedded tracker

`Optional`enable_coalesce_read_write

enable_coalesce_read_write?: boolean

True enables coalesce reads & writes

`Optional`enable_embedded_tracker

enable_embedded_tracker?: boolean

True enables embedded tracker

`Optional`enable_multi_connections_from_same_ip

enable_multi_connections_from_same_ip?: boolean

True allows multiple connections from the same IP address

`Optional`enable_os_cache

enable_os_cache?: boolean

True enables os cache

`Optional`enable_upload_suggestions

enable_upload_suggestions?: boolean

True enables sending of upload piece suggestions

`Optional`file_pool_size

file_pool_size?: number

File pool size

`Optional`outgoing_ports_max

outgoing_ports_max?: number

Maximal outgoing port (0: Disabled)

`Optional`outgoing_ports_min

outgoing_ports_min?: number

Minimal outgoing port (0: Disabled)

`Optional`recheck_completed_torrents

recheck_completed_torrents?: boolean

True rechecks torrents on completion

`Optional`resolve_peer_countries

resolve_peer_countries?: boolean

True resolves peer countries

`Optional`save_resume_data_interval

save_resume_data_interval?: number

Save resume data interval in min

`Optional`send_buffer_low_watermark

send_buffer_low_watermark?: number

Send buffer low watermark in KiB

`Optional`send_buffer_watermark

send_buffer_watermark?: number

Send buffer watermark in KiB

`Optional`send_buffer_watermark_factor

send_buffer_watermark_factor?: number

Send buffer watermark factor in percent

`Optional`socket_backlog_size

socket_backlog_size?: number

Socket backlog size

`Optional`upload_choking_algorithm

upload_choking_algorithm?: 0 | 1 | 2

Upload choking algorithm used (see list of possible values below)

Value	Description
0	Round-robin
1	Fastest upload
2	Anti-leech

`Optional`upload_slots_behavior

upload_slots_behavior?: 0 | 1

Upload slots behavior used (see list of possible values below)

Value	Description
0	Fixed slots
1	Upload rate based

`Optional`upnp_lease_duration

upnp_lease_duration?: number

UPnP lease duration (0: Permanent lease)

`Optional`utp_tcp_mixed_mode

utp_tcp_mixed_mode?: 0 | 1

μTP-TCP mixed mode algorithm (see list of possible values below)

Value	Description
0	Prefer TCP
1	Peer proportional

Type Alias Preferences

Indexable

Index

Properties

Properties

Optionallocale

Optionalcreate_subfolder_enabled

Optionalstart_paused_enabled

Optionalauto_delete_mode

Optionalpreallocate_all

Optionalincomplete_files_ext

Optionalauto_tmm_enabled

Optionaltorrent_changed_tmm_enabled

Optionalsave_path_changed_tmm_enabled

Optionalcategory_changed_tmm_enabled

Optionalsave_path

Optionaltemp_path_enabled

Optionaltemp_path

Optionalscan_dirs

Optionalexport_dir

Optionalexport_dir_fin

Optionalmail_notification_enabled

Optionalmail_notification_sender

Optionalmail_notification_email

Optionalmail_notification_smtp

Optionalmail_notification_ssl_enabled

Optionalmail_notification_auth_enabled

Optionalmail_notification_username

Optionalmail_notification_password

Optionalautorun_enabled

Optionalautorun_program

Optionalqueueing_enabled

Optionalmax_active_downloads

Optionalmax_active_torrents

Optionalmax_active_uploads

Optionaldont_count_slow_torrents

Optionalslow_torrent_dl_rate_threshold

Optionalslow_torrent_ul_rate_threshold

Optionalslow_torrent_inactive_timer

Optionalmax_ratio_enabled

Optionalmax_ratio

Optionalmax_ratio_act

Optionallisten_port

Optionalupnp

Optionalrandom_port

Optionaldl_limit

Optionalup_limit

Optionalmax_connec

Optionalmax_connec_per_torrent

Optionalmax_uploads

Optionalmax_uploads_per_torrent

Optionalstop_tracker_timeout

Optionalenable_piece_extent_affinity

Optionalbittorrent_protocol

Optionallimit_utp_rate

Optionallimit_tcp_overhead

Optionallimit_lan_peers

Optionalalt_dl_limit

Optionalalt_up_limit

Optionalscheduler_enabled

Optionalschedule_from_hour

Optionalschedule_from_min

Optionalschedule_to_hour

Optionalschedule_to_min

Optionalscheduler_days

Optionaldht

Optionalpex

Optionallsd

Optionalencryption

Optionalanonymous_mode

Optionalproxy_type

Optionalproxy_ip

Optionalproxy_port

Optionalproxy_peer_connections

Optionalproxy_auth_enabled

Optionalproxy_username

Optionalproxy_password

Optionalproxy_torrents_only

Optionalip_filter_enabled

Optionalip_filter_path

`Optional`locale

`Optional`create_subfolder_enabled

`Optional`start_paused_enabled

`Optional`auto_delete_mode

`Optional`preallocate_all

`Optional`incomplete_files_ext

`Optional`auto_tmm_enabled

`Optional`torrent_changed_tmm_enabled

`Optional`save_path_changed_tmm_enabled

`Optional`category_changed_tmm_enabled

`Optional`save_path

`Optional`temp_path_enabled

`Optional`temp_path

`Optional`scan_dirs

`Optional`export_dir

`Optional`export_dir_fin

`Optional`mail_notification_enabled

`Optional`mail_notification_sender

`Optional`mail_notification_email

`Optional`mail_notification_smtp

`Optional`mail_notification_ssl_enabled

`Optional`mail_notification_auth_enabled

`Optional`mail_notification_username

`Optional`mail_notification_password

`Optional`autorun_enabled

`Optional`autorun_program

`Optional`queueing_enabled

`Optional`max_active_downloads

`Optional`max_active_torrents

`Optional`max_active_uploads

`Optional`dont_count_slow_torrents

`Optional`slow_torrent_dl_rate_threshold

`Optional`slow_torrent_ul_rate_threshold

`Optional`slow_torrent_inactive_timer

`Optional`max_ratio_enabled

`Optional`max_ratio

`Optional`max_ratio_act

`Optional`listen_port

`Optional`upnp

`Optional`random_port

`Optional`dl_limit

`Optional`up_limit

`Optional`max_connec

`Optional`max_connec_per_torrent

`Optional`max_uploads

`Optional`max_uploads_per_torrent

`Optional`stop_tracker_timeout

`Optional`enable_piece_extent_affinity

`Optional`bittorrent_protocol

`Optional`limit_utp_rate

`Optional`limit_tcp_overhead

`Optional`limit_lan_peers

`Optional`alt_dl_limit

`Optional`alt_up_limit

`Optional`scheduler_enabled

`Optional`schedule_from_hour

`Optional`schedule_from_min

`Optional`schedule_to_hour

`Optional`schedule_to_min

`Optional`scheduler_days

`Optional`dht

`Optional`pex

`Optional`lsd

`Optional`encryption

`Optional`anonymous_mode

`Optional`proxy_type

`Optional`proxy_ip

`Optional`proxy_port

`Optional`proxy_peer_connections

`Optional`proxy_auth_enabled

`Optional`proxy_username

`Optional`proxy_password

`Optional`proxy_torrents_only

`Optional`ip_filter_enabled

`Optional`ip_filter_path

`Optional`ip_filter_trackers

`Optional`web_ui_domain_list

`Optional`web_ui_address

`Optional`web_ui_port

`Optional`web_ui_upnp