mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-02 05:23:18 +00:00
Several updates
This commit is contained in:
kn0wmad
@@ -1,46 +1,57 @@
|
||||
.. _backup:
|
||||
|
||||
******************
|
||||
==================
|
||||
Backing Up Embassy
|
||||
******************
|
||||
==================
|
||||
|
||||
There are 2 options for backing up your Embassy and all its service data. You can setup a shared folder on a remote machine, such as a laptop or desktop, or you can backup to a local drive, which must be externally powered or plugged into a powered USB hub before plugging into Embassy.
|
||||
|
||||
Remote Backups
|
||||
==============
|
||||
--------------
|
||||
|
||||
Linux
|
||||
-----
|
||||
=====
|
||||
|
||||
#. IYKYK
|
||||
|
||||
Mac
|
||||
---
|
||||
===
|
||||
|
||||
go to system settings
|
||||
click sharing
|
||||
click file sharing
|
||||
click the + under shared folders
|
||||
add a folder
|
||||
click options
|
||||
enable Windows file sharing for the user you would like to use to authenticate
|
||||
click done
|
||||
enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui
|
||||
enter the name of the folder as shown in the shared folders section as the path
|
||||
enter your macbook username and password for the user that you enabled windows file sharing for
|
||||
#. go to system settings
|
||||
#. click sharing
|
||||
#. click file sharing
|
||||
#. click the + under shared folders
|
||||
#. add a folder
|
||||
#. click options
|
||||
#. enable Windows file sharing for the user you would like to use to authenticate
|
||||
#. click done
|
||||
#. enter the name of your macbook, as shown in the computer name field at the top of the sharing page into the hostname field in embassy ui
|
||||
#. enter the name of the folder as shown in the shared folders section as the path
|
||||
#. enter your macbook username and password for the user that you enabled windows file sharing for
|
||||
|
||||
Windows
|
||||
-------
|
||||
=======
|
||||
|
||||
Create a folder
|
||||
Right click the folder
|
||||
select "properties"
|
||||
click the share tab
|
||||
click share...
|
||||
select a user you want to use for login, or select everyone
|
||||
click share
|
||||
enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui)
|
||||
enter the path that is shown after the hostname in the windows ui into the path field
|
||||
enter your username for the windows computer
|
||||
enter the password for the windows computer
|
||||
#. Create a folder
|
||||
#. Right click the folder
|
||||
#. select "properties"
|
||||
#. click the share tab
|
||||
#. click share...
|
||||
#. select a user you want to use for login, or select everyone
|
||||
#. click share
|
||||
#. enter your computer name into the hostname field in embassy ui (the name is shown after a \\ in the windows ui)
|
||||
#. enter the path that is shown after the hostname in the windows ui into the path field
|
||||
#. enter your username for the windows computer
|
||||
#. enter the password for the windows computer
|
||||
|
||||
Local Backups
|
||||
=============
|
||||
-------------
|
||||
|
||||
Linux
|
||||
=====
|
||||
|
||||
Mac
|
||||
===
|
||||
|
||||
Windows
|
||||
=======
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
***********
|
||||
===========
|
||||
Walkthrough
|
||||
***********
|
||||
===========
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
@@ -8,7 +8,6 @@ An overview of EmbassyOS general capabilities.
|
||||
:maxdepth: 2
|
||||
|
||||
overview
|
||||
power
|
||||
updating
|
||||
updates
|
||||
backup
|
||||
password
|
||||
|
||||
@@ -1,46 +1,80 @@
|
||||
.. _overview:
|
||||
|
||||
*********************
|
||||
Overview of EmbassyOS
|
||||
*********************
|
||||
=====================
|
||||
Overview of EmbassyOS - ***NEED SCREENSHOTS / DETAILS***
|
||||
=====================
|
||||
|
||||
.. _services-tab:
|
||||
|
||||
Services Tab
|
||||
============
|
||||
------------
|
||||
|
||||
The Services Tab will show you all of your currently installed :ref:`Services<services>`, or in the case of a fresh install, no Services.
|
||||
|
||||
Services
|
||||
========
|
||||
|
||||
.. _embassy-tab:
|
||||
|
||||
Embassy Tab
|
||||
===========
|
||||
-----------
|
||||
|
||||
The Embassy Tab is where you can perform :ref:`Backups<backups>`, get Insights into EOS, change some basic Settings, and Power cycle your device if necessary.
|
||||
|
||||
Backups
|
||||
=======
|
||||
|
||||
Do the backups
|
||||
|
||||
Insights
|
||||
========
|
||||
|
||||
Get the insights
|
||||
|
||||
Settings
|
||||
========
|
||||
|
||||
Set the things
|
||||
|
||||
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. Please be patient as a Restart will take some time.
|
||||
|
||||
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.
|
||||
|
||||
.. _marketplace-tab:
|
||||
|
||||
Marketplace Tab
|
||||
===============
|
||||
---------------
|
||||
|
||||
The Marketplace Tab is obviously the home of the Marketplace, where you can install new Services, or manange existing ones.
|
||||
|
||||
Marketplace
|
||||
===========
|
||||
|
||||
.. _notifications-tab:
|
||||
|
||||
Notifications Tab
|
||||
=================
|
||||
-----------------
|
||||
|
||||
You can view and manage your Notifications inside the "Notifications" tab in the main menu. They include:
|
||||
The Notifications Tab is where you can view and manage Notifications produced by EOS and your Services
|
||||
|
||||
Notifications
|
||||
=============
|
||||
|
||||
* 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
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
.. _forgot-password:
|
||||
|
||||
===============
|
||||
Forgot Password
|
||||
Forgot Password - ***NEEDS UPDATING***
|
||||
===============
|
||||
|
||||
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.
|
||||
|
||||
@@ -21,7 +21,7 @@ If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR
|
||||
|
||||
which sqlite3
|
||||
sudo apt install sqlite3
|
||||
|
||||
|
||||
* Access the sqlite3 terminal::
|
||||
|
||||
sudo sqlite3 /root/agent/start9_agent.sqlite3
|
||||
@@ -71,6 +71,6 @@ If you already have :ref:`SSH keys registered with your Embassy<ssh-setup>` **OR
|
||||
|
||||
|
||||
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>`_.
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
.. _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. Please be patient as a Restart will take some time.
|
||||
|
||||
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.
|
||||
32
source/user-manual/walkthrough/updates.rst
Normal file
32
source/user-manual/walkthrough/updates.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
.. _updates:
|
||||
|
||||
========
|
||||
Updating
|
||||
========
|
||||
|
||||
Keeping current on Updates ensures a fast and secure system.
|
||||
|
||||
.. _update-eos:
|
||||
|
||||
Updating EmbassyOS
|
||||
------------------
|
||||
|
||||
When an Operating System update is available, a big, beautiful banner will appear in the Marketplace as an announcement. Simply click on this and follow the UI flow to update EmbassyOS. It is recommended to keep EOS up to date for the latest security and performance patches, as well as to take advantage of new features.
|
||||
|
||||
.. _auto-check-updates:
|
||||
|
||||
Enable Auto Check for Updates
|
||||
-----------------------------
|
||||
|
||||
#. Navigate to the ``Embassy`` tab -> ``Preferences``
|
||||
#. Click "Auto Check for Updates" and click Enable
|
||||
#. 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.
|
||||
|
||||
Manually Checking Updates
|
||||
-------------------------
|
||||
|
||||
If you choose not to enable automatic updates, service updates will appear in the `Updates` tab of the Marketplace when ready.
|
||||
@@ -1,18 +0,0 @@
|
||||
.. _updating:
|
||||
|
||||
==================
|
||||
Updating EmbassyOS
|
||||
==================
|
||||
|
||||
.. _update-eos:
|
||||
|
||||
Enable Auto Check for Updates
|
||||
-----------------------------
|
||||
|
||||
#. Navigate to the ``Embassy`` tab -> ``Preferences``
|
||||
#. 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.
|
||||
Reference in New Issue
Block a user