From 0bd5a44e9a73781b12f5c40cb887db8c9c4023cd Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Thu, 6 Jan 2022 10:39:16 -0700 Subject: [PATCH] lan-browser init --- site/source/about/roadmap.rst | 6 +++ site/source/conf.py | 1 + site/source/learn/concepts/embassy.rst | 6 +++ site/source/learn/media/articles.rst | 2 + .../configuration/lan-setup/index.rst | 9 ++--- .../lan-setup/lan-browser/index.rst | 15 +++++++ .../lan-setup/lan-browser/lan-brave.rst | 29 ++++++++++++++ .../lan-setup/lan-browser/lan-chrome.rst | 11 ++++++ .../lan-setup/lan-browser/lan-ff.rst | 39 +++++++++++++++++++ .../lan-setup/lan-browser/lan-safari.rst | 7 ++++ .../configuration/lan-setup/lan-os/index.rst | 16 ++++++++ .../lan-setup/{ => lan-os}/lan-ios.rst | 2 +- .../lan-setup/{ => lan-os}/lan-linux.rst | 0 .../lan-setup/{ => lan-os}/lan-mac.rst | 2 +- .../lan-setup/{ => lan-os}/lan-windows.rst | 0 .../configuration/tor-setup/index.rst | 2 + .../tor-setup/tor-firefox/torff-windows.rst | 2 +- .../getting-started/initial-setup.rst | 4 +- .../getting-started/recover-02.rst | 4 +- .../getting-started/recover-03.rst | 6 +-- .../services/managing-services/index.rst | 1 + .../managing-services/service-donate.rst | 2 +- .../user-manual/walkthrough/overview.rst | 2 + 23 files changed, 150 insertions(+), 18 deletions(-) create mode 100644 site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst create mode 100644 site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst create mode 100644 site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst create mode 100644 site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst create mode 100644 site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-safari.rst create mode 100644 site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst rename site/source/support/user-manual/configuration/lan-setup/{ => lan-os}/lan-ios.rst (99%) rename site/source/support/user-manual/configuration/lan-setup/{ => lan-os}/lan-linux.rst (100%) rename site/source/support/user-manual/configuration/lan-setup/{ => lan-os}/lan-mac.rst (98%) rename site/source/support/user-manual/configuration/lan-setup/{ => lan-os}/lan-windows.rst (100%) diff --git a/site/source/about/roadmap.rst b/site/source/about/roadmap.rst index 1b65b2a..6393de5 100644 --- a/site/source/about/roadmap.rst +++ b/site/source/about/roadmap.rst @@ -1,3 +1,9 @@ +.. _roadmap: + +======= +Roadmap +======= + Probably needs to actually be an html page that is linked to from "About" diff --git a/site/source/conf.py b/site/source/conf.py index 5407171..74bcc94 100644 --- a/site/source/conf.py +++ b/site/source/conf.py @@ -32,6 +32,7 @@ needs_sphinx = "1.8" extensions = [ "sphinx.ext.autodoc", "sphinx.ext.todo", + "sphinx.ext.viewcode", "sphinx.ext.mathjax", "sphinx.ext.extlinks", "sphinx_scylladb_theme", diff --git a/site/source/learn/concepts/embassy.rst b/site/source/learn/concepts/embassy.rst index ca48fe6..46bb642 100644 --- a/site/source/learn/concepts/embassy.rst +++ b/site/source/learn/concepts/embassy.rst @@ -52,3 +52,9 @@ Sometimes, a dependency can be satisfied in multiple ways. For example, Lightnin Web User Interface (UI) ----------------------- A User Interface, or UI, is as the name suggests, the way in which the user interacts with some software, typically in our context it will be a graphical interface (GUI). A WebUI is basically a website that is served (often by your Embassy) specifically for a user to issue commands or view data. A great example of this is EmbassyOS itself, which serves a WebUI for the user to add/remove services, make configurations, etc. This is your main point of contact with EOS. + +.. _health-checks: + +Health Checks +------------- + diff --git a/site/source/learn/media/articles.rst b/site/source/learn/media/articles.rst index 122f1f0..f5a2f62 100644 --- a/site/source/learn/media/articles.rst +++ b/site/source/learn/media/articles.rst @@ -21,3 +21,5 @@ Articles featuring Start9 Labs and/or Embassy :anchor: Coindesk Start9 Labs' Embassy server sets up its own private internet network and comes with its own operating system. We tried it. + + diff --git a/site/source/support/user-manual/configuration/lan-setup/index.rst b/site/source/support/user-manual/configuration/lan-setup/index.rst index e9342aa..ae48482 100644 --- a/site/source/support/user-manual/configuration/lan-setup/index.rst +++ b/site/source/support/user-manual/configuration/lan-setup/index.rst @@ -4,13 +4,10 @@ Local Access ============ -When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. +When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices` before setting up a :ref:`Browser`. .. toctree:: :maxdepth: 2 - lan-linux - lan-mac - lan-windows - lan-android - lan-ios + lan-os/index + lan-browser/index diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst b/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst new file mode 100644 index 0000000..95f5948 --- /dev/null +++ b/site/source/support/user-manual/configuration/lan-setup/lan-browser/index.rst @@ -0,0 +1,15 @@ +.. _lan-browser: + +====================== +Local Access (Devices) +====================== + +When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. + +.. toctree:: + :maxdepth: 2 + + lan-brave + lan-chrome + lan-firefox + lan-safari diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst new file mode 100644 index 0000000..28b2924 --- /dev/null +++ b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-brave.rst @@ -0,0 +1,29 @@ +.. _lan-brave: + +===== +Brave +===== + +#. Navigate to your Brave Settings in a new tab. + +#. On the left hand sidebar, navigate to *Additional Settings > Privacy and Security*. + +#. Add the bottom of the section, select "Manage Certificates". + + .. figure:: /_static/images/ssl/browser/brave_security_settings.png + :width: 90% + :alt: Brave privacy and security settings page + +#. If you see a trusted “Embassy Local Root CA”, open a new tab to apply the certificate. If this does not work, quit and restart Brave. + +#. If you do not see a trusted “Embassy Local Root CA” certificate in the list, ensure the certificate is properly set up on your computer system. + + .. figure:: /_static/images/ssl/browser/brave_view_certs.png + :width: 90% + :alt: Brave Manage Certificates sub-menu on MacOS + +#. Obtain the LAN address provided in the Setup App and enter it in a new tab. + +#. You can now securely navigate to your Embassy over HTTPS! + +#. Additionally, you can start a Brave private window with Tor to visit the Tor address over HTTPS (unnecessary in principle, but will circumvent annoying browser warnings). \ No newline at end of file diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst new file mode 100644 index 0000000..d98e219 --- /dev/null +++ b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-chrome.rst @@ -0,0 +1,11 @@ +.. _lan-chrome: + +====== +Chrome +====== + +#. Once you have followed the steps to setup your device, open a new tab to apply the certificate. If this does not work, quit and restart Chrome. + +#. Obtain the LAN address provided in the Setup App and enter it in the URL bar. + +#. You can now securely navigate to your Embassy over HTTPS! \ No newline at end of file diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst new file mode 100644 index 0000000..30768b9 --- /dev/null +++ b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-ff.rst @@ -0,0 +1,39 @@ +.. _lan-ff: + +======= +Firefox +======= + +#. Navigate to your Firefox Settings in a new tab. + +#. Select “Privacy and Security” from the left hand navigation menu. + +#. Scroll all the way to the bottom of the page and select “View Certificates”. + + .. figure:: /_static/images/ssl/browser/firefox_security_settings.png + :width: 90% + :alt: Firefox security settings + + Firefox privacy and security settings page + +#. Select the "Authorities" tab from the "Certificate Manager". + +#. Click “Import” and open the downloaded *Embassy Local Root CA.crt* file on your device. If you cannot find this, make sure you completed the :ref:`device setup steps `. + +#. When prompted, check “Trust this CA to identity websites” and select “OK”. + + .. figure:: /_static/images/ssl/browser/firefox_security_settings.png + :width: 90% + :alt: Firefox import cert + + Firefox import certificate page + +#. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”. + +#. Click “OK” to save. + +#. Open a new tab in Firefox to apply the changes. If this does not work, quit and restart Firefox. + +#. Navigate to the LAN address provided in the Setup App. + +#. You can now securely navigate to your Embassy over HTTPS! \ No newline at end of file diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-safari.rst b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-safari.rst new file mode 100644 index 0000000..20354df --- /dev/null +++ b/site/source/support/user-manual/configuration/lan-setup/lan-browser/lan-safari.rst @@ -0,0 +1,7 @@ +.. _lan-safari: + +====== +Safari +====== + +Once you have completed the steps to install a SSL certificate on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now securely navigate to the LAN address for your Embassy! \ No newline at end of file diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst new file mode 100644 index 0000000..1755331 --- /dev/null +++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/index.rst @@ -0,0 +1,16 @@ +.. _lan-os: + +====================== +Local Access (Devices) +====================== + +When you are on the same network as your Embassy (typically a home or small office), :ref:`Local Access` is much faster and will allow access to your data, even with no Internet connection. + +.. toctree:: + :maxdepth: 2 + + lan-linux + lan-mac + lan-windows + lan-android + lan-ios diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-ios.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-ios.rst similarity index 99% rename from site/source/support/user-manual/configuration/lan-setup/lan-ios.rst rename to site/source/support/user-manual/configuration/lan-setup/lan-os/lan-ios.rst index 7590585..21c2be1 100644 --- a/site/source/support/user-manual/configuration/lan-setup/lan-ios.rst +++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-ios.rst @@ -1,7 +1,7 @@ .. _lan-ios: === -iOS - ***UPDATE SCREENS*** +iOS === #. Navigate back to the `Start9 Setup App `_. diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-linux.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-linux.rst rename to site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-mac.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-mac.rst similarity index 98% rename from site/source/support/user-manual/configuration/lan-setup/lan-mac.rst rename to site/source/support/user-manual/configuration/lan-setup/lan-os/lan-mac.rst index d5d78c0..5e11144 100644 --- a/site/source/support/user-manual/configuration/lan-setup/lan-mac.rst +++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-mac.rst @@ -1,7 +1,7 @@ .. _lan-mac: === -Mac - ***UPDATE SCREENS*** +Mac === #. Visit your Embassy at its Tor Address. diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-windows.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst similarity index 100% rename from site/source/support/user-manual/configuration/lan-setup/lan-windows.rst rename to site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst diff --git a/site/source/support/user-manual/configuration/tor-setup/index.rst b/site/source/support/user-manual/configuration/tor-setup/index.rst index 955b76a..31fcdb4 100644 --- a/site/source/support/user-manual/configuration/tor-setup/index.rst +++ b/site/source/support/user-manual/configuration/tor-setup/index.rst @@ -1,3 +1,5 @@ +.. _running-tor: + ========= Tor Setup ========= diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst b/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst index fb35aae..9bdd993 100644 --- a/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst +++ b/site/source/support/user-manual/configuration/tor-setup/tor-firefox/torff-windows.rst @@ -50,4 +50,4 @@ Windows #. Click ``OK`` and then restart Firefox for the changes to take effect. -#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. You can test by going to Start9's ``.onion`` homepage, `here `_. This means you can access tor-only service :ref:`WebUIs `, such as Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin `_. +#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. You can test by going to Start9's ``.onion`` homepage, `here `_. This means you can access tor-only service :ref:`WebUIs `, such as Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin `_. diff --git a/site/source/support/user-manual/getting-started/initial-setup.rst b/site/source/support/user-manual/getting-started/initial-setup.rst index 9d36ab6..ceb59ce 100644 --- a/site/source/support/user-manual/getting-started/initial-setup.rst +++ b/site/source/support/user-manual/getting-started/initial-setup.rst @@ -29,7 +29,7 @@ Setup Your Embassy .. caution:: Sometmies a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet. -2. Visit ``embassy.local`` from your web browser. You will be prompted to enter your :ref:`Product Key`. This is found on the bottom side of your device. +2. Visit ``embassy.local`` from your web browser. You will be prompted to enter your :ref:`Product Key`. This is found on the bottom side of your device. .. figure:: /_static/images/setup/setup0.png :width: 60% @@ -40,7 +40,7 @@ Setup Your Embassy The product key is used to discover your Embassy's IP address on the Local Area Network using a hashing function and a protocol named :ref:`MDNS (or Zeroconf) `. -3. Next, select "Start Fresh" if this is your first time using an Embassy. If you'd like to "Recover" from an existing Embassy, please follow that guide :ref:`here`. +3. Next, select "Start Fresh" if this is your first time using an Embassy. If you'd like to "Recover" from an existing Embassy, please follow the guide for :ref:`versions 0.2.x ` or :ref:`versions 0.3.x `. .. figure:: /_static/images/setup/setup1.png :width: 60% diff --git a/site/source/support/user-manual/getting-started/recover-02.rst b/site/source/support/user-manual/getting-started/recover-02.rst index 2da341a..c86ed7f 100644 --- a/site/source/support/user-manual/getting-started/recover-02.rst +++ b/site/source/support/user-manual/getting-started/recover-02.rst @@ -1,4 +1,4 @@ -.. _recover-02: +.. _recover-02x: =================================== Migrate Embassy from Versions 0.2.x - **NEEDS SCREENS** @@ -9,7 +9,7 @@ Migrate Embassy Series 0.2.x Data This guide will cover how to upgrade from EmbassyOS version 0.2.x to version 0.3.0. -If you purchased the upgrade kit from us you can skip to :ref:`backing up ` unless you received your kit before we completed 0.3.0, in which case please skip to :ref:`flashing ` as you will need to flash 0.3.0 onto your SD card to continue migrating. +If you purchased the upgrade kit from us you can skip to :ref:`backing up ` unless you received your kit before we completed 0.3.0, in which case please skip to :ref:`flashing ` as you will need to flash 0.3.0 onto your SD card to continue migrating. Additional Hardware =================== diff --git a/site/source/support/user-manual/getting-started/recover-03.rst b/site/source/support/user-manual/getting-started/recover-03.rst index 0a57119..c62f689 100644 --- a/site/source/support/user-manual/getting-started/recover-03.rst +++ b/site/source/support/user-manual/getting-started/recover-03.rst @@ -1,12 +1,10 @@ -.. _recover-03: +.. _recover-03x: =================================== Recover Embassy from Versions 0.3.x =================================== -.. _recover-03x: - -Migrate Embassy Series 0.3.x Data +Recover Embassy Series 0.3.x Data --------------------------------- Recover From Remote Backup diff --git a/site/source/support/user-manual/services/managing-services/index.rst b/site/source/support/user-manual/services/managing-services/index.rst index 540e348..abbe1a3 100644 --- a/site/source/support/user-manual/services/managing-services/index.rst +++ b/site/source/support/user-manual/services/managing-services/index.rst @@ -18,3 +18,4 @@ An overview of Services and Marketplaces on EmbassyOS. service-logs service-marketplace service-donate + service-updates diff --git a/site/source/support/user-manual/services/managing-services/service-donate.rst b/site/source/support/user-manual/services/managing-services/service-donate.rst index a79da77..51ca81e 100644 --- a/site/source/support/user-manual/services/managing-services/service-donate.rst +++ b/site/source/support/user-manual/services/managing-services/service-donate.rst @@ -6,7 +6,7 @@ Donate Currently, this is a link provided by the service package developer so that you may donate to them or the developer of the service they packaged directly. If this is not provided, a pop-up message will let you know this, and you will need to find the devs on their own platforms in order to donate. - .. figure:: /_static/images/services/donate.png + .. figure:: /_static/images/services/donate.svg :width: 60% Donate diff --git a/site/source/support/user-manual/walkthrough/overview.rst b/site/source/support/user-manual/walkthrough/overview.rst index 4efee6f..890870b 100644 --- a/site/source/support/user-manual/walkthrough/overview.rst +++ b/site/source/support/user-manual/walkthrough/overview.rst @@ -21,6 +21,8 @@ Embassy Tab The Embassy Tab is where you can perform :ref:`Backups`, get Insights into EOS, change some basic Settings, and Power cycle your device if necessary. +.. _backups: + Backups =======