Restructure 'complete'

This commit is contained in:
kn0wmad
2021-12-06 11:21:50 -07:00
committed by Lucy Cifferello
parent 03d33ca4ec
commit 4b8c1a98f7
127 changed files with 1188 additions and 2783 deletions

View File

@@ -0,0 +1,7 @@
.. _backup:
******************
Backing Up Embassy
******************
Lorem Ipsum

View File

@@ -8,4 +8,7 @@ An overview of EmbassyOS general capabilities.
:maxdepth: 2
overview
power
updating
backup
password

View File

@@ -0,0 +1,46 @@
.. _overview:
*********************
Overview of EmbassyOS
*********************
.. _services:
Services Tab
============
.. _embassy:
Embassy Tab
===========
.. _marketplace:
Marketplace Tab
===============
.. _notifications:
Notifications Tab
=================
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

View File

@@ -0,0 +1,76 @@
.. _password:
***************
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 SSH access to your Embassy::
ssh pi@start9-[network-id].local
* Check if you have sqlite3 installed. If not, install it::
which sqlite3
sudo apt install sqlite3
* Access the sqlite3 terminal::
sudo sqlite3 /root/agent/start9_agent.sqlite3
* Run::
delete from account;
.quit
* Exit the SSH session::
exit
* You can now use the Start9 Setup App to reclaim your Embassy and set a new password.
.. warning:: Running setup process will generate new certificate and Tor address for your Embassy.
* 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
* Access the sqlite3 terminal::
sudo sqlite3 /root/agent/start9_agent.sqlite3
* Run::
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.
.. warning:: Running setup process will generate new certificate and Tor address for your Embassy.
No SSH/Linux
============
You must factory reset your device by re-installing EmbassyOS, resulting in permanent loss of data. Visit the `image downloader <https://images.start9labs.com/download>`_ to obtain a new EmbassyOS image, then follow the `installation instructions </getting-started/diy.html#installing-embassyos>`_.

View File

@@ -0,0 +1,20 @@
.. _power:
*****
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.

View File

@@ -0,0 +1,13 @@
.. _updating:
******************
Updating EmbassyOS
******************
#. Navigate to ``Menu > Embassy``
#. 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.
#. You can also enable automatic check for updates in the :ref:`Embassy config <auto-update>` tab.
.. 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 your Internet bandwidth, they can sometimes take up to an hour.