diff --git a/source/user-manuals/embassyos/developer-options/alt-marketplace.rst b/source/user-manuals/embassyos/developer-options/alt-marketplace.rst index 1cb678c..4bb4d8d 100644 --- a/source/user-manuals/embassyos/developer-options/alt-marketplace.rst +++ b/source/user-manuals/embassyos/developer-options/alt-marketplace.rst @@ -10,7 +10,13 @@ Start9 Labs is not responsible for issues encountered by downloading unverified After SSHing into the Embassy, run the following commands:: sudo systemctl stop agent - sudo sh -c "echo '' > /root/agent/alt_registry_url.txt" + sudo sh -c "echo '' > /root/agent/alt_registry_url.txt" sudo systemctl start agent -The Embassy is now able to connect to the provided alternative registry. \ No newline at end of file +The Embassy is now able to connect to the provided alternative registry. + +---- + +To revert this change, simply delete the file:: + + sudo rm /root/agent/alt_registry_url.txt \ No newline at end of file diff --git a/source/user-manuals/embassyos/configure.rst b/source/user-manuals/embassyos/embassy-config.rst similarity index 85% rename from source/user-manuals/embassyos/configure.rst rename to source/user-manuals/embassyos/embassy-config.rst index c98e323..077c4e3 100644 --- a/source/user-manuals/embassyos/configure.rst +++ b/source/user-manuals/embassyos/embassy-config.rst @@ -1,6 +1,6 @@ -********* -Configure -********* +************** +Embassy Config +************** ``Embassy ---> Configure`` diff --git a/source/user-manuals/embassyos/index.rst b/source/user-manuals/embassyos/index.rst index bff948c..a9c7b4c 100644 --- a/source/user-manuals/embassyos/index.rst +++ b/source/user-manuals/embassyos/index.rst @@ -8,14 +8,14 @@ You can view and manage your Embassy inside the ``Embassy`` tab in the main menu :width: 90% :alt: Embassy Menu Tab - Embassy settings tab in dashboard menu + Embassy tab .. toctree:: :maxdepth: 2 about monitor - configure + embassy-config updating wifi developer-options/index diff --git a/source/user-manuals/services/backups.rst b/source/user-manuals/services/backups.rst index d1eccd6..520dd80 100644 --- a/source/user-manuals/services/backups.rst +++ b/source/user-manuals/services/backups.rst @@ -2,7 +2,13 @@ Backups ******* -The Embassy supports encrypted backups of installed services to an external USB drive. Encryption utilizes the master password, so memorization of only one password is necessary. +Creating frequent service backups is critical. If anything happens to your Embassy, these backups are you only path to recovering your data. + +.. warning:: Backups are encrypted using your Embassy master password. If you forget your password, you lose your backups. + + +Creating A Backup +================= To begin the backup process: @@ -11,35 +17,39 @@ To begin the backup process: #. Select the service to be backed-up. #. Select the floppy disc icon next to the `Last Backup` menu item. If a backup was never completed, this should say "never". -.. figure:: /_static/images/bitcoin_view.png - :width: 90% - :alt: Bitcoin Core Service Sub Menu + .. figure:: /_static/images/bitcoin_view.png + :width: 90% + :alt: Bitcoin Core Service Sub Menu - Bitcoin Core Service Sub Menu + Bitcoin Core Service Sub Menu #. In the modal prompt, select the available disc space. If no option is marked as available, ensure the USB drive has enough space and that it is properly inserted. -.. figure:: /_static/images/bitcoin_backup_view_storage.png - :width: 90% - :alt: Bitcoin Core Service Backup Storage + .. figure:: /_static/images/bitcoin_backup_view_storage.png + :width: 90% + :alt: Bitcoin Core Service Backup Storage - Backup menu with available storage space + Backup menu with available storage space -.. figure:: /_static/images/bitcoin_backup_view_no_storage.png - :width: 90% - :alt: Bitcoin Core Service Backup No Storage + .. figure:: /_static/images/bitcoin_backup_view_no_storage.png + :width: 90% + :alt: Bitcoin Core Service Backup No Storage - Backup menu with no available storage disc + Backup menu with no available storage disc #. Enter the master password to encrypt the backup. #. "Creating Backup..." will appear on the service sub menu while the backup is in process. -.. figure:: /_static/images/bitcoin_creating_backup.png - :width: 90% - :alt: Bitcoin Core Service Backup No Storage + .. figure:: /_static/images/bitcoin_creating_backup.png + :width: 90% + :alt: Bitcoin Core Service Backup No Storage - Creating Backup + Creating Backup #. A notification will emit when the backup has successfully completed. -#. The `Last Backup` menu item in the service will now indicate the date and time at which the last backup was made. \ No newline at end of file +#. The `Last Backup` menu item in the service will now indicate the date and time at which the last backup was made. + + +Restoring A Backup +================== \ No newline at end of file diff --git a/source/user-manuals/services/config.rst b/source/user-manuals/services/config.rst deleted file mode 100644 index 6172410..0000000 --- a/source/user-manuals/services/config.rst +++ /dev/null @@ -1,3 +0,0 @@ -****** -Config -****** \ No newline at end of file diff --git a/source/user-manuals/services/dependencies.rst b/source/user-manuals/services/dependencies.rst deleted file mode 100644 index 1e13224..0000000 --- a/source/user-manuals/services/dependencies.rst +++ /dev/null @@ -1,10 +0,0 @@ -************ -Dependencies -************ - -Some services require a dependency on another service. For example, in order to run Lightning, Bitcoin also needs to be installed and running on the Embassy - Bitcoin is a *depencency* of Lightning. - -Dependency management is complicated. Managing the installation of dependent software is something a computer's operating system does well behind the scenes and with little user input. In this sense, it is not very transparent. Start9 has opted to take a transparency first approach by generating a user interface that supplies awareness to required dependencies. As such, input is required to opt in to such installations, and nothing will be installed on the Embassy without the user's knowledge. Furthermore, Start9 has made it supremely easy by making a one click install for all services and their associated dependencies. - -Dependencies can be required, optional, or dependently-optional, such as if a particular subset of features on a service want to be enabled. All of this information is presented upfront to the user before a service is installed to demonstrate transparency. As always, the user is in control of what is running on their Embassy. - diff --git a/source/user-manuals/services/index.rst b/source/user-manuals/services/index.rst index 10637f6..fe25910 100644 --- a/source/user-manuals/services/index.rst +++ b/source/user-manuals/services/index.rst @@ -2,7 +2,7 @@ Services ******** -After you install a service, you can view its instructions by navigating to ``Services ---> [Service Name] ---> Instructions`` +To view the instructions for a particular service, navigating to ``Services ---> [Service Name] ---> Instructions`` .. note:: Some services require configuration before starting up. You can only connect to and use a service once it is in a *running* state. @@ -18,9 +18,9 @@ After you install a service, you can view its instructions by navigating to ``Se .. toctree:: :maxdepth: 2 - updating + installing backups - config + service-config properties logs - dependencies \ No newline at end of file + managing-deps \ No newline at end of file diff --git a/source/user-manuals/services/installing.rst b/source/user-manuals/services/installing.rst new file mode 100644 index 0000000..2e30592 --- /dev/null +++ b/source/user-manuals/services/installing.rst @@ -0,0 +1,30 @@ +******************* +Adding and Removing +******************* + +.. note:: Some services have :ref:`dependencies` on other services. Adding, updating, or removing a service can sometimes have requirements or consequences for other services. Your Embassy will inform you of these issues along the way. + +Adding +====== + +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 shoud take between 60 seconds and a few minutes. + +After installtion, 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` complete, and is in a *running* state. + + +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. + + +Removing +======== + +To remove a service, navigate to ``Services ---> [Service Name] ---> Uninstall``. \ No newline at end of file diff --git a/source/user-manuals/services/logs.rst b/source/user-manuals/services/logs.rst index ce2d46e..60da215 100644 --- a/source/user-manuals/services/logs.rst +++ b/source/user-manuals/services/logs.rst @@ -1,3 +1,7 @@ -**** -Logs -**** \ No newline at end of file +************ +Viewing Logs +************ + +``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 extremeley useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all. \ No newline at end of file diff --git a/source/user-manuals/services/managing-deps.rst b/source/user-manuals/services/managing-deps.rst new file mode 100644 index 0000000..8a2ae0e --- /dev/null +++ b/source/user-manuals/services/managing-deps.rst @@ -0,0 +1,13 @@ +.. _managing dependencies: + +********************* +Managing Dependencies +********************* + +Some services have dependencies on other services. A service may even require its dependency to be *configured* in a particular way. + +Traditionally, managing dependencies was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary dependency management system makes the process transparent and simple. + +If a service has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy will inform you and offer solutions. + +Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. But that does not necessarily mean you need to have Bitcoin installed on your Embassy. You could just as easily configure Lightning to use another Bitcoin node located somewhere else! diff --git a/source/user-manuals/services/properties.rst b/source/user-manuals/services/properties.rst index fb84ee1..f094118 100644 --- a/source/user-manuals/services/properties.rst +++ b/source/user-manuals/services/properties.rst @@ -2,4 +2,12 @@ Properties ********** -These are user initiated configuration properties, typically for credentials such as a password. \ No newline at end of file +``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. + +Properties may be accompanied by one or more of the following: + +* a *help* icon for further explanation. +* a *copy* icon for copying the value to your clipboard. +* a *QR* icon for viewing the value as a QR code. \ No newline at end of file diff --git a/source/user-manuals/services/service-config.rst b/source/user-manuals/services/service-config.rst new file mode 100644 index 0000000..a2e7910 --- /dev/null +++ b/source/user-manuals/services/service-config.rst @@ -0,0 +1,13 @@ +.. _service-config: + +************** +Service Config +************** + +``Services ---> [Service Name] ---> Config`` + +After installation or update, some services require configuration before they can be started. + +Traditionally, configuring services was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary service config system makes the process transparent, simple, and safe. + +Config options are defined by the service developer and can be alomst anything. They are represented as simple UI elements - such as toggles and drop downs - and they include explanations and validations, such that users understand their purpose and are prevented from making mistakes. \ No newline at end of file diff --git a/source/user-manuals/services/updating.rst b/source/user-manuals/services/updating.rst deleted file mode 100644 index 2932f37..0000000 --- a/source/user-manuals/services/updating.rst +++ /dev/null @@ -1,11 +0,0 @@ -******************** -Updating/Downgrading -******************** - -Visit the Marketplace tab from the Dashboard menu. Each service will denote a status, such as: - -* Not Installed -* Installed -* Update Available - -If Update Available is denoted as the option, select the service you are interested in updating, and click the green update button on the service page in the Marketplace. \ No newline at end of file