Changes between Version 161 and Version 162 of Faq

Timestamp:

06/15/2016 10:40:44 PM (8 years ago)

Author:

Cas

Comment:

reword and tidyup

Faq

@@ -21 +21 @@
 
 == How to start the various user-interfaces? ==
-
-=== GTK UI ===
-
-The main graphical interface. Can be started with either of the following:
-{{{
-deluge
-}}}
-{{{
-deluge-gtk
-}}}
-
-=== Console UI ===
-
-''Note: Requires the Deluge daemon, `deluged`, to be running.''
-
-The text-based interface, ideal for terminal use:
-{{{
-deluge-console
-}}}
-
-The console can be also run in a non-interactive mode which outputs to the terminal:
-{{{
-deluge-console "info [torrent]"
-}}}
-
-
-=== Web UI ===
-
-The web interface enables access to Deluge from your browser. There are two ways to enable this interface:
-
- 1. From the GTK UI you can enable the `WebUI` plugin
- 1. If running the Deluge daemon it is recommended to disable the plugin and run the standalone Web UI instead:
-
-{{{
-deluge-web
-}}}
-
-Open browser at `http://localhost:8112` and the default password is: `deluge`
+See [wiki:Faq#UserInterfaceSpecific UI specific questions]
 
 == How do I set Deluge as my default !BitTorrent program? ==
@@ -106 +69 @@
 
 = User Interface Specific =
+=== GTK UI ===
+=== How do I start the GTK UI? ===
+The main graphical interface. Can be started with either of the following:
+{{{
+deluge
+}}}
+{{{
+deluge-gtk
+}}}
+
+== Web UI ==
+=== How do I start the Web UI? ===
+The web interface enables access to Deluge from your browser. 
+
+There are two ways to enable this interface:
+
+ 1. From the GTK UI you can enable the `WebUI` plugin.
+ 1. If running the Deluge daemon `deluged` it is recommended not use the plugin and instead run the standalone Web UI:
+{{{
+deluge-web
+}}}
+
+Open browser at `http://localhost:8112` and the default password is: `deluge`
+
+=== What is the default password ===
+
+The Web UI default password  is `deluge`. 
+
+For security you should change this upon first login.
+
+=== How do I change the password? ===
+In the Web UI:
+ 1. Click on `Preferences`.
+ 1. Select the `Interface` category.
+ 1. Fill out the fields under `Password`.
+ 1. Click `Change` button.
+
+=== How can I reset the password? ===
+
+ 1. Stop the Web UI before modifying the `web.conf` file.
+ 2. Edit `web.conf` and delete the entire `pwd_sha1` line or use quick method via command-line e.g.:
+{{{
+sed -i.bak "/pwd_sha1/d" ~/.config/deluge/web.conf
+}}}
+ 3. Start the Web UI and the password will have been reset to default password `deluge`.
+
+=== How do I configure plugins with the Web UI? ===
+Not all plugins are configurable directly with the Web UI, see [Plugins] table. 
+
+The easiest way to configure the plugins is to use the GTK UI. If you cannot install the GTK UI on the machine with your daemon, it is possible to connect to that daemon from another computer with the GTK UI. See [wiki:UserGuide/ThinClient ThinClient] for more information on remote GTK UI.
+
+=== How do I auto-connect to a specific daemon? ===
+
+ 1. Stop the Web UI before modifying the `web.conf` file.
+ 1. Edit `web.conf`, find `"default_daemon"` and set its value to the daemon `id` in `hostlist.conf`[[br]]
+    e.g. To connect to localhost you would open `hostlist.conf` as see a snippet such as:
+{{{
+...
+      "123459d5a5b414159caa1323f6e0c9b240c7abcd",
+      "localhost",
+      58846,
+...
+}}}
+ 1. Use the first entry from hostlist, which is the `id` and add it to `web.conf`:
+{{{
+"default_daemon": "123459d5a5b414159caa1323f6e0c9b240c7abcd",
+}}}
+ 1. Restart the Web UI.
+
+=== How do I enable HTTPS? ===
+
+ 1. Create a (self-signed) SSL certificate: http://httpd.apache.org/docs/2.0/ssl/ssl_faq.html#selfcert
+ 1. Put the resulting `deluge.crt` and `deluge.key` in the [wiki:Faq#WheredoesDelugestoreitssettingsconfig config's] `ssl` directory.
+ 1. Enable HTTPS in Web UI config and modify the filepaths to match the above files.
+ 1. Restart the Web UI.
+
+=== Can I bind the Web UI to port 80 in Linux? ===
+You cannot bind to anything under 1024 in Linux, however with kernel >=2.6.24, you can use capabilities to allow Python to bind to port 80 securely.
+
+So for example in Debian or Ubuntu:
+ 1. `sudo apt-get install libcap2-bin`
+ 1. `sudo setcap 'cap_net_bind_service=+ep' /path/to/python`
+ 1. Configure the Web UI to use port `80`
+ 1. Restart the Web UI.
+
 == Console UI ==
 
+=== How do I start the Console UI? ===
+''Note: Requires the Deluge daemon `deluged` to be running.''
+
+The text-based interface, ideal for terminal use:
+{{{
+deluge-console
+}}}
+
+The console can be also run in a non-interactive mode which outputs to the terminal:
+{{{
+deluge-console "info [torrent]"
+}}}
 === How do I connect the console UI to a daemon on a non-default port? ===
 
@@ -169 +229 @@
 See above.
 
-== Web UI ==
-
-=== What is the default password ===
-
-The Web UI default password  is `deluge`. For security You should change this upon first login.
-
-=== How do I change the password? ===
-In the Web UI:
- 1. Click on "Preferences"
- 1. Select the "Interface" category
- 1. Fill out the fields under "Password"
- 1. Click "Change"
-
-=== How can I reset the password? ===
-
-'''Note:''' Stop the Web UI before you do any of the following.
-
-If you have forgotten the password, you can reset it by deleting web.conf from Deluge's config directory.
-
-'''Important:''' This will delete '''''all''''' of your Web UI settings.
-
-You can also reset it by using the following script (which does not delete your existing settings):
-
-{{{
-#!python
-#!/usr/bin/env python                                                                                                                                                                         
-# Changes the password for Deluge's Web UI
-
-from deluge.config import Config
-import hashlib
-import os.path
-import sys
-
-if len(sys.argv) == 2:
-    deluge_dir = os.path.expanduser(sys.argv[1])
-
-    if os.path.isdir(deluge_dir):
-        try:
-            config = Config("web.conf", config_dir=deluge_dir)
-        except IOError, e:
-            print "Can't open web ui config file: ", e
-        else:
-            password = raw_input("Enter new password: ")
-            s = hashlib.sha1()
-            s.update(config['pwd_salt'])
-            s.update(password)
-            config['pwd_sha1'] = s.hexdigest()
-            try:
-                config.save()
-            except IOError, e:
-                print "Couldn't save new password: ", e
-            else:
-                print "New password successfully set!"
-    else:
-        print "%s is not a directory!" % deluge_dir
-else:
-    print "Usage: %s <deluge config dir>" % (os.path.basename(sys.argv[0]))
-}}}
-
-=== How do I use HTTPS? ===
-
- 1. Create a (self-signed) SSL certificate: http://httpd.apache.org/docs/2.0/ssl/ssl_faq.html#selfcert
- 1. Put the resulting `deluge.crt` and `deluge.key` in the [wiki:Faq#WheredoesDelugestoreitssettingsconfig config's] `ssl` directory.
- 1. Enable HTTPS in Web UI config and modify the filepaths to match the above files.
- 1. Restart Web UI
-
-=== Can I bind the Web UI to port :80 in Linux? ===
-You cannot bind to anything under 1024 in Linux, however with kernel >=2.6.24, you can use capabilities to allow Python to bind to port 80 securely.
-
-So for example in Debian or Ubuntu:
- 1. sudo apt-get install libcap2-bin
- 1. sudo setcap 'cap_net_bind_service=+ep' /path/to/python
- 1. Configure the Web UI to use port 80
- 1. Restart `deluged` daemon.
-
-=== How do I configure plugins with the Web UI? ===
-Not all plugins are configurable directly with the Web UI, see [Plugins] table. The easiest way to configure the plugins is to use the GTK UI. If you cannot install the GTK UI on the machine with your daemon, it is possible to connect to that daemon from another computer with the GTK UI. See [wiki:UserGuide/ThinClient ThinClient] for more information on remote GTK UI.
-
-=== How do I auto-connect to a specific daemon? ===
-
- 1. Stop the Web UI.
- 1. Edit `web.conf`, find "default_daemon" and set its value to the daemon `id` in `hostlist.conf`[[br]]
-    e.g. To connect to localhost you would open `hostlist.conf` as see a snippet such as:
-{{{
-...
-      "123459d5a5b414159caa1323f6e0c9b240c7abcd",
-      "localhost",
-      58846,
-...
-}}}
- use the first entry, which is the `id` and add it to `web.conf`
-{{{
-"default_daemon": "123459d5a5b414159caa1323f6e0c9b240c7abcd",
-}}}
- 1. Restart the Web UI.
-
 = !BitTorrent Related=