Update documentation for 2.4.1

docs/check-weblate.py

@@ -15,7 +15,7 @@ async def api(path):
 
     async with httpx.AsyncClient() as client:
         r = await client.get(
-            url, headers={"Authorization": f"Token {api_token}"}, timeout=30.0
+            url, headers={"Authorization": f"Token {api_token}"}, timeout=60
         )
 
     if r.status_code == 200:
@@ -109,7 +109,8 @@ async def main():
         languages[obj["code"]] = obj["language"]
 
     # Get the app translations for each language
-    await asyncio.gather(*[get_app_translation(lang_code) for lang_code in languages])
+    for lang_code in languages:
+        await get_app_translation(lang_code)
 
     # Get the documentation translations for each component for each language
     for component in [
@@ -123,11 +124,8 @@ async def main():
         "doc-sphinx",
         "doc-tor",
     ]:
-        docs_futures = []
         for lang_code in languages:
-            docs_futures.append(get_docs_translation(component, lang_code))
+            await get_docs_translation(component, lang_code)
-
-        await asyncio.gather(*docs_futures)
 
     print("")
 

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]
+                          [--auto-start-timer SECONDS] [--auto-stop-timer SECONDS] [--no-autostop-sharing] [--data-dir data_dir] [--webhook-url webhook_url] [--disable-text]
-                          [--disable_csp] [-v]
+                          [--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

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"

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/          │
     ╰───────────────────────────────────────────╯

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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.