aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-08-26 20:14:12 -0700
committerMicah Lee <micah@micahflee.com>2020-08-26 20:14:12 -0700
commit1d4c296a49768614fff7524db30ff8d56124cd07 (patch)
tree6320e8c724a66c92e67fbb172ae0a55df06051c3
parent9f0fb6b6e58ad9006e318cdad8f130846bed5dd4 (diff)
downloadonionshare-1d4c296a49768614fff7524db30ff8d56124cd07.tar.gz
onionshare-1d4c296a49768614fff7524db30ff8d56124cd07.zip
Make this just the docs website, not the full website
-rw-r--r--docs/README.md2
-rw-r--r--docs/source/advanced.rst10
-rw-r--r--docs/source/develop.rst8
-rw-r--r--docs/source/features.rst2
-rw-r--r--docs/source/index.rst21
-rw-r--r--docs/source/install.rst13
-rw-r--r--docs/source/security.rst10
-rw-r--r--onionshare_gui/settings_dialog.py2
8 files changed, 31 insertions, 37 deletions
diff --git a/docs/README.md b/docs/README.md
index 3811f1f7..b6546aa2 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -5,7 +5,7 @@ All these commands must be run from the `docs` folder.
You must have the python dependencies installed to build the docs:
```sh
-pip3 install --user requirements.txt
+pip3 install --user -r requirements.txt
```
To build HTML docs:
diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst
index e398f778..eb6afd1e 100644
--- a/docs/source/advanced.rst
+++ b/docs/source/advanced.rst
@@ -1,9 +1,9 @@
-Advanced Usage
+Advanced usage
==============
.. _save_tabs:
-Save Tabs
+Save tabs
---------
By default, everything in OnionShare is temporary. As soon as you close an OnionShare tab its address no longer exists and can't be used again. But sometimes you might want an OnionShare service to be persistent. For example, this would be useful if you want to host a website that can keep the same URL even if you reboot your computer.
@@ -18,7 +18,7 @@ If you save a tab, a copy of that tab's onion service secret key will be stored
.. _disable_passwords:
-Disable Passwords
+Disable passwords
-----------------
By default, all OnionShare services are protected with the username `onionshare` and a randomly-generated password. If someone makes 20 wrong guesses of the password, your onion service is automatically stopped to prevent a brute force attack against the OnionShare service.
@@ -27,7 +27,7 @@ But sometimes you might want your OnionShare service to be accessible to the pub
To disable the password for any tab, just check the "Don't use a password" box before starting the server. Then the server will be public and won't have a password.
-Scheduled Times
+Scheduled times
---------------
OnionShare supports scheduling exactly when a service should start and stop. Before starting server, click "Show advanced settings" in its tab and then check the boxes next to either "Start onion service at scheduled time", "Stop onion service at scheduled time", or both, and set the desired dates and times.
@@ -42,7 +42,7 @@ If you scheduled a service to start in the future, when you click the start butt
.. image:: _static/screenshots/advanced-schedule-stop-timer.png
-Legacy Addresses
+Legacy addresses
----------------
OnionShare uses v3 Tor onion services by default. These are modern onion addresses that have 56 characters, for example::
diff --git a/docs/source/develop.rst b/docs/source/develop.rst
index 7d35d4e9..25aa6996 100644
--- a/docs/source/develop.rst
+++ b/docs/source/develop.rst
@@ -10,7 +10,7 @@ OnionShare has an open Keybase team that we use to discuss the project, includin
OnionShare also has a `mailing list <https://lists.riseup.net/www/subscribe/onionshare-dev>`_ for developers and and designers to discuss the project.
-Contributing Code
+Contributing code
-----------------
OnionShare source code is in this git repository: https://github.com/micahflee/onionshare
@@ -19,7 +19,7 @@ If you'd like to contribute code to OnionShare, it helps to join the Keybase tea
When you're ready to contribute code, open a pull request in the GitHub repository and one of the project maintainers will review it and possible ask questions, request changes, reject it, or merge it into the project.
-Starting Development
+Starting development
--------------------
OnionShare is developed in Python. To get started, you should close the git repository at https://github.com/micahflee/onionshare/ and then consult the ``BUILD.md`` file.
@@ -31,7 +31,7 @@ That file contains the technical instructions and commands necessary:
* Building packages
* Making a release of OnionShare
-Debugging Tips
+Debugging tips
--------------
Verbose mode
@@ -174,7 +174,7 @@ Then rebuild the EXE with ``install\build_exe.bat`` (you may need to comment out
After this, you can run ``onionshare-gui.exe -v`` from a command prompt to see the debug output.
-Contributing Translations
+Contributing translations
-------------------------
Most of the OnionShare is translatable. You can help make it easier to use and more familiar and welcoming for people around the globe. The Localization Lab has some `documentation about translating OnionShare <https://wiki.localizationlab.org/index.php/OnionShare>`_.
diff --git a/docs/source/features.rst b/docs/source/features.rst
index e78baa1a..07ff7d21 100644
--- a/docs/source/features.rst
+++ b/docs/source/features.rst
@@ -1,6 +1,6 @@
.. _how_it_works:
-How OnionShare Works
+How OnionShare works
====================
OnionShare works by starting web servers locally on your own computer and making them accessible to other people as `Tor <https://www.torproject.org/>`_ `onion services <https://community.torproject.org/onion-services/>`_.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 560e8ea5..55d874e3 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,27 +1,14 @@
-OnionShare
-==========
-
-OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network.
+OnionShare's documentation
+==========================
.. image:: _static/screenshots/tabs.png
-Download
---------
-
-============================================================ ==================================================== =============================================================
-.. image:: _static/windows-logo.png .. image:: _static/apple-logo.png .. image:: _static/linux-logo.png
-============================================================ ==================================================== =============================================================
-`Download for Windows </dist/2.3/onionshare-2.3-setup.exe>`_ `Download for macOS </dist/2.3/OnionShare-2.3.pkg>`_ :ref:`linux`
-============================================================ ==================================================== =============================================================
-
-Learn about :ref:`verifying_sigs`.
-
-Documentation
--------------
+OnionShare is an open source tool that lets you securely and anonymously share files, host websites, and chat with friends using the Tor network.
.. toctree::
:maxdepth: 2
+ install
features
advanced
tor
diff --git a/docs/source/install.rst b/docs/source/install.rst
index 9e284e29..78829553 100644
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -1,9 +1,16 @@
Installation
============
+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:
-Linux Instructions
+Install in Linux with Flatpak
------------------
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.
@@ -14,12 +21,12 @@ Then install OnionShare from Flathub by following `the instructions here <https:
.. _verifying_sigs:
-Verifying PGP Signatures
+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.
-Signing Key
+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>`_.
diff --git a/docs/source/security.rst b/docs/source/security.rst
index 64d776f1..901dff03 100644
--- a/docs/source/security.rst
+++ b/docs/source/security.rst
@@ -1,10 +1,10 @@
-Security Design
+Security design
===============
First read :ref:`how_it_works` to understand the basics of how OnionShare works.
-What It Protects Against
-------------------------
+What OnionShare protects against
+--------------------------------
**Third parties don't have access to anything that happens in OnionShare.** When you use OnionShare, you host services directly on your computer. For example, when you share files with OnionShare, you don't upload these files to any server, and when you start an OnionShare chat room, your computer is the chat room server itself. Traditional ways of sharing files or setting up websites and chat rooms require trusting a service with access to your data.
@@ -14,8 +14,8 @@ What It Protects Against
**If an attacker learns about the onion service, they still can't access anything.** There have been attacks against the Tor network that can enumerate onion services. Even if someone discovers the .onion address of an OnionShare onion service, they can't access it without also knowing the service's random password (unless, of course, the OnionShare users chooses to disable the password and make it public). The password is generated by choosing two random words from a list of 6800 words, meaning there are 6800^2, or about 46 million possible password. But they can only make 20 wrong guesses before OnionShare stops the server, preventing brute force attacks against the password.
-What It Doesn't Protect Against
--------------------------------
+What OnionShare doesn't protect against
+---------------------------------------
**Communicating the OnionShare address might not be secure.** The OnionShare user is responsible for securely communicating the OnionShare address with people. If they send it insecurely (such as through an email message, and their email is being monitored by an attacker), the eavesdropper will learn that they're using OnionShare. If the attacker loads the address in Tor Browser before the legitimate recipient gets to it, they can access the service. If this risk fits the user's threat model, they must find a more secure way to communicate the address, such as in an encrypted email, chat, or voice call. This isn't necessary in cases where OnionShare is being used for something that isn't secret.
diff --git a/onionshare_gui/settings_dialog.py b/onionshare_gui/settings_dialog.py
index d599e814..46057905 100644
--- a/onionshare_gui/settings_dialog.py
+++ b/onionshare_gui/settings_dialog.py
@@ -892,7 +892,7 @@ class SettingsDialog(QtWidgets.QDialog):
@staticmethod
def open_help():
- help_url = "https://onionshare.org/"
+ help_url = "https://docs.onionshare.org/"
QtGui.QDesktopServices.openUrl(QtCore.QUrl(help_url))
def settings_from_fields(self):