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

re-arrange the user docs (#76)

Browse Source 
* re-arrange the user docs

* Minor description edit

* update styles

* fix service links

Co-authored-by: kn0wmad <kn0wmad@protonmail.com>
Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
Matt Hill
2022-02-18 08:49:53 -07:00
committed by GitHub
parent c38d5c1a0c
commit aed86e7e6c
151 changed files with 500 additions and 781 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
site/source/developer-docs/advanced/dev-tools/embassy-cli.rst Normal file
View File

@@ -0,0 +1,52 @@
.. _embassy-cli:
==============================
Embassy Command Line Interface
==============================
.. warning:: This is for advanced users only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
When interacting with Embassy directly, you will invariably want to use ``embassy-cli``. Embassy-CLI can control EmbassyOS in many of the same ways that the UI can, but with finer controls and deeper insights.
In order to use Embassy-CLI, you will first need to authorize yourself with the following command...
.. code-block:: bash
embassy-cli auth login
and enter your Embassy Master Password at the prompt.
You can enter ``embassy-cli help`` or ``embassy-cli <option> help`` to get an overview of capabilities:
.. code-block:: bash
Embassy CLI
USAGE:
embassy-cli [OPTIONS] <SUBCOMMAND>
FLAGS:
--help Prints help information
-V, --version Prints version information
OPTIONS:
-c, --config <config>
-h, --host <host>
-p, --proxy <proxy>
SUBCOMMANDS:
auth Login/logout and manage sessions
backup Manage backups
db Interact with the Database
disk Information on the external drive
echo Echoes
git-info Print the current git hash
help Prints this message or the help of the given subcommand(s)
inspect Details on services and their components
net Network information
notification Control UI notifications
package Interact with packages
server EmbassyOS operations and information
ssh Manage SSH keys
wifi Manage WiFi networks

43
site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst Normal file
View File

@@ -0,0 +1,43 @@
.. _embassy-sdk:
================================
Embassy Software Development Kit
================================
.. warning:: This is for developers only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
You can install to your system by running the following from your ``embassy-os`` directory:
.. code-block:: bash
cd backend
./install-sdk.sh
You can enter ``embassy-sdk help`` or ``embassy-sdk <option> help`` to get an overview of capabilities:
.. code-block:: bash
embassy-sdk --help
Embassy SDK
USAGE:
embassy-sdk [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-c, --config <config>
SUBCOMMANDS:
git-info Print current git hash
help Prints this message or the help of the given subcommand(s)
init Initialize
inspect Inspect a .s9pk
pack Package a service into the .s9pk format
verify Verify a .s9pk is valid
Please visit the `EmbassyOS backend <https://github.com/Start9Labs/embassy-os/tree/master/backend>`_ for more details

21
site/source/developer-docs/advanced/dev-tools/embassyd.rst Normal file
View File

@@ -0,0 +1,21 @@
.. _embassyd:
==============
Embassy Daemon
==============
.. warning:: This is for advanced users only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician.
``embassyd`` is the daemon that runs everything that could be considered EmbassyOS.
When SSH'd into your Embassy, you may see the status of EmbassyD with the following:
.. code-block:: bash
systemctl status embassyd
If you need to restart the daemon for some reason, you can do so with:
.. code-block:: bash
systemctl restart embassyd

15
site/source/developer-docs/advanced/dev-tools/index.rst Normal file
View File

@@ -0,0 +1,15 @@
.. _dev-tools:
===============
Developer Tools
===============
Brief overviews of Developer Tools that will come in handy when :ref:`packaging a service<developer-docs>`, or interacting directly with the OS to learn or contribute to the project.
.. toctree::
:maxdepth: 2
embassyd
embassy-cli
embassy-sdk
service-container

19
site/source/developer-docs/advanced/dev-tools/service-container.rst Normal file
View File

@@ -0,0 +1,19 @@
.. _exec-service-container:
==================
Service Containers
==================
For simplicity, EmbassyOS is designed to be completely operated via the :ref:`WebUI <web-ui>`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands.
.. warning:: The following guide is for those that have advanced command line skills, or those who are being guided by a Start9 support technician. Nothing you do inside a container is supported unless under the direction of Start9. Here be dragons!!
This guide assumes you already have :ref:`SSH Access<ssh>` setup on your machine.
Open a terminal, ssh into your device, and enter the following command, replacing ``<package-id>`` with the name of the service you are trying to access. You can list the services with ``embassy-cli package list`` (you will need to be logged in under ``embassy-cli`` for this). You will need to either be ``root`` or use ``sudo``.
.. code-block:: bash
docker exec -it <package-id>.embassy sh
This will give you a shell within the container. Reminder that nothing you do in here is supported, please be careful!