1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2024-12-22 07:42:37 +00:00
transmission/docs/Blocklists.md
maxz 7c76d40a4d
Improve the documentation (#2900)
* Unify the line endings to the Unix style (LF only).

* Fix (where possible) or remove broken links.

* Improve the documentation.

Fix or remove broken links (depending on whether I could find a
working version of the resource).

Change all links to use HTTPS instead of HTTP.

Unify the capitalizations (e.g. uppercase abbreviations, capitalize
proper names and downcase other words).

Fix or improve some parts of the text, clarifying what is meant.

Improve some parts of the program examples (e.g. only use root
privileges where really required).
2022-04-11 12:38:32 -05:00

2.5 KiB

A blocklist is third-party list of peer addresses to block. This can be used to block peers whose addresses are believed to belong to spyware or malware manufacturers.

What blocklist does Transmission use?

Transmission supports the P2P plaintext format, which is used by PeerGuardian, Bluetack, Vuze, ProtoWall, and KTorrent, and the DAT format, which was originally made popular by eMule.

The Transmission Project does not evaluate or endorse any specific blocklists. If you do not know what blocklist to use, you might read about some third-party blocklists and evaluate them on your own.

If "Enable automatic updates" is enabled, Transmission will periodically refresh its copy of your blocklist from the specified URL.

When you press the "Update Blocklist" button, Transmission will download a new copy of your blocklist.

Adding other blocklists

Transmission stores blocklists in a folder named blocklists in its configuration folder.

In that directory, files ending in ".bin" are blocklists that Transmission has parsed into a binary format suitable for quick lookups. When Transmission starts, it scans this directory for files not ending in ".bin" and tries to parse them. So to add another blocklist, all you have to do is put it in this directory and restart Transmission. Text and gzip formats are supported.

Using blocklists in transmission-daemon

transmission-daemon does not have an "update blocklist" button, so its users have two options. They can either copy blocklists from transmission-gtk's directory to transmission-daemon's directory, or they can download a blocklist by hand, uncompress it, and place it in the daemon's blocklists folder. In both cases, the daemon's settings.json file will need to be edited to set "blocklist-enabled" to "true".

In both cases the daemon is unaware of blocklist updates. Only when it starts it creates new .bin files.

There is a third option: add the blocklist URL in settings.json (only one blocklist is allowed), and use transmission-remote to tell the daemon to update it periodically.

settings.json snippet:

"blocklist-enabled": true,
"blocklist-url": "http://www.example.com/blocklist",

Manual update example:

$ transmission-remote -n admin:password --blocklist-update
localhost:9091/transmission/rpc/ responded: "success"