Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2 from Start9Labs/1.0.0

Browse Source 
content + styling
This commit is contained in:
Lucy C
2020-10-08 20:58:39 -06:00
committed by GitHub
parent 5f432974e1 1985952f87
commit 7232d6854a
18 changed files with 166 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
source/_static/default.css
View File

@@ -9,17 +9,17 @@ h1 {
}
h2 {
font-size: 1.75rem;
}
h3 {
font-size: 1.5rem;
}
h4 {
h3 {
font-size: 1.25rem;
}
h4 {
font-size: 1.15rem;
}
p, nav a {
font-size: 1.1em;
letter-spacing: 0.75px;
@@ -78,4 +78,55 @@ ul .current li .current {
#site-navigation {
background-color: #2b2b2b;
}
}
code {
color: #ff4961!important;
}
.topbar .topbar-main button.topbarbtn {
background-color: #2b2b2b;
color: #ff4960;
}
.admonition {
width: 80%;
}
/* TOGGLE */
.toggle .admonition {
padding-bottom: 0px!important;
}
.toggle .admonition-title {
display: block;
clear: both;
cursor: pointer;
}
.toggle .admonition-title::after {
content: " ▶";
}
.toggle .admonition-title.open::after {
content: " ▼";
}
.expand {
width: 60%;
margin: 1em 0 1em 5em;
padding: 0 .6rem 0rem!important;
border-left: .2rem solid #393838!important;
box-shadow: 0 0.2rem 0.5rem rgba(0,0,0,.05), 0 0 0.05rem rgba(0,0,0,.1);
transition: color .25s,background-color .25s,border-color .25s;
}
.expand .admonition-title {
background-color: #1e1e1e;
font-weight: 300;
}
.expand .admonition-title:before {
color: #393838!important;
}

12
source/_static/js/main.js
View File

@@ -1,3 +1,11 @@
$(document).ready(function () {
$('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank');
});
// open external links in separate tab
$('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank');
// toggle hidable sections
$(".toggle > *").hide();
$(".toggle .admonition-title").show();
$(".toggle .admonition-title").click(function() {
$(this).parent().children().not(".admonition-title").toggle(400);
$(this).parent().children(".admonition-title").toggleClass("open");
})
});

3
source/conf.py
View File

@@ -80,4 +80,7 @@ html_title = ""
html_favicon = "_static/favicon.ico"
html_js_files = [
'js/main.js'
]
html_cs_files = [
'default.css'
]

11
source/getting-started/initial-setup.rst
View File

@@ -1,11 +0,0 @@
.. _initial-setup:
*************
Initial Setup
*************
Ensure your phone is connected to the same WiFi network as your router.
Visit the appropriate setup instructions for your version:
`Setup0.2.x <https://start9labs.com/devices/embassy/setup?version=0.2.0>`_

2
source/index.rst
View File

@@ -8,7 +8,7 @@ Start9 Lab's documentation resources aim to provide product and troubleshooting
:maxdepth: 2
:caption: Getting Started
getting-started/initial-setup
getting-started/setup/index
getting-started/connecting
.. toctree::

2
source/user-manuals/embassyos/about.rst
View File

@@ -2,6 +2,6 @@
About
*****
``Embassy ---> About``
``Embassy > About``
This page contains static information about your device, such as its ID, Tor Address, and hardware specs.

2
source/user-manuals/embassyos/developer-options/ssh-setup.rst
View File

@@ -4,7 +4,7 @@
SSH Setup
*********
``Embassy ---> Developer Options ---> SSH Keys``
``Embassy > Developer Options > SSH Keys``
#. Click the ``+`` button in the lower right hand corner.
#. Paste in your SSH key.

2
source/user-manuals/embassyos/embassy-config.rst
View File

@@ -2,7 +2,7 @@
Embassy Config
**************
``Embassy ---> Configure``
``Embassy > Configure``
Here you can set custom configurations for your Embassy. Currently, changing the ``Device Name`` is the only option.

2
source/user-manuals/embassyos/monitor.rst
View File

@@ -2,7 +2,7 @@
Monitor
*******
``Embassy ---> Monitor``
``Embassy > Monitor``
Provides real-time statistics, such as temperature, CPU usage, memory and disk space.

4
source/user-manuals/embassyos/power.rst
View File

@@ -5,7 +5,7 @@ Power
Restart
=======
#. ``Embassy ---> Restart ---> '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 +13,7 @@ Restart
Shutdown
========
#. ``Embassy ---> Shutdown ---> '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
source/user-manuals/embassyos/updating.rst
View File

@@ -2,7 +2,7 @@
Updating EmbassyOS
******************
``Embassy ---> Check for Updates``
``Embassy > 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.

2
source/user-manuals/embassyos/wifi.rst
View File

@@ -2,7 +2,7 @@
WiFi Setup
**********
``Embassy tab ---> WiFi``
``Embassy tab > WiFi``
#. Click the ``+`` button in the lower right corner.
#. Select the appropriate country.

102
source/user-manuals/services/backups.rst
View File

