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

first sweep

Browse Source
This commit is contained in:
Matt Hill
2020-10-07 16:36:17 -06:00
parent c481ce9ff4
commit a09b2ae77b
48 changed files with 418 additions and 430 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
source/contributing/adding-services.rst Normal file
View File

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

13
source/contributing/beta-testing.rst Normal file
View File

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

5
source/contributing/documentation.rst Normal file
View File

@@ -0,0 +1,5 @@
.. _documentation:
*************
Documentation
*************