first sweep

source/user-manuals/embassyos/about.rst

@@ -0,0 +1,7 @@
+*****
+About
+*****
+
+``Embassy ---> About``
+
+This page conatins static information about your device, such as its ID, Tor Address, and hardware specs.

source/user-manuals/embassyos/configure.rst

@@ -0,0 +1,13 @@
+*********
+Configure
+*********
+
+``Embassy ---> Configure``
+
+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%
+  :alt: Embassy Config View
+
+  View of Embassy Config

source/user-manuals/embassyos/developer-options/alt-marketplace.rst

@@ -0,0 +1,16 @@
+.. _alt-marketplace:
+
+***********************
+Alternative Marketplace
+***********************
+
+Embassy OS supports accessing alternative marketplaces by configuring a system file.
+Start9 Labs is not responsible for issues encountered by downloading unverified services from these alternative marketplaces.
+
+After SSHing into the Embassy, run the following commands::
+
+    sudo systemctl stop agent
+    sudo sh -c "echo '<alternative_registry_url>' > /root/agent/alt_registry_url.txt"
+    sudo systemctl start agent
+
+The Embassy is now able to connect to the provided alternative registry.

source/user-manuals/embassyos/developer-options/index.rst

@@ -0,0 +1,9 @@
+*****************
+Developer Options
+*****************
+
+.. toctree::
+  :maxdepth: 2
+
+  ssh-setup
+  alt-marketplace

source/user-manuals/embassyos/developer-options/ssh-setup.rst

@@ -0,0 +1,13 @@
+.. _ssh-setup:
+
+*********
+SSH Setup
+*********
+
+``Embassy ---> 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>``
+
+.. warning:: Adding an SSH key voids the device warranty. This is an advanced feature for developers and should ne used with caution.

source/user-manuals/embassyos/index.rst

@@ -0,0 +1,24 @@
+*********
+EmbassyOS
+*********
+
+You can view and manage your Embassy inside the ``Embassy`` tab in the main menu.
+
+.. figure:: /_static/images/embassy_tab.png
+  :width: 90%
+  :alt: Embassy Menu Tab
+
+  Embassy settings tab in dashboard menu
+
+.. toctree::
+  :maxdepth: 2
+
+  about
+  monitor
+  configure
+  updating
+  wifi
+  developer-options/index
+  power
+  notifications
+  ssl

source/user-manuals/embassyos/monitor.rst

@@ -0,0 +1,13 @@
+*******
+Monitor
+*******
+
+``Embassy ---> Monitor``
+
+Provides real-time statistics, such as temperature, CPU usage, memory and disk space. 
+
+.. figure:: /_static/images/embassy_metrics.png
+  :width: 90%
+  :alt: Embassy Metrics View
+
+  View of Embassy Metrics

source/user-manuals/embassyos/notifications.rst

@@ -0,0 +1,24 @@
+*************
+Notifications
+*************
+
+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
+* successful or failed service backups
+* successful or failed service updates
+
+To delete a notification, slide the notification to the left and click the *trash* icon.
+
+.. figure:: /_static/images/embassy_notifications.png
+  :width: 90%
+  :alt: Embassy Notifications
+
+  All notifications View
+
+.. figure:: /_static/images/embassy_notification.png
+  :width: 90%
+  :alt: Embassy notification alert
+
+  Example notification alerts

source/user-manuals/embassyos/power.rst

@@ -0,0 +1,20 @@
+*****
+Power
+*****
+
+Restart
+=======
+
+#. ``Embassy ---> Restart ---> 'Restart'``.
+#. Be patient while services shut down. A *tune* will play, indicating the powerdown is complete. 
+#. A gentle *bep* will sound when the Embassy is powered back on.
+#. A *chime* will sound when the Embassy is ready to use.
+
+Shutdown
+========
+
+#. ``Embassy ---> Shutdown ---> 'Shutdown'``
+#. Be patient while services shut down. A *tune* will play, indicating the powerdown is complete. 
+#. It is now safe to unplug the Embassy from power and the ethernet cable, if connected.
+
+.. note:: After a shutdown, the *only* way to turn your Embassy back on is to unplug it and plug it back in. As such, we do not recommend shutting down your Embassy when you are not physically near it. Instead, you should use the restart option.

source/user-manuals/embassyos/ssl.rst

@@ -0,0 +1,7 @@
+.. _ssl-setup:
+
+*********
+SSL Setup
+*********
+
+Please follow the setup instructions `here <https://medium.com/@start9labs/embassy-https-certificate-setup-8cd873d7075c>`_.

source/user-manuals/embassyos/updating.rst

@@ -0,0 +1,10 @@
+******************
+Updating EmbassyOS
+******************
+
+``Embassy ---> Check for Updates``
+
+#. If there is an update available, you will be promted to install it.
+#. While updating, your Embassy will emit a gantle chime every 20 seconds.
+
+.. note:: Ensure you have a stable Internet connection, and do not unplug your Embassy during an update. Updates usually complete within a few minutes, but depending on the size of the update and you Internet bandwidth, they can sometimes take up to an hour.

source/user-manuals/embassyos/wifi.rst

@@ -0,0 +1,20 @@
+**********
+WiFi Setup
+**********
+
+``Embassy tab ---> WiFi``
+
+#. Click the ``+`` button in the lower right corner.
+#. Select the appropriate country.
+#. Enter your WiFi SSID and password.
+
+    .. figure:: /_static/images/embassy_wifi.png
+      :width: 90%
+      :alt: Add WiFi
+
+      Add WiFi Network options
+
+#. Save
+    * Clicking *Add* will save the network credentials but not try to connect immediately. This is useful, for example, if you are conncted over Ethernet at home and want to add your office WiFi credentials.
+    * `Add and Connect`.
+#. The saved network will appear in the list when successfully added. If you are successfully connected, the WiFi symbol will be green, at which point, you can safely disconnect the Embassy from your router.

source/user-manuals/services/backups.rst

@@ -0,0 +1,45 @@
+*******
+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.
+
+To begin the backup process:
+
+#. Enter the USB stick provided with the Embassy kit, or any USB drive with enough storage capacity, into a USB port on the device.
+#. Navigate to the `Services` sub menu from the main dashboard menu.
+#. 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
+
+    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
+
+    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
+
+
+#. 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
+
+    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.

source/user-manuals/services/config.rst

@@ -0,0 +1,3 @@
+******
+Config
+******

source/user-manuals/services/dependencies.rst

@@ -0,0 +1,10 @@
+************
+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.
+

source/user-manuals/services/index.rst

@@ -0,0 +1,26 @@
+********
+Services
+********
+
+After you install a service, you can view its instructions by 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.
+
+
+`Bitcoin <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/instructions.md>`_
+
+`Bitwarden <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docs/instructions.md>`_
+
+`Cups <https://github.com/Start9Labs/cups-wrapper/blob/master/docs/instructions.md>`_
+
+`File Browser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/docs/instructions.md>`_
+
+.. toctree::
+  :maxdepth: 2
+
+  updating
+  backups
+  config
+  properties
+  logs
+  dependencies

source/user-manuals/services/logs.rst

@@ -0,0 +1,3 @@
+****
+Logs
+****

source/user-manuals/services/properties.rst

@@ -0,0 +1,5 @@
+**********
+Properties
+**********
+
+These are user initiated configuration properties, typically for credentials such as a password.

source/user-manuals/services/updating.rst

@@ -0,0 +1,11 @@
+********************
+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.