summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2019-06-08 16:42:25 +0100
committerCalum Lind <calumlind+deluge@gmail.com>2019-06-08 16:42:25 +0100
commit25087d3f2d321b63e46d59e5076df899bfcdf518 (patch)
treee88ba809763824b12f0e0f737808eb13b162cef9
parentd24109f0a2d69f9bed644be7d77bcf059315d3af (diff)
downloaddeluge-25087d3f2d321b63e46d59e5076df899bfcdf518.tar.gz
deluge-25087d3f2d321b63e46d59e5076df899bfcdf518.tar.bz2
deluge-25087d3f2d321b63e46d59e5076df899bfcdf518.zip
[Docs] Add release notes and update pages
-rw-r--r--docs/source/devguide/index.md1
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/intro/01-install.md2
-rw-r--r--docs/source/reference/web.md42
-rw-r--r--docs/source/releases/2.0.md45
-rw-r--r--docs/source/releases/index.md10
6 files changed, 90 insertions, 12 deletions
diff --git a/docs/source/devguide/index.md b/docs/source/devguide/index.md
index e69db080b..bde04b3e0 100644
--- a/docs/source/devguide/index.md
+++ b/docs/source/devguide/index.md
@@ -5,3 +5,4 @@ This is a guide to help with developing Deluge.
- [Tutorials](tutorials/index.md)
- [How-to guides](how-to/index.md)
- [Packaging](packaging/index.md)
+- [Changelog](../changelog.md)
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 5b68effe4..b46b8f463 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -9,7 +9,7 @@ Contents
Getting started <intro/index.md>
How-to guides <how-to/index.md>
- Changelog <changelog.md>
+ Release notes <releases/index.md>
Contributing <contributing/index.md>
Developer guide <devguide/index.md>
Reference <reference/index.rst>
diff --git a/docs/source/intro/01-install.md b/docs/source/intro/01-install.md
index 28941796f..bcd1712a2 100644
--- a/docs/source/intro/01-install.md
+++ b/docs/source/intro/01-install.md
@@ -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:
- sudo add-apt-repository -u ppa:deluge-team/develop
+ sudo add-apt-repository -u ppa:deluge-team/stable
sudo apt install deluge
### <i class="icon-python"></i> PyPi
diff --git a/docs/source/reference/web.md b/docs/source/reference/web.md
index eb2d3747d..a91d85173 100644
--- a/docs/source/reference/web.md
+++ b/docs/source/reference/web.md
@@ -1,16 +1,38 @@
# Deluge Web UI
-The Deluge web interface is intended to be a full featured interface built using
-the ExtJS framework, running on top of a Twisted webserver.
+The Deluge web interface is a full featured interface built using the ExtJS framework,
+running on top of a Twisted webserver.
## SSL Configuration
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
-[How to Create a SSL Certificate](http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/))
-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
-in your configuration (accessible via the Preferences window). The other is to
-add '--ssl' when running the webserver, which will override the configuration
-value and enable SSL.
+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
+
+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/
diff --git a/docs/source/releases/2.0.md b/docs/source/releases/2.0.md
new file mode 100644
index 000000000..8f196c654
--- /dev/null
+++ b/docs/source/releases/2.0.md
@@ -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
diff --git a/docs/source/releases/index.md b/docs/source/releases/index.md
new file mode 100644
index 000000000..d72588465
--- /dev/null
+++ b/docs/source/releases/index.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