Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-04-04 14:29:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

add new services, reformat some things

Browse Source
This commit is contained in:
Matt Hill
2020-12-05 21:47:36 -07:00
parent 557c9040a1
commit f3daf23c52
25 changed files with 91 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
source/user-manuals/embassyos/general/developer-options/ssh-setup.rst
View File

@@ -4,9 +4,11 @@
SSH Setup
*********
#. Click ``Developer Options > SSH Keys``
#. Navigate to *Developer Options > SSH Keys*
#. Click the ``+`` button in the lower right hand corner.
#. Paste in your SSH key.
#. You can now access your Embassy from the command line using ``ssh pi@<LAN URL>``
#. You can now access your Embassy from the command line using::
ssh pi@<LAN URL>
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.

2
source/user-manuals/embassyos/general/embassy-config.rst
View File

@@ -2,7 +2,7 @@
Config Options
**************
Click ``config``. Here you can set custom configurations for your Embassy. Currently, changing the ``Device Name`` is the only option.
Click "Config". Here you can set custom configurations for your Embassy. Currently, changing the Device Name is the only option.
.. figure:: /_static/images/embassy_config.png
:width: 90%

2
source/user-manuals/embassyos/general/notifications.rst
View File

@@ -2,7 +2,7 @@
Notifications
*************
You can view and manage your Notifications inside the ``Notifications`` tab in the main menu. They include:
You can view and manage your Notifications inside the "Notifications" tab in the main menu. They include:
* successful or failed EmbassyOS updates
* successful or failed service installations

12
source/user-manuals/embassyos/general/secure-lan/browser.rst
View File

@@ -11,15 +11,13 @@ Brave
1. Navigate to your Brave Settings in a new tab.
2. On the left hand sidebar, select ``Additional Settings > Privacy and Security``.
2. On the left hand sidebar, navigate to *Additional Settings > Privacy and Security*.
3. Add the bottom of the section, select "Manage Certificates".
.. figure:: /_static/images/ssl/browser/brave_security_settings.png
:width: 90%
:alt: Brave security settings
Brave privacy and security settings page
:alt: Brave privacy and security settings page
4. 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.
@@ -27,9 +25,7 @@ Brave
.. figure:: /_static/images/ssl/browser/brave_view_certs.png
:width: 90%
:alt: Brave manage certs
Brave Manage Certificates sub-menu on MacOS
:alt: Brave Manage Certificates sub-menu on MacOS
6. Obtain the LAN address provided in the Setup App and enter it in a new tab.
@@ -63,7 +59,7 @@ Firefox
4. Select the "Authorities" tab from the "Certificate Manager".
5. 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>`.
5. 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>`.
6. When prompted, check “Trust this CA to identity websites” and select “OK”.

14
source/user-manuals/embassyos/general/secure-lan/desktop.rst
View File

@@ -9,7 +9,7 @@ MacOS
2. Navigate to a :ref:`Tor enabled browser <connecting>`.
3. Your browser might display a warning screen. You can typically navigate to ``Advanced > Accept the risk and continue``.
3. Your browser might display a warning screen. You can typically navigate to *Advanced > Accept the risk and continue*.
4. Allow the page to load with your Tor address over HTTP. Using HTTPS is less performant and unnecessary because Tor v3 is self authenticating.
@@ -49,9 +49,9 @@ MacOS
Keychain access import menu
If the keychain console did not open, press ``Command + spacebar`` and type “Keychain Access”, and hit enter to open it.
If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it.
11. Navigate to the “System” tab and find the certificate entitled “Embassy Local Root CA”.
11. Navigate to the "System" tab and find the certificate entitled “Embassy Local Root CA”.
12. Double click on this certificate. A second window will pop up.
@@ -82,7 +82,7 @@ Windows
2. Navigate to a :ref:`Tor enabled browser <connecting>`.
3. Your browser might display a warning screen. You can typically navigate to ``Advanced > Accept the risk and continue``.
3. Your browser might display a warning screen. You can typically navigate to *Advanced > Accept the risk and continue*.
4. Allow the page to load with your Tor address over HTTP. Using HTTPS is less performant and unnecessary because Tor v3 is self authenticating.
@@ -106,7 +106,7 @@ Windows
Select the "SSL Certificate" sub menu download icon
9. Select the option to save the ``Embassy Local CA.crt`` file.
9. Select the option to save the *Embassy Local CA.crt* file.
.. figure:: /_static/images/ssl/windows/windows_download_cert.png
:width: 90%
@@ -124,7 +124,7 @@ Windows
Access the Windows Management Console
12. When the Management Console opens, navigate to ``File > Add/Remove Snap-in``.
12. When the Management Console opens, navigate to *File > Add/Remove Snap-in*.
.. figure:: /_static/images/ssl/windows/2_windows_console_root.png
:width: 90%
@@ -158,7 +158,7 @@ Windows
Access Certificates in Management Console
17. Right click on “Certificates”, then select ``All Tasks > Import``.
17. Right click on “Certificates”, then navigate to *All Tasks > Import*.
.. figure:: /_static/images/ssl/windows/6_windows_import_cert.png
:width: 90%

6
source/user-manuals/embassyos/general/secure-lan/index.rst
View File

@@ -8,7 +8,7 @@ EmbassyOS has ability to securely access your Embassy over HTTPS from any browse
The following guides will take you through the steps to install and trust the SSL certificate generated from your Embassy.
First, determine your current version of EmbassyOS from the menu at ``Embassy > About > EmbassyOS Version``.
First, determine your current version of EmbassyOS, found in *Embassy > About > EmbassyOS Version*.
.. figure:: /_static/images/embassy_version.png
:width: 90%
@@ -18,10 +18,10 @@ First, determine your current version of EmbassyOS from the menu at ``Embassy >
.. warning::
For EmbassyOS versions ``<0.2.5``, please follow the setup instructions on this `blog post <https://medium.com/@start9labs/embassy-https-certificate-setup-8cd873d7075c>`_.
For EmbassyOS versions <0.2.5, please follow the setup instructions on this `blog post <https://medium.com/@start9labs/embassy-https-certificate-setup-8cd873d7075c>`_.
For EmbassyOS versions ``>=0.2.5``, continue completing the setup for your device operating system:
For EmbassyOS versions >=0.2.5, continue completing the setup for your device operating system:
.. toctree::
:maxdepth: 2

4
source/user-manuals/embassyos/general/secure-lan/mobile.rst
View File

@@ -43,7 +43,7 @@ iOS
General settings
7. Navigate to ``General > Profile(s) > Downloaded Profile > Install``.
7. Navigate to *General > Profile(s) > Downloaded Profile > Install*.
.. figure:: /_static/images/ssl/mobile/ssl_ipad_profiles.png
:width: 90%
@@ -59,7 +59,7 @@ iOS
8. Select “yes” to any warning prompts.
9. Next, navigate to ``General > About > Certificate Trust Settings``.
9. Next, navigate to *General > About > Certificate Trust Settings*.
.. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.png
:width: 90%

2
source/user-manuals/embassyos/general/updating.rst
View File

@@ -2,7 +2,7 @@
Updating EmbassyOS
******************
#. Click ``Check for Updates``
#. Click "Check for Updates"
#. If there is an update available, you will be prompted to install it.
#. While updating, your Embassy will emit a gentle chime every 20 seconds.

2
source/user-manuals/embassyos/general/wifi.rst
View File

@@ -2,7 +2,7 @@
Setting up WiFi
***************
#. Click ``WiFi``.
#. Click "WiFi".
#. Click the ``+`` button in the lower right corner.
#. Select the appropriate country.
#. Enter your WiFi SSID and password.