restructure for available services

source/user-manuals/embassyos/general/index.rst

@@ -0,0 +1,20 @@
+*******
+General
+*******
+
+An overview of EmbassyOS general capabilities. 
+
+Features
+========
+
+.. toctree::
+  :maxdepth: 2
+
+  embassy-config
+  updating
+  wifi
+  developer-options/index
+  power
+  notifications
+  ssl
+  forgot-password

source/user-manuals/embassyos/index.rst

@@ -10,14 +10,11 @@ You can view and manage your Embassy inside the ``Embassy`` tab in the main menu
 
   Embassy tab
 
+Features
+========
+
 .. toctree::
   :maxdepth: 2
 
-  embassy-config
-  updating
-  wifi
-  developer-options/index
-  power
-  notifications
-  ssl
-  forgot-password
+  general/index
+  services/index

source/user-manuals/embassyos/services/backups.rst

@@ -0,0 +1,105 @@
+*******
+Backups
+*******
+
+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:
+
+1. Enter the USB stick provided with the Embassy kit, or any USB drive with enough storage capacity, into a USB port on the device.
+2. Navigate to the `Services` sub menu from the main dashboard menu.
+3. Select the service to be backed-up.
+4. 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
+
+  Bitcoin Core Service Sub Menu
+
+5. 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
+
+  Backup menu with available storage space
+
+.. 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
+
+
+6. Enter the master password to encrypt the backup.
+7. "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
+
+  Creating Backup
+
+8. A notification will emit when the backup has successfully completed.
+9. 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
+==================
+
+To begin the backup restore process:
+
+1. Enter the same USB stick used to originally backup the service.
+2. Navigate to the `Services` sub menu from the main dashboard menu.
+3. Select the service to be backed-up.
+4. Select the `Restore from backup` menu item.
+
+.. figure:: /_static/images/restore_backup_menu.png
+  :width: 90%
+  :alt: Restore backup from Services tab
+
+  Restore backup from Services tab
+
+5. In the modal prompt, select the same disc used to originally back up the service. If no option is marked as available, ensure the USB drive is properly inserted.
+
+.. figure:: /_static/images/restore_backup_submenu.png
+  :width: 90%
+  :alt: Restore backup submenu
+
+  Restore backup sub-menu options
+
+6. Note the warning that restoring will wipe current data. 
+
+.. figure:: /_static/images/backup_warning.png
+  :width: 90%
+  :alt: Backup warning message
+
+  Backup warning message
+
+7. Enter the master password to decrypt the backup and select `Restore`.
+
+.. figure:: /_static/images/decrypt_backup.png
+  :width: 90%
+  :alt: Decrypt backup
+
+  Decrypt backup view
+
+8. "Restoring Backup..." will appear on the service sub menu while the restoration is in process.
+
+.. note:: 
+  The service might be momentarily unreachable as it starts back up. This is expected behavior.
+
+.. figure:: /_static/images/restoring_backup.png
+  :width: 90%
+  :alt: Restoring backup
+
+  Restoring backup view
+
+9. A notification will emit when the backup restoration has successfully completed.

source/user-manuals/embassyos/services/index.rst

@@ -0,0 +1,21 @@
+********
+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.
+
+.. note:: Some services require configuration before starting up. You can only connect to and use a service once it is in a *running* state.
+
+Features
+========
+
+.. toctree::
+  :maxdepth: 2
+
+  installing
+  instructions
+  backups
+  service-config
+  properties
+  logs
+  managing-deps

source/user-manuals/embassyos/services/installing.rst

@@ -0,0 +1,30 @@
+*******************
+Install / Uninstall
+*******************
+
+.. note:: Some services have :ref:`dependencies<managing-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.
+
+Installing
+==========
+
+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``
+
+.. 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.
+
+
+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.
+
+
+Uninstalling
+============
+
+To remove a service, navigate to ``Services > [Service Name] > Uninstall``.

source/user-manuals/embassyos/services/instructions.rst

@@ -0,0 +1,19 @@
+************
+Instructions
+************
+
+To view the instructions for a particular service, navigate to ``Services > [Service Name] > Instructions``.
+
+.. figure:: /_static/images/bitcoin_instructions.png
+  :width: 90%
+  :alt: Bitcoin instructions menu item
+
+  Instructions menu item
+
+.. figure:: /_static/images/bitcoin_instructions_view.png
+  :width: 90%
+  :alt: Bitcoin instructions view
+
+  Instructions view
+
+.. note:: For advanced instructions and integration guides, visit the wrapper repository for an :ref:`available service <available-services>`.

source/user-manuals/embassyos/services/logs.rst

@@ -0,0 +1,7 @@
+************
+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 extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all.

source/user-manuals/embassyos/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!

source/user-manuals/embassyos/services/properties.rst

@@ -0,0 +1,13 @@
+**********
+Properties
+**********
+
+``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.

source/user-manuals/embassyos/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 almost 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.