Setting up Transmission (bittorrent) with Clutch WebUI - Revision history

Bbbhltz: formatting and typos

2023-05-26T20:31:15Z

formatting and typos

← Older revision		Revision as of 20:31, 26 May 2023
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

	This document will show you how you can setup Transmission BitTorrent client on Alpine Linux and control it with a nice HTTP web-interface. ~~I assume~~ that you know the basics ~~about~~ Alpine Linux (package management and internals) and you have enough storage available ~~to store~~ your downloaded media (ie USB hard-drive) and of course a working internet connection.		This document will show you how you can setup [https://transmissionbt.com/ Transmission BitTorrent] client on Alpine Linux and control it with a nice HTTP web-interface. It is assumed that you know the basics of Alpine Linux (package management and internals) and you have enough storage available for your downloaded media (i.e. USB hard drive) and, of course, a working internet connection.

	== Setting up Transmission ==		== Setting up Transmission ==
Line 7:		Line 7:
	Lets install it:		Lets install it:

	{{Cmd\|apk add transmission-daemon}}		{{Cmd\|# apk add {{Pkg\|transmission-daemon}}}}

	This should install Transmission ~~3.0.0~~. After the installation is complete you should have default configuration file for init in:		This should install latest available version of Transmission (available on Alpine). After the installation is complete you should have default configuration file for init in {{Path\|/etc/conf.d/transmission-daemon}}.

	~~/etc/conf~~.d/transmission-daemon		By default, Transmission will run as the user '''transmission'''. If you need to make changes, do so, and save them. You can restart <code>transmission-daemon</code> and see if all is working as desired:

	~~By default, transmission will run as the user "transmission". If you need to make changes, do so, and save them. You can restart~~ transmission-daemon ~~and see if all is working ok:~~		{{Cmd\|# rc-service transmission-daemon restart}}

	{{~~Cmd~~\|~~rc-service~~ transmission~~-daemon restart~~}}		To configure the transmission settings (including the download location), edit the configuration file here: {{Path\|/var/lib/transmission/config/settings.json}}

	~~To configure the~~ transmission ~~settings (including the download location), edit~~ the ~~configuration file~~:		If everything is working, you should see <code>transmission-daemon</code> running with the following command:

	~~/var/lib/transmission/config/settings.json~~		{{Cmd\|$ ps}}

	If ~~everything is OK~~ you ~~should see~~ transmission~~-daemon running with the following command:~~		If you change the download location in the settings, remember to transfer ownership to the '''transmission''' user and group.

	{{Cmd\|ps}}		{{Cmd\|# chown -R transmission:transmission <DOWNLOAD_FOLDER>}}

	~~If you change~~ the ~~download location in~~ the ~~settings, remember~~ to ~~transfer ownership~~ to the transmission ~~user and~~ group.		It may also be convenient for the '''root''' user to be able to access the files when administering the server. An easy way to do this is to add the root user to the '''transmission''' group:

	{{Cmd\|~~chown -R~~ transmission~~:transmission <DOWNLOAD_FODLER>~~}}		{{Cmd\|# addgroup root transmission}}

	~~It may also be convienent for the "root" user to be able to access the files when administering the server. An easy way to do this is to~~ add ~~the root user~~ to ~~the transmission group~~:		Let's add <code>transmission</code> to our system start:

	{{Cmd\|~~addgroup root~~ transmission}}		{{Cmd\|# rc-update add transmission-daemon}}

	~~Lets add transmission to our system start:~~		The transmission web GUI will run on <code>http://<IP_ADDRESS>:9091/transmission</code>

	~~{{Cmd\|rc-update add transmission-daemon}}~~

	The transmission web GUI will run on http://<IP_ADDRESS>:9091/transmission

	== Saving your changes to disk ==		== Saving your changes to disk ==

	Now is a good time to write ~~you~~ changes to disk:		Now is a good time to write your changes to disk:

	{{Cmd\|lbu_commit device}}		{{Cmd\|# lbu_commit device}}

	[[Category:Server]]		[[Category:Server]]

Jdusablon: Corrected install package name

2023-05-25T19:51:57Z

Corrected install package name

← Older revision		Revision as of 19:51, 25 May 2023
Line 7:		Line 7:
	Lets install it:		Lets install it:

	{{Cmd\|apk add transmission}}		{{Cmd\|apk add transmission-daemon}}

	This should install Transmission 3.0.0. After the installation is complete you should have default configuration file for init in:		This should install Transmission 3.0.0. After the installation is complete you should have default configuration file for init in:

Mkem114: Update the guide for Alpine 3 and Transmission 3

2022-08-15T15:02:03Z

Update the guide for Alpine 3 and Transmission 3

Show changes

Zcrayfish: Removed hyperlinks to hypothetical URLs.

2021-12-20T19:16:00Z

Removed hyperlinks to hypothetical URLs.

← Older revision		Revision as of 19:16, 20 December 2021
Line 36:		Line 36:
	Fire up your prefered browser and point it to:		Fire up your prefered browser and point it to:

	http://ipaddress/		<nowiki>http://ipaddress/</nowiki>

	This should give a 404 document not found error. If not something went wrong... A good way of knowing if PHP is functioning properly is by creating a test page which includes the phpinfo() function. We do this like this:		This should give a 404 document not found error. If not something went wrong... A good way of knowing if PHP is functioning properly is by creating a test page which includes the phpinfo() function. We do this like this:
Line 44:		Line 44:
	Now change the address in your browser to:		Now change the address in your browser to:

	http://ipaddress/test.php		<nowiki>http://ipaddress/test.php</nowiki>

	This should display a page which tells you everything regarding your PHP installation. If all is ok we can add lighttpd to the system start:		This should display a page which tells you everything regarding your PHP installation. If all is ok we can add lighttpd to the system start:
Line 105:		Line 105:
	Now it's time to see if our Clutch WebUI can find Transmission:		Now it's time to see if our Clutch WebUI can find Transmission:

	http://ipaddress/clutch		<nowiki>http://ipaddress/clutch</nowiki>

	If everything is setup correctly it should return an error. This is because the default download directory is not setup correctly. In the left bottom corner of Clutch you will see a config button which will open the configuration window. Adjust your configuration and make sure you select a directory which is owned by the same user as transmission-daemon is running. After you save your settings you should have a working Clutch installation.		If everything is setup correctly it should return an error. This is because the default download directory is not setup correctly. In the left bottom corner of Clutch you will see a config button which will open the configuration window. Adjust your configuration and make sure you select a directory which is owned by the same user as transmission-daemon is running. After you save your settings you should have a working Clutch installation.

Dubiousjim: Category:Server

2012-03-24T16:57:02Z

Category:Server

← Older revision		Revision as of 16:57, 24 March 2012
Line 1:		Line 1:
	~~[[Category:Networking]]~~
	== Introduction ==		== Introduction ==

Line 115:		Line 114:

	{{Cmd\|lbu_commit device}}		{{Cmd\|lbu_commit device}}

			[[Category:Server]]

Fab: /* Setting up Clutch WebUI */

2011-07-01T16:33:25Z

Setting up Clutch WebUI

← Older revision		Revision as of 16:33, 1 July 2011
Line 100:		Line 100:
	Clutch uses an configuration file which we can manage from the interface. The configuration file is stored outside our /etc directory so we will have to add it also with lbu add and we need to setup the proper permissions to the directory where its stored so clutch is able to write to it:		Clutch uses an configuration file which we can manage from the interface. The configuration file is stored outside our /etc directory so we will have to add it also with lbu add and we need to setup the proper permissions to the directory where its stored so clutch is able to write to it:

	{{Cmd\|chown lighttpd:lighttpd /usr/share/webapps/clutch/0.4/htdocs/remote/data}		{{Cmd\|chown lighttpd:lighttpd /usr/share/webapps/clutch/0.4/htdocs/remote/data}}

	{{Cmd\|lbu add /usr/share/webapps/clutch/0.4/htdocs/remote/data}}		{{Cmd\|lbu add /usr/share/webapps/clutch/0.4/htdocs/remote/data}}

Fab: /* Saving your changes to disk */

2011-06-15T10:44:44Z

Saving your changes to disk

← Older revision		Revision as of 10:44, 15 June 2011
Line 114:		Line 114:
	Now is a good time to write you changes to disk:		Now is a good time to write you changes to disk:

			{{Cmd\|lbu_commit device}}
	''lbu_commit device''

Fab: /* Setting up Clutch WebUI */

2011-06-15T10:44:29Z

Setting up Clutch WebUI

← Older revision		Revision as of 10:44, 15 June 2011
Line 83:		Line 83:
	The last step is to install our web-interface. We do this by running:		The last step is to install our web-interface. We do this by running:

			{{Cmd\|apk_add clutch}}
	''apk_add clutch''


	After the installation completes it should be located in:		After the installation completes it should be located in:

			/usr/share/webapps/clutch/0.4
	/usr/share/webapps/clutch/0.4


	To make it available for lighttpd we need to make a symlink in the docroot of lighttpd:		To make it available for lighttpd we need to make a symlink in the docroot of lighttpd:

			{{Cmd\|ln -s /usr/share/webapps/clutch/0.4/htdocs /var/www/localhost/htdocs/clutch}}
	''ln -s /usr/share/webapps/clutch/0.4/htdocs /var/www/localhost/htdocs/clutch''


	Because we are adding a file outside /etc we need to add it with lbu add:		Because we are adding a file outside /etc we need to add it with lbu add:

			{{Cmd\|lbu add /var/www/localhost/htdocs/clutch}}
	''lbu add /var/www/localhost/htdocs/clutch''


	Clutch uses an configuration file which we can manage from the interface. The configuration file is stored outside our /etc directory so we will have to add it also with lbu add and we need to setup the proper permissions to the directory where its stored so clutch is able to write to it:		Clutch uses an configuration file which we can manage from the interface. The configuration file is stored outside our /etc directory so we will have to add it also with lbu add and we need to setup the proper permissions to the directory where its stored so clutch is able to write to it:

			{{Cmd\|chown lighttpd:lighttpd /usr/share/webapps/clutch/0.4/htdocs/remote/data}

	~~''chown lighttpd:lighttpd /usr/share/webapps/clutch/0.4/htdocs/remote/data''~~		{{Cmd\|lbu add /usr/share/webapps/clutch/0.4/htdocs/remote/data}}

	''lbu add /usr/share/webapps/clutch/0.4/htdocs/remote/data''


	Now it's time to see if our Clutch WebUI can find Transmission:		Now it's time to see if our Clutch WebUI can find Transmission:


	http://ipaddress/clutch		http://ipaddress/clutch


	If everything is setup correctly it should return an error. This is because the default download directory is not setup correctly. In the left bottom corner of Clutch you will see a config button which will open the configuration window. Adjust your configuration and make sure you select a directory which is owned by the same user as transmission-daemon is running. After you save your settings you should have a working Clutch installation.		If everything is setup correctly it should return an error. This is because the default download directory is not setup correctly. In the left bottom corner of Clutch you will see a config button which will open the configuration window. Adjust your configuration and make sure you select a directory which is owned by the same user as transmission-daemon is running. After you save your settings you should have a working Clutch installation.

Fab: /* Setting up Transmission */

2011-06-15T10:43:31Z

Setting up Transmission

← Older revision		Revision as of 10:43, 15 June 2011
Line 55:		Line 55:
	As of Alpine 1.7.18 it includes Transmission BitTorrent client. Lets install it:		As of Alpine 1.7.18 it includes Transmission BitTorrent client. Lets install it:

			{{Cmd\|apk_add transmission}}
	''apk_add transmission''


	This should install Transmission 1.20 which is included in Alpine 1.7.18. After the installation is complete you should have default configuration file for init in:		This should install Transmission 1.20 which is included in Alpine 1.7.18. After the installation is complete you should have default configuration file for init in:

			/etc/conf.d/transmission-daemon
	/etc/conf.d/transmission-daemon


	We need to make some changes to this file. Because transmission-daemon will be controlled via Clutch which is run by lighttpd we need to change the user/group transmission-daemon runs at. We also need to change the DATA directory because we do not want to loose transmissions runtime info after a reboot (if it does it will need to recheck the hash of each running torrent). Personally I have mounted my USB disk to /media/usb and created a subdirectory torrents. This will be the directory where my media will be saved to. Inside this directory I created a .config directory. This is my DATA dir where transmission holds its runtime data. Make sure the torrents directory and everything below it is owned by lighttpd:lighttpd or else transmission cannot save any media. The contents of my conf.d file is like this:		We need to make some changes to this file. Because transmission-daemon will be controlled via Clutch which is run by lighttpd we need to change the user/group transmission-daemon runs at. We also need to change the DATA directory because we do not want to loose transmissions runtime info after a reboot (if it does it will need to recheck the hash of each running torrent). Personally I have mounted my USB disk to /media/usb and created a subdirectory torrents. This will be the directory where my media will be saved to. Inside this directory I created a .config directory. This is my DATA dir where transmission holds its runtime data. Make sure the torrents directory and everything below it is owned by lighttpd:lighttpd or else transmission cannot save any media. The contents of my conf.d file is like this:
Line 73:		Line 69:
	If you need another DATA_DIR change it and save it. If you are sure that all permissions are setup correctly you can start transmission-daemon and see if all is working ok:		If you need another DATA_DIR change it and save it. If you are sure that all permissions are setup correctly you can start transmission-daemon and see if all is working ok:

			{{Cmd\|/etc/init.d/transmission-daemon start}}
	''/etc/init.d/transmission-daemon start''


	If everything is OK you should see transmission-daemon running with the following command:		If everything is OK you should see transmission-daemon running with the following command:

			{{Cmd\|ps}}
	''ps''


	Lets add it to our system start:		Lets add it to our system start:

			{{Cmd\|rc_add -k transmission-daemon}}
	''rc_add -k transmission-daemon''


	== Setting up Clutch WebUI ==		== Setting up Clutch WebUI ==

Fab: /* Setting up Lighttpd with PHP support */

2011-06-15T10:42:18Z

Setting up Lighttpd with PHP support

← Older revision		Revision as of 10:42, 15 June 2011
Line 8:		Line 8:
	The first thing we need to setup is lighttpd. We need lighttpd because our web-interface (Clutch) depends on PHP and the default webserver in Alpine Linux (mini_httpd) does not support it. Lets install it:		The first thing we need to setup is lighttpd. We need lighttpd because our web-interface (Clutch) depends on PHP and the default webserver in Alpine Linux (mini_httpd) does not support it. Lets install it:

			{{Cmd\|apk_add lighttpd php}}
	''apk_add lighttpd php''


	'''NOTE:''' When you install PHP you will see it has some dependencies. PHP isn't a light package so please consider this before you install it.		'''NOTE:''' When you install PHP you will see it has some dependencies. PHP isn't a light package so please consider this before you install it.


	When the installation is finished we need to add PHP support to lighttpd. There are two ways of adding PHP support to lighttpd:		When the installation is finished we need to add PHP support to lighttpd. There are two ways of adding PHP support to lighttpd:
Line 22:		Line 19:
	If you need a high performance HTTP server with PHP support, you should probably go for the second option but if you need PHP only for some administrative tasks like controlling Clutch, CGI mode should be enough. FastCGI keeps PHP running in the background waiting for lighttpd to talk to it This makes it fast and more responsive than normal CGI mode. I choose normal CGI because I have a small embedded system and I prefer to use my memory for other things. Lets add PHP CGI support by creating the following file:		If you need a high performance HTTP server with PHP support, you should probably go for the second option but if you need PHP only for some administrative tasks like controlling Clutch, CGI mode should be enough. FastCGI keeps PHP running in the background waiting for lighttpd to talk to it This makes it fast and more responsive than normal CGI mode. I choose normal CGI because I have a small embedded system and I prefer to use my memory for other things. Lets add PHP CGI support by creating the following file:

			{{Cmd\|vi /etc/lighttpd/mod_cgi_php.conf}}
	''vi /etc/lighttpd/mod_cgi_php.conf''


	And add the following to it and save it:		And add the following to it and save it:
Line 38:		Line 33:
	Our Lighttpd with PHP support should be complete. Lets start lighttpd and see if it works (make sure no other service is running on port 80).		Our Lighttpd with PHP support should be complete. Lets start lighttpd and see if it works (make sure no other service is running on port 80).

			{{Cmd\|/etc/init.d/lighttpd start}}
	''/etc/init.d/lighttpd start''


	Fire up your prefered browser and point it to:		Fire up your prefered browser and point it to:


	http://ipaddress/		http://ipaddress/


	This should give a 404 document not found error. If not something went wrong... A good way of knowing if PHP is functioning properly is by creating a test page which includes the phpinfo() function. We do this like this:		This should give a 404 document not found error. If not something went wrong... A good way of knowing if PHP is functioning properly is by creating a test page which includes the phpinfo() function. We do this like this:

			{{Cmd\|echo "<? phpinfo(); ?>" > /var/www/localhost/htdocs/test.php}}
	''echo "<? phpinfo(); ?>" > /var/www/localhost/htdocs/test.php''


	Now change the address in your browser to:		Now change the address in your browser to:


	http://ipaddress/test.php		http://ipaddress/test.php


	This should display a page which tells you everything regarding your PHP installation. If all is ok we can add lighttpd to the system start:		This should display a page which tells you everything regarding your PHP installation. If all is ok we can add lighttpd to the system start:

			{{Cmd\|rc_add -k lighttpd}}
	''rc_add -k lighttpd''

	== Setting up Transmission ==		== Setting up Transmission ==