aboutsummaryrefslogtreecommitdiff
path: root/docs/source/install.rst
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-08-23 22:52:43 -0400
committerMicah Lee <micah@micahflee.com>2020-08-23 22:52:43 -0400
commit50dbe20270841ca24ffad4d8e033f1dc58cfd308 (patch)
treea8e991f84def1e0c55bb4b3457c42fe72dd55c3c /docs/source/install.rst
parentddf1532eed9b9c9e0ab1219168a8dc88589a8abf (diff)
downloadonionshare-50dbe20270841ca24ffad4d8e033f1dc58cfd308.tar.gz
onionshare-50dbe20270841ca24ffad4d8e033f1dc58cfd308.zip
Start adding documentation into the source tree
Diffstat (limited to 'docs/source/install.rst')
-rw-r--r--docs/source/install.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/source/install.rst b/docs/source/install.rst
new file mode 100644
index 00000000..5a8ac3a0
--- /dev/null
+++ b/docs/source/install.rst
@@ -0,0 +1,19 @@
+Installing OnionShare
+=====================
+
+Windows and macOS
+-----------------
+
+You can always get the latest version of OnionShare for Windows and macOS from `onionshare.org <https://onionshare.org/>`_.
+
+You can find old versions of OnionShare for Windows and macOS from https://onionshare.org/dist/.
+
+Linux
+-----
+
+Many Linux distributions come with OnionShare in their package repositories. You can use these if you want, but they might be old.
+
+If you want to make sure you have the latest version with support for the most features, you should use the Flatpak package. The Flatpak package is also more secure because it always uses the most up-to-date dependencies and runs OnionShare inside of a sandbox.
+
+**To install OnionShare using Flatpak:** Make sure you have ``flatpak`` installed and the Flathub repository added by following `these instructions <https://flatpak.org/setup/>`_ for your Linux distribution. Then install OnionShare from Flathub by following `the instructions here <https://flathub.org/apps/details/org.onionshare.OnionShare>`_.
+