deluge/docs/source/intro/01-install.md

# Installing Deluge

These are the instructions for installing Deluge. Consider them a work-in-progress and
feel free to make suggestions for improvement.

## <i class="icon-ubuntu"></i> Ubuntu

### PPA

Until the stable PPA is updated, the development version of Deluge can be used:

    sudo add-apt-repository -u ppa:deluge-team/stable
    sudo apt install deluge

### <i class="icon-python"></i> PyPi

To install from Python PyPi, Deluge requires the following system installed packages:

    sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3

Install with pip:

    pip install deluge

## <i class="fa fa-windows"></i> Windows

Unfortunately due to move to GTK3 and Python 3 there is no installer package currently
available for Windows.

Intrepid users can install Deluge from separate packages as detailed in [issue #3201].

## <i class="fa fa-apple"></i> macOS

There is no `.app` package currently for macOS, but can try Deluge with [Homebrew].

1.  Install [Homebrew]
2.  Open a terminal.
3.  Run the following to install required packages:

        brew install pygobject3 gtk+3 adwaita-icon-theme
        brew install libtorrent-rasterbar

4.  To fix translations:

        brew link gettext --force

5.  Install Deluge:

        pip3 install deluge

[develop ppa]: https://launchpad.net/~deluge-team/+archive/ubuntu/develop/
[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
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00			`# Installing Deluge`

[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`These are the instructions for installing Deluge. Consider them a work-in-progress and`
			`feel free to make suggestions for improvement.`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`## <i class="icon-ubuntu"></i> Ubuntu`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
			`### PPA`

[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`Until the stable PPA is updated, the development version of Deluge can be used:`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Docs] Add release notes and update pages 2019-06-08 15:42:25 +00:00			`sudo add-apt-repository -u ppa:deluge-team/stable`
[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`sudo apt install deluge`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`### <i class="icon-python"></i> PyPi`

			`To install from Python PyPi, Deluge requires the following system installed packages:`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
			`sudo apt install python3-pip python3-libtorrent python3-gi python3-gi-cairo gir1.2-gtk-3.0 gir1.2-appindicator3`

			`Install with pip:`

[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`pip install deluge`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00			`## <i class="fa fa-windows"></i> Windows`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[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			`Unfortunately due to move to GTK3 and Python 3 there is no installer package currently`
[Docs] Remove incomplete Windows install instructions The instructions are in-progress and missing steps so instead point to the issue ticket for now. 2019-06-11 10:31:43 +00:00			`available for Windows.`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[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			`Intrepid users can install Deluge from separate packages as detailed in [issue #3201].`
[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00
			`## <i class="fa fa-apple"></i> macOS`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[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 is no `.app` package currently for macOS, but can try Deluge with [Homebrew].
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Packaging] Add updated launchd scripts Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073 2019-06-08 18:29:20 +00:00			`1. Install [Homebrew]`
			`2. Open a terminal.`
			`3. Run the following to install required packages:`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
Fix typo in install instructions for macOS 2019-06-10 05:17:51 +00:00			`brew install pygobject3 gtk+3 adwaita-icon-theme`
[Packaging] Add updated launchd scripts Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073 2019-06-08 18:29:20 +00:00			`brew install libtorrent-rasterbar`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Packaging] Add updated launchd scripts Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073 2019-06-08 18:29:20 +00:00			`4. To fix translations:`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Packaging] Add updated launchd scripts Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073 2019-06-08 18:29:20 +00:00			`brew link gettext --force`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Packaging] Add updated launchd scripts Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073 2019-06-08 18:29:20 +00:00			`5. Install Deluge:`
[Docs] Update install details and add more pages 2019-04-03 12:31:38 +00:00
[Packaging] Add updated launchd scripts Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073 2019-06-08 18:29:20 +00:00			`pip3 install deluge`
[Docs] Cleanup changelog and docs 2019-06-05 22:32:37 +00:00
			`[develop ppa]: https://launchpad.net/~deluge-team/+archive/ubuntu/develop/`
			`[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`
[Docs] Fix typo and url for Windows install 2019-06-12 13:56:21 +00:00			`[issue #3201]: https://dev.deluge-torrent.org/ticket/3201#comment:9`