mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 04:01:59 +00:00
add new services, reformat some things
This commit is contained in:
@@ -4,12 +4,21 @@
|
||||
Available Services
|
||||
******************
|
||||
|
||||
A list of currently released services for EmbassyOS. Links to the wrapper repository that contains advanced instructions and integration guides.
|
||||
A list of currently released services for EmbassyOS. Links to the wrapper repository that contains advanced instructions and integration guides.
|
||||
|
||||
`Bitcoin <https://github.com/Start9Labs/bitcoind-wrapper>`_
|
||||
Bitcoin-related services
|
||||
========================
|
||||
|
||||
`Bitwarden <https://github.com/Start9Labs/bitwarden-wrapper>`_
|
||||
* `Bitcoin <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs>`_
|
||||
* `Bitcoin Proxy <https://github.com/Start9Labs/btc-rpc-proxy-wrapper/tree/master/docs>`_
|
||||
* `Lightning Network Daemon (LND) <https://github.com/Start9Labs/lnd-wrapper/tree/master/docs>`_
|
||||
* `c-lightning <https://github.com/Start9Labs/c-lightning-wrapper/tree/master/docs>`_
|
||||
* `Ride the Lightning (RTL) <https://github.com/Start9Labs/ride-the-lightning-wrapper/tree/master/docs>`_
|
||||
* `Spark Wallet <https://github.com/Start9Labs/spark-wallet-wrapper/tree/master/docs>`_
|
||||
|
||||
`Cups <https://github.com/Start9Labs/cups-wrapper>`_
|
||||
Other services
|
||||
==============
|
||||
|
||||
`File Browser <https://github.com/Start9Labs/filebrowser-wrapper>`_
|
||||
* `Bitwarden <https://github.com/Start9Labs/bitwarden-wrapper/tree/master/docs>`_
|
||||
* `Cups <https://github.com/Start9Labs/cups-wrapper/tree/master/docs>`_
|
||||
* `File Browser <https://github.com/Start9Labs/filebrowser-wrapper/tree/master/docs>`_
|
||||
@@ -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,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,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
|
||||
|
||||
@@ -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”.
|
||||
|
||||
|
||||
@@ -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%
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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,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,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.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
EmbassyOS
|
||||
*********
|
||||
|
||||
You can view and manage your Embassy inside the ``Embassy`` tab in the main menu.
|
||||
You can view and manage your Embassy inside the "Embassy" tab in the main menu.
|
||||
|
||||
.. figure:: /_static/images/embassy_tab.png
|
||||
:width: 90%
|
||||
@@ -17,4 +17,4 @@ Features
|
||||
:maxdepth: 2
|
||||
|
||||
general/index
|
||||
services/index
|
||||
using-services/index
|
||||
@@ -1,6 +1,6 @@
|
||||
********
|
||||
Services
|
||||
********
|
||||
**************
|
||||
Using Services
|
||||
**************
|
||||
|
||||
Services are self-hosted, open source projects made compatible for EmbassyOS. Each service is has been independently developed by members of the open source community. The Embassy enables configuration, customization and a one click install.
|
||||
|
||||
@@ -7,11 +7,11 @@ Install / Uninstall
|
||||
Installing
|
||||
==========
|
||||
|
||||
To add a new service, find it's listing inside the Service Marketplace: ``Marketplace > [Service Name] > Install``.
|
||||
To add a new service, find it's listing inside the Service Marketplace: *Marketplace > [Service Name] > Install*.
|
||||
|
||||
Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.
|
||||
|
||||
After installation, you can view the service's instructions by navigating to ``Services > [Service Name] > Instructions``
|
||||
After installation, you can view the service's instructions by navigating to *Services > [Service Name] > Instructions*
|
||||
|
||||
.. note:: You can only start and use a service once its dependencies are met, its :ref:`configuration<service-config>` complete, and is in a *running* state.
|
||||
|
||||
@@ -21,10 +21,10 @@ Updating
|
||||
|
||||
To see if an update is available for a service, you can click the *refresh* button inside the dashboard of the installed service or by visiting its listing in the Service Marketplace.
|
||||
|
||||
If an update is available, simply click ``Update`` and confirm the action.
|
||||
If an update is available, simply click "Update" and confirm the action.
|
||||
|
||||
|
||||
Uninstalling
|
||||
============
|
||||
|
||||
To remove a service, navigate to ``Services > [Service Name] > Uninstall``.
|
||||
To remove a service, navigate to *Services > [Service Name] > Uninstall*.
|
||||
@@ -2,7 +2,7 @@
|
||||
Instructions
|
||||
************
|
||||
|
||||
To view the instructions for a particular service, navigate to ``Services > [Service Name] > Instructions``.
|
||||
To view the instructions for a particular service, navigate to *Services > [Service Name] > Instructions*.
|
||||
|
||||
.. figure:: /_static/images/bitcoin_instructions.png
|
||||
:width: 90%
|
||||
@@ -2,6 +2,6 @@
|
||||
Viewing Logs
|
||||
************
|
||||
|
||||
``Services > [Service Name] > Logs``
|
||||
Naviage to *Services > [Service Name] > Logs*
|
||||
|
||||
Every service emits logs while it is in a *running* state. Logs give an *under-the-hood* glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all.
|
||||
@@ -2,7 +2,7 @@
|
||||
Properties
|
||||
**********
|
||||
|
||||
``Services > [Service Name] > Properties``
|
||||
Navigate to *Services > [Service Name] > Properties*
|
||||
|
||||
Properties are both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Service Config
|
||||
**************
|
||||
|
||||
``Services > [Service Name] > Config``
|
||||
Navigate to *Services > [Service Name] > Config*
|
||||
|
||||
After installation or update, some services require configuration before they can be started.
|
||||
|
||||
Reference in New Issue
Block a user