summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-11-08 20:45:54 -0800
committerMicah Lee <micah@micahflee.com>2020-11-08 20:45:54 -0800
commit0154c8477c38619ebde2c7128c7704e5afb084e3 (patch)
tree6bf32819a7e7340664e35fd51ad6fc49f6f0b796 /docs
parentdb0e22083119e1a87357c021fa19c09c8191213e (diff)
downloadonionshare-0154c8477c38619ebde2c7128c7704e5afb084e3.tar.gz
onionshare-0154c8477c38619ebde2c7128c7704e5afb084e3.zip
Version bump to 2.3.dev2, and update Linux installation in docs
Diffstat (limited to 'docs')
-rw-r--r--docs/pyproject.toml2
-rw-r--r--docs/source/conf.py2
-rw-r--r--docs/source/install.rst20
3 files changed, 13 insertions, 11 deletions
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
index 9cc7bcc2..1b1cb289 100644
--- a/docs/pyproject.toml
+++ b/docs/pyproject.toml
@@ -5,7 +5,7 @@ description = ""
authors = ["Micah Lee <micah@micahflee.com>"]
[tool.poetry.dependencies]
-python = "~3.6"
+python = "^3.6"
sphinx = "^3.2.1"
sphinx-rtd-theme = "^0.5.0"
sphinx-intl = "^2.0.1"
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a8d0393e..ac8bd793 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -16,7 +16,7 @@ languages = [
("Українська", "uk"),
]
-versions = ["2.3"]
+versions = ["2.3.dev2"]
html_theme = "sphinx_rtd_theme"
html_logo = "_static/logo.png"
diff --git a/docs/source/install.rst b/docs/source/install.rst
index a8383e35..51e000de 100644
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -6,30 +6,32 @@ Install on Windows or macOS
You can download OnionShare for Windows and macOS from the `OnionShare website <https://onionshare.org/>`_.
-For added security, see :ref:`verifying_sigs`.
-
.. _linux:
-Install in Linux with Flatpak
------------------------------
+Install in Linux
+----------------
+
+There are various ways to install OnionShare for Linux, but the recommended way is to use either the `Flatpak <https://flatpak.org/>`_ or the `Snapcraft <https://snapcraft.io/>`_ package. Flatpak and Snapcraft ensure that you'll always use the most latest dependencies and run OnionShare inside of a sandbox.
+
+Snapcraft is built-in to Ubuntu and Flatpak is built-in to Fedora, but which you use is up to you. Both work in all Linux distributions.
-There are various ways to install OnionShare for Linux, but the recommended way is to use the Flatpak package. Flatpak ensures that you'll always use the most latest dependencies and run OnionShare inside of a sandbox.
+**Install OnionShare using Flatpak**: https://flathub.org/apps/details/org.onionshare.OnionShare
-Make sure you have ``flatpak`` installed and the Flathub repository added by following `these instructions <https://flatpak.org/setup/>`_ for your Linux distribution.
+**Install OnionShare using Snapcraft**: https://snapcraft.io/onionshare
-Then install OnionShare from Flathub by following `the instructions here <https://flathub.org/apps/details/org.onionshare.OnionShare>`_.
+You can also download and install a PGP-signed ``.flatpak`` or ``.snap`` packages from https://onionshare.org/dist/ if you prefer.
.. _verifying_sigs:
Verifying PGP signatures
------------------------
-You can verify that the Windows, macOS, or source package you download is legitimate and hasn't been tampered with by verifying its PGP signature. For Windows and macOS, this step is optional and provides defense in depth: the installers also include their operating system-specific signatures, and you can just rely on those alone if you'd like.
+You can verify that the Windows, macOS, Flatpak, Snapcraft, or source package you download is legitimate and hasn't been tampered with by verifying its PGP signature. For Windows and macOS, this step is optional and provides defense in depth: the installers also include their operating system-specific signatures, and you can just rely on those alone if you'd like.
Signing key
^^^^^^^^^^^
-Windows, macOS, and source packaged are signed by Micah Lee, the core developer, using his PGP public key with fingerprint ``927F419D7EC82C2F149C1BD1403C2657CD994F73``. You can download Micah's key `from the keys.openpgp.org keyserver <https://keys.openpgp.org/vks/v1/by-fingerprint/927F419D7EC82C2F149C1BD1403C2657CD994F73>`_.
+Packages are signed by Micah Lee, the core developer, using his PGP public key with fingerprint ``927F419D7EC82C2F149C1BD1403C2657CD994F73``. You can download Micah's key `from the keys.openpgp.org keyserver <https://keys.openpgp.org/vks/v1/by-fingerprint/927F419D7EC82C2F149C1BD1403C2657CD994F73>`_.
In order to verify signatures, you must have GnuPG installed. For macOS you probably want `GPGTools <https://gpgtools.org/>`_, and for Windows you probably want `Gpg4win <https://www.gpg4win.org/>`_.