LAN setup, image fixes, misc edits

This commit is contained in:
kn0wmad
2022-01-26 21:05:07 -07:00
committed by Lucy Cifferello
parent 1058083bc4
commit 5aed44dc54
59 changed files with 86 additions and 91 deletions

View File

@@ -19,9 +19,10 @@
- (after release) create badges for topic boxes
- Configuration
- LAN Setup
- Mac
- Android
- Browsers
- Android - Screenshots of LAN setup and verify steps on an Android 12+ device
- Brave
- Chrome
- Firefox
- Tunin
- DIY Guide
- Advanced Config
@@ -41,5 +42,8 @@
- CIFS
- OS guides for CIFS (screens)
- Local
- Restore from backup
- Migrations
- Possible sounds in troubleshooting (and walkthrough?)
- Verify LAN setup steps on a Mac
- Verify Tor setup steps on a Mac

Binary file not shown.

Before

Width:  |  Height:  |  Size: 247 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 494 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 514 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 504 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 500 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 346 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 591 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 295 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 478 KiB

View File

Before

Width:  |  Height:  |  Size: 41 KiB

After

Width:  |  Height:  |  Size: 41 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

Before

Width:  |  Height:  |  Size: 273 KiB

After

Width:  |  Height:  |  Size: 273 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 323 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 294 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 384 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 351 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 478 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 317 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 304 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 499 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 504 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 502 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 336 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 272 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 534 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 256 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 255 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 268 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 266 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 389 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 43 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 79 KiB

View File

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 59 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 150 KiB

After

Width:  |  Height:  |  Size: 150 KiB

View File

Before

Width:  |  Height:  |  Size: 185 KiB

After

Width:  |  Height:  |  Size: 185 KiB

View File

Before

Width:  |  Height:  |  Size: 988 KiB

After

Width:  |  Height:  |  Size: 988 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

Before

Width:  |  Height:  |  Size: 102 KiB

After

Width:  |  Height:  |  Size: 102 KiB

View File

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

View File

@@ -11,12 +11,13 @@ Automatically Report Bugs
You are asked at first setup if you would like to provide bug reports to Start9. You can edit that setting here if you change your mind. This data is anonymous and you can see exactly what is collected :ref:`here<error-logs>`.
1. As in the :ref:`Set Device Name<device-name>` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
2. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable``
#. As in the :ref:`Set Device Name<device-name>` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
.. figure:: /_static/images/config/basic-config3.png
:width: 60%
:alt: Automatically Report Bugs
#. Click ``Auto Report Bugs`` and either ``Enable`` or ``Disable``
.. figure:: /_static/images/config/basic-config3.svg
:width: 60%
:alt: Automatically Report Bugs
.. _auto-update:
@@ -25,9 +26,10 @@ Automatically Check for Updates
Automatic check for updates enables you to choose whether you want to be informed of EmbassyOS updates. Enabling this feature makes a request to the Start9 Marketplace to see if a new OS version has been released, and notifies you if so. This request is only made when you log into a new session or refresh your current session.
1. As in the :ref:`Set Device Name<device-name>` steps above, go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
2. Click ``Automatically Check for Updates`` and either ``Enable`` or ``Disable``
#. Go to the ``Embasssy`` tab, then under ``Settings``, click ``Preferences``
.. figure:: /_static/images/config/basic-config4.png
:width: 60%
:alt: Automatically Report Bugs
#. Click ``Automatically Check for Updates`` and either ``Enable`` or ``Disable``
.. figure:: /_static/images/config/basic-config4.svg
:width: 60%
:alt: Automatically Report Bugs

View File

@@ -1,8 +1,8 @@
.. _lan-browser:
======================
LAN Setup for Browsers
======================
====================
LAN Setup - Browsers
====================
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.

View File

