mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
more cleanup and copy
This commit is contained in:
@@ -32,8 +32,7 @@ It consists of a bash script that completes any environment setup (eg. creating
|
||||
Example
|
||||
=======
|
||||
|
||||
See an example `here <https://github.com/Start9Labs/lnd-wrapper/blob/master/Dockerfile>`_.
|
||||
|
||||
The `LND wrapper <https://github.com/Start9Labs/lnd-wrapper/blob/master/Dockerfile>`_ features a well defined Dockerfile, for example.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
@@ -12,6 +12,9 @@ If an ``instructions.md`` file is included, this markdown formatted file will be
|
||||
:width: 80%
|
||||
:alt: Bitcoin Instructions
|
||||
|
||||
Example
|
||||
=======
|
||||
|
||||
The `bitcoind wrapper <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs>`_ demonstrates a good use of instructions and external integrations.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
|
||||
@@ -4,7 +4,9 @@
|
||||
Service Makefile
|
||||
****************
|
||||
|
||||
*This file is optional*
|
||||
.. note::
|
||||
|
||||
*This file is optional*
|
||||
|
||||
A Makefile serves as a convenience for outlining the build. This helps streamline additional developer contributions to the project. Please reference the GNU `documentation <https://www.gnu.org/software/make/manual/html_node/Introduction.html>`_ for implementation details.
|
||||
|
||||
@@ -20,7 +22,7 @@ This purpose of this file is to:
|
||||
Example
|
||||
=======
|
||||
|
||||
See an example `here <https://github.com/Start9Labs/lnd-wrapper/blob/master/Makefile>`_.
|
||||
The `LND wrapper <https://github.com/Start9Labs/lnd-wrapper/blob/master/Makefile>`_ features a well defined Makefile, for example.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
@@ -14,7 +14,10 @@ The output of this step is a file titled ``stats.yaml``. This file contains a ma
|
||||
|
||||
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 configurator producing the ``stats.yaml`` file can be found `here <https://github.com/Start9Labs/lnd-wrapper/blob/master/configurator/src/main.rs`_.
|
||||
Example
|
||||
=======
|
||||
|
||||
A good example of the configurator producing the ``stats.yaml`` file can be found `here <https://github.com/Start9Labs/lnd-wrapper/blob/master/configurator/src/main.rs>`_.
|
||||
|
||||
.. role:: raw-html(raw)
|
||||
:format: html
|
||||
|
||||
@@ -48,7 +48,9 @@ Run ``git submodule add <link_to_source_project>``
|
||||
Assets
|
||||
======
|
||||
|
||||
*This section is being deprecated in favor of baking assets into the Docker image, and moved into the mountpoint at runtime if necessary*
|
||||
.. warning::
|
||||
|
||||
*This section is being deprecated in favor of baking assets into the Docker image, and moved into the mountpoint at runtime if necessary*
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user