restructure for available services

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

@@ -0,0 +1,21 @@
+***********************
+Alternative Marketplace
+***********************
+
+EmbassyOS supports accessing alternative marketplaces by configuring a system file. Start9 Labs is not responsible for issues encountered by downloading services from alternative marketplaces.
+
+After SSH-ing into the Embassy, run the following commands::
+
+    sudo systemctl stop agent
+    sudo sh -c "echo '<alternative_marketplace_url>' > /root/agent/alt_registry_url.txt"
+    sudo systemctl start agent
+
+The Embassy is now able to connect to the provided alternative registry.
+
+----
+
+To revert this change, simply delete the file::
+
+    sudo systemctl stop agent
+    sudo rm /root/agent/alt_registry_url.txt
+    sudo systemctl start agent

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

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

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

@@ -0,0 +1,12 @@
+.. _ssh-setup:
+
+*********
+SSH Setup
+*********
+
+#. Click ``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:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.

source/user-manuals/embassyos/general/embassy-config.rst

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

source/user-manuals/embassyos/general/forgot-password.rst

@@ -0,0 +1,51 @@
+***************
+Forgot Password
+***************
+
+There is currently no way to reset you Embassy master password through a standard UI flow.
+
+SSH/Linux
+=========
+
+If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR** you have access to a Linux computer, you can reset your Embassy password without losing any data.
+
+* SSH:
+
+  * Use the command line to gain remote access to your Embassy, then run::
+
+      sudo sqlite3 /root/agent/start9_agent.sqlite3
+      delete from account;
+      .quit
+
+  * You can now use the Start9 Setup App to reclaim your Embassy and set a new password.
+
+* Linux computer:
+
+  * Shut down your Embassy, disconnect from power, and remove the microSD card.
+  * Insert the microSD card into your Linux computer and mount the drive::
+
+      mount [drive] [mount folder]
+
+  * Check if you have sqlite3 installed. If not, install it::
+
+      which sqlite3
+      sudo apt install sqlite3
+
+  * Run::
+
+      sudo sqlite3 [mount folder]/root/agent/start9_agent.sqlite3
+      delete from account;
+      .quit
+
+  * Un-mount the microSD card::
+
+      umount [mount folder]
+
+  * Return the microSD card to your Embassy and power it on.
+  * You can now use the Start9 Setup App to reclaim your Embassy and set a new password.
+
+
+No SSH/Linux
+============
+
+The only way to regain access to your Embassy is to :ref:`contact the Start9 dev team<contact>` directly to obtain a new operating system image. This is equivalent to a factory reset; all data will be lost.

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/general/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/general/power.rst

@@ -0,0 +1,18 @@
+*****
+Power
+*****
+
+Restart
+=======
+
+#. Be patient while services shut down. A *tune* will play, indicating the shutdown 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
+========
+
+#. Be patient while services shut down. A *tune* will play, indicating the shutdown 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/general/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/general/updating.rst

@@ -0,0 +1,9 @@
+******************
+Updating EmbassyOS
+******************
+
+#. 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.
+
+.. 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/general/wifi.rst

@@ -0,0 +1,19 @@
+***************
+Setting up WiFi
+***************
+
+#. Click ``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 connected 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.