@@ -4,15 +4,19 @@
Firefox
=======
#. Navigate to your Firefox Settings in a new tab.
#. Open Firefox and in a new tab select ``Settings`` from the right-hand hamburger menu:
.. figure:: /_static/images/tor/os_ff_settings.svg
:width: 30%
:alt: Firefox options screenshot
#. 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
.. figure:: /_static/images/ssl/browser/firefox_security_settings.svg
:width: 80%
:alt: Firefox security settings
Firefox privacy and security settings page
@@ -22,18 +26,14 @@ Firefox
#. 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
.. figure:: /_static/images/ssl/browser/firefox_view_certs.svg
:width: 80%
:alt: Firefox import cert
Firefox import certificate page
#. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”.
#. Click “OK” to save.
#. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”. Then 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!
#. Navigate to the LAN address provided at setup, or in the :ref:`Embassy tab<embassy-tab>` -> LAN. You can now securely navigate to your Embassy over HTTPS!

View File

@@ -4,4 +4,4 @@
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!
Once you have completed the :ref:`LAN Setup<lan-os>` steps 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!

View File

@@ -1,8 +1,8 @@
.. _lan-os:
=====================
LAN Setup for Devices
=====================
===================
LAN Setup - 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.

View File

@@ -4,62 +4,52 @@
Mac
===
#. Visit your Embassy at its Tor Address.
#. Visit your Embassy at its Tor Address (for security purposes), and navigate to the :ref:`Embassy tab<embassy-tab>` -> LAN
#. Navigate to --> Embassy --> Connect Over LAN
.. figure:: /_static/images/ssl/macos/embassy_lan_setup.svg
:width: 60%
:alt: LAN setup menu item
.. figure:: /_static/images/embassy_lan_setup.png
:width: 90%
:alt: LAN setup menu item
#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine.
Select the "Connect over LAN" menu item
.. figure:: /_static/images/ssl/macos/embassy_lan_setup0.svg
:width: 60%
:alt: LAN setup page
#. Select the "Root Certificate Authority" sub menu. This will prompt a download to save the certificate file to your machine.
#. Select the option to ``Open with`` "Keychain Access" and select ``OK``. If you choose to save the file, double click on it once downloaded.
.. figure:: /_static/images/secure_lan_setup_page.png
:width: 90%
:alt: LAN setup page
.. figure:: /_static/images/ssl/macos/embassy_lan_setup1.svg
:width: 60%
:alt: LAN setup prompt
Select the "Root Certificate Authority" sub menu
#. Enter your computer password when prompted. It will be imported into your mac's keychain.
#. Select the option to open your key with Keychain Access. If you choose to save file, double click on it once downloaded.
.. figure:: /_static/images/ssl/macos/certificate_untrusted.svg
:width: 60%
:alt: Keychain access import menu
.. figure:: /_static/images/secure_lan_setup_prompt.png
:width: 90%
:alt: LAN setup prompt
Keychain access import menu
Open with "Keychain Access" and select "OK"
.. note:: If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it.
#. Enter your computer password when prompted. It will be imported into your computer's keychain.
#. Navigate to the "System" tab on the left, find the certificate entitled “Embassy Local Root CA”, and double click on this certificate. A second window will pop up.
.. figure:: /_static/images/ssl/macos/certificate_untrusted.png
:width: 90%
:alt: Keychain access import menu
#. Open the “Trust” dropdown and select “Always Trust” from the dropdown next to “When using this certificate”.
Keychain access import menu
.. figure:: /_static/images/ssl/macos/always_trust.svg
:width: 60%
:alt: Keychain submenu
#. If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it.
#. Navigate to the "System" tab and find the certificate entitled “Embassy Local Root CA”.
#. Double click on this certificate. A second window will pop up.
#. Open the “Trust” dropdown and select “Always Trust” from the dropdown next to “when using this certificate”.
.. figure:: /_static/images/ssl/macos/always_trust.png
:width: 90%
:alt: Keychain submenu
Select "Always trust" under SSL dropdown for Embassy Local CA
Select "Always trust" under the "Trust" dropdown for Embassy Local CA
#. Close this window and enter your password to apply the settings.
#. The “Embassy Local Root CA” cert will now read “This certificate is marked as trusted for all users” in Keychain Access.
.. figure:: /_static/images/ssl/macos/certificate_trusted.png
:width: 90%
:alt: Keychain menu trusted certificate
.. figure:: /_static/images/ssl/macos/certificate_trusted.svg
:width: 60%
:alt: Keychain menu trusted certificate
Trusted Embassy Local CA certificate
Trusted Embassy Local CA certificate
#. Open your favorite browser to import this certificate and follow the steps for :ref:`browser setup <lan-browser>`.
#. Open your favorite browser and follow the steps for :ref:`browser setup <lan-browser>` to complete LAN setup.

