mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
forgot password flow and cleaning up
This commit is contained in:
Matt Hill
@@ -1,5 +1,3 @@
|
||||
.. _adding-services:
|
||||
|
||||
***************
|
||||
Adding Services
|
||||
***************
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
.. _best-testing:
|
||||
|
||||
************
|
||||
Beta Testing
|
||||
************
|
||||
|
||||
On request, or by selective offerings, we will admit certain users to test upcoming releases in our beta environment. This environment requires authorized SSH authentication, the credentials for which will be provided to selected users.
|
||||
|
||||
After successful authentication, run the following commands::
|
||||
|
||||
sudo systemctl stop agent
|
||||
sudo sh -c "echo '<https://beta-registry.start9labs.com:443>' > /root/agent/alt_registry_url.txt"
|
||||
sudo systemctl start agent
|
||||
@@ -1,5 +0,0 @@
|
||||
.. _documentation:
|
||||
|
||||
*************
|
||||
Documentation
|
||||
*************
|
||||
@@ -2,7 +2,9 @@
|
||||
Documentation
|
||||
#############
|
||||
|
||||
Start9 Lab's documentation resources aim to provide product and troubleshooting information for all levels of users. Explore to learn more about our mission, our products, and the technology behind our solutions.
|
||||
Welcome to the docs!
|
||||
|
||||
Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS. If you identify an error with the docs or would like to contribute to them, please use the GitHub link at the top of this page.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -23,8 +25,6 @@ Start9 Lab's documentation resources aim to provide product and troubleshooting
|
||||
:caption: Contributing
|
||||
|
||||
contributing/adding-services
|
||||
contributing/beta-testing
|
||||
contributing/documentation
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -86,5 +86,3 @@ Is there a product warranty?
|
||||
Yes. Start9 commits to serving each beta Embassy product released until the wild. We commit, to the best of our ability, to resolve any issue encountered with our provided hardware or software in a personalized matter until resolved.
|
||||
|
||||
Do not hesitate to :ref:`contact`. We strive to also provide quality and available customer service upfront.
|
||||
|
||||
.. warning:: Adding an SSH key voids the product warranty in totality.
|
||||
@@ -1,13 +0,0 @@
|
||||
*****
|
||||
About
|
||||
*****
|
||||
|
||||
``Embassy > About``
|
||||
|
||||
This page contains static information about your device, such as its ID, Tor Address, and hardware specs.
|
||||
|
||||
.. figure:: /_static/images/about_screen.png
|
||||
:width: 90%
|
||||
:alt: Embassy about view
|
||||
|
||||
View of information about Embassy
|
||||
@@ -1,11 +1,8 @@
|
||||
.. _alt-marketplace:
|
||||
|
||||
***********************
|
||||
Alternative Marketplace
|
||||
***********************
|
||||
|
||||
Embassy OS supports accessing alternative marketplaces by configuring a system file.
|
||||
Start9 Labs is not responsible for issues encountered by downloading unverified services from these alternative marketplaces.
|
||||
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::
|
||||
|
||||
|
||||
@@ -6,4 +6,3 @@ Developer Options
|
||||
:maxdepth: 2
|
||||
|
||||
ssh-setup
|
||||
alt-marketplace
|
||||
@@ -4,10 +4,9 @@
|
||||
SSH Setup
|
||||
*********
|
||||
|
||||
``Embassy > Developer Options > SSH Keys``
|
||||
|
||||
#. 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:: Adding an SSH key voids the device warranty. This is an advanced feature for developers and should ne used with caution.
|
||||
.. 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,10 +1,8 @@
|
||||
**************
|
||||
Embassy Config
|
||||
Config Options
|
||||
**************
|
||||
|
||||
``Embassy > Configure``
|
||||
|
||||
Here you can set custom configurations for your Embassy. Currently, changing the ``Device Name`` is the only option.
|
||||
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%
|
||||
|
||||
51
source/user-manuals/embassyos/forgot-password.rst
Normal file
51
source/user-manuals/embassyos/forgot-password.rst
Normal file
@@ -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 insall sqlite3
|
||||
|
||||
* Run::
|
||||
|
||||
sudo sqlite3 [mount folder]/root/agent/start9_agent.sqlite3
|
||||
delete from account;
|
||||
.quit
|
||||
|
||||
* Unmount 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 Emabssy is to :ref:`contact the Start9 dev team<contact>` directly to obtain a new operating system image. This is equivelent to a factory reset; all data will be lost.
|
||||
@@ -13,8 +13,6 @@ You can view and manage your Embassy inside the ``Embassy`` tab in the main menu
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
about
|
||||
monitor
|
||||
embassy-config
|
||||
updating
|
||||
wifi
|
||||
@@ -22,3 +20,4 @@ You can view and manage your Embassy inside the ``Embassy`` tab in the main menu
|
||||
power
|
||||
notifications
|
||||
ssl
|
||||
forgot-password
|
||||
@@ -1,13 +0,0 @@
|
||||
*******
|
||||
Monitor
|
||||
*******
|
||||
|
||||
``Embassy > Monitor``
|
||||
|
||||
Provides real-time statistics, such as temperature, CPU usage, memory and disk space.
|
||||
|
||||
.. figure:: /_static/images/embassy_metrics.png
|
||||
:width: 90%
|
||||
:alt: Embassy Metrics View
|
||||
|
||||
View of Embassy Metrics
|
||||
@@ -5,7 +5,6 @@ Power
|
||||
Restart
|
||||
=======
|
||||
|
||||
#. ``Embassy > Restart > '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.
|
||||
@@ -13,7 +12,6 @@ Restart
|
||||
Shutdown
|
||||
========
|
||||
|
||||
#. ``Embassy > Shutdown > '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.
|
||||
|
||||
|
||||
@@ -2,8 +2,7 @@
|
||||
Updating EmbassyOS
|
||||
******************
|
||||
|
||||
``Embassy > Check for Updates``
|
||||
|
||||
#. 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.
|
||||
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
**********
|
||||
WiFi Setup
|
||||
**********
|
||||
|
||||
``Embassy tab > WiFi``
|
||||
***************
|
||||
Setting up WiFi
|
||||
***************
|
||||
|
||||
#. Click ``WiFi``.
|
||||
#. Click the ``+`` button in the lower right corner.
|
||||
#. Select the appropriate country.
|
||||
#. Enter your WiFi SSID and password.
|
||||
|
||||
Reference in New Issue
Block a user