From 62ae0f5ef68118c31ecd664379b8cf9cbc64cb14 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Sun, 12 Dec 2021 18:25:32 +0000 Subject: [Docs] Update install guide Rewrite install instructions to include more details on Deluge 2.0 install. * Added other Linux distros * Added stable PPA details * Added link to forum for Windows and macOS community packages Co-authored-by: Sergio M Co-authored-by: Ofry Linkovsky <15746116+OfryL@users.noreply.github.com> Closes: deluge-torrent/deluge#296 Closes: deluge-torrent/deluge#310 --- docs/source/depends.md | 1 + docs/source/intro/01-install.md | 131 ++++++++++++++++++++++++++++++++-------- 2 files changed, 106 insertions(+), 26 deletions(-) create mode 120000 docs/source/depends.md diff --git a/docs/source/depends.md b/docs/source/depends.md new file mode 120000 index 000000000..974bd08b5 --- /dev/null +++ b/docs/source/depends.md @@ -0,0 +1 @@ +../../DEPENDS.md \ No newline at end of file diff --git a/docs/source/intro/01-install.md b/docs/source/intro/01-install.md index 2474dcebb..243f7e395 100644 --- a/docs/source/intro/01-install.md +++ b/docs/source/intro/01-install.md @@ -1,59 +1,138 @@ # Installing Deluge -These are the instructions for installing Deluge. Consider them a work-in-progress and -feel free to make suggestions for improvement. +Instructions for installing Deluge. -## Ubuntu +## Linux -### PPA +### Ubuntu -Until the stable PPA is updated, the development version of Deluge can be used: +One-click [**APT Install**](https://tinyurl.com/installdeluge) - sudo add-apt-repository -u ppa:deluge-team/stable - sudo apt install deluge +``` +sudo apt install deluge +``` -### PyPi +[Package Details](https://packages.ubuntu.com/deluge) -To install from Python PyPi, Deluge requires the following system installed packages: +### Fedora - sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3 +``` +sudo dnf install deluge +``` + +[Package Details](https://src.fedoraproject.org/rpms/deluge) + +### Arch + +``` +pacman -S deluge-gtk +``` + +[Arch Wiki](https://wiki.archlinux.org/title/Deluge) + +### OpenSUSE + +[**1 Click Install**](http://packman.links2linux.org/install/deluge) + +[Package Details](https://software.opensuse.org/package/deluge) + +### Gentoo + +[Package Details](https://packages.gentoo.org/packages/net-p2p/deluge) + +## Windows + +Unfortunately no official installer package currently available. + +See [Alternative Installs](#alternative-installs) + +## macOS + +Unfortunately no official installer package currently available. + +See [Alternative Installs](#alternative-installs) + +## FreeBSD + +``` +pkg add deluge +``` + +[Package details](https://www.freshports.org/net-p2p/deluge/) + +## PyPi Install with pip: pip install deluge -Install with all optional dependencies: +Install with all [optional dependencies][depends]: pip install deluge[all] -## Windows +Will require system installed packages such as libtorent and GTK3. See [DEPENDS] + +e.g. on Ubuntu/Debian install these packages: -Unfortunately due to move to GTK3 and Python 3 there is no installer package currently -available for Windows. + sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3 -Intrepid users can install Deluge from separate packages as detailed in [issue #3201]. +## Alternative Installs -## macOS +### Ubuntu PPA + +The [stable PPA] contains the latest releases. + + sudo add-apt-repository -u ppa:deluge-team/stable + sudo apt install deluge + +The [development PPA] contains daily builds from the `develop` branch. + + sudo add-apt-repository -u ppa:deluge-team/develop + sudo apt install deluge + +### Windows Community + +Due to move to GTK3 and Python 3 and problems with pyinstaller there are only community +created installers available. + +Check sticky topics in [Windows Forum] for latest updates. + +For reference [issue #3201] is tracking progress on an official installer. + +### macOS Community + +#### Unofficial `.app` packages + +Check sticky topics in [MacOS Forum] + +#### Macports + +``` +sudo port install deluge +``` + +[Package Details](https://ports.macports.org/port/deluge/) -There is no `.app` package currently for macOS, but can try Deluge with [Homebrew]. +#### Homebrew 1. Install [Homebrew] -2. Open a terminal. -3. Run the following to install required packages: +1. Open a terminal to install required packages: brew install pygobject3 gtk+3 adwaita-icon-theme brew install libtorrent-rasterbar -4. To fix translations: +1. To fix translations: brew link gettext --force -5. Install Deluge: +1. Install Deluge: - pip3 install deluge + pip install deluge -[develop ppa]: https://launchpad.net/~deluge-team/+archive/ubuntu/develop/ +[development ppa]: https://launchpad.net/~deluge-team/+archive/ubuntu/develop/ +[stable ppa]: https://launchpad.net/~deluge-team/+archive/ubuntu/stable/ [homebrew]: https://brew.sh/ -[python 3.6]: https://www.python.org/downloads/release/python-368/ -[gvsbuild]: https://ci.appveyor.com/api/buildjobs/b0y2sttcq3t1071q/artifacts/gvsbuild-vs14-x64.tar.gz -[issue #3201]: https://dev.deluge-torrent.org/ticket/3201#comment:9 +[issue #3201]: https://dev.deluge-torrent.org/ticket/3201 +[windows forum]: https://forum.deluge-torrent.org/viewforum.php?f=12 +[macos forum]: https://forum.deluge-torrent.org/viewforum.php?f=13 +[depends]: ../depends.md -- cgit