Context Navigation

Upstart

Timestamp:: 02/11/2013 02:30:44 PM (11 years ago)
Author:: Cas
Comment:: add comments & description to job scripts and reword sections

Legend:

: Unmodified
: Added
: Removed
: Modified

UserGuide/Service/Upstart

-                      v13
+                      v14
 {{{
 # sudo adduser --system --group --home /var/lib/deluge deluge
+sudo adduser --system --group --home /var/lib/deluge deluge
 }}}
 …
 {{{
 # sudo adduser <username> deluge
+sudo adduser <username> deluge
 }}}
 == Deluge Daemon (deluged) Upstart Script ==
+== Deluge Daemon (deluged) Job ==
 Create the file `/etc/init/deluged.conf` with the following code and set uid and gid to the user and group you wish to run `deluged` as:
+Create the file `/etc/init/deluged.conf` with the following code and set `uid` and `gid` to the user and group you wish to run `deluged` as:
 {{{
+# deluged - Deluge daemon
+#
+# The daemon component of Deluge BitTorrent client. Deluge UI clients
+# connect to this daemon via DelugeRPC protocol.
+description "Deluge daemon"
+author "Deluge Team"
 start on filesystem and stopped networking
 stop on runlevel [016]
 …
  Refer to [http://en.wikipedia.org/wiki/Umask#Octal_umasks Wikipedia] for details of possible values and their effects. Deluged must be stopped and started instead of just restarted after changes. If you enable logging, as described later in this page, the umasks specified here also affect the permissions of newly created logs.
 == Deluge Web UI (deluge-web) Upstart Script ==
+== Deluge Web UI (deluge-web) Job ==
 '''Put this in /etc/init/deluge-web.conf, remember to set uid and gid to your preference:'''
+Create the file `/etc/init/deluge-web.conf` with the following code and set `uid` and `gid` as required:'''
 {{{
+# deluge-web - Deluge Web UI
+#
+# The Web UI component of Deluge BitTorrent client, connects to deluged and
+# provides a web application interface for users. Default url: http://localhost:8112
+description "Deluge Web UI"
+author "Deluge Team"
 start on started deluged
 stop on stopping deluged
 …
 exec start-stop-daemon -S -c $uid:$gid -k $umask -x /usr/bin/deluge-web
 }}}
  * Note: The use of a umask with deluge-web is believed to only affect the permissions of plugin scripts installed through the web UI and, if you enable logging, deluge-web logs.
+  * 027 grants full access to the user deluge is running as, read access to members of the group that deluge is running as and prevents access from all other accounts.[[br]]Group permission was restricted to read only in order to prevent the possibility that compromised member accounts could inject malicious code in to plugins or modify the log.
+ ''umask `027` grants full access to `uid`, read access to `gid` and prevents access from all other accounts. This should only affect the permissions of plugins installed through the Web UI and, if enabled, logs. Group permissions are restricted to read-only to prevent compromised member accounts injecting malicious code into plugins or modifying the logs.''
 == Migration from init.d script ==
 If you followed the old guide to make an init script, remove it:
+If you followed the old guide to create an init script you need to remove them:
 {{{
 # sudo /etc/init.d/deluge-daemon stop
 # sudo rm /etc/init.d/deluge-daemon
 # sudo update-rc.d deluge-daemon remove
+sudo /etc/init.d/deluge-daemon stop
+sudo rm /etc/init.d/deluge-daemon
+sudo update-rc.d deluge-daemon remove
 }}}
 …
 === Deluge Daemon ===
 {{{
+# sudo start deluged
+and stopping:
+# sudo stop deluged
+sudo start deluged
+}}}
+{{{
+sudo stop deluged
 }}}
 …
 Although the Web UI will start/stop automatically when deluged starts/stops it can be manually controlled with:
 {{{
+# sudo start deluge-web
+and stopped with:
+# sudo stop deluge-web
+sudo start deluge-web
 }}}
+ * To prevent the web UI starting automatically comment out the `start on` line in `deluge-web.conf` by prefixing with `#`.
+{{{
+sudo stop deluge-web
+}}}
+''Note: To prevent the web UI starting automatically comment out (# prefix) the '`start on`' line in `deluge-web.conf`.''
 == Logging ==
 Create a structure for Deluge to log to and give the user that Deluge is running as (in this case deluge) full access to that directory:
+Create a structure for Deluge to log to and give the user that Deluge is running as (in this case `deluge`) full access to that directory:
 {{{
 # sudo mkdir -p /var/log/deluge
 # sudo chown -R deluge:deluge /var/log/deluge
 # sudo chmod -R 750 /var/log/deluge
+sudo mkdir -p /var/log/deluge
+sudo chown -R deluge:deluge /var/log/deluge
+sudo chmod -R 750 /var/log/deluge
 }}}
+ * Note: The previous commands affect the log directory and all files within it.[[br]]However, as already mentioned, the umask specified in the upstart jobs at the top of this page affect the permissions new logs are created with.
+  * 750 grants full access to the deluge user, only recurse tree and read access to members of the deluge group and prevents access from all other accounts.[[br]]Refer to [http://en.wikipedia.org/wiki/Chmod#Octal_numbers Wikipedia ] for details of possible values and their effects.
+ * Note: The above commands affect the log directory and all files within it, combined with the umask specified in the upstart jobs these affect the permissions new logs are created with.
+  * 750 grants full access to the deluge user, only recurse tree and read access to members of the deluge group and prevents access from all other accounts. [http://en.wikipedia.org/wiki/Chmod#Octal_numbers Chmod]
 Edit the upstart job confs like so:
 {{{
 …
 Restart the daemon:
 {{{
 # sudo restart deluge
+sudo restart deluge
 }}}
 Tell logrotate to rotate the logs by putting this in /etc/logrotate.d/deluge:
+Create `/etc/logrotate.d/deluge` with the following code to rotate the logs:
 {{{
 /var/log/deluge/*.log {