View File

@@ -1,8 +1,8 @@
.. _tor-firefox:
====================
Setup Tor on Firefox
====================
===================
Tor Setup - Firefox
===================
.. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer<running-tor>`.

View File

@@ -28,7 +28,6 @@ Linux
:width: 30%
:alt: Firefox options screenshot
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
.. figure:: /_static/images/tor/firefox_search.svg

View File

@@ -1,8 +1,8 @@
.. _tor-os:
=====================
Setup Tor for Devices
=====================
===================
Tor Setup - Devices
===================
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Embassy with remotely.

View File

@@ -19,8 +19,8 @@ Check out our quick setup video below, and follow along with the steps in this g
Embassy will initialize, which may take 10-15min. You will hear 2 distinct sounds:
* "bep" Starting up
* "chime" Embassy is ready
* "bep" - Starting up
* "chime" - Embassy is ready
Setup Your Embassy
------------------
@@ -31,7 +31,7 @@ Setup Your Embassy
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
.. figure:: /_static/images/setup/setup0.svg
:width: 60%
:alt: Enter Product Key
@@ -42,19 +42,19 @@ Setup Your Embassy
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
.. figure:: /_static/images/setup/setup1.svg
:width: 60%
:alt: Fresh Install
4. Select your storage drive. You should only have one drive plugged into your Embassy at this time, but always verify it is what you expect before clicking (such as, is it a 1TB drive?)
.. figure:: /_static/images/setup/setup2.png
.. figure:: /_static/images/setup/setup2.svg
:width: 60%
:alt: Select Drive
5. Create your *permanent* master password and complete setup.
.. figure:: /_static/images/setup/setup3.png
.. figure:: /_static/images/setup/setup3.svg
:width: 60%
:alt: Enter a New Password
@@ -73,7 +73,7 @@ Setup Your Embassy
6. That's it!
.. figure:: /_static/images/setup/setup4.png
.. figure:: /_static/images/setup/setup4.svg
:width: 60%
:alt: Setup Complete
@@ -82,7 +82,7 @@ Your Embassy is now hosted on the private web! After setup is complete you will
Enjoy!
------
.. figure:: /_static/images/setup/setup5.png
.. figure:: /_static/images/setup/setup5.svg
:width: 60%
:alt: Fresh Embassy

View File

@@ -25,4 +25,4 @@ Replacing ``<LAN URL>`` with your Embassy's LAN (``embassy-xxxxxxx.local``) addr
Connecting via SSH on Windows, using PuTTY
------------------------------------------
One of our community members, @brewsbitcoin, has put together this guide for connecting via PuTTY on Windows: https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a
One of our community members, `@brewsbitcoin <https://twitter.com/brewsbitcoin>`_ (https://brewsbitcoin.com/), has put together this `Guide <https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a>`_ for connecting via PuTTY on Windows.

View File

@@ -4,7 +4,7 @@
DIY Guide
=========
.. figure:: /_static/images/diy/pi.png
.. figure:: /_static/images/diy/pi.svg
:width: 40%
:alt: Raspberry Pi
@@ -49,7 +49,7 @@ Hardware: Assembly
#. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`.
.. figure:: /_static/images/diy/pins.png
.. figure:: /_static/images/diy/pins.svg
:width: 60%
:alt: Speaker board spec
@@ -83,7 +83,7 @@ Whether you purchase EmbassyOS from us or build it yourself, you need to flash i
#. Click `Select Target`, then find and select your micro SD card.
#. Click `Flash!` You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal.
.. figure:: /_static/images/diy/balena.png
.. figure:: /_static/images/diy/balena.svg
:width: 60%
:alt: Balena Etcher Dashboard