base docs

source/manual/embassy-one/backups.rst

@@ -0,0 +1,46 @@
+.. _backups:
+
+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/manual/embassy-one/dependencies.rst

@@ -0,0 +1,11 @@
+.. _dependencies:
+
+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/manual/embassy-one/manage.rst

@@ -0,0 +1,34 @@
+.. _manage-device:
+
+Manage device
+=============
+
+The Embassy settings can be managed from the Embassy tab in the main dashboard menu. Here, configuration options can be adjusted and server metrics viewed. 
+
+.. figure:: /_static/images/embassy_tab.png
+    :width: 90%
+    :alt: Embassy Menu Tab
+
+    Embassy settings tab in dashboard menu
+
+Config 
+-------
+
+Currently, the only configurable property is the device name. It can be adjusted by selecting the `Configure` item in Embassy sub menu. Once changed, the new device name will appear in the top left of the main dashboard menu.
+
+.. figure:: /_static/images/embassy_config.png
+    :width: 90%
+    :alt: Embassy Config View
+
+    View of Embassy Config
+
+Metrics
+-------
+
+Accessible via the `Monitor` item in the Embassy sub menu. Real time statistics, such as CPU usage and temperature, stream. Also included are details about memory and disk space. 
+
+.. figure:: /_static/images/embassy_metrics.png
+    :width: 90%
+    :alt: Embassy Metrics View
+
+    View of Embassy Metrics

source/manual/embassy-one/notifications.rst

@@ -0,0 +1,26 @@
+.. _notifications:
+
+View notifications
+==================
+
+Select the `Notifications` tab in the main dashboard menu. A history of all notifications persists here. It also provides further information for failure scenarios. 
+
+.. figure:: /_static/images/embassy_notifications.png
+    :width: 90%
+    :alt: Embassy Notifications
+
+    All notifications View
+
+
+Notifications will be emitted on:
+
+* successful or failed service installations
+* successful or failed service backups
+* successful or failed system updates
+* successful or failed service updates
+
+.. figure:: /_static/images/embassy_notification.png
+    :width: 90%
+    :alt: Embassy notification alert
+
+    Example notification alerts

source/manual/embassy-one/restart.rst

@@ -0,0 +1,11 @@
+.. _restart:
+
+Restart
+=======
+
+#. Open the Embassy dashboard using its Tor address.
+#. Access the Embassy tab from the main menu
+#. Select `Restart` from the sub menu
+#. A tune will play (mario death song), indicating the restart has been initiated. 
+#. A bep will sound when the Embassy is powered back on.
+#. A chime (mario coin chime) will sound when the Embassy is ready to use.

source/manual/embassy-one/services.rst

@@ -0,0 +1,20 @@
+.. _installing-services:
+
+Installing services
+===================
+
+Visit the marketplace from the Embassy dashboard menu. Select a service to download. When the service has finished installing, a notification will appear when complete. 
+
+Services can be viewed in the Services tab in the dashboard menu. Selecting a service here allows you to:
+
+#. View the instructions:
+
+   * Details on what the service is and how to use it. Any gotchas, special options, or gaps in functionality are noted here.
+
+#. Supply configuration options:
+
+   * Some services require input to configure the service before running. This could be entering a password, enabling certain features, or confirming the default options.
+
+#. Run the service:
+
+   * A service will not be started when downloaded. This will need to be user initiated. Once a service has been configured, the option to start the service will appear. After it is started, the service is available for you to use.

source/manual/embassy-one/shutdown.rst

@@ -0,0 +1,11 @@
+.. _shutdown:
+
+Shutdown
+========
+
+#. Open the Embassy dashboard using its Tor address.
+#. Access the Embassy tab from the main menu
+#. Select `Shutdown` from the sub menu
+#. Wait for the Embassy to shut down, typically about 1 minute. The dashboard will no longer be accessible from the browser.
+#. It is now safe to unplug the Embassy from power and the ethernet cable, if connected.
+#. To turn it back on, plug the Embassy back into the power supply and wait for it to bep and chime (mario coin chime). 

source/manual/embassy-one/ssl.rst

@@ -0,0 +1,10 @@
+.. _ssl-setup:
+
+SSL Setup
+=========
+
+This advanced feature will be enabled soon. Then, users can download the SSL root certificate to a device and follow the setup instructions `here <https://medium.com/@start9labs/embassy-https-certificate-setup-8cd873d7075c>`_.
+
+In depth
+--------
+Check out the :ref:`ssl-concept` concept guide for a deeper dive.

source/manual/embassy-one/upgrade.rst

@@ -0,0 +1,27 @@
+.. _upgrading:
+
+Upgrading
+=========
+
+Embassy OS
+----------
+Visit the Embassy tab from the Dashboard menu. Select “Check for Upgrades”. Clicking this will reach out to the marketplace to see if a new OS update has been released, and will indicate if it has. You can then update and get access to new features and bug fixes. 
+
+Services
+--------
+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.
+
+Config
+^^^^^^
+These are configuration options that can be changed at any time. When a service is in `Needs Config` status, it requires user input to complete setup before the service can be started. 
+
+Properties
+^^^^^^^^^^
+These are user initiated configuration properties, typically for credentials such as a password.
+

source/manual/embassy-one/wifi.rst

@@ -0,0 +1,24 @@
+.. _connecting-wifi:
+
+Connecting to WiFi
+==================
+
+#. Once logged into your Embassy dashboard, access the Embassy tab from the dashboard menu. 
+#. Navigate to the `WiFi` section. 
+#. Obtain the WiFi network name and password.
+#. Click the (+) button in the lower right corner to add a network with the gathered credentials.
+
+.. figure:: /_static/images/embassy_wifi.png
+    :width: 90%
+    :alt: Add WiFi menu
+
+    Add WiFi Network options
+
+#. Select the appropriate country to ensure the proper protocol is used.
+#. Click `Add and Connect`. 
+#. The saved network will appear in the list when successfully added. At this point, you can disconnect the Embassy from your router.
+
+If the Embassy relocates or needs to change WiFi networks, it can be connected into the new router’s ethernet jack and powered on to complete this process again.
+
+.. note::
+    The network speeds (and other server metrics) can be monitored within the Embassy dashboard.