@@ -12,44 +12,94 @@ Creating A Backup
To begin the backup process:
#. Enter the USB stick provided with the Embassy kit, or any USB drive with enough storage capacity, into a USB port on the device.
#. Navigate to the `Services` sub menu from the main dashboard menu.
#. Select the service to be backed-up.
#. Select the floppy disc icon next to the `Last Backup` menu item. If a backup was never completed, this should say "never".
1. Enter the USB stick provided with the Embassy kit, or any USB drive with enough storage capacity, into a USB port on the device.
2. Navigate to the `Services` sub menu from the main dashboard menu.
3. Select the service to be backed-up.
4. Select the floppy disc icon next to the `Last Backup` menu item. If a backup was never completed, this should say "never".
.. figure:: /_static/images/bitcoin_view.png
:width: 90%
:alt: Bitcoin Core Service Sub Menu
.. figure:: /_static/images/bitcoin_view.png
:width: 90%
:alt: Bitcoin Core Service Sub Menu
Bitcoin Core Service Sub Menu
Bitcoin Core Service Sub Menu
#. In the modal prompt, select the available disc space. If no option is marked as available, ensure the USB drive has enough space and that it is properly inserted.
5. In the modal prompt, select the available disc space. If no option is marked as available, ensure the USB drive has enough space and that it is properly inserted.
.. figure:: /_static/images/bitcoin_backup_view_storage.png
:width: 90%
:alt: Bitcoin Core Service Backup Storage
.. figure:: /_static/images/bitcoin_backup_view_storage.png
:width: 90%
:alt: Bitcoin Core Service Backup Storage
Backup menu with available storage space
Backup menu with available storage space
.. figure:: /_static/images/bitcoin_backup_view_no_storage.png
:width: 90%
:alt: Bitcoin Core Service Backup No Storage
.. figure:: /_static/images/bitcoin_backup_view_no_storage.png
:width: 90%
:alt: Bitcoin Core Service Backup No Storage
Backup menu with no available storage disc
Backup menu with no available storage disc
#. Enter the master password to encrypt the backup.
#. "Creating Backup..." will appear on the service sub menu while the backup is in process.
6. Enter the master password to encrypt the backup.
7. "Creating Backup..." will appear on the service sub menu while the backup is in process.
.. figure:: /_static/images/bitcoin_creating_backup.png
:width: 90%
:alt: Bitcoin Core Service Backup No Storage
.. figure:: /_static/images/bitcoin_creating_backup.png
:width: 90%
:alt: Bitcoin Core Service Backup No Storage
Creating Backup
Creating Backup
#. A notification will emit when the backup has successfully completed.
#. The `Last Backup` menu item in the service will now indicate the date and time at which the last backup was made.
8. A notification will emit when the backup has successfully completed.
9. The `Last Backup` menu item in the service will now indicate the date and time at which the last backup was made.
Restoring A Backup
==================
==================
To begin the backup restore process:
1. Enter the same USB stick used to originally backup the service.
2. Navigate to the `Services` sub menu from the main dashboard menu.
3. Select the service to be backed-up.
4. Select the `Restore from backup` menu item.
.. figure:: /_static/images/restore_backup_menu.png
:width: 90%
:alt: Restore backup from Services tab
Restore backup from Services tab
5. In the modal prompt, select the same disc used to originally back up the service. If no option is marked as available, ensure the USB drive is properly inserted.
.. figure:: /_static/images/restore_backup_submenu.png
:width: 90%
:alt: Restore backup submenu
Restore backup sub-menu options
6. Note the warning that restoring will wipe current data.
.. figure:: /_static/images/backup_warning.png
:width: 90%
:alt: Backup warning message
Backup warning message
7. Enter the master password to decrypt the backup and select `Restore`.
.. figure:: /_static/images/decrypt_backup.png
:width: 90%
:alt: Decrypt backup
Decrypt backup view
8. "Restoring Backup..." will appear on the service sub menu while the restoration is in process.
.. note::
The service might be momentarily unreachable as it starts back up. This is expected behavior.
.. figure:: /_static/images/restoring_backup.png
:width: 90%
:alt: Restoring backup
Restoring backup view
9. A notification will emit when the backup restoration has successfully completed.

2
source/user-manuals/services/index.rst
View File

@@ -2,7 +2,7 @@
Services
********
To view the instructions for a particular service, navigating to ``Services ---> [Service Name] ---> Instructions``
To view the instructions for a particular service, navigating to ``Services > [Service Name] > Instructions``
.. note:: Some services require configuration before starting up. You can only connect to and use a service once it is in a *running* state.

16
source/user-manuals/services/installing.rst
View File

@@ -1,17 +1,17 @@
*******************
Adding and Removing
Install / Uninstall
*******************
.. 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.
Adding
======
Installing
==========
To add a new service, find it's listing inside the Service Marketplace: ``Marketplace ---> [Service Name] ---> Install``.
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``
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.
@@ -24,7 +24,7 @@ To see if an update is available for a service, you can click the *refresh* butt
If an update is available, simply click ``Update`` and confirm the action.
Removing
========
Uninstalling
============
To remove a service, navigate to ``Services ---> [Service Name] ---> Uninstall``.
To remove a service, navigate to ``Services > [Service Name] > Uninstall``.

2
source/user-manuals/services/logs.rst
View File

@@ -2,6 +2,6 @@
Viewing Logs
************
``Services ---> [Service Name] ---> Logs``
``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.

2
source/user-manuals/services/properties.rst
View File

@@ -2,7 +2,7 @@
Properties
**********
``Services ---> [Service Name] ---> Properties``
``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.

2
source/user-manuals/services/service-config.rst
View File

@@ -4,7 +4,7 @@
Service Config
**************
``Services ---> [Service Name] ---> Config``
``Services > [Service Name] > Config``
After installation or update, some services require configuration before they can be started.