mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
lan-browser init
This commit is contained in:
kn0wmad
@@ -1,3 +1,9 @@
|
||||
.. _roadmap:
|
||||
|
||||
=======
|
||||
Roadmap
|
||||
=======
|
||||
|
||||
Probably needs to actually be an html page that is linked to from "About"
|
||||
|
||||
|
||||
|
||||
@@ -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",
|
||||
|
||||
@@ -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
|
||||
-------------
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
|
||||
@@ -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<lan>` 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<lan>` is much faster and will allow access to your data, even with no Internet connection. Begin by setting up :ref:`Devices<lan-os>` before setting up a :ref:`Browser<lan-browser>`.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-linux
|
||||
lan-mac
|
||||
lan-windows
|
||||
lan-android
|
||||
lan-ios
|
||||
lan-os/index
|
||||
lan-browser/index
|
||||
|
||||
@@ -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<lan>` 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
|
||||
@@ -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).
|
||||
@@ -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!
|
||||
@@ -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 <ssl-setup>`.
|
||||
|
||||
#. 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!
|
||||
@@ -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!
|
||||
@@ -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<lan>` 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
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _lan-ios:
|
||||
|
||||
===
|
||||
iOS - ***UPDATE SCREENS***
|
||||
iOS
|
||||
===
|
||||
|
||||
#. Navigate back to the `Start9 Setup App <https://apps.apple.com/us/app/start9-setup-app/id1528125889>`_.
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _lan-mac:
|
||||
|
||||
===
|
||||
Mac - ***UPDATE SCREENS***
|
||||
Mac
|
||||
===
|
||||
|
||||
#. Visit your Embassy at its Tor Address.
|
||||
@@ -1,3 +1,5 @@
|
||||
.. _running-tor:
|
||||
|
||||
=========
|
||||
Tor Setup
|
||||
=========
|
||||
|
||||
@@ -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 <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_. This means you can access tor-only service :ref:`WebUIs <webui>`, such as Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.
|
||||
#. 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 <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_. This means you can access tor-only service :ref:`WebUIs <web-ui>`, such as Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.
|
||||
|
||||
@@ -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<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) <mdns>`.
|
||||
|
||||
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<recover>`.
|
||||
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 <recover-02x>` or :ref:`versions 0.3.x <recover-03x>`.
|
||||
|
||||
.. figure:: /_static/images/setup/setup1.png
|
||||
:width: 60%
|
||||
|
||||
@@ -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 <recover-03-backup>` unless you received your kit before we completed 0.3.0, in which case please skip to :ref:`flashing <recover-03-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 <recover-02-backup>` unless you received your kit before we completed 0.3.0, in which case please skip to :ref:`flashing <recover-02-flashing>` as you will need to flash 0.3.0 onto your SD card to continue migrating.
|
||||
|
||||
Additional Hardware
|
||||
===================
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -18,3 +18,4 @@ An overview of Services and Marketplaces on EmbassyOS.
|
||||
service-logs
|
||||
service-marketplace
|
||||
service-donate
|
||||
service-updates
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -21,6 +21,8 @@ Embassy Tab
|
||||
|
||||
The Embassy Tab is where you can perform :ref:`Backups<backups>`, get Insights into EOS, change some basic Settings, and Power cycle your device if necessary.
|
||||
|
||||
.. _backups:
|
||||
|
||||
Backups
|
||||
=======
|
||||
|
||||
|
||||
Reference in New Issue
Block a user