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,15 +1,13 @@
|
||||
.. _adding-services:
|
||||
|
||||
***************
|
||||
Adding Services
|
||||
***************
|
||||
|
||||
We are finalizing the OS infrastructure requirements to ensure a smooth process for developer contribution. This includes wrapping everything up into a software development kit for developing services on the Embassy OS platform.
|
||||
We are finalizing the OS infrastructure requirements to ensure a smooth process for developer contribution. This includes wrapping everything up into a software development kit for developing services on the EmbassyOS platform.
|
||||
|
||||
If you are interested in developing a service, keep the following in mind:
|
||||
|
||||
Marketplace services need to provide a "service manifest" and a "config spec", which the SDK will facilitate. The service manifest is for the store listing. The config spec is a detailed mapping of configuration options with acceptable values, defaults, and relational rule-sets. For example, if the user chooses config option A, then config option B must be between 5 and 10. That way, users can enjoy a simple GUI configuration experience, complete with validations and protections, and not have to worry about screwing up a .conf file in some unknown way.
|
||||
|
||||
The config spec will also denote any dependencies. Many services depend on other libraries and services on the Embassy (such as Bitcoin), sometimes even a particular version of those services, which need to be specified by the developers so that Embassy OS can handle installing these dependencies under the hood.
|
||||
The config spec will also denote any dependencies. Many services depend on other libraries and services on the Embassy (such as Bitcoin), sometimes even a particular version of those services, which need to be specified by the developers so that EmbassyOS can handle installing these dependencies under the hood.
|
||||
|
||||
Check back soon for more details!
|
||||
@@ -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
|
||||
|
||||
@@ -11,7 +11,7 @@ Depending on your background, the Embassy platform may deal with some unfamiliar
|
||||
EmbassyOS
|
||||
=========
|
||||
|
||||
Embassy OS refers to a custom Linux distribution along with a suite of software tools installed on the Embassy which makes it easy to:
|
||||
EmbassyOS refers to a custom Linux distribution along with a suite of software tools installed on the Embassy which makes it easy to:
|
||||
|
||||
* Install new services
|
||||
* Uninstall services
|
||||
@@ -19,7 +19,7 @@ Embassy OS refers to a custom Linux distribution along with a suite of software
|
||||
* Upgrade your Embassy software to future versions
|
||||
* Manage the data of each installed service
|
||||
|
||||
Embassy OS is a forked branch of the Buster Lite version of Raspberry Pi OS. Start9 Labs augmented this base operating system to include:
|
||||
EmbassyOS is a forked branch of the Buster Lite version of Raspberry Pi OS. Start9 Labs augmented this base operating system to include:
|
||||
|
||||
* a custom application management layer specialized for installing, running, and backing up .s9pk packaged services
|
||||
* a layer responsible for Embassy specific operations, such as Tor, Backups, and Notifications
|
||||
|
||||
@@ -23,7 +23,7 @@ How does the Embassy work?
|
||||
|
||||
The Embassy runs on the Raspberry Pi 4B hardware with a Cortex-a72 CPU, 4GB of RAM, and has 2.4ghz and 5.0ghz IEEE 802.11AC wireless capabilities and a BLE internal speaker for audio feedback of system operations. It also features a high endurance MicroSD card, on which the operating system software is installed.
|
||||
|
||||
Embassy OS is a stripped down version of Raspbian Buster Lite and handles all operations of your Embassy device. This core element of the technology stack is what enables you to set up, login, access your Embassy’s dashboard, and download and install services.
|
||||
EmbassyOS is a stripped down version of Raspbian Buster Lite and handles all operations of your Embassy device. This core element of the technology stack is what enables you to set up, login, access your Embassy’s dashboard, and download and install services.
|
||||
|
||||
One of these operations is creating and managing Tor addresses, which are uniquely attributed to each service you download, as well as to the Embassy device itself. You can see your uniquely generated Tor address when you complete the setup process using the Setup App. This address is how you view your Embassy’s dashboard, which is actually just a website served up from your Embassy itself! It is authenticated, of course, so only you can access it.
|
||||
|
||||
@@ -61,7 +61,7 @@ The list of services will grow rapidly over the coming months, such that many th
|
||||
Are my Internet requests anonymous and secure?
|
||||
==============================================
|
||||
|
||||
Embassy OS and every service on the Embassy are served on their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up the Embassy. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them.
|
||||
EmbassyOS and every service on the Embassy are served on their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up the Embassy. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them.
|
||||
|
||||
There is also the option to communicate with your Embassy using standard :ref:`ssl` encryption and a uniquely generated `.local` address. This method is faster than Tor, but can only be used on your home network.
|
||||
|
||||
@@ -75,7 +75,7 @@ Make sure the service is started by viewing it in the Services tab in the Embass
|
||||
Is the software open source?
|
||||
============================
|
||||
|
||||
The team at Start9 Labs is working to open source Embassy OS with a custom license.
|
||||
The team at Start9 Labs is working to open source EmbassyOS with a custom license.
|
||||
|
||||
Some of our projects are currently open sourced under MIT.
|
||||
|
||||
@@ -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