diff options
author | Micah Lee <micah@micahflee.com> | 2021-11-23 19:33:21 -0800 |
---|---|---|
committer | Micah Lee <micah@micahflee.com> | 2021-11-23 19:33:21 -0800 |
commit | 9ad87ea25efd8fc8f896eb8c6054a5da3e7f3ec5 (patch) | |
tree | 3b6ec14ba57d2808e6239c32da31f2108b659b8d /docs/source | |
parent | a4985e7029df1d1e3d569dca09fd85afe6402dc8 (diff) | |
download | onionshare-9ad87ea25efd8fc8f896eb8c6054a5da3e7f3ec5.tar.gz onionshare-9ad87ea25efd8fc8f896eb8c6054a5da3e7f3ec5.zip |
Update documentation for 2.4.1
Diffstat (limited to 'docs/source')
21 files changed, 35 insertions, 23 deletions
diff --git a/docs/source/_static/screenshots/chat-sharing.png b/docs/source/_static/screenshots/chat-sharing.png Binary files differindex 51cf24a1..2ce7f0cc 100644 --- a/docs/source/_static/screenshots/chat-sharing.png +++ b/docs/source/_static/screenshots/chat-sharing.png diff --git a/docs/source/_static/screenshots/chat.png b/docs/source/_static/screenshots/chat.png Binary files differindex b328d375..25db2e19 100644 --- a/docs/source/_static/screenshots/chat.png +++ b/docs/source/_static/screenshots/chat.png diff --git a/docs/source/_static/screenshots/receive-sharing.png b/docs/source/_static/screenshots/receive-sharing.png Binary files differindex 36bf175b..0ef4ca0e 100644 --- a/docs/source/_static/screenshots/receive-sharing.png +++ b/docs/source/_static/screenshots/receive-sharing.png diff --git a/docs/source/_static/screenshots/receive-torbrowser.png b/docs/source/_static/screenshots/receive-torbrowser.png Binary files differindex 70ca189b..0a4e0cc7 100644 --- a/docs/source/_static/screenshots/receive-torbrowser.png +++ b/docs/source/_static/screenshots/receive-torbrowser.png diff --git a/docs/source/_static/screenshots/receive.png b/docs/source/_static/screenshots/receive.png Binary files differindex 9a5a9265..738edef4 100644 --- a/docs/source/_static/screenshots/receive.png +++ b/docs/source/_static/screenshots/receive.png diff --git a/docs/source/_static/screenshots/settings.png b/docs/source/_static/screenshots/settings.png Binary files differdeleted file mode 100644 index 2e0e49f1..00000000 --- a/docs/source/_static/screenshots/settings.png +++ /dev/null diff --git a/docs/source/_static/screenshots/share-files.png b/docs/source/_static/screenshots/share-files.png Binary files differindex b5f0223f..e75b3cab 100644 --- a/docs/source/_static/screenshots/share-files.png +++ b/docs/source/_static/screenshots/share-files.png diff --git a/docs/source/_static/screenshots/share-sharing.png b/docs/source/_static/screenshots/share-sharing.png Binary files differindex 47f00975..baafcdd9 100644 --- a/docs/source/_static/screenshots/share-sharing.png +++ b/docs/source/_static/screenshots/share-sharing.png diff --git a/docs/source/_static/screenshots/share-torbrowser.png b/docs/source/_static/screenshots/share-torbrowser.png Binary files differindex 4eeabf0e..2b7650c3 100644 --- a/docs/source/_static/screenshots/share-torbrowser.png +++ b/docs/source/_static/screenshots/share-torbrowser.png diff --git a/docs/source/_static/screenshots/share.png b/docs/source/_static/screenshots/share.png Binary files differindex 91e42dd1..9c62ecd1 100644 --- a/docs/source/_static/screenshots/share.png +++ b/docs/source/_static/screenshots/share.png diff --git a/docs/source/_static/screenshots/tabs.png b/docs/source/_static/screenshots/tabs.png Binary files differindex 04d01f0f..069dd37d 100644 --- a/docs/source/_static/screenshots/tabs.png +++ b/docs/source/_static/screenshots/tabs.png diff --git a/docs/source/_static/screenshots/tor-settings-bridges.png b/docs/source/_static/screenshots/tor-settings-bridges.png Binary files differnew file mode 100644 index 00000000..d3bb4237 --- /dev/null +++ b/docs/source/_static/screenshots/tor-settings-bridges.png diff --git a/docs/source/_static/screenshots/tor-settings-moat.png b/docs/source/_static/screenshots/tor-settings-moat.png Binary files differnew file mode 100644 index 00000000..9d3d9a59 --- /dev/null +++ b/docs/source/_static/screenshots/tor-settings-moat.png diff --git a/docs/source/_static/screenshots/tor-settings.png b/docs/source/_static/screenshots/tor-settings.png Binary files differnew file mode 100644 index 00000000..19d6b6c3 --- /dev/null +++ b/docs/source/_static/screenshots/tor-settings.png diff --git a/docs/source/_static/screenshots/website-files.png b/docs/source/_static/screenshots/website-files.png Binary files differindex b7c49ef8..8f92ec29 100644 --- a/docs/source/_static/screenshots/website-files.png +++ b/docs/source/_static/screenshots/website-files.png diff --git a/docs/source/_static/screenshots/website.png b/docs/source/_static/screenshots/website.png Binary files differindex 83919507..ce0ebf27 100644 --- a/docs/source/_static/screenshots/website.png +++ b/docs/source/_static/screenshots/website.png diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst index 61e9d15c..870f8777 100644 --- a/docs/source/advanced.rst +++ b/docs/source/advanced.rst @@ -105,14 +105,14 @@ You can browse the command-line documentation by running ``onionshare --help``:: │ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │ │ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │ │ │ - │ v2.4 │ + │ v2.4.1 │ │ │ │ https://onionshare.org/ │ ╰───────────────────────────────────────────╯ usage: onionshare-cli [-h] [--receive] [--website] [--chat] [--local-only] [--connect-timeout SECONDS] [--config FILENAME] [--persistent FILENAME] [--title TITLE] [--public] - [--auto-start-timer SECONDS] [--auto-stop-timer SECONDS] [--no-autostop-sharing] [--data-dir data_dir] [--webhook-url webhook_url] [--disable-text] [--disable-files] - [--disable_csp] [-v] + [--auto-start-timer SECONDS] [--auto-stop-timer SECONDS] [--no-autostop-sharing] [--data-dir data_dir] [--webhook-url webhook_url] [--disable-text] + [--disable-files] [--disable_csp] [--custom_csp custom_csp] [-v] [filename ...] positional arguments: @@ -140,5 +140,6 @@ You can browse the command-line documentation by running ``onionshare --help``:: Receive files: URL to receive webhook notifications --disable-text Receive files: Disable receiving text messages --disable-files Receive files: Disable receiving files - --disable_csp Publish website: Disable Content Security Policy header (allows your website to use third-party resources) + --disable_csp Publish website: Disable the default Content Security Policy header (allows your website to use third-party resources) + --custom_csp custom_csp Publish website: Set a custom Content Security Policy header -v, --verbose Log OnionShare errors to stdout, and web errors to disk diff --git a/docs/source/conf.py b/docs/source/conf.py index b20e51db..d2eb1566 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,6 +1,6 @@ project = "OnionShare" author = copyright = "Micah Lee, et al." -version = release = "2.4" +version = release = "2.4.1" extensions = ["sphinx_rtd_theme"] templates_path = ["_templates"] @@ -19,7 +19,7 @@ languages = [ ("Українська", "uk"), # Ukranian ] -versions = ["2.3", "2.3.1", "2.3.2", "2.3.3", "2.4"] +versions = ["2.3", "2.3.1", "2.3.2", "2.3.3", "2.4", "2.4.1"] html_theme = "sphinx_rtd_theme" html_logo = "_static/logo.png" diff --git a/docs/source/develop.rst b/docs/source/develop.rst index 042800c4..a9121bfe 100644 --- a/docs/source/develop.rst +++ b/docs/source/develop.rst @@ -58,7 +58,7 @@ This prints a lot of helpful messages to the terminal, such as when certain obje │ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │ │ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │ │ │ - │ v2.4 │ + │ v2.4.1 │ │ │ │ https://onionshare.org/ │ ╰───────────────────────────────────────────╯ @@ -144,7 +144,7 @@ You can do this with the ``--local-only`` flag. For example:: │ █ █ █▀▄ █ ▄▀▄ █▀▄ ▀▄ █▀▄ ▄▀▄ █▄▀ ▄█▄ │ │ ▀▄▀ █ █ █ ▀▄▀ █ █ ▄▄▀ █ █ ▀▄█ █ ▀▄▄ │ │ │ - │ v2.4 │ + │ v2.4.1 │ │ │ │ https://onionshare.org/ │ ╰───────────────────────────────────────────╯ diff --git a/docs/source/features.rst b/docs/source/features.rst index 497b0ede..3cb89ed7 100644 --- a/docs/source/features.rst +++ b/docs/source/features.rst @@ -118,7 +118,10 @@ Content Security Policy By default OnionShare helps secure your website by setting a strict `Content Security Policy <https://en.wikipedia.org/wiki/Content_Security_Policy>`_ header. However, this prevents third-party content from loading inside the web page. -If you want to load content from third-party websites, like assets or JavaScript libraries from CDNs, check the "Don't send Content Security Policy header (allows your website to use third-party resources)" box before starting the service. +If you want to load content from third-party websites, like assets or JavaScript libraries from CDNs, you have two options: + +- You can disable sending a Content Security Policy header by checking the "Don't send Content Security Policy header (allows your website to use third-party resources)" box before starting the service. +- You can send a custom Content Security Policy header. Tips for running a website service ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/tor.rst b/docs/source/tor.rst index e0b02d27..a883dfb7 100644 --- a/docs/source/tor.rst +++ b/docs/source/tor.rst @@ -1,12 +1,12 @@ Connecting to Tor ================= -Pick a way to connect OnionShare to Tor by clicking the "⚙" icon in the bottom right of the OnionShare window to get to its settings. +Pick a way to connect OnionShare to Tor by clicking the Tor onion icon in the bottom right of the OnionShare window to open the Tor Settings tab. -.. image:: _static/screenshots/settings.png +.. image:: _static/screenshots/tor-settings.png -Use the ``tor`` bundled with OnionShare ---------------------------------------- +Use the Tor version built into OnionShare +----------------------------------------- This is the default, simplest and most reliable way that OnionShare connects to Tor. For this reason, it's recommended for most users. @@ -14,6 +14,24 @@ For this reason, it's recommended for most users. When you open OnionShare, it launches an already configured ``tor`` process in the background for OnionShare to use. It doesn't interfere with other ``tor`` processes on your computer, so you can use the Tor Browser or the system ``tor`` on their own. +Getting Around Censorship +------------------------- + +If your access to the internet is censored, you can configure OnionShare to connect to the Tor network using `Tor bridges <https://tb-manual.torproject.org/bridges/>`_. If OnionShare connects to Tor without one, you don't need to use a bridge. + +To use a bridge, open the Tor Settings tab. +You must select "Use the Tor version built into OnionShare" and check the "Use a bridge" checkbox. + +Try using a built-in bridge first. Using `obfs4` or `snowflake` bridges is recommended over using `meek-azure`. + +.. image:: _static/screenshots/tor-settings-bridges.png + +If using a built-in bridge doesn't work, you can request a bridge from torproject.org. You will have to solve a CAPTCHA in order to request a bridge. (This makes it more difficult for governments or ISPs to block access to Tor bridges.) + +.. image:: _static/screenshots/tor-settings-moat.png + +You also have the option of using a bridge that you learned about from a trusted source. + Attempt auto-configuration with Tor Browser ------------------------------------------- @@ -102,13 +120,3 @@ Under "Tor authentication settings" choose "No authentication, or cookie authent Click the "Test Connection to Tor" button. If all goes well, you should see "Connected to the Tor controller". - -Using Tor bridges ------------------ - -If your access to the internet is censored, you can configure OnionShare to connect to the Tor network using `Tor bridges <https://2019.www.torproject.org/docs/bridges.html.en>`_. If OnionShare connects to Tor without one, you don't need to use a bridge. - -To configure bridges, click the "⚙" icon in OnionShare. - -You can use the built-in obfs4 pluggable transports, the built-in meek_lite (Azure) pluggable transports, or custom bridges, which you can obtain from Tor's `BridgeDB <https://bridges.torproject.org/>`_. -If you need to use a bridge, try the built-in obfs4 ones first. |