diff --git a/README.md b/README.md index 7bc4ea6..5b0c1b5 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,22 @@ brew install poetry git clone https://github.com/Start9Labs/documentation.git && cd documentation ``` -1. Install theme submodule: +2. Install theme submodule: ``` git submodule update --init ``` -1. Navigate to the `site` folder and start the project: +3. (Optional, if you have an older build that needs to be updated) Navigate to `sphinx-scylladb-theme`, update and build with: + +``` +cd sphinx-scylladb-theme +git pull +npm i +npm run build +``` + +4. Navigate to the `site` folder and start the project: ``` cd site @@ -76,7 +85,7 @@ Click on the "Issues" tab in the top navbar. Provide a good title and describe c ### Submitting a pull request -Click on the "Pull requests" tab in the top navbar. Select the green "New pull request button" in the top right section. Select your branch for the compare dropdown, and master as the base. Provide an appropriate title and summary of the changes in the pull request description. Changes will be reviewed and merged when satisfactory. +Click on the "Pull requests" tab in the top navbar. Select the green "New pull request button" in the top right section. Select your branch for the compare dropdown, and master as the base. Provide an appropriate title and summary of the changes in the pull request description. Changes will be reviewed and merged when satisfactory. ## Helpful Resources @@ -85,4 +94,4 @@ http://sphinx-doc.org/rest.html http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html http://www.siafoo.net/help/reST http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html -https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html \ No newline at end of file +https://sublime-and-sphinx-guide.readthedocs.io/en/latest/lists.html diff --git a/site/03-todo.md b/site/03-todo.md index c2ee675..2e9012c 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -18,17 +18,11 @@ - Device-specific Guides - (after release) create badges for topic boxes - Configuration - - Tor Setup - - Mac - - Android - - FF OS - - FF Mobile - LAN Setup - Mac - Android - - iOS - Browsers -- Tuning +- Tunin - DIY Guide - Advanced Config - SSH over Tor @@ -45,7 +39,7 @@ - Mission / values - Backups - CIFS - - OS guides for CIFS + - OS guides for CIFS (screens) - Local - Migrations - Possible sounds in troubleshooting (and walkthrough?) diff --git a/site/source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG b/site/source/_static/images/ssl/mobile/ssl_certificate_install_page.svg similarity index 100% rename from site/source/_static/images/ssl/mobile/ssl_certificate_install_page.PNG rename to site/source/_static/images/ssl/mobile/ssl_certificate_install_page.svg diff --git a/site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.svg similarity index 100% rename from site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust.svg diff --git a/site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.svg similarity index 100% rename from site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.svg diff --git a/site/source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_general_settings.svg similarity index 100% rename from site/source/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_general_settings.svg diff --git a/site/source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_install_profile.svg similarity index 100% rename from site/source/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_install_profile.svg diff --git a/site/source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG b/site/source/_static/images/ssl/mobile/ssl_ipad_profiles.svg similarity index 100% rename from site/source/_static/images/ssl/mobile/ssl_ipad_profiles.PNG rename to site/source/_static/images/ssl/mobile/ssl_ipad_profiles.svg diff --git a/site/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG b/site/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG deleted file mode 100644 index 19def4e..0000000 Binary files a/site/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG and /dev/null differ diff --git a/site/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG b/site/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG deleted file mode 100644 index d077c5e..0000000 Binary files a/site/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG and /dev/null differ diff --git a/site/source/_static/images/tor/about_config.png b/site/source/_static/images/tor/about_config.svg similarity index 100% rename from site/source/_static/images/tor/about_config.png rename to site/source/_static/images/tor/about_config.svg diff --git a/site/source/_static/images/tor/autoconfig_url.png b/site/source/_static/images/tor/autoconfig_url.svg similarity index 100% rename from site/source/_static/images/tor/autoconfig_url.png rename to site/source/_static/images/tor/autoconfig_url.svg diff --git a/site/source/_static/images/tor/firefox_options_windows.png b/site/source/_static/images/tor/firefox_options_windows.svg similarity index 100% rename from site/source/_static/images/tor/firefox_options_windows.png rename to site/source/_static/images/tor/firefox_options_windows.svg diff --git a/site/source/_static/images/tor/firefox_preferences.png b/site/source/_static/images/tor/firefox_preferences.svg similarity index 100% rename from site/source/_static/images/tor/firefox_preferences.png rename to site/source/_static/images/tor/firefox_preferences.svg diff --git a/site/source/_static/images/tor/firefox_proxy.png b/site/source/_static/images/tor/firefox_proxy.svg similarity index 100% rename from site/source/_static/images/tor/firefox_proxy.png rename to site/source/_static/images/tor/firefox_proxy.svg diff --git a/site/source/_static/images/tor/firefox_search.png b/site/source/_static/images/tor/firefox_search.svg similarity index 100% rename from site/source/_static/images/tor/firefox_search.png rename to site/source/_static/images/tor/firefox_search.svg diff --git a/site/source/_static/images/tor/firefox_whitelist.png b/site/source/_static/images/tor/firefox_whitelist.svg similarity index 100% rename from site/source/_static/images/tor/firefox_whitelist.png rename to site/source/_static/images/tor/firefox_whitelist.svg diff --git a/site/source/_static/images/tor/firefox_whitelist_mobile.png b/site/source/_static/images/tor/firefox_whitelist_mobile.svg similarity index 100% rename from site/source/_static/images/tor/firefox_whitelist_mobile.png rename to site/source/_static/images/tor/firefox_whitelist_mobile.svg diff --git a/site/source/_static/images/tor/install_homebrew.png b/site/source/_static/images/tor/install_homebrew.svg similarity index 100% rename from site/source/_static/images/tor/install_homebrew.png rename to site/source/_static/images/tor/install_homebrew.svg diff --git a/site/source/_static/images/tor/install_homebrew1.png b/site/source/_static/images/tor/install_homebrew1.svg similarity index 100% rename from site/source/_static/images/tor/install_homebrew1.png rename to site/source/_static/images/tor/install_homebrew1.svg diff --git a/site/source/_static/images/tor/install_tor.png b/site/source/_static/images/tor/install_tor.svg similarity index 100% rename from site/source/_static/images/tor/install_tor.png rename to site/source/_static/images/tor/install_tor.svg diff --git a/site/source/_static/images/tor/network_proxy_type.png b/site/source/_static/images/tor/network_proxy_type.svg similarity index 100% rename from site/source/_static/images/tor/network_proxy_type.png rename to site/source/_static/images/tor/network_proxy_type.svg diff --git a/site/source/_static/images/tor/orbot_apps.png b/site/source/_static/images/tor/orbot_apps.png deleted file mode 100644 index f0b3e49..0000000 Binary files a/site/source/_static/images/tor/orbot_apps.png and /dev/null differ diff --git a/site/source/_static/images/tor/orbot_apps.svg b/site/source/_static/images/tor/orbot_apps.svg new file mode 100644 index 0000000..61a194d Binary files /dev/null and b/site/source/_static/images/tor/orbot_apps.svg differ diff --git a/site/source/_static/images/tor/orbot_menu.png b/site/source/_static/images/tor/orbot_menu.svg similarity index 100% rename from site/source/_static/images/tor/orbot_menu.png rename to site/source/_static/images/tor/orbot_menu.svg diff --git a/site/source/_static/images/tor/orbot_settings.png b/site/source/_static/images/tor/orbot_settings.svg similarity index 100% rename from site/source/_static/images/tor/orbot_settings.png rename to site/source/_static/images/tor/orbot_settings.svg diff --git a/site/source/_static/images/tor/orbot_start.png b/site/source/_static/images/tor/orbot_start.svg similarity index 100% rename from site/source/_static/images/tor/orbot_start.png rename to site/source/_static/images/tor/orbot_start.svg diff --git a/site/source/_static/images/tor/orbot_started.png b/site/source/_static/images/tor/orbot_started.svg similarity index 100% rename from site/source/_static/images/tor/orbot_started.png rename to site/source/_static/images/tor/orbot_started.svg diff --git a/site/source/_static/images/tor/orbot_vpn.png b/site/source/_static/images/tor/orbot_vpn.png deleted file mode 100644 index 8371b0f..0000000 Binary files a/site/source/_static/images/tor/orbot_vpn.png and /dev/null differ diff --git a/site/source/_static/images/tor/orbot_vpn.svg b/site/source/_static/images/tor/orbot_vpn.svg new file mode 100644 index 0000000..e9af1e3 Binary files /dev/null and b/site/source/_static/images/tor/orbot_vpn.svg differ diff --git a/site/source/_static/images/tor/os_ff_settings.svg b/site/source/_static/images/tor/os_ff_settings.svg new file mode 100644 index 0000000..dad30c5 Binary files /dev/null and b/site/source/_static/images/tor/os_ff_settings.svg differ diff --git a/site/source/_static/images/tor/private_dns_off.png b/site/source/_static/images/tor/private_dns_off.svg similarity index 100% rename from site/source/_static/images/tor/private_dns_off.png rename to site/source/_static/images/tor/private_dns_off.svg diff --git a/site/source/_static/images/tor/socks_remote_dns.png b/site/source/_static/images/tor/socks_remote_dns.svg similarity index 100% rename from site/source/_static/images/tor/socks_remote_dns.png rename to site/source/_static/images/tor/socks_remote_dns.svg diff --git a/site/source/learn/concepts/networks.rst b/site/source/learn/concepts/networks.rst index 93a0a01..3a65b62 100644 --- a/site/source/learn/concepts/networks.rst +++ b/site/source/learn/concepts/networks.rst @@ -8,20 +8,26 @@ Networks LAN --- - A Local Area Network (LAN) is a computer network that interconnects computers within a limited area such as a residence, school, laboratory, university campus, or office building. Devices on a LAN are private and protected, such that only devices connected to the same Ethernet or WiFi network can see or communicate with them. Your Embassy hosts itself on the LAN and is reachable by visiting its ``embassy.local`` URL in the browser while also connected to the LAN. -.. note:: Any device connected to a LAN can inspect all communications on that LAN. To avoid snooping, your Embassy's LAN communications are encrypted using :ref:`ssl`, which requires :ref:`additional setup `. +.. note:: Any device connected to a LAN can inspect all communications on that LAN. To avoid snooping, your Embassy's LAN communications are encrypted using :ref:`ssl`, which requires :ref:`additional setup `. + +.. _lan-cert: + +LAN Certificate +--------------- +When you visit an SSL secured website (https://), in addition to the connection being secured using SSL/TSL encryption, the website will present your browser with an SSL certificate showing that it (or more accurately ownership of the website's public key) has been authenticated by a recognized Certificate Authority (CA). In the case of your Embassy, this certificate is "self-signed," and as such, the CA is you. + +Your certificate is created when you initially setup your Embassy, or migrate to a new version, such as 0.3.0. .. _mdns: MDNS ---- - Multicast Domain Name System (MDNS) is a protocol that resolves a human-readable hostname to an IP address on a small network, such as the home or office network you might host your Embassy on. This is known as a "zeroconf," or zero-configuration service, meaning that you can instantly visit a human-recognizable domain name, such as ``embassy.local`` from your network. @@ -32,7 +38,6 @@ This domain is not broadcast outside of your local network, so it is as private SSL --- - Visiting websites on the Tor network is slow. We wanted to provide a better option to access the Embassy at home. That’s why we created an address for the Embassy that can be accessed on your Local Area Network. By default, this ``.local`` address is served like a regular website, over HTTP. Browsers make it noticeable when visiting a site over HTTP in the URL bar - it could be red, show an unlocked lock, or warn that the connection is not secure. @@ -52,7 +57,6 @@ For more information on how to setup your devices to enable this feature visit : Tor --- - The Onion Router, or Tor, is a free and open source software that enables anonymous communication. By routing Internet traffic though a worldwide, volunteer overlay network of nodes, requests are bundled in layers of encryption like the layers of an onion. The request is relayed across nodes, decrypting a layer only to reveal the next relay destination, until the request meets its final destination, without revealing the source IP address. If a malicious third party were to intercept a request, they would see a garbled mess of the remaining onion encryption, and would only know that it came from some onion node and was heading to some other onion node. The contents, source, and destination of the message are totally anonymous. @@ -67,7 +71,6 @@ Here's an introductory video on `Tor