codex-storage
/
deluge
mirror of https://github.com/codex-storage/deluge.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
deluge/docs/source/reference/web.md

39 lines
1.2 KiB
Markdown
Raw Normal View History

[Docs] Reorganise and add sections from wiki - Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py.
2018-10-05 08:33:26 +00:00
# Deluge Web UI
update the docs, creating a simple structure for user orientated documentation
2009-07-20 09:36:16 +00:00
[Docs] Add release notes and update pages
2019-06-08 15:42:25 +00:00
The Deluge web interface is a full featured interface built using the ExtJS framework,
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
running on top of a Twisted web server.
update the docs, creating a simple structure for user orientated documentation
2009-07-20 09:36:16 +00:00
[Docs] Reorganise and add sections from wiki - Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py.
2018-10-05 08:33:26 +00:00
## SSL Configuration
update the docs, creating a simple structure for user orientated documentation
2009-07-20 09:36:16 +00:00
By default the web interface will use the same private key and certificate as
[Docs] Add release notes and update pages
2019-06-08 15:42:25 +00:00
the Deluge daemon. You can use a different certificate/key and specify it in the Web UI
config, see below for details.
### Create SSL Certificate Examples
Sample guide: [How to Create a SSL Certificate][ssl cert]
#### Linux
openssl req -new -x509 -nodes -out deluge.cert.pem -keyout deluge.key.pem
#### Windows
C:\OpenSSL\bin\openssl.exe req -config C:\OpenSSL\bin\openssl.cnf -x509 -days 365 -newkey rsa:1024 -keyout hostkey.pem -nodes -out hostcert.pem
### Enable Web UI SSL
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
There are two ways to enable SSL encryption in the web server:
[Docs] Add release notes and update pages
2019-06-08 15:42:25 +00:00
- Specify in your config (accessible via the Preferences window).
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
- Use `--ssl` when running the web server, overriding the configuration value to enable SSL.
[Docs] Add release notes and update pages
2019-06-08 15:42:25 +00:00
## Enable Development mode
[Docs] Add spellchecking with pyenchant - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
2019-06-15 18:44:33 +00:00
Append `?dev=true` to the Web UI URL to enable development mode, uses the source
JavaScript files (if available) rather than compressed versions:
[Docs] Add release notes and update pages
2019-06-08 15:42:25 +00:00
http://127.0.0.1:8112/?dev=true
[ssl cert]: http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/