mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-02 05:23:18 +00:00
Restructure 'complete'
This commit is contained in:
kn0wmad
@@ -3,3 +3,19 @@
|
||||
*******************
|
||||
Basic Configuration
|
||||
*******************
|
||||
|
||||
Click "Config". Here you can set custom configurations for your Embassy. Currently, you can change the "Device Name" and enable/disable "Auto Check for Updates."
|
||||
|
||||
.. figure:: /_static/images/embassy_config.png
|
||||
:width: 90%
|
||||
:alt: Embassy Config View
|
||||
|
||||
.. _auto-update:
|
||||
|
||||
Automatic check for updates enables you to choose whether you want to be informed of EmbassyOS updates. Enabling this feature makes a request to the Start9 Marketplace to see if a new OS version has been released, and notifies you if so. This request is only made when you log into a new session or refresh your current session.
|
||||
|
||||
.. figure:: /_static/images/embassy_auto_check_updates.png
|
||||
:width: 90%
|
||||
:alt: Embassy Config View
|
||||
|
||||
View of Embassy Config
|
||||
|
||||
@@ -10,4 +10,5 @@ An overview of EmbassyOS general capabilities.
|
||||
basic-config
|
||||
tor-setup/index
|
||||
lan-setup/index
|
||||
wifi
|
||||
limitations/index
|
||||
|
||||
@@ -12,8 +12,8 @@ Once you have completed the above guide, select your device's operating system b
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
linux
|
||||
mac
|
||||
windows
|
||||
android
|
||||
ios
|
||||
lan-linux
|
||||
lan-mac
|
||||
lan-windows
|
||||
lan-android
|
||||
lan-ios
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. android:
|
||||
.. _lan-android:
|
||||
|
||||
*******
|
||||
Android
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _iOS:
|
||||
.. _lan-ios:
|
||||
|
||||
***
|
||||
iOS
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _linux:
|
||||
.. _lan-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
15
source/user-manual/configuration/lan-setup/lan-mac.rst
Normal file
15
source/user-manual/configuration/lan-setup/lan-mac.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _lan-mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
|
||||
.. _lan-new-mac:
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|
||||
.. _lan-old-mac:
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _windows:
|
||||
.. _lan-windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
@@ -12,8 +12,8 @@ Once you have completed the above guide, select your device's operating system b
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
linux
|
||||
mac
|
||||
windows
|
||||
android
|
||||
ios
|
||||
lim-linux
|
||||
lim-mac
|
||||
lim-windows
|
||||
lim-android
|
||||
lim-ios
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. android:
|
||||
.. _lim-android:
|
||||
|
||||
*******
|
||||
Android
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _iOS:
|
||||
.. _lim-ios:
|
||||
|
||||
***
|
||||
iOS
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _linux:
|
||||
.. _lim-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
15
source/user-manual/configuration/limitations/lim-mac.rst
Normal file
15
source/user-manual/configuration/limitations/lim-mac.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _lim-mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
|
||||
.. _lim-new-mac:
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|
||||
.. _lim-old-mac:
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _windows:
|
||||
.. _lim-windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
@@ -7,6 +7,5 @@ An overview of EmbassyOS general capabilities.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-setup/index
|
||||
tor-os/index
|
||||
tor-firefox/index
|
||||
|
||||
@@ -12,8 +12,8 @@ Once you have completed the above guide, select your device's operating system b
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
linux
|
||||
mac
|
||||
windows
|
||||
android
|
||||
ios
|
||||
torff-linux
|
||||
torff-mac
|
||||
torff-windows
|
||||
torff-android
|
||||
torff-ios
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
@@ -0,0 +1,5 @@
|
||||
.. _torff-android:
|
||||
|
||||
*******
|
||||
Android
|
||||
*******
|
||||
@@ -0,0 +1,5 @@
|
||||
.. _torff-ios:
|
||||
|
||||
***
|
||||
iOS
|
||||
***
|
||||
@@ -0,0 +1,5 @@
|
||||
.. _torff-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
*****
|
||||
@@ -0,0 +1,15 @@
|
||||
.. _torff-mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
|
||||
.. _torff-new-mac:
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|
||||
.. _torff-old-mac:
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
@@ -0,0 +1,5 @@
|
||||
.. _torff-windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
*******
|
||||
@@ -12,8 +12,8 @@ Once you have completed the above guide, select your device's operating system b
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
linux
|
||||
mac
|
||||
windows
|
||||
android
|
||||
ios
|
||||
tor-linux
|
||||
tor-mac
|
||||
tor-windows
|
||||
tor-android
|
||||
tor-ios
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _iOS:
|
||||
|
||||
***
|
||||
iOS
|
||||
***
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
@@ -1,4 +1,4 @@
|
||||
.. android:
|
||||
.. _tor-android:
|
||||
|
||||
*******
|
||||
Android
|
||||
@@ -0,0 +1,7 @@
|
||||
.. _tor-ios:
|
||||
|
||||
***
|
||||
iOS
|
||||
***
|
||||
|
||||
No Tor on iOS. Get a different phone
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _linux:
|
||||
.. _tor-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
@@ -0,0 +1,15 @@
|
||||
.. _tor-mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
|
||||
.. _tor-new-mac:
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|
||||
.. _tor-old-mac:
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _windows:
|
||||
.. _tor-windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
19
source/user-manual/configuration/wifi.rst
Normal file
19
source/user-manual/configuration/wifi.rst
Normal file
@@ -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.
|
||||
@@ -1,5 +0,0 @@
|
||||
.. android:
|
||||
|
||||
*******
|
||||
Android
|
||||
*******
|
||||
@@ -1,4 +1,4 @@
|
||||
.. android:
|
||||
.. _dg-android:
|
||||
|
||||
*******
|
||||
Android
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _iOS:
|
||||
.. _dg-ios:
|
||||
|
||||
***
|
||||
iOS
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _linux:
|
||||
.. _dg-linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
16
source/user-manual/getting-started/device-guides/dg-mac.rst
Normal file
16
source/user-manual/getting-started/device-guides/dg-mac.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
.. _dg-mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
|
||||
.. _dg-new-mac:
|
||||
|
||||
Newer Mac (M1)
|
||||
==============
|
||||
|
||||
.. _dg-old-mac:
|
||||
|
||||
Older Mac
|
||||
=========
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _windows:
|
||||
.. _dg-windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
@@ -7,8 +7,8 @@ An overview of EmbassyOS general capabilities.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
linux
|
||||
mac
|
||||
windows
|
||||
android
|
||||
ios
|
||||
dg-linux
|
||||
dg-mac
|
||||
dg-windows
|
||||
dg-android
|
||||
dg-ios
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _iOS:
|
||||
|
||||
***
|
||||
iOS
|
||||
***
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _linux:
|
||||
|
||||
*****
|
||||
Linux
|
||||
*****
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _mac:
|
||||
|
||||
***
|
||||
Mac
|
||||
***
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _windows:
|
||||
|
||||
*******
|
||||
Windows
|
||||
*******
|
||||
11
source/user-manual/services/index.rst
Normal file
11
source/user-manual/services/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
********
|
||||
Services
|
||||
********
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
marketplace
|
||||
managing-services
|
||||
@@ -0,0 +1,122 @@
|
||||
.. _managing-services:
|
||||
|
||||
*****************
|
||||
Managing Services
|
||||
*****************
|
||||
|
||||
.. _managing-dependencies:
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
Some services have dependencies on other services. A service may even require its dependency to be *configured* in a particular way.
|
||||
|
||||
Traditionally, managing dependencies was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary dependency management system makes the process transparent and simple.
|
||||
|
||||
If a service has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy will inform you and offer solutions.
|
||||
|
||||
Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. But that does not necessarily mean you need to have Bitcoin installed on your Embassy. You could just as easily configure Lightning to use another Bitcoin node located somewhere else!
|
||||
|
||||
.. _installing:
|
||||
|
||||
.. note:: Some services have :ref:`dependencies<managing-dependencies>` on other services. Adding, updating, or removing a service can sometimes have requirements or consequences for other services. Your Embassy will inform you of these issues along the way.
|
||||
|
||||
Installing
|
||||
==========
|
||||
|
||||
To add a new service, find it's listing inside the Service Marketplace: *Marketplace > [Service Name] > Install*.
|
||||
|
||||
Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.
|
||||
|
||||
After installation, you can view the service's instructions by navigating to *Services > [Service Name] > Instructions*
|
||||
|
||||
.. note:: You can only start and use a service once its dependencies are met, its :ref:`configuration<service-config>` complete, and is in a *running* state.
|
||||
|
||||
.. _updates:
|
||||
|
||||
Updating
|
||||
========
|
||||
|
||||
To see if an update is available for a service, you can click the *refresh* button inside the dashboard of the installed service or by visiting its listing in the Service Marketplace.
|
||||
|
||||
If an update is available, simply click "Update" and confirm the action.
|
||||
|
||||
.. _uninstalling:
|
||||
|
||||
Uninstalling
|
||||
============
|
||||
|
||||
To remove a service, navigate to *Services > [Service Name] > Uninstall*.
|
||||
|
||||
.. _instructions:
|
||||
|
||||
Instructions
|
||||
============
|
||||
|
||||
To view the instructions for a particular service, navigate to *Services > [Service Name] > Instructions*.
|
||||
|
||||
.. figure:: /_static/images/bitcoin_instructions.png
|
||||
:width: 90%
|
||||
:alt: Bitcoin instructions menu item
|
||||
|
||||
Instructions menu item
|
||||
|
||||
.. figure:: /_static/images/bitcoin_instructions_view.png
|
||||
:width: 90%
|
||||
:alt: Bitcoin instructions view
|
||||
|
||||
Instructions view
|
||||
|
||||
.. note:: For advanced instructions and integration guides, visit the wrapper repository for an :ref:`available service <available-services>`.
|
||||
|
||||
.. _service-config:
|
||||
|
||||
Service Config
|
||||
==============
|
||||
|
||||
Navigate to *Services > [Service Name] > Config*
|
||||
|
||||
After installation or update, some services require configuration before they can be started.
|
||||
|
||||
Traditionally, configuring services was a massive headache and a huge barrier to running a personal server. But no more! The Embassy's revolutionary service config system makes the process transparent, simple, and safe.
|
||||
|
||||
Config options are defined by the service developer and can be almost anything. They are represented as simple UI elements - such as toggles and drop downs - and they include explanations and validations, such that users understand their purpose and are prevented from making mistakes.
|
||||
|
||||
.. _properties:
|
||||
|
||||
Properties
|
||||
==========
|
||||
|
||||
Navigate to *Services > [Service Name] > Properties*
|
||||
|
||||
Properties are both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful.
|
||||
|
||||
Properties may be accompanied by one or more of the following:
|
||||
|
||||
* a *help* icon for further explanation.
|
||||
* a *copy* icon for copying the value to your clipboard.
|
||||
* a *QR* icon for viewing the value as a QR code.
|
||||
|
||||
.. _actions:
|
||||
|
||||
Actions
|
||||
=======
|
||||
|
||||
.. _interfaces:
|
||||
|
||||
Interfaces
|
||||
==========
|
||||
|
||||
.. _logs:
|
||||
|
||||
Logs
|
||||
====
|
||||
|
||||
Naviage to *Services > [Service Name] > Logs*
|
||||
|
||||
Every service emits logs while it is in a *running* state. Logs give an *under-the-hood* glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all.
|
||||
|
||||
.. _donate:
|
||||
|
||||
Donate
|
||||
======
|
||||
@@ -0,0 +1,6 @@
|
||||
.. _service-marketplace:
|
||||
|
||||
***********
|
||||
Marketplace
|
||||
***********
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
.. _shoot-connection:
|
||||
|
||||
***************************
|
||||
Troubleshooting Connections
|
||||
***************************
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
.. _shoot-embassy:
|
||||
|
||||
***********************
|
||||
Troubleshooting Embassy
|
||||
***********************
|
||||
|
||||
Hardware
|
||||
========
|
||||
|
||||
Software
|
||||
========
|
||||
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
.. _shoot-services:
|
||||
|
||||
************************
|
||||
Troubleshooting Services
|
||||
************************
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
***********************
|
||||
Alternative Marketplace
|
||||
***********************
|
||||
|
||||
EmbassyOS supports accessing alternative marketplaces by configuring a system file. Start9 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
|
||||
11
source/user-manual/tuning/advanced-config/index.rst
Normal file
11
source/user-manual/tuning/advanced-config/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
**********************
|
||||
Advanced Configuration
|
||||
**********************
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
ssh-setup
|
||||
alt-marketplace
|
||||
22
source/user-manual/tuning/advanced-config/ssh-setup.rst
Normal file
22
source/user-manual/tuning/advanced-config/ssh-setup.rst
Normal file
@@ -0,0 +1,22 @@
|
||||
.. _ssh-setup:
|
||||
|
||||
*********
|
||||
SSH Setup
|
||||
*********
|
||||
|
||||
.. 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.
|
||||
|
||||
Connecting via CLI
|
||||
==================
|
||||
|
||||
#. Navigate to *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>
|
||||
|
||||
Connecting via SSH on Windows, using PuTTY
|
||||
==========================================
|
||||
|
||||
One of our community members, @brewsbitcoin, has put together this guide for connecting via PuTTY on Windows: https://medium.com/@brewsbitcoin/ssh-to-start9-embassy-from-windows-4a4e17891b5a
|
||||
@@ -0,0 +1,6 @@
|
||||
.. _tune-embassy-os:
|
||||
|
||||
*********************
|
||||
Customizing EmbassyOS
|
||||
*********************
|
||||
|
||||
|
||||
@@ -7,11 +7,8 @@ An overview of EmbassyOS general capabilities.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
embassy-config
|
||||
updating
|
||||
wifi
|
||||
developer-options/index
|
||||
power
|
||||
notifications
|
||||
lan-setup/index
|
||||
forgot-password
|
||||
diy
|
||||
migrating
|
||||
advanced-config/index
|
||||
embassy-os
|
||||
service-guides
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
.. _migrating:
|
||||
|
||||
********************
|
||||
Migrating To Embassy
|
||||
********************
|
||||
|
||||
From Umbrel
|
||||
===========
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
.. _service-guides:
|
||||
|
||||
***********************
|
||||
Service-Specific Guides
|
||||
***********************
|
||||
|
||||
.. _bitcoin-cli:
|
||||
|
||||
*****************
|
||||
Using Bitcoin-Cli
|
||||
*****************
|
||||
|
||||
Instructions for accessing the bitcoind service in order to issue commands directly.
|
||||
|
||||
.. 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.
|
||||
|
||||
1. First, you will need SSH access. Please see the :ref:`setup instructions <ssh-setup>` for details.
|
||||
2. Access your Embassy and then you can interact with the bitcoind docker container using the following syntax::
|
||||
|
||||
sudo docker exec bitcoind bitcoin-cli COMMAND
|
||||
|
||||
.. admonition:: Example
|
||||
|
||||
sudo docker exec bitcoind bitcoin-cli getnetworkinfo
|
||||
|
||||
A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`_.
|
||||
|
||||
You can also drop into a shell using::
|
||||
|
||||
sudo docker exec -it bitcoind bash
|
||||
|
||||
and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``.
|
||||
7
source/user-manual/walkthrough/backup.rst
Normal file
7
source/user-manual/walkthrough/backup.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
.. _backup:
|
||||
|
||||
******************
|
||||
Backing Up Embassy
|
||||
******************
|
||||
|
||||
Lorem Ipsum
|
||||
@@ -8,4 +8,7 @@ An overview of EmbassyOS general capabilities.
|
||||
:maxdepth: 2
|
||||
|
||||
overview
|
||||
power
|
||||
updating
|
||||
backup
|
||||
password
|
||||
@@ -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
|
||||
76
source/user-manual/walkthrough/password.rst
Normal file
76
source/user-manual/walkthrough/password.rst
Normal 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>`_.
|
||||
20
source/user-manual/walkthrough/power.rst
Normal file
20
source/user-manual/walkthrough/power.rst
Normal 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.
|
||||
@@ -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.
|
||||
Reference in New Issue
Block a user