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

base docs

Browse Source
This commit is contained in:
Lucy Cifferello
2020-10-06 20:37:32 -06:00
commit 1f075a1d58
47 changed files with 833 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
source/developer/alt-reg.rst Normal file
View File

@@ -0,0 +1,15 @@
.. _alt-reg:
Alternative Registry URL
========================
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.
After SSHing into the Embassy, run the following commands::
sudo systemctl stop agent
sudo sh -c "echo '<alternative_registry_url>' > /root/agent/alt_registry_url.txt"
sudo systemctl start agent
The Embassy is now able to connect to the provided alternative registry.

12
source/developer/beta.rst Normal file
View File

@@ -0,0 +1,12 @@
.. _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

14
source/developer/sdk.rst Normal file
View File

@@ -0,0 +1,14 @@
.. _sdk:
Services Software Development Kit (SDK)
=======================================
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.
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.
Check back soon for more details!

11
source/developer/ssh.rst Normal file
View File

@@ -0,0 +1,11 @@
.. _ssh-key:
Adding a SSH Key
================
#. Navigate to the Embassy tab in the dashboard menu after logging in.
#. Select `Developer Options`.
#. Select the (+) button in the lower right hand corner to add an SSH key.
#. Navigate back to the Embassy tab and select `Monitor` to find the Embassy's `LAN IP address`. `pi@` will be your SSH target.
.. warning:: Adding an SSH key will void the warranty. This is an advanced feature and should only be completed by experienced users. We can make no guarantees about the continued functioning of the Embassy once this process is completed.