Changes between Version 161 and Version 162 of Faq


Ignore:
Timestamp:
06/15/2016 10:40:44 PM (5 years ago)
Author:
Cas
Comment:

reword and tidyup

Legend:

Unmodified
Added
Removed
Modified
  • Faq

    v161 v162  
    2121 
    2222== How to start the various user-interfaces? == 
    23  
    24 === GTK UI === 
    25  
    26 The main graphical interface. Can be started with either of the following: 
    27 {{{ 
    28 deluge 
    29 }}} 
    30 {{{ 
    31 deluge-gtk 
    32 }}} 
    33  
    34 === Console UI === 
    35  
    36 ''Note: Requires the Deluge daemon, `deluged`, to be running.'' 
    37  
    38 The text-based interface, ideal for terminal use: 
    39 {{{ 
    40 deluge-console 
    41 }}} 
    42  
    43 The console can be also run in a non-interactive mode which outputs to the terminal: 
    44 {{{ 
    45 deluge-console "info [torrent]" 
    46 }}} 
    47  
    48  
    49 === Web UI === 
    50  
    51 The web interface enables access to Deluge from your browser. There are two ways to enable this interface: 
    52  
    53  1. From the GTK UI you can enable the `WebUI` plugin 
    54  1. If running the Deluge daemon it is recommended to disable the plugin and run the standalone Web UI instead: 
    55  
    56 {{{ 
    57 deluge-web 
    58 }}} 
    59  
    60 Open browser at `http://localhost:8112` and the default password is: `deluge` 
     23See [wiki:Faq#UserInterfaceSpecific UI specific questions] 
    6124 
    6225== How do I set Deluge as my default !BitTorrent program? == 
     
    10669 
    10770= User Interface Specific = 
     71=== GTK UI === 
     72=== How do I start the GTK UI? === 
     73The main graphical interface. Can be started with either of the following: 
     74{{{ 
     75deluge 
     76}}} 
     77{{{ 
     78deluge-gtk 
     79}}} 
     80 
     81== Web UI == 
     82=== How do I start the Web UI? === 
     83The web interface enables access to Deluge from your browser.  
     84 
     85There are two ways to enable this interface: 
     86 
     87 1. From the GTK UI you can enable the `WebUI` plugin. 
     88 1. If running the Deluge daemon `deluged` it is recommended not use the plugin and instead run the standalone Web UI: 
     89{{{ 
     90deluge-web 
     91}}} 
     92 
     93Open browser at `http://localhost:8112` and the default password is: `deluge` 
     94 
     95=== What is the default password === 
     96 
     97The Web UI default password  is `deluge`.  
     98 
     99For security you should change this upon first login. 
     100 
     101=== How do I change the password? === 
     102In the Web UI: 
     103 1. Click on `Preferences`. 
     104 1. Select the `Interface` category. 
     105 1. Fill out the fields under `Password`. 
     106 1. Click `Change` button. 
     107 
     108=== How can I reset the password? === 
     109 
     110 1. Stop the Web UI before modifying the `web.conf` file. 
     111 2. Edit `web.conf` and delete the entire `pwd_sha1` line or use quick method via command-line e.g.: 
     112{{{ 
     113sed -i.bak "/pwd_sha1/d" ~/.config/deluge/web.conf 
     114}}} 
     115 3. Start the Web UI and the password will have been reset to default password `deluge`. 
     116 
     117=== How do I configure plugins with the Web UI? === 
     118Not all plugins are configurable directly with the Web UI, see [Plugins] table.  
     119 
     120The 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. 
     121 
     122=== How do I auto-connect to a specific daemon? === 
     123 
     124 1. Stop the Web UI before modifying the `web.conf` file. 
     125 1. Edit `web.conf`, find `"default_daemon"` and set its value to the daemon `id` in `hostlist.conf`[[br]] 
     126    e.g. To connect to localhost you would open `hostlist.conf` as see a snippet such as: 
     127{{{ 
     128... 
     129      "123459d5a5b414159caa1323f6e0c9b240c7abcd", 
     130      "localhost", 
     131      58846, 
     132... 
     133}}} 
     134 1. Use the first entry from hostlist, which is the `id` and add it to `web.conf`: 
     135{{{ 
     136"default_daemon": "123459d5a5b414159caa1323f6e0c9b240c7abcd", 
     137}}} 
     138 1. Restart the Web UI. 
     139 
     140=== How do I enable HTTPS? === 
     141 
     142 1. Create a (self-signed) SSL certificate: http://httpd.apache.org/docs/2.0/ssl/ssl_faq.html#selfcert 
     143 1. Put the resulting `deluge.crt` and `deluge.key` in the [wiki:Faq#WheredoesDelugestoreitssettingsconfig config's] `ssl` directory. 
     144 1. Enable HTTPS in Web UI config and modify the filepaths to match the above files. 
     145 1. Restart the Web UI. 
     146 
     147=== Can I bind the Web UI to port 80 in Linux? === 
     148You 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. 
     149 
     150So for example in Debian or Ubuntu: 
     151 1. `sudo apt-get install libcap2-bin` 
     152 1. `sudo setcap 'cap_net_bind_service=+ep' /path/to/python` 
     153 1. Configure the Web UI to use port `80` 
     154 1. Restart the Web UI. 
     155 
    108156== Console UI == 
    109157 
     158=== How do I start the Console UI? === 
     159''Note: Requires the Deluge daemon `deluged` to be running.'' 
     160 
     161The text-based interface, ideal for terminal use: 
     162{{{ 
     163deluge-console 
     164}}} 
     165 
     166The console can be also run in a non-interactive mode which outputs to the terminal: 
     167{{{ 
     168deluge-console "info [torrent]" 
     169}}} 
    110170=== How do I connect the console UI to a daemon on a non-default port? === 
    111171 
     
    169229See above. 
    170230 
    171 == Web UI == 
    172  
    173 === What is the default password === 
    174  
    175 The Web UI default password  is `deluge`. For security You should change this upon first login. 
    176  
    177 === How do I change the password? === 
    178 In the Web UI: 
    179  1. Click on "Preferences" 
    180  1. Select the "Interface" category 
    181  1. Fill out the fields under "Password" 
    182  1. Click "Change" 
    183  
    184 === How can I reset the password? === 
    185  
    186 '''Note:''' Stop the Web UI before you do any of the following. 
    187  
    188 If you have forgotten the password, you can reset it by deleting web.conf from Deluge's config directory. 
    189  
    190 '''Important:''' This will delete '''''all''''' of your Web UI settings. 
    191  
    192 You can also reset it by using the following script (which does not delete your existing settings): 
    193  
    194 {{{ 
    195 #!python 
    196 #!/usr/bin/env python                                                                                                                                                                          
    197 # Changes the password for Deluge's Web UI 
    198  
    199 from deluge.config import Config 
    200 import hashlib 
    201 import os.path 
    202 import sys 
    203  
    204 if len(sys.argv) == 2: 
    205     deluge_dir = os.path.expanduser(sys.argv[1]) 
    206  
    207     if os.path.isdir(deluge_dir): 
    208         try: 
    209             config = Config("web.conf", config_dir=deluge_dir) 
    210         except IOError, e: 
    211             print "Can't open web ui config file: ", e 
    212         else: 
    213             password = raw_input("Enter new password: ") 
    214             s = hashlib.sha1() 
    215             s.update(config['pwd_salt']) 
    216             s.update(password) 
    217             config['pwd_sha1'] = s.hexdigest() 
    218             try: 
    219                 config.save() 
    220             except IOError, e: 
    221                 print "Couldn't save new password: ", e 
    222             else: 
    223                 print "New password successfully set!" 
    224     else: 
    225         print "%s is not a directory!" % deluge_dir 
    226 else: 
    227     print "Usage: %s <deluge config dir>" % (os.path.basename(sys.argv[0])) 
    228 }}} 
    229  
    230 === How do I use HTTPS? === 
    231  
    232  1. Create a (self-signed) SSL certificate: http://httpd.apache.org/docs/2.0/ssl/ssl_faq.html#selfcert 
    233  1. Put the resulting `deluge.crt` and `deluge.key` in the [wiki:Faq#WheredoesDelugestoreitssettingsconfig config's] `ssl` directory. 
    234  1. Enable HTTPS in Web UI config and modify the filepaths to match the above files. 
    235  1. Restart Web UI 
    236  
    237 === Can I bind the Web UI to port :80 in Linux? === 
    238 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. 
    239  
    240 So for example in Debian or Ubuntu: 
    241  1. sudo apt-get install libcap2-bin 
    242  1. sudo setcap 'cap_net_bind_service=+ep' /path/to/python 
    243  1. Configure the Web UI to use port 80 
    244  1. Restart `deluged` daemon. 
    245  
    246 === How do I configure plugins with the Web UI? === 
    247 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. 
    248  
    249 === How do I auto-connect to a specific daemon? === 
    250  
    251  1. Stop the Web UI. 
    252  1. Edit `web.conf`, find "default_daemon" and set its value to the daemon `id` in `hostlist.conf`[[br]] 
    253     e.g. To connect to localhost you would open `hostlist.conf` as see a snippet such as: 
    254 {{{ 
    255 ... 
    256       "123459d5a5b414159caa1323f6e0c9b240c7abcd", 
    257       "localhost", 
    258       58846, 
    259 ... 
    260 }}} 
    261  use the first entry, which is the `id` and add it to `web.conf` 
    262 {{{ 
    263 "default_daemon": "123459d5a5b414159caa1323f6e0c9b240c7abcd", 
    264 }}} 
    265  1. Restart the Web UI. 
    266  
    267231= !BitTorrent Related= 
    268232