mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 18:31:53 +00:00
Restructure 'complete'
This commit is contained in:
kn0wmad
@@ -0,0 +1,10 @@
|
||||
.. _faq-contributing:
|
||||
|
||||
************
|
||||
Contributing
|
||||
************
|
||||
|
||||
We ❤️ contributions!
|
||||
|
||||
Please follow the guide `here <https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md>`_ and reach out to the `community dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ channel on Matrix with any questions.
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
.. _faq-service-packaging:
|
||||
|
||||
*********************
|
||||
Service Packaging FAQ
|
||||
*********************
|
||||
11
source/dev-docs/dev-faq/index.rst
Normal file
11
source/dev-docs/dev-faq/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
*************
|
||||
Developer FAQ
|
||||
*************
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
faq-contributing
|
||||
faq-service-packaging
|
||||
@@ -1,12 +0,0 @@
|
||||
***********************
|
||||
Developer Documentation
|
||||
***********************
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
service-packaging/index
|
||||
example
|
||||
dev-faq/index
|
||||
7
source/dev-docs/packaging-example.rst
Normal file
7
source/dev-docs/packaging-example.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
.. _packaging-example:
|
||||
|
||||
*****************
|
||||
Packaging Example
|
||||
*****************
|
||||
|
||||
A rough walkthrough of how to package a service using our example "Hello World" wrapper.
|
||||
@@ -1,44 +0,0 @@
|
||||
.. _service_pacakge:
|
||||
|
||||
***********************
|
||||
Service Packaging Guide
|
||||
***********************
|
||||
|
||||
Welcome! If you are here, you are interested in becoming part of the mission to change the future of personal computing. This guide will take you through the process of packaging a service for EmbassyOS, a novel, self-hosted, sovereign computing platform.
|
||||
|
||||
A service in this context is any open source project that has been bundled into the appropriate format to run on EmbassyOS. By configuring and packaging a project according to this guide, it can be installed on EmbassyOS with no command line or technical expertise required. This opens up an entire platform for self-hosted software to run independent of third parties in a completely private and sovereign way for all individuals.
|
||||
|
||||
This guide is technical, but breaks down the steps for deployment. If you have any feedback or questions concerning this guide, please don't hesitate to `reach out <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ or submit a pull request with alterations.
|
||||
|
||||
To start, you will need to acquire EmbassyOS for testing the packaged service. This can be done by:
|
||||
|
||||
- building from `source <https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md#setting-up-your-development-environment>`_
|
||||
- following the :ref:`DIY <diy>` guide
|
||||
- :ref:`purchasing <purchasing>` the ready to run personal server
|
||||
|
||||
While you are waiting to receive or assemble a device, you can begin the process of packaging a project. The sections below outline these steps in detail.
|
||||
|
||||
Happy building!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Overview <overview>
|
||||
Wrapper <wrapper>
|
||||
Manifest <manifest>
|
||||
Docker <docker>
|
||||
Makefile <makefile>
|
||||
Config <config>
|
||||
Properties <properties>
|
||||
Instructions <instructions>
|
||||
Backups <backups>
|
||||
|
||||
Submission process
|
||||
------------------
|
||||
|
||||
When you have built and tested your project for EmbassyOS, please send Start9 a submission with the project repository to ``dev@start9labs.com``. After being reviewed for security and compatibility, the service will be deployed to the marketplace and available for all EmbassyOS users to download.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
:raw-html:`<br />`
|
||||
@@ -2,7 +2,21 @@
|
||||
Service Packaging
|
||||
*****************
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
Welcome! If you are here, you are interested in becoming part of the mission to change the future of personal computing. This guide will take you through the process of packaging a service for EmbassyOS, a novel, self-hosted, sovereign computing platform.
|
||||
|
||||
A service in this context is any open source project that has been bundled into the appropriate format to run on EmbassyOS. By configuring and packaging a project according to this guide, it can be installed on EmbassyOS with no command line or technical expertise required. This opens up an entire platform for self-hosted software to run independent of third parties in a completely private and sovereign way for all individuals.
|
||||
|
||||
This guide is technical, but breaks down the steps for deployment. If you have any feedback or questions concerning this guide, please don't hesitate to `reach out <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ or submit a pull request with alterations.
|
||||
|
||||
To start, you will need to acquire EmbassyOS for testing the packaged service. This can be done by:
|
||||
|
||||
- building from `source <https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md#setting-up-your-development-environment>`_
|
||||
- following the :ref:`DIY <diy>` guide
|
||||
- :ref:`purchasing <purchasing>` the ready to run personal server
|
||||
|
||||
While you are waiting to receive or assemble a device, you can begin the process of packaging a project. The sections below outline these steps in detail.
|
||||
|
||||
Happy building!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -16,3 +30,4 @@ An overview of EmbassyOS general capabilities.
|
||||
properties
|
||||
instructions
|
||||
backups
|
||||
submission
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _service_manifest:
|
||||
.. _manifest:
|
||||
|
||||
****************
|
||||
Service Manifest
|
||||
|
||||
@@ -38,7 +38,7 @@ Image
|
||||
|
||||
Each service boils down to a Docker image. We're not going to dive into Docker specifics in this guide, since there exists tons of `resources <https://docs.docker.com/>`_ for developing with this containerization tool.
|
||||
|
||||
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <service_manifest>` configuration file.
|
||||
Because the service ultimately runs on a Raspberry Pi, the created Docker image should be a snapshot of an arm based linux environment. The service image is then mounted to the EmbassyOS image during installation. This path is defined in the :ref:`manifest <manifest>` configuration file.
|
||||
|
||||
The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features.
|
||||
|
||||
|
||||
7
source/dev-docs/service-packaging/submission.rst
Normal file
7
source/dev-docs/service-packaging/submission.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
.. _submission:
|
||||
|
||||
==================
|
||||
Submission Process
|
||||
==================
|
||||
|
||||
When you have built and tested your project for EmbassyOS, please send Start9 a submission with the project repository to ``dev@start9labs.com``. After being reviewed for security and compatibility, the service will be deployed to the marketplace and available for all EmbassyOS users to download.
|
||||
Reference in New Issue
Block a user