[Docs] Add release notes and update pages
This commit is contained in:
parent
d24109f0a2
commit
25087d3f2d
|
@ -5,3 +5,4 @@ This is a guide to help with developing Deluge.
|
||||||
- [Tutorials](tutorials/index.md)
|
- [Tutorials](tutorials/index.md)
|
||||||
- [How-to guides](how-to/index.md)
|
- [How-to guides](how-to/index.md)
|
||||||
- [Packaging](packaging/index.md)
|
- [Packaging](packaging/index.md)
|
||||||
|
- [Changelog](../changelog.md)
|
||||||
|
|
|
@ -9,7 +9,7 @@ Contents
|
||||||
|
|
||||||
Getting started <intro/index.md>
|
Getting started <intro/index.md>
|
||||||
How-to guides <how-to/index.md>
|
How-to guides <how-to/index.md>
|
||||||
Changelog <changelog.md>
|
Release notes <releases/index.md>
|
||||||
Contributing <contributing/index.md>
|
Contributing <contributing/index.md>
|
||||||
Developer guide <devguide/index.md>
|
Developer guide <devguide/index.md>
|
||||||
Reference <reference/index.rst>
|
Reference <reference/index.rst>
|
||||||
|
|
|
@ -9,7 +9,7 @@ feel free to make suggestions for improvement.
|
||||||
|
|
||||||
Until the stable PPA is updated, the development version of Deluge can be used:
|
Until the stable PPA is updated, the development version of Deluge can be used:
|
||||||
|
|
||||||
sudo add-apt-repository -u ppa:deluge-team/develop
|
sudo add-apt-repository -u ppa:deluge-team/stable
|
||||||
sudo apt install deluge
|
sudo apt install deluge
|
||||||
|
|
||||||
### <i class="icon-python"></i> PyPi
|
### <i class="icon-python"></i> PyPi
|
||||||
|
|
|
@ -1,16 +1,38 @@
|
||||||
# Deluge Web UI
|
# Deluge Web UI
|
||||||
|
|
||||||
The Deluge web interface is intended to be a full featured interface built using
|
The Deluge web interface is a full featured interface built using the ExtJS framework,
|
||||||
the ExtJS framework, running on top of a Twisted webserver.
|
running on top of a Twisted webserver.
|
||||||
|
|
||||||
## SSL Configuration
|
## SSL Configuration
|
||||||
|
|
||||||
By default the web interface will use the same private key and certificate as
|
By default the web interface will use the same private key and certificate as
|
||||||
the Deluge daemon. If you wish to use a different certificate/key (see
|
the Deluge daemon. You can use a different certificate/key and specify it in the Web UI
|
||||||
[How to Create a SSL Certificate](http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/))
|
config, see below for details.
|
||||||
for information on creating one) you are able to specify which you want to use.
|
|
||||||
|
|
||||||
There are 2 ways to enable SSL encryption in the webserver, 1 is to specify it
|
### Create SSL Certificate Examples
|
||||||
in your configuration (accessible via the Preferences window). The other is to
|
|
||||||
add '--ssl' when running the webserver, which will override the configuration
|
Sample guide: [How to Create a SSL Certificate][ssl cert]
|
||||||
value and enable SSL.
|
|
||||||
|
#### 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
|
||||||
|
|
||||||
|
There are two ways to enable SSL encryption in the webserver:
|
||||||
|
|
||||||
|
- Specify in your config (accessible via the Preferences window).
|
||||||
|
- Use `--ssl` when running the webserver, overriding the configuration value to enable SSL.
|
||||||
|
|
||||||
|
## Enable Development mode
|
||||||
|
|
||||||
|
Add `?dev=true` to the webui url to enable development mode, uses the source js files
|
||||||
|
(if available) rather than compressed versions:
|
||||||
|
|
||||||
|
http://127.0.0.1:8112/?dev=true
|
||||||
|
|
||||||
|
[ssl cert]: http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/
|
||||||
|
|
|
@ -0,0 +1,45 @@
|
||||||
|
# Deluge 2.0 release notes
|
||||||
|
|
||||||
|
Welcome to the latest release of Deluge, a long time in the making!
|
||||||
|
|
||||||
|
## What's new
|
||||||
|
|
||||||
|
Some of the highlights since the last major release.
|
||||||
|
|
||||||
|
- Migrated to Python 3.
|
||||||
|
- Shiny new logo.
|
||||||
|
- Multi-user support.
|
||||||
|
- Performance updates to handle thousands of torrents with faster loading times.
|
||||||
|
- A New Console UI which emulates GTK/Web UIs.
|
||||||
|
- GTK UI migrated to GTK3 with UI improvements and additions.
|
||||||
|
- Magnet pre-fetching to allow file selection when adding torrent.
|
||||||
|
- Fully support libtorrent 1.2 release.
|
||||||
|
- Language switching support.
|
||||||
|
- Improved documentation hosted on ReadTheDocs.
|
||||||
|
- AutoAdd plugin replaces built-in functionality.
|
||||||
|
|
||||||
|
## Packaging
|
||||||
|
|
||||||
|
Unfortunately there are no packages yet for [Windows] or MacOS but they are being worked
|
||||||
|
on. For now alternative [install] methods are available for testing.
|
||||||
|
|
||||||
|
## Upgrade considerations
|
||||||
|
|
||||||
|
Deluge 2.0 is not compatible with Deluge 1.x clients or daemons so these will require
|
||||||
|
upgrading too. Also third-party Python scripts may not be compatible if they directly
|
||||||
|
connect to the Deluge client and will need migrating.
|
||||||
|
|
||||||
|
Always make a backup of your [config] before a major version upgrade to guard against
|
||||||
|
data loss.
|
||||||
|
|
||||||
|
Translations may not be as up-to date so please help out, see [translations] page.
|
||||||
|
|
||||||
|
Plugins written for Deluge 1.3 will need upgrading for Deluge 2.0, due to the
|
||||||
|
requirement of Python 3 and GTK3 UI. There is a [update plugin] document to help
|
||||||
|
Plugin authors update their plugins.
|
||||||
|
|
||||||
|
[update plugin]: ../devguide/how-to/update-1.3-plugin.md
|
||||||
|
[windows]: https://dev.deluge-torrent.org/ticket/3201
|
||||||
|
[install]: https://deluge.readthedocs.io/en/latest/intro/01-install.html
|
||||||
|
[config]: https://dev.deluge-torrent.org/wiki/Faq#WheredoesDelugestoreitssettingsconfig
|
||||||
|
[translations]: ../contributing/translations.md
|
|
@ -0,0 +1,10 @@
|
||||||
|
# Release notes
|
||||||
|
|
||||||
|
A summary of the important changes in major releases of Deluge. For more details see
|
||||||
|
the [changelog] or the [git commit log].
|
||||||
|
|
||||||
|
- [Changelog]
|
||||||
|
- [Deluge 2.0 release notes](2.0.md)
|
||||||
|
|
||||||
|
[git commit log]: http://git.deluge-torrent.org/deluge/log/?h=master
|
||||||
|
[changelog]: ../changelog.md
|
Loading…
Reference in New Issue