spacing and indexing

This commit is contained in:
Lucy Cifferello
2021-02-08 08:37:38 -07:00
parent 1f5d7be961
commit d4eef72ad0
9 changed files with 80 additions and 5 deletions

View File

@@ -570,4 +570,9 @@ SetVariant Examples:
.. code:: yaml
- rule: 'rpc.enable? OR !(''advanced.pruning.mode = "manual")'
description: "RPC must be enabled for manual pruning."
description: "RPC must be enabled for manual pruning."
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -26,4 +26,9 @@ File specified as: ``docker_entrypoint.sh``
This file defines what to do when the service application starts.
It consists of a bash script that completes any environment setup (eg. creating folder substructure), sets any environment variables, and executes the run command. The only required feature of this file is to execute the run commands on EmbassyOS.
It consists of a bash script that completes any environment setup (eg. creating folder substructure), sets any environment variables, and executes the run command. The only required feature of this file is to execute the run commands on EmbassyOS.
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -10,4 +10,9 @@ If an ``instructions.md`` file is included, this markdown formatted file will be
.. figure:: /_static/images/service/bitcoin_instructions.png
:width: 80%
:alt: Bitcoin Instructions
:alt: Bitcoin Instructions
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -15,4 +15,9 @@ This purpose of this file is to:
- Read the docker container and build the project
- Build all prerequisite for running the docker file
- Build all dependencies
- Package ``config.yaml``, ``manifest.yaml``, and ``image.tar`` into an ``.s9pk`` extension by invoke ``appmgr``.
- Package ``config.yaml``, ``manifest.yaml``, and ``image.tar`` into an ``.s9pk`` extension by invoke ``appmgr``.
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -339,3 +339,8 @@ Cups
dst: "."
overwrite: true
hidden-service-version: v3
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -41,3 +41,8 @@ Recommended Dependencies
`make <https://www.gnu.org/software/make/>`_
`musl <https://github.com/Start9Labs/rust-musl-cross>`_
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -12,4 +12,11 @@ The output of this step is a file titled ``stats.yaml``. This file contains a ma
Service Properties Tab
Due to the fact that config variables are only available when the service is running, this file can only be populated at runtime. In services Start9 has wrapped or created, we typically handle this in ``configurator/src/main.rs``. This file is essentially a script that acquires the necessary values at runtime from config (eg. ``/root/.lnd/start9/config.yaml``), and dynamically populating them to the ``stats.yaml`` file, marking each value with the appropriate keys for UI display (ie. masked or copyable). Running the configurator is typically included in the ``docker_entrypoint.sh`` file.
Due to the fact that config variables are only available when the service is running, this file can only be populated at runtime. In services Start9 has wrapped or created, we typically handle this in ``configurator/src/main.rs``. This file is essentially a script that acquires the necessary values at runtime from config (eg. ``/root/.lnd/start9/config.yaml``), and dynamically populating them to the ``stats.yaml`` file, marking each value with the appropriate keys for UI display (ie. masked or copyable). Running the configurator is typically included in the ``docker_entrypoint.sh`` file.
A good example of the a configurator producing the ``stats.yaml`` file can be found `here <https://github.com/Start9Labs/btc-rpc-proxy-wrapper/blob/master/configurator/src/main.rs>`_.
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

View File

@@ -53,3 +53,8 @@ Assets
Whenever a service is stopped, any file that is not contained within in the ``/assets`` directory will be cleared from memory. Any unsaved changes will be reverted. This folder acts as a persistance storage container.
In this folder belongs any assets that are unique configurations to your service. For instance, bitcoind's ``.conf`` file is saved here.
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`