Difference between revisions of "Transmission"

From ArchWiki
Jump to: navigation, search
(rearranged article. it should not be necessary to change the daemon user so I put that at the bottom of the article)
m (Installation: Added note about requiring transmission-cli for web-client)
(9 intermediate revisions by 6 users not shown)
Line 2: Line 2:
 
[[de:Transmission]]
 
[[de:Transmission]]
 
[[it:Transmission]]
 
[[it:Transmission]]
 
+
[[zh-CN:Transmission]]
 
[http://www.transmissionbt.com/ Transmission] is a light-weight and cross-platform BitTorrent client. It is the default BitTorrent client in many Linux distributions.
 
[http://www.transmissionbt.com/ Transmission] is a light-weight and cross-platform BitTorrent client. It is the default BitTorrent client in many Linux distributions.
  
==Installation==
+
== Installation ==
There are several options in [[Official Repositories]]:
+
  
;{{pkg|transmission-cli}}: includes CLI tools, daemon and web client.
+
There are several options in [[official repositories]]:
  
;{{pkg|transmission-gtk}}: GTK+ GUI.
+
* {{Pkg|transmission-cli}} - includes CLI tools, daemon and web client
  
;{{pkg|transmission-qt}}: Qt GUI.
+
* {{Pkg|transmission-gtk}} - GTK+ GUI
  
==Configuration==
+
* {{Pkg|transmission-qt}} - Qt GUI
For {{pkg|transmission-gtk}} and {{pkg|transmission-qt}}, the default path of configuration files is {{ic|~/.config/transmission}}.
+
  
For {{pkg|transmission-cli}}, default configuration path is {{ic|~/.config/transmission-daemon}}.
+
If you install {{Pkg|transmission-gtk}} or {{Pkg|transmission-qt}} and you want to use the remote web client then you must also install {{Pkg|transmission-cli}} as that is where the {{ic|/usr/share/transmission/web/}} files are packaged.
  
===Run as a daemon===
+
== Configuration ==
To run transmission as a [[daemon]], you need have {{pkg|transmission-cli}} installed. The systemd daemon is called ''transmission''.
+
  
Navigate to http://127.0.0.1:9091 in web browser and you can see the web client.
+
For transmission-gtk and transmission-qt, the default path of configuration files is {{ic|~/.config/transmission}}.
  
You can also edit the main configuration file {{ic|~/.config/transmission-daemon/settings.json}} to fit your preference. By default, the daemon will run as the user {{ic|transmission}}, whose home directory is {{ic|/var/lib/transmission/}}. This means the default location for the configuration file is {{ic|/var/lib/transmission/.config/transmission-daemon/settings.json}}.
+
For transmission-cli, default configuration path is {{ic|~/.config/transmission-daemon}}.
  
{{Note|
+
=== Run as a daemon ===
*If you cannot find the {{ic|~/.config/transmission-daemon}} folder, run {{ic|transmission-daemon}} once to create it.
+
*'''You need to stop the daemon''' before editing configuration files, or your edits '''will not be saved'''.}}
+
  
If you change your download location, make sure the ''transmission'' user has rw privileges to your download directory.
+
Start the {{ic|transmission}} daemon [[systemd#Using units|using systemd]].
  
====Changing daemon user====
+
Navigate to http://localhost:9091/ in your web browser to see the web client.
  
If you use systemd, you have to override the user in both the service file ({{ic|/usr/lib/systemd/system/transmission.service}}) and the tmpfile ({{ic|/usr/lib/tmpfiles.d/transmission.conf}}). To do so, copy both files to the appropriate directory in {{ic|/etc}}:
+
You can edit the main configuration file {{ic|~/.config/transmission-daemon/settings.json}} to fit your preference. '''You need to stop the daemon''' before editing configuration files, or your edits '''will not be saved'''.
# cp /usr/lib/systemd/system/transmission.service /etc/systemd/system/
+
By default, the daemon will run as the user ''transmission'', whose home directory is {{ic|/var/lib/transmission/}}. This means the default location for the configuration file is {{ic|/var/lib/transmission/.config/transmission-daemon/settings.json}}.
# cp /usr/lib/tmpfiles.d/transmission.conf /etc/tmpfiles.d/
+
  
Create a new group named for example, {{ic|transmission}}:
+
{{Note|If you cannot find the {{ic|~/.config/transmission-daemon}} folder, run {{ic|transmission-daemon}} once to create it.}}
# groupadd transmission
+
  
Add your custom user to the newly created {{ic|1=[group]}} ie. {{ic|transmission}}:
+
If you change your download location, make sure the ''transmission'' user has read/write privileges to your download directory.
# gpasswd -a [user] [group]
+
  
Then change {{ic|1=User=}} to your custom user in the service file and edit the tmpfile to the following:
+
==== Changing daemon user ====
{{hc|/etc/tmpfiles.d/transmission.conf|
+
To change the user the daemon is running as, simply override {{ic|1=User=}} in the service file with a drop-in config (see [[systemd#Editing provided unit files]]):
d /run/transmission - [user] [group] -}}
+
{{hc|/etc/systemd/system/transmission.service.d/user.conf|2=<nowiki>
Then run {{ic|systemd-tmpfiles --create transmission.conf}} and restart the transmission service.
+
[Service]
 
+
User=<custom user></nowiki>}}
You may need to reload service files after editing:
+
Then run the following to reload the service file:
 
  # systemctl daemon-reload
 
  # systemctl daemon-reload
 +
When the daemon is started, it will create its settings in {{ic|~/.config/transmission-daemon/}}.
  
Don't forget to change permissions to '''777''' on folder '/run/transmission'.
+
== See also ==
 
+
If you would use Transmission daemon with its own group, you have to give the writing permission to transmission group in your download's directory. For this you need to run:
+
# chgrp transmission /path/to/download
+
# chmod g+w /path/to/download
+
  
==See also==
 
 
*[https://trac.transmissionbt.com/wiki Transmission wiki]
 
*[https://trac.transmissionbt.com/wiki Transmission wiki]
 
*[https://trac.transmissionbt.com/wiki/HeadlessUsage/General HeadlessUsage]
 
*[https://trac.transmissionbt.com/wiki/HeadlessUsage/General HeadlessUsage]

Revision as of 23:42, 18 November 2013

Transmission is a light-weight and cross-platform BitTorrent client. It is the default BitTorrent client in many Linux distributions.

Installation

There are several options in official repositories:

If you install transmission-gtk or transmission-qt and you want to use the remote web client then you must also install transmission-cli as that is where the /usr/share/transmission/web/ files are packaged.

Configuration

For transmission-gtk and transmission-qt, the default path of configuration files is ~/.config/transmission.

For transmission-cli, default configuration path is ~/.config/transmission-daemon.

Run as a daemon

Start the transmission daemon using systemd.

Navigate to http://localhost:9091/ in your web browser to see the web client.

You can edit the main configuration file ~/.config/transmission-daemon/settings.json to fit your preference. You need to stop the daemon before editing configuration files, or your edits will not be saved. By default, the daemon will run as the user transmission, whose home directory is /var/lib/transmission/. This means the default location for the configuration file is /var/lib/transmission/.config/transmission-daemon/settings.json.

Note: If you cannot find the ~/.config/transmission-daemon folder, run transmission-daemon once to create it.

If you change your download location, make sure the transmission user has read/write privileges to your download directory.

Changing daemon user

To change the user the daemon is running as, simply override User= in the service file with a drop-in config (see systemd#Editing provided unit files):

/etc/systemd/system/transmission.service.d/user.conf
[Service]
User=<custom user>

Then run the following to reload the service file:

# systemctl daemon-reload

When the daemon is started, it will create its settings in ~/.config/transmission-daemon/.

See also