Add some OnionShare styling to the theme and write some more docs

This commit is contained in:
Micah Lee 2020-08-24 19:56:34 -04:00
parent b3b09a6f2c
commit 50ae994535
No known key found for this signature in database
GPG Key ID: 403C2657CD994F73
6 changed files with 64 additions and 58 deletions

View File

@ -0,0 +1,7 @@
.wy-nav-top {
background-color: #4e0d4e;
}
.wy-side-nav-search {
background-color: #5f0f5f;
}

View File

@ -16,6 +16,7 @@ html_theme = "sphinx_rtd_theme"
html_logo = "_static/logo.svg"
html_theme_options = {}
html_static_path = ["_static"]
html_css_files = ["custom.css"]
# sphinx-intl
locale_dirs = ["locale/"]

35
docs/source/features.rst Normal file
View File

@ -0,0 +1,35 @@
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/>`_.
By default, OnionShare web addresses are protected with a random password. A typical OnionShare address might look something like this::
http://onionshare:constrict-purity@by4im3ir5nsvygprmjq74xwplrkdgt44qmeapxawwikxacmr3dqzyjad.onion
In this case, the Tor onion address is ``by4im3ir5nsvygprmjq74xwplrkdgt44qmeapxawwikxacmr3dqzyjad.onion`` -- this is random, and each time you use OnionShare you'll get a different onion address. The username is always ``onionshare`` and the random password is ``constrict-purity``.
You're responsible for securely sharing that URL using a communication channel of their choice such as in an encrypted chat message, or using something less secure like a Twitter or Facebook message, depending on their `threat model <https://ssd.eff.org/en/module/your-security-plan>`_.
The people who you send the URL to must then copy and paste it into `Tor Browser <https://www.torproject.org/>`_ (a privacy-protecting anonymous web browser) to access the OnionShare service.
With OnionShare, *your own computer is the web server*. If you run OnionShare on your laptop to send someone files, and then suspends your laptop before the files have been downloaded, the service will not be available until your laptop is unsuspended and connected to the internet again. OnionShare works best when working with people in real-time.
Because your own computer is the web server, *no third party can access anything that happens in OnionShare*, not even the developers of OnionShare. It's completely private. And because OnionShare is based on Tor onion services too, it also protects your anonymity. See the :doc:`security design </security>` for more information.
Connecting to Tor
-----------------
Share Files
-----------
You can use OnionShare to securely and anonymously send files and folders to people. Just open OnionShare, drag in the files and folders you wish to share, and click "Start sharing".
Receive Files
-------------
Host a Website
--------------
Chat Anonymously
----------------

View File

@ -1,37 +0,0 @@
How it Works
============
OnionShare works by starting web servers locally on your own computer (at ``127.0.0.1`` on a random port between 17600 and 17650), and then making them accessible to other people as a `Tor <https://www.torproject.org/>`_ `onion service <https://community.torproject.org/onion-services/>`_.
By default, OnionShare web addresses are password protected. The username is always ``onionshare`` and the password is randomly generated. For example, a typical OnionShare address might look something like this::
http://onionshare:constrict-purity@by4im3ir5nsvygprmjq74xwplrkdgt44qmeapxawwikxacmr3dqzyjad.onion
In this case, the Tor onion address is ``by4im3ir5nsvygprmjq74xwplrkdgt44qmeapxawwikxacmr3dqzyjad.onion`` -- this is random, and each time you use OnionShare you'll get a different onion address. The username is ``onionshare`` and the random password is ``constrict-purity``.
The OnionShare user is responsible for securely sharing that URL with their audience using a communication channel of their choice such as in an encrypted chat message, or something less secure like a Twitter or Facebook message, depending on their threat model.
The members of the audience must use `Tor Browser <https://www.torproject.org/>`_ to load the URL and access the OnionShare service.
With OnionShare, *your own computer is the web server*. If you start an OnionShare service and send the URL to someone, you must keep your computer turned on and connected to the internet or else the service will go down. Because of this, OnionShare is most useful if it's used in real-time.
For example, if a user runs OnionShare on their laptop to send someone files, and then suspends their laptop before the files have been downloaded, the service will not be available until the laptop is unsuspended and connected to the internet again.
Because your own computer is the web server, *no third party can access anything that happens in OnionShare*, not even the developers of OnionShare. It's completely private. And because OnionShare is based on Tor onion services too, it also protects your anonymity. See the :doc:`security design </security>` for more information.
Connecting to Tor
-----------------
Share Files
-----------
You can use OnionShare to securely and anonymously send files and folders to people. Just open OnionShare, drag in the files and folders you wish to share, and click "Start sharing".
Receive Files
-------------
Host a Website
--------------
Chat Anonymously
----------------

View File

@ -3,11 +3,30 @@ How to Use 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.
Getting Started
---------------
Install in Windows or macOS
^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can always get the latest version of OnionShare for Windows or macOS from `onionshare.org <https://onionshare.org/>`_.
And you can find old versions of OnionShare at https://onionshare.org/dist/.
Install in Linux
^^^^^^^^^^^^^^^^
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.
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>`_.
Documentation
-------------
.. toctree::
:maxdepth: 2
install
how_it_works
features
advanced
security
develop

View File

@ -1,19 +0,0 @@
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>`_.