mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-01 21:13:10 +00:00
restructure to account for new theme, add new build process, update readme
This commit is contained in:
Lucy Cifferello
587
docs/_build/dirhtml/contributing/services/backups/index.html
vendored
Normal file
587
docs/_build/dirhtml/contributing/services/backups/index.html
vendored
Normal file
@@ -0,0 +1,587 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Backups | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Backups</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Backups&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/backups%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/backups.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-backups">
|
||||
<span id="id1"></span><h1>Service Backups<a class="headerlink" href="#service-backups" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Everything within the root of the mounted volume directory will be stored in an EmbassyOS backup. This includes the config (config.yaml) and properties (stats.yaml) files, as well as any other persisted data within the volume directory.</p>
|
||||
<p>For restoration purposes, it might be beneficial to ignore certain files or folders. For instance, ignore the shared/public folder that is mounted for dependencies that expose this feature as it causes data inconsistencies on restore.</p>
|
||||
<p>In this case, create a <cite>.backupignore</cite> file. This file contains a list of relative paths to the ignored files.</p>
|
||||
<div class="section" id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference external" href="https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/configurator/src/templates/.backupignore.templates">btcpayserver wrapper</a> demonstrates a good use of a backupignore template.</p>
|
||||
<p>Ultimately, <code class="docutils literal notranslate"><span class="pre">/datadir/.backupignore</span></code> gets populated with:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">volumes</span><span class="o">/</span><span class="n">btcpayserver</span><span class="o">/</span><span class="n">start9</span><span class="o">/</span><span class="n">public</span>
|
||||
<span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">volumes</span><span class="o">/</span><span class="n">btcpayserver</span><span class="o">/</span><span class="n">start9</span><span class="o">/</span><span class="n">shared</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../instructions/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Instructions & Documentation
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../../embassyos/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />EmbassyOS
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Backups</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
1094
docs/_build/dirhtml/contributing/services/config/index.html
vendored
Normal file
1094
docs/_build/dirhtml/contributing/services/config/index.html
vendored
Normal file
File diff suppressed because it is too large
Load Diff
597
docs/_build/dirhtml/contributing/services/docker/index.html
vendored
Normal file
597
docs/_build/dirhtml/contributing/services/docker/index.html
vendored
Normal file
@@ -0,0 +1,597 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Dockerfile | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Dockerfile</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Dockerfile&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/docker%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/docker.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-dockerfile">
|
||||
<span id="service-docker"></span><h1>Service Dockerfile<a class="headerlink" href="#service-dockerfile" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="dockerfile">
|
||||
<h2>Dockerfile<a class="headerlink" href="#dockerfile" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This purpose of the Dockerfile is to define how to build the image for the service. It declares the environment and building stages.
|
||||
The Dockerfile is responsible for mounting the service application to whatever volume the manifest specifies, typically <code class="docutils literal notranslate"><span class="pre">/root/.<service-id></span></code>.</p>
|
||||
<p>Since the build requires specific arm runtime environments, these base images can be imported into the Dockerfile as a starting point so the base system does not need to be completely redefined. This enables importing a specific build environment version that encapsulates any necessary libraries for running the service build, eg. golang, rust.</p>
|
||||
<p>For instance:</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">FROM</span> <span class="pre">alpine:3.12</span></code></p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">FROM</span> <span class="pre">arm32v7/alpine</span></code></p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">FROM</span> <span class="pre">arm32v7/golang:alpine</span></code></p>
|
||||
<p>We recommended using <code class="docutils literal notranslate"><span class="pre">alpine</span></code> since it produces the smallest image. We try to keep the image under 100MB when possible.</p>
|
||||
</div>
|
||||
<div class="section" id="entry-point">
|
||||
<h2>Entry-point<a class="headerlink" href="#entry-point" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">docker_entrypoint.sh</span></code> defines what to do when the service application starts.</p>
|
||||
<p>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 for EmbassyOS.</p>
|
||||
</div>
|
||||
<div class="section" id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference external" href="https://github.com/Start9Labs/lnd-wrapper/blob/master/Dockerfile">LND wrapper</a> features a well defined Dockerfile, for example.</p>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../manifest/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Manifest
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../makefile/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Makefile
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Dockerfile</a><ul>
|
||||
<li><a class="reference internal" href="#dockerfile">Dockerfile</a></li>
|
||||
<li><a class="reference internal" href="#entry-point">Entry-point</a></li>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
599
docs/_build/dirhtml/contributing/services/index.html
vendored
Normal file
599
docs/_build/dirhtml/contributing/services/index.html
vendored
Normal file
@@ -0,0 +1,599 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Packaging Guide | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../"
|
||||
src="../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../_static/underscore.js"></script> <script src="../../_static/doctools.js"></script> <script src="../../_static/language_data.js"></script> <script src="../../_static/clipboard.min.js"></script> <script src="../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Packaging Guide</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Packaging Guide&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/index%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/index.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-packaging-guide">
|
||||
<span id="service-pacakge"></span><h1>Service Packaging Guide<a class="headerlink" href="#service-packaging-guide" title="Permalink to this headline">¶</a></h1>
|
||||
<p>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.</p>
|
||||
<p>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.</p>
|
||||
<p>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 <a class="reference external" href="https://matrix.to/#/#community-dev:matrix.start9labs.com">reach out</a> or submit a pull request with alterations.</p>
|
||||
<p>To start, you will need to acquire EmbassyOS for testing the packaged service. This can be done by:</p>
|
||||
<ul class="simple">
|
||||
<li><p>building from <a class="reference external" href="https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md#setting-up-your-development-environment">source</a></p></li>
|
||||
<li><p>following the <a class="reference internal" href="../../getting-started/diy/#diy"><span class="std std-ref">DIY</span></a> guide</p></li>
|
||||
<li><p><a class="reference internal" href="../../getting-started/purchasing/#purchasing"><span class="std std-ref">purchasing</span></a> the ready to run personal server</p></li>
|
||||
</ul>
|
||||
<p>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.</p>
|
||||
<p>Happy building!</p>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview/">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manifest/">Manifest</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="docker/">Docker</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="makefile/">Makefile</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="config/">Config</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="properties/">Properties</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="instructions/">Instructions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="backups/">Backups</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="submission-process">
|
||||
<h2>Submission process<a class="headerlink" href="#submission-process" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When you have built and tested your project for EmbassyOS, please send Start9 a submission with the project repository to <code class="docutils literal notranslate"><span class="pre">dev@start9labs.com</span></code>. After being reviewed for security and compatibility, the service will be deployed to the marketplace and available for all EmbassyOS users to download.</p>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../../misc-guides/tor-firefox/ios/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Setting up Firefox with Tor on iOS
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="overview/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Package Overview
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Packaging Guide</a><ul>
|
||||
<li><a class="reference internal" href="#submission-process">Submission process</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
584
docs/_build/dirhtml/contributing/services/instructions/index.html
vendored
Normal file
584
docs/_build/dirhtml/contributing/services/instructions/index.html
vendored
Normal file
@@ -0,0 +1,584 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Instructions & Documentation | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Instructions & Documentation</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Instructions & Documentation&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/instructions%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/instructions.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-instructions-documentation">
|
||||
<span id="service-instructions"></span><h1>Service Instructions & Documentation<a class="headerlink" href="#service-instructions-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Within each wrapper repository should exist a <code class="docutils literal notranslate"><span class="pre">docs</span></code> directory. This folder should include any pertinent documentation, instructions, external integrations, or other details about the service that users or developers might find relevant.</p>
|
||||
<p>If an <code class="docutils literal notranslate"><span class="pre">instructions.md</span></code> file is included, this markdown formatted file will be rendered in the “Instructions” tab within the service detail menu on EmbassyOS:</p>
|
||||
<div class="figure align-default">
|
||||
<a class="reference internal image-reference" href="../../../_images/bitcoin_instructions.png"><img alt="Bitcoin Instructions" src="../../../_images/bitcoin_instructions.png" style="width: 80%;" /></a>
|
||||
</div>
|
||||
<div class="section" id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference external" href="https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs">bitcoind wrapper</a> demonstrates a good use of instructions and external integrations.</p>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../properties/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Properties
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../backups/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Backups
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Instructions & Documentation</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
592
docs/_build/dirhtml/contributing/services/makefile/index.html
vendored
Normal file
592
docs/_build/dirhtml/contributing/services/makefile/index.html
vendored
Normal file
@@ -0,0 +1,592 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Makefile | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Makefile</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Makefile&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/makefile%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/makefile.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-makefile">
|
||||
<span id="id1"></span><h1>Service Makefile<a class="headerlink" href="#service-makefile" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p><em>This file is optional</em></p>
|
||||
</div>
|
||||
<p>A Makefile serves as a convenience for outlining the build. This helps streamline additional developer contributions to the project. Please reference the GNU <a class="reference external" href="https://www.gnu.org/software/make/manual/html_node/Introduction.html">documentation</a> for implementation details.</p>
|
||||
<p>An alternative to using <code class="docutils literal notranslate"><span class="pre">make</span></code> is to use the <a class="reference external" href="https://nixos.wiki/wiki/Nix">nix</a> specification.</p>
|
||||
<p>This purpose of this file is to:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Read the docker container and build the project</p></li>
|
||||
<li><p>Build all prerequisites for running the docker file</p></li>
|
||||
<li><p>Build all dependencies</p></li>
|
||||
<li><p>Package <code class="docutils literal notranslate"><span class="pre">config_rules.yaml</span></code>, <code class="docutils literal notranslate"><span class="pre">config_spec.yaml</span></code>, <code class="docutils literal notranslate"><span class="pre">manifest.yaml</span></code>, and <code class="docutils literal notranslate"><span class="pre">image.tar</span></code> into an <code class="docutils literal notranslate"><span class="pre">.s9pk</span></code> extension by invoking <code class="docutils literal notranslate"><span class="pre">appmgr</span></code>.</p></li>
|
||||
</ul>
|
||||
<div class="section" id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <a class="reference external" href="https://github.com/Start9Labs/lnd-wrapper/blob/master/Makefile">LND wrapper</a> features a well defined Makefile, for example.</p>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../docker/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Dockerfile
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../config/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Config Specification
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Makefile</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
905
docs/_build/dirhtml/contributing/services/manifest/index.html
vendored
Normal file
905
docs/_build/dirhtml/contributing/services/manifest/index.html
vendored
Normal file
@@ -0,0 +1,905 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Manifest | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Manifest</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Manifest&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/manifest%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/manifest.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-manifest">
|
||||
<span id="id1"></span><h1>Service Manifest<a class="headerlink" href="#service-manifest" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="overview">
|
||||
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This file describes the service and it’s requirements. It is used to:</p>
|
||||
<ul class="simple">
|
||||
<li><p>create a listing in the marketplace</p></li>
|
||||
<li><p>denote any installation considerations</p></li>
|
||||
<li><p>define dependency requirements</p></li>
|
||||
</ul>
|
||||
<p>Each time a service is updated, the manifest should be updated to include the new version, release notes, and any pertinent updates to the install, uninstall, or restoration flows. All this information is displayed in the marketplace listing, and the optionally denoted alerts will be displayed when appropriate to provide the user with more information.</p>
|
||||
<p>For instance, <a class="reference external" href="https://github.com/Start9Labs/lnd-wrapper/blob/master/manifest.yaml#L28">LND displays alerts</a> around restoration since data will be overwritten.</p>
|
||||
<p>There is nothing you need to do as a developer to set up Tor for running a service. This is <em>completely</em> handled by EmbassyOS - a Tor address will be automatically generated when the service is installed. Just define the port and which version of Tor the service needs in this manifest file! You do, however, need to ensure the service is in fact capable of running over Tor.</p>
|
||||
<p>The manifest is also responsible for outlining service <a class="reference internal" href="#dependencies"><span class="std std-ref">dependencies</span></a>. By defining rules using the <a class="reference internal" href="../config/#config-rules"><span class="std std-ref">EmbassyOS DSL specification</span></a>, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. EmbassyOS presents this information in a polished install/uninstall/update wizard, so there’s no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest!</p>
|
||||
</div>
|
||||
<div class="section" id="formatting">
|
||||
<h2>Formatting<a class="headerlink" href="#formatting" title="Permalink to this headline">¶</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Serialization language:<code class="docutils literal notranslate"><span class="pre">.yaml</span></code></p></li>
|
||||
<li><p>Case style: <code class="docutils literal notranslate"><span class="pre">kebab-case</span></code></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="type-definitions">
|
||||
<h2>Type definitions<a class="headerlink" href="#type-definitions" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Below are the types and sub-type definitions, with necessary elaborations. Any item that contains <code class="docutils literal notranslate"><span class="pre">Option<></span></code> is an optional field.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># manifest version compatibility ie. v0 (this is currently the only option)</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">compat</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v0</span>
|
||||
<span class="c1"># service id, used for uniqueness and BE identification ie. bitcoind</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">id</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># version number of the release conforming to the semantic versioning scheme</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">version</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># display name of service</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">title</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># an object containing a short and long description of the service. TODO character lengths</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">short</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">long</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># a link to the release tag notes in GitHub, or a short description TODO character length</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">release-notes</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># a notification message that should caution the user with any service particularities, eg. beta tech</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">install-alert</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Option<String></span>
|
||||
<span class="c1"># a notification message warning users of potential problems with uninstalling, such as dependency failures or data loss</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">uninstall-alert</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Option<String></span>
|
||||
<span class="c1"># a notification message containing warning or details about backup restoration</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">restore-alert</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Option<String></span>
|
||||
<span class="c1"># denoting the existence of instructions.md</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">has-instructions</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Boolean</span>
|
||||
<span class="c1"># required semver version range of EmbassyOS to run service eg. ">=1.0.0"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">os-version-required</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">VersionReq</span>
|
||||
<span class="c1"># recommended semver version range of EmbassyOS to run service eg."^1.0.0"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">os-version-recommended</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">VersionReq</span>
|
||||
<span class="c1"># a list of objects of ports to run the service on localhost and tor</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ports</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># currently only tar is supported</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">image</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># shared memory container size</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">shm-size-mb</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Option<usize></span>
|
||||
<span class="c1"># path to mount the image on the volume, ie: /root/bitcoind</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">mount</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># read only data exposed to dependencies (path is relevant to mount)</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">public</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Option<String></span>
|
||||
<span class="c1"># shared filesystem segment with each of your dependencies (path is relevant to mount)</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">shared</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Option<String></span>
|
||||
<span class="c1"># deprecated - will default to an empty vector</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">assets</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[]</span>
|
||||
<span class="c1"># version of tor support, eg. v2, v3</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">hidden-service-version</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">String</span>
|
||||
<span class="c1"># A map of dependent services, see below for more details</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">dependencies</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Dependencies</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="dependencies">
|
||||
<span id="id2"></span><h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Many services depend on other libraries and services on EmbassyOS (such as Bitcoin), sometimes even a particular version of those services, which need to be specified by the developers so that EmbassyOS can handle installing these dependencies under the hood.</p>
|
||||
<p>The key of each field in the dependencies object is the lowercase, kebab-case app ID of the service that is depended on. Each dependency contains a set of rules that need to be fulfilled as true if the dependency is to be properly installed. The “config rules” here are for auto-configuring dependencies - the action defined by the rule will be executed if the service is auto configured with defaults during initial setup. This simplifies and streamlines the user experience. The interface should provide suggestions for the behavior if the denoted rule cannot be met with previous configurations.</p>
|
||||
<p>Let’s take this snippet for example:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">...</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">dependencies</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">btc-rpc-proxy</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">version</span><span class="p p-Indicator">:</span> <span class="s">"^0.1.0"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">optional</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Can configure an external bitcoin node.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Required for fetching validated blocks.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">config</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.*.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"c-lightning"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'Must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">an</span><span class="nv"> </span><span class="s">RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">named</span><span class="nv"> </span><span class="s">"c-lightning"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">c-lightning</span>
|
||||
<span class="nn">...</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
<p>The service <code class="docutils literal notranslate"><span class="pre">btc-rpc-proxy</span></code> is a dependency of the service <code class="docutils literal notranslate"><span class="pre">c-lightning</span></code>. <code class="docutils literal notranslate"><span class="pre">c-lightning</span></code> requires it to be installed at a version >=0.1.0 <0.2.0. There exists a rule that states the config option <code class="docutils literal notranslate"><span class="pre">user.name</span></code> must be equal to “c-lightning”. If this value does not exist for <code class="docutils literal notranslate"><span class="pre">user.name</span></code> when accessed, <code class="docutils literal notranslate"><span class="pre">PUSH</span></code> the value “c-lighting” to the field. This all takes place during the initial service configuration, before the service is started for the first time.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Dependency config rules are processed in order.</p>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h3>Type definitions<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Types for <code class="docutils literal notranslate"><span class="pre">manifest.yaml</span></code> fields:</p>
|
||||
<div class="highlight-typescript notranslate"><div class="highlight"><pre><span></span><span class="kr">interface</span> <span class="nx">Dependencies</span> <span class="p">[{</span>
|
||||
<span class="nx">serviceId</span>: <span class="kt">DepInfo</span>
|
||||
<span class="p">}]</span>
|
||||
|
||||
<span class="kr">interface</span> <span class="nx">DepInfo</span> <span class="p">{</span>
|
||||
<span class="nx">version</span>: <span class="kt">String</span> <span class="c1">// ie. 0.11.1.1</span>
|
||||
<span class="nx">optional?</span>: <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="nx">description?</span>: <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="nx">config</span><span class="o">:</span> <span class="p">[</span><span class="nx">ConfigRule</span><span class="p">],</span>
|
||||
<span class="p">],</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kr">interface</span> <span class="nx">ConfigRule</span> <span class="p">{</span>
|
||||
<span class="nx">rule</span>: <span class="kt">String</span><span class="p">,</span> <span class="c1">// ie. 'users.*.name = "lnd"</span>
|
||||
<span class="nx">description</span>: <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="nx">suggestions</span><span class="o">:</span> <span class="p">[</span><span class="nx">SuggestionVariant</span><span class="p">]</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kr">interface</span> <span class="nx">SuggestionVariant</span> <span class="p">{</span>
|
||||
<span class="nx">SET</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="kd">var</span><span class="o">:</span> <span class="nb">String</span><span class="p">,</span>
|
||||
<span class="nx">to</span>: <span class="kt">SetVariant</span><span class="p">,</span>
|
||||
<span class="p">},</span>
|
||||
<span class="nx">DELETE</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">src</span>: <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="p">},</span>
|
||||
<span class="nx">PUSH</span><span class="o">:</span> <span class="p">{</span>
|
||||
<span class="nx">to</span>: <span class="kt">String</span><span class="p">,</span>
|
||||
<span class="nx">value</span>: <span class="kt">Value</span><span class="p">,</span>
|
||||
<span class="p">},</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="kr">interface</span> <span class="nx">SetVariant</span> <span class="p">{</span>
|
||||
<span class="nx">to</span>: <span class="kt">Option</span><span class="o"><</span><span class="nb">String</span><span class="o">></span><span class="p">,</span>
|
||||
<span class="nx">to</span><span class="o">-</span><span class="nx">value</span>: <span class="kt">Option</span><span class="o"><</span><span class="nx">Value</span><span class="o">></span><span class="p">,</span> <span class="c1">// ie. true/false</span>
|
||||
<span class="nx">to</span><span class="o">-</span><span class="nx">entropy</span>: <span class="kt">Option</span><span class="o"><</span><span class="p">{</span>
|
||||
<span class="nx">charset</span>: <span class="kt">String</span> <span class="c1">// ie. 'a-z,A-Z,0-9'</span>
|
||||
<span class="nx">len</span>: <span class="kt">number</span>
|
||||
<span class="p">}</span><span class="o">></span>
|
||||
<span class="p">}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
<div class="section" id="examples">
|
||||
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Actual <code class="docutils literal notranslate"><span class="pre">manifest.yaml</span></code> files for existing services:</p>
|
||||
<div class="section" id="lnd">
|
||||
<h4>LND<a class="headerlink" href="#lnd" title="Permalink to this headline">¶</a></h4>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">compat</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v0</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">id</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">lnd</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">version</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">0.11.1.1</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">title</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Lightning Network Daemon</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">short</span><span class="p p-Indicator">:</span> <span class="s">"A</span><span class="nv"> </span><span class="s">complete</span><span class="nv"> </span><span class="s">implementation</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">Lightning</span><span class="nv"> </span><span class="s">Network</span><span class="nv"> </span><span class="s">node</span><span class="nv"> </span><span class="s">by</span><span class="nv"> </span><span class="s">Lightning</span><span class="nv"> </span><span class="s">Labs"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">long</span><span class="p p-Indicator">:</span> <span class="s">"LND</span><span class="nv"> </span><span class="s">fully</span><span class="nv"> </span><span class="s">conforms</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">Lightning</span><span class="nv"> </span><span class="s">Network</span><span class="nv"> </span><span class="s">specification</span><span class="nv"> </span><span class="s">(BOLTs).</span><span class="nv"> </span><span class="s">BOLT</span><span class="nv"> </span><span class="s">stands</span><span class="nv"> </span><span class="s">for:</span><span class="nv"> </span><span class="s">Basis</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">Lightning</span><span class="nv"> </span><span class="s">Technology.</span><span class="nv"> </span><span class="s">In</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">current</span><span class="nv"> </span><span class="s">state</span><span class="nv"> </span><span class="s">lnd</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">capable</span><span class="nv"> </span><span class="s">of:</span><span class="nv"> </span><span class="s">creating</span><span class="nv"> </span><span class="s">channels,</span><span class="nv"> </span><span class="s">closing</span><span class="nv"> </span><span class="s">channels,</span><span class="nv"> </span><span class="s">managing</span><span class="nv"> </span><span class="s">all</span><span class="nv"> </span><span class="s">channel</span><span class="nv"> </span><span class="s">states</span><span class="nv"> </span><span class="s">(including</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">exceptional</span><span class="nv"> </span><span class="s">ones!),</span><span class="nv"> </span><span class="s">maintaining</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">fully</span><span class="nv"> </span><span class="s">authenticated+validated</span><span class="nv"> </span><span class="s">channel</span><span class="nv"> </span><span class="s">graph,</span><span class="nv"> </span><span class="s">performing</span><span class="nv"> </span><span class="s">path</span><span class="nv"> </span><span class="s">finding</span><span class="nv"> </span><span class="s">within</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">network,</span><span class="nv"> </span><span class="s">passively</span><span class="nv"> </span><span class="s">forwarding</span><span class="nv"> </span><span class="s">incoming</span><span class="nv"> </span><span class="s">payments,</span><span class="nv"> </span><span class="s">sending</span><span class="nv"> </span><span class="s">outgoing</span><span class="nv"> </span><span class="s">onion-encrypted</span><span class="nv"> </span><span class="s">payments</span><span class="nv"> </span><span class="s">through</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">network,</span><span class="nv"> </span><span class="s">updating</span><span class="nv"> </span><span class="s">advertised</span><span class="nv"> </span><span class="s">fee</span><span class="nv"> </span><span class="s">schedules,</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">automatic</span><span class="nv"> </span><span class="s">channel</span><span class="nv"> </span><span class="s">management</span><span class="nv"> </span><span class="s">(autopilot)."</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">release-notes</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">https://github.com/lightningnetwork/lnd/releases/tag/v0.11.1-beta</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ports</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">8080</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">8080</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">9735</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">9735</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">9911</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">9911</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">10009</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">10009</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">image</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">tar</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">mount</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">/root/.lnd</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">public</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">public</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">has-instructions</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">os-version-required</span><span class="p p-Indicator">:</span> <span class="s">">=0.2.8"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">os-version-recommended</span><span class="p p-Indicator">:</span> <span class="s">">=0.2.8"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">install-alert</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">|</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">READ CAREFULLY! LND and the Lightning Network are considered beta software. Please use with caution and do not risk more money than you are willing to lose. We encourage frequent backups. If for any reason, you need to restore LND from a backup, your on-chain wallet will be restored, but all your channels will be closed and their funds returned to your on-chain wallet, minus fees. It may also take some time for this process to occur.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">uninstall-alert</span><span class="p p-Indicator">:</span> <span class="s">"READ</span><span class="nv"> </span><span class="s">CAREFULLY!</span><span class="nv"> </span><span class="s">Uninstalling</span><span class="nv"> </span><span class="s">LND</span><span class="nv"> </span><span class="s">will</span><span class="nv"> </span><span class="s">result</span><span class="nv"> </span><span class="s">in</span><span class="nv"> </span><span class="s">permanent</span><span class="nv"> </span><span class="s">loss</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">data,</span><span class="nv"> </span><span class="s">including</span><span class="nv"> </span><span class="s">its</span><span class="nv"> </span><span class="s">private</span><span class="nv"> </span><span class="s">keys</span><span class="nv"> </span><span class="s">for</span><span class="nv"> </span><span class="s">its</span><span class="nv"> </span><span class="s">on-chain</span><span class="nv"> </span><span class="s">wallet</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">all</span><span class="nv"> </span><span class="s">channel</span><span class="nv"> </span><span class="s">states.</span><span class="nv"> </span><span class="s">Please</span><span class="nv"> </span><span class="s">make</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">backup</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">you</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">any</span><span class="nv"> </span><span class="s">funds</span><span class="nv"> </span><span class="s">in</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">on-chain</span><span class="nv"> </span><span class="s">wallet</span><span class="nv"> </span><span class="s">or</span><span class="nv"> </span><span class="s">in</span><span class="nv"> </span><span class="s">any</span><span class="nv"> </span><span class="s">channels.</span><span class="nv"> </span><span class="s">Recovering</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">backup</span><span class="nv"> </span><span class="s">will</span><span class="nv"> </span><span class="s">restore</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">on-chain</span><span class="nv"> </span><span class="s">wallet,</span><span class="nv"> </span><span class="s">but</span><span class="nv"> </span><span class="s">due</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">architecture</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">Lightning</span><span class="nv"> </span><span class="s">Network,</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">channels</span><span class="nv"> </span><span class="s">cannot</span><span class="nv"> </span><span class="s">be</span><span class="nv"> </span><span class="s">recovered.</span><span class="nv"> </span><span class="s">All</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">channels</span><span class="nv"> </span><span class="s">will</span><span class="nv"> </span><span class="s">be</span><span class="nv"> </span><span class="s">closed</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">their</span><span class="nv"> </span><span class="s">funds</span><span class="nv"> </span><span class="s">returned</span><span class="nv"> </span><span class="s">to</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">on-chain</span><span class="nv"> </span><span class="s">wallet,</span><span class="nv"> </span><span class="s">minus</span><span class="nv"> </span><span class="s">fees.</span><span class="nv"> </span><span class="s">\n"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">restore-alert</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">|</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">Restoring LND will overwrite its current data, including its on-chain wallet and channels. Any channels opened since the last backup will be forgotten and may linger indefinitely, and channels contained in the backup will be closed and their funds returned to your on-chain wallet, minus fees.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">assets</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[]</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">hidden-service-version</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v3</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">dependencies</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">btc-rpc-proxy</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">version</span><span class="p p-Indicator">:</span> <span class="s">"^0.2.4"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">optional</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Can alternatively configure an external bitcoin node.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Used to fetch validated blocks.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">config</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.*.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'Must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">an</span><span class="nv"> </span><span class="s">RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">named</span><span class="nv"> </span><span class="s">"lnd"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">"users"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">lnd</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">allowed-calls</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">[]</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">SET</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">var</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].password'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to-entropy</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">charset</span><span class="p p-Indicator">:</span> <span class="s">"a-z,A-Z,0-9"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">len</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">22</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getinfo"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getinfo"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getinfo"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getbestblockhash"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getbestblockhash"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getbestblockhash"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"gettxout"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"gettxout"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"gettxout"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getblockchaininfo"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getblockchaininfo"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getblockchaininfo"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"sendrawtransaction"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"sendrawtransaction"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"sendrawtransaction"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getblockhash"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getblockhash"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getblockhash"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getblock"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getblock"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getblock"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getblockheader"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getblockheader"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getblockheader"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"estimatesmartfee"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"estimatesmartfee"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"estimatesmartfee"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'</span><span class="se">''</span><span class="s">users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls.*</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"getnetworkinfo"'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"getnetworkinfo"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">PUSH</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].allowed-calls'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">value</span><span class="p p-Indicator">:</span> <span class="s">"getnetworkinfo"</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].fetch-blocks?'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">'RPC</span><span class="nv"> </span><span class="s">user</span><span class="nv"> </span><span class="s">"lnd"</span><span class="nv"> </span><span class="s">must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">"Fetch</span><span class="nv"> </span><span class="s">Blocks"</span><span class="nv"> </span><span class="s">enabled'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">SET</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">var</span><span class="p p-Indicator">:</span> <span class="s">'users.[first(item</span><span class="nv"> </span><span class="s">=></span><span class="nv"> </span><span class="se">''</span><span class="s">item.name</span><span class="nv"> </span><span class="s">=</span><span class="nv"> </span><span class="s">"lnd")].fetch-blocks'</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to-value</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">bitcoind</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">version</span><span class="p p-Indicator">:</span> <span class="s">"^0.21.0"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">optional</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Can alternatively configure an external bitcoin node.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">Used to subscribe to new block events.</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">config</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">rule</span><span class="p p-Indicator">:</span> <span class="s">"zmq-enabled?"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span> <span class="s">"Must</span><span class="nv"> </span><span class="s">have</span><span class="nv"> </span><span class="s">an</span><span class="nv"> </span><span class="s">ZeroMQ</span><span class="nv"> </span><span class="s">enabled"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">suggestions</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">SET</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">var</span><span class="p p-Indicator">:</span> <span class="s">"zmq-enabled"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">to-value</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="cups">
|
||||
<h4>Cups<a class="headerlink" href="#cups" title="Permalink to this headline">¶</a></h4>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">compat</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v0</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">id</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">cups</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">version</span><span class="p p-Indicator">:</span> <span class="s">"0.3.6"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">title</span><span class="p p-Indicator">:</span> <span class="s">"Cups</span><span class="nv"> </span><span class="s">Messenger"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">description</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">short</span><span class="p p-Indicator">:</span> <span class="s">"Real</span><span class="nv"> </span><span class="s">private</span><span class="nv"> </span><span class="s">messaging"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">long</span><span class="p p-Indicator">:</span> <span class="s">"Cups</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">private,</span><span class="nv"> </span><span class="s">self-hosted,</span><span class="nv"> </span><span class="s">peer-to-peer,</span><span class="nv"> </span><span class="s">Tor-based,</span><span class="nv"> </span><span class="s">instant</span><span class="nv"> </span><span class="s">messenger.</span><span class="nv"> </span><span class="s">Unlike</span><span class="nv"> </span><span class="s">other</span><span class="nv"> </span><span class="s">end-to-end</span><span class="nv"> </span><span class="s">encrypted</span><span class="nv"> </span><span class="s">messengers,</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">Cups</span><span class="nv"> </span><span class="s">on</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">Embassy</span><span class="nv"> </span><span class="s">there</span><span class="nv"> </span><span class="s">are</span><span class="nv"> </span><span class="s">no</span><span class="nv"> </span><span class="s">trusted</span><span class="nv"> </span><span class="s">third</span><span class="nv"> </span><span class="s">parties."</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">release-notes</span><span class="p p-Indicator">:</span> <span class="p p-Indicator">|</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">Features</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">- Adds instructions defined by EmbassyOS 0.2.4 instructions feature</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">ports</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">59001</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">59001</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">internal</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">80</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">tor</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">80</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">image</span><span class="p p-Indicator">:</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">type</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">tar</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">mount</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">/root</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">has-instructions</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">os-version-required</span><span class="p p-Indicator">:</span> <span class="s">">=0.2.4"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">os-version-recommended</span><span class="p p-Indicator">:</span> <span class="s">">=0.2.4"</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">assets</span><span class="p p-Indicator">:</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">src</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">httpd.conf</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">dst</span><span class="p p-Indicator">:</span> <span class="s">"."</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">overwrite</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">src</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">www</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">dst</span><span class="p p-Indicator">:</span> <span class="s">"."</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">overwrite</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
<span class="l l-Scalar l-Scalar-Plain">hidden-service-version</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">v3</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../wrapper/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Wrapper
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../docker/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Dockerfile
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Manifest</a><ul>
|
||||
<li><a class="reference internal" href="#overview">Overview</a></li>
|
||||
<li><a class="reference internal" href="#formatting">Formatting</a></li>
|
||||
<li><a class="reference internal" href="#type-definitions">Type definitions</a></li>
|
||||
<li><a class="reference internal" href="#dependencies">Dependencies</a><ul>
|
||||
<li><a class="reference internal" href="#id3">Type definitions</a></li>
|
||||
<li><a class="reference internal" href="#examples">Examples</a><ul>
|
||||
<li><a class="reference internal" href="#lnd">LND</a></li>
|
||||
<li><a class="reference internal" href="#cups">Cups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
657
docs/_build/dirhtml/contributing/services/overview/index.html
vendored
Normal file
657
docs/_build/dirhtml/contributing/services/overview/index.html
vendored
Normal file
@@ -0,0 +1,657 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Package Overview | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Package Overview</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Package Overview&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/overview%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/overview.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-package-overview">
|
||||
<span id="id1"></span><h1>Service Package Overview<a class="headerlink" href="#service-package-overview" title="Permalink to this headline">¶</a></h1>
|
||||
<p>There are several main components that comprise a service package for EmbassyOS. This overview will introduce them and following sections will dive into technical specifics.</p>
|
||||
<p>First, let’s get your system setup with the necessary software dependencies.</p>
|
||||
<div class="section" id="environment-setup">
|
||||
<h2>Environment Setup<a class="headerlink" href="#environment-setup" title="Permalink to this headline">¶</a></h2>
|
||||
<p>At minimum, <code class="docutils literal notranslate"><span class="pre">docker</span></code>, <code class="docutils literal notranslate"><span class="pre">docker-buildx</span></code>, and <code class="docutils literal notranslate"><span class="pre">appmgr</span></code> are required. The rest of the recommendations serve to optimize the build process.</p>
|
||||
<div class="section" id="recommended-dependencies">
|
||||
<h3>Recommended Dependencies<a class="headerlink" href="#recommended-dependencies" title="Permalink to this headline">¶</a></h3>
|
||||
<blockquote>
|
||||
<div><p><a class="reference external" href="https://docs.docker.com/get-docker">docker</a></p>
|
||||
<p><a class="reference external" href="https://docs.docker.com/buildx/working-with-buildx/">docker-buildx</a></p>
|
||||
<p><a class="reference external" href="https://github.com/Start9Labs/embassy-os/tree/master/appmgr">appmgr</a></p>
|
||||
<p><a class="reference external" href="https://doc.rust-lang.org/cargo/">cargo</a></p>
|
||||
<p><a class="reference external" href="https://mikefarah.gitbook.io/yq">yq (version 4)</a></p>
|
||||
<p><a class="reference external" href="https://www.gnu.org/software/make/">make</a></p>
|
||||
<p><a class="reference external" href="https://github.com/Start9Labs/rust-musl-cross">musl</a></p>
|
||||
</div></blockquote>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="package-components">
|
||||
<h2>Package Components<a class="headerlink" href="#package-components" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="image">
|
||||
<h3>Image<a class="headerlink" href="#image" title="Permalink to this headline">¶</a></h3>
|
||||
<p>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 <a class="reference external" href="https://docs.docker.com/">resources</a> for developing with this containerization tool.</p>
|
||||
<p>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 <a class="reference internal" href="../manifest/#service-manifest"><span class="std std-ref">manifest</span></a> configuration file.</p>
|
||||
<p>The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features.</p>
|
||||
</div>
|
||||
<div class="section" id="volume">
|
||||
<h3>Volume<a class="headerlink" href="#volume" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Each service application gets a volume allocated to it by EmbassyOS. All service application data is stored in this directory and is persisted across updates.</p>
|
||||
<p>The volume directory (for seeding data into the volume) is typically: <code class="docutils literal notranslate"><span class="pre">/root/volumes/<service-id></span></code>.</p>
|
||||
<div class="admonition warning">
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>Any files that are in the image at the volume path will be overwritten when a backup restore occurs.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="dependencies">
|
||||
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline">¶</a></h3>
|
||||
<p>When it comes to running your own server, managing dependencies is perhaps the most difficult part. The term “dependency hell” emerged from this sentiment. Even the best developers have lost significant amounts of time trying to find, correct, or clarify documentation for dependencies or dependency configuration. Individuals who manage their own servers have specific technical skills and are willing to devote the time and effort necessary to maintain them. Companies have entire departments dedicated to this feat.</p>
|
||||
<p>Some other personal server products aimed at non-technical individuals tackle this problem by simply hard coding dependencies. Since EmbassyOS is a platform for running all open-source, self-hosted software, it is not possible to hard code every possible service, service dependency, and service dependency configuration forever. Instead, Start9 built a new, unprecedented operating system that touts a generalized, intuitive approach to dependency management and service configuration. EmbassyOS enables users to easily and selectively install, uninstall, and update any service they want without getting stuck in dependency hell.</p>
|
||||
<p>This may sound cool or neat, but it is more than that: <em>it’s novel</em>. This has never been done before.</p>
|
||||
<p>The key to making the system work is a new, domain-specific-language (DSL) and set of standards that are used by developers to define the rules and requirements of their services. Run in the context of EmbassyOS, these rules and requirements appear as simple UI elements, such as inputs, toggles, and drop downs, and they are enforced by validations and clear user instructions. Using this system, what previously required involved time and expertise, can now be done by anyone in a matter of seconds.</p>
|
||||
<p>This DSL is utilized in the <a class="reference internal" href="../config/#config-rules"><span class="std std-ref">config rules</span></a> and <a class="reference internal" href="../manifest/#dependencies"><span class="std std-ref">dependencies</span></a> key in the service manifest.</p>
|
||||
</div>
|
||||
<div class="section" id="manifest">
|
||||
<h3>Manifest<a class="headerlink" href="#manifest" title="Permalink to this headline">¶</a></h3>
|
||||
<p>This file describes the service and its requirements. It is used to:</p>
|
||||
<ul class="simple">
|
||||
<li><p>create a listing in the marketplace</p></li>
|
||||
<li><p>denote any installation considerations</p></li>
|
||||
<li><p>define dependency requirements</p></li>
|
||||
</ul>
|
||||
<p>Each time a service is updated, the manifest should be updated to include the new version, release notes, and any pertinent updates to the install, uninstall, or restoration flows. All this information is displayed in the marketplace listing, and the optionally denoted alerts will be displayed when appropriate to provide the user with more information about the particularities of the service.</p>
|
||||
<p>For instance, <a class="reference external" href="https://github.com/Start9Labs/lnd-wrapper/blob/master/manifest.yaml#L28">LND displays alerts</a> around restoration since data will be overwritten.</p>
|
||||
<p>There is nothing you need to do as a developer to enable the service to run over Tor. This is <em>completely</em> handled by EmbassyOS - a Tor address will be automatically generated and an Nginx server configured (if a client application) when the service is installed. Just define which version of Tor your service needs in this manifest file!</p>
|
||||
</div>
|
||||
<div class="section" id="config">
|
||||
<h3>Config<a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Most self-hosted applications require the user to tell the app how to behave using a config file in a specific format, environment variables, command-line arguments, or some combination of these inputs. One of the coolest features of EmbassyOS is that, when packaged correctly, the app’s <a class="reference internal" href="../config/#service-config"><span class="std std-ref">configuration</span></a> will be available to the user as a slick GUI that always produces a valid configuration no matter how little experience or skill the user has.</p>
|
||||
<p>With EmbassyOS, this means a service wrappers’ configuration requires a particular format and rule structure to ensure it integrates smoothly with the user interface. This format enables clean handling of improper values and configuration dependencies.</p>
|
||||
</div>
|
||||
<div class="section" id="s9pk-bundle">
|
||||
<h3>.s9pk Bundle<a class="headerlink" href="#s9pk-bundle" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The configuration and manifest files get bundled into the <code class="docutils literal notranslate"><span class="pre">.s9pk</span></code> package, which is <a class="reference external" href="https://github.com/Start9Labs/embassy-os/tree/master/appmgr">built using appmgr</a>. Each new version release should include the updated version of these files re-bundled into a new binary. This is the file that will be downloaded from the marketplace. Upon user initiation, EmbassyOS then un-packages and installs the service.</p>
|
||||
</div>
|
||||
<div class="section" id="hello-world-example">
|
||||
<h3>Hello World Example<a class="headerlink" href="#hello-world-example" title="Permalink to this headline">¶</a></h3>
|
||||
<p>For reference, the <a class="reference external" href="https://github.com/Start9Labs/hello-world-wrapper">Hello world</a> repository should be used as an example. A project template can be cloned using the “Use this template” button in GitHub.</p>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Packaging Guide
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../wrapper/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Wrapper
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Package Overview</a><ul>
|
||||
<li><a class="reference internal" href="#environment-setup">Environment Setup</a><ul>
|
||||
<li><a class="reference internal" href="#recommended-dependencies">Recommended Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#package-components">Package Components</a><ul>
|
||||
<li><a class="reference internal" href="#image">Image</a></li>
|
||||
<li><a class="reference internal" href="#volume">Volume</a></li>
|
||||
<li><a class="reference internal" href="#dependencies">Dependencies</a></li>
|
||||
<li><a class="reference internal" href="#manifest">Manifest</a></li>
|
||||
<li><a class="reference internal" href="#config">Config</a></li>
|
||||
<li><a class="reference internal" href="#s9pk-bundle">.s9pk Bundle</a></li>
|
||||
<li><a class="reference internal" href="#hello-world-example">Hello World Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
585
docs/_build/dirhtml/contributing/services/properties/index.html
vendored
Normal file
585
docs/_build/dirhtml/contributing/services/properties/index.html
vendored
Normal file
@@ -0,0 +1,585 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Properties | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Properties</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Properties&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/properties%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/properties.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-properties">
|
||||
<span id="id1"></span><h1>Service Properties<a class="headerlink" href="#service-properties" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The output of this step is a file titled <code class="docutils literal notranslate"><span class="pre">stats.yaml</span></code>. This file contains a mapping of the values that will be displayed in the <code class="docutils literal notranslate"><span class="pre">Properties</span></code> section in a service’s menu.</p>
|
||||
<div class="figure align-default" id="id2">
|
||||
<a class="reference internal image-reference" href="../../../_images/service_properties.png"><img alt="Service Properties" src="../../../_images/service_properties.png" style="width: 80%;" /></a>
|
||||
<p class="caption"><span class="caption-text">Service Properties Tab</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>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 <code class="docutils literal notranslate"><span class="pre">configurator/src/main.rs</span></code>. This file is essentially a script that acquires the necessary values at runtime from config (eg. <code class="docutils literal notranslate"><span class="pre">/root/.lnd/start9/config.yaml</span></code>), and dynamically populating them to the <code class="docutils literal notranslate"><span class="pre">stats.yaml</span></code> file, marking each value with the appropriate keys for UI display (ie. masked or copyable). Running the configurator is typically included in the <code class="docutils literal notranslate"><span class="pre">docker_entrypoint.sh</span></code> file.</p>
|
||||
<div class="section" id="example">
|
||||
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
|
||||
<p>A good example of the configurator producing the <code class="docutils literal notranslate"><span class="pre">stats.yaml</span></code> file can be found <a class="reference external" href="https://github.com/Start9Labs/lnd-wrapper/blob/master/configurator/src/main.rs">here</a>.</p>
|
||||
<p><span class="raw-html"><br /></span></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../config/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Config Specification
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../instructions/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Instructions & Documentation
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../wrapper/">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Properties</a><ul>
|
||||
<li><a class="reference internal" href="#example">Example</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
607
docs/_build/dirhtml/contributing/services/wrapper/index.html
vendored
Normal file
607
docs/_build/dirhtml/contributing/services/wrapper/index.html
vendored
Normal file
@@ -0,0 +1,607 @@
|
||||
|
||||
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="no-js" lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width initial-scale=1" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<title> Service Wrapper | Start9 Docs
|
||||
</title>
|
||||
<meta name="description" content="Start9 Product Documentation and Education Guides" />
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon.ico"
|
||||
type="image/x-icon"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-32x32.png"
|
||||
sizes="32x32"
|
||||
/>
|
||||
<link
|
||||
rel="icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
sizes="192x192"
|
||||
/>
|
||||
<link
|
||||
rel="apple-touch-icon"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<meta
|
||||
name="msapplication-TileImage"
|
||||
href="../../../_static/img/favicon-228x228.png"
|
||||
/>
|
||||
<link rel="canonical" href="https://docs.start9.com/" />
|
||||
<link rel="author" href="mailto:support@start9labs.com" />
|
||||
<!-- connect to domain of font files -->
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
||||
|
||||
<!-- optionally increase loading priority -->
|
||||
<link
|
||||
rel="preload"
|
||||
as="style"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- async CSS -->
|
||||
<link
|
||||
rel="stylesheet"
|
||||
media="print"
|
||||
onload="this.onload=null;this.removeAttribute('media');"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
|
||||
<!-- no-JS fallback -->
|
||||
<noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
|
||||
/>
|
||||
</noscript>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/css/main.css"
|
||||
type="text/css"
|
||||
/>
|
||||
<link
|
||||
rel="stylesheet"
|
||||
href="../../../_static/pygments.css"
|
||||
type="text/css"
|
||||
/> <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" />
|
||||
|
||||
<script
|
||||
type="text/javascript"
|
||||
id="documentation_options"
|
||||
data-url_root="../../../"
|
||||
src="../../../_static/documentation_options.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/runtime.bundle.js"
|
||||
></script>
|
||||
<script
|
||||
type="text/javascript"
|
||||
src="../../../_static/js/main.bundle.js"
|
||||
></script> <script src="../../../_static/underscore.js"></script> <script src="../../../_static/doctools.js"></script> <script src="../../../_static/language_data.js"></script> <script src="../../../_static/clipboard.min.js"></script> <script src="../../../_static/copybutton.js"></script>
|
||||
|
||||
<!-- Google Tag Manager -->
|
||||
<script>
|
||||
(function (w, d, s, l, i) {
|
||||
w[l] = w[l] || [];
|
||||
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
|
||||
var f = d.getElementsByTagName(s)[0],
|
||||
j = d.createElement(s),
|
||||
dl = l != "dataLayer" ? "&l=" + l : "";
|
||||
j.async = true;
|
||||
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
|
||||
f.parentNode.insertBefore(j, f);
|
||||
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
|
||||
</script>
|
||||
<!-- End Google Tag Manager -->
|
||||
<!-- Marketo -->
|
||||
<script type="text/javascript">
|
||||
(function () {
|
||||
var didInit = false;
|
||||
function initMunchkin() {
|
||||
if (didInit === false) {
|
||||
didInit = true;
|
||||
Munchkin.init("791-QBF-350");
|
||||
}
|
||||
}
|
||||
var s = document.createElement("script");
|
||||
s.type = "text/javascript";
|
||||
s.async = true;
|
||||
s.src = "//munchkin.marketo.net/munchkin.js";
|
||||
s.onreadystatechange = function () {
|
||||
if (this.readyState == "complete" || this.readyState == "loaded") {
|
||||
initMunchkin();
|
||||
}
|
||||
};
|
||||
s.onload = initMunchkin;
|
||||
document.getElementsByTagName("head")[0].appendChild(s);
|
||||
})();
|
||||
</script>
|
||||
<!-- End Marketo -->
|
||||
<!-- Expertrec -->
|
||||
<script>
|
||||
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
|
||||
var ci_search = document.createElement("script");
|
||||
ci_search.type = "text/javascript";
|
||||
ci_search.async = true;
|
||||
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
|
||||
var s = document.getElementsByTagName("script")[0];
|
||||
s.parentNode.insertBefore(ci_search, s);
|
||||
</script>
|
||||
<!-- End Expertrec -->
|
||||
|
||||
<!-- Font Awesome -->
|
||||
<script
|
||||
src="https://kit.fontawesome.com/b1870adf6a.js"
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<!-- End Font Awesome -->
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="header">
|
||||
<div class="header-logo">
|
||||
<a class="header-logo__img" href="https://start9.com/">
|
||||
<img
|
||||
src="../../../_static/img/logo.png"
|
||||
alt="Start9 Logo"
|
||||
/>
|
||||
</a>
|
||||
<span class="header-logo__bar"></span>
|
||||
<a class="header-logo__text" href="https://docs.start9.com/">
|
||||
Documentation
|
||||
</a>
|
||||
</div>
|
||||
<div class="header-navigation">
|
||||
<ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--header"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/developing"
|
||||
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/service-packaging"
|
||||
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
|
||||
>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a href="#" class="scylla-dropdown__title"
|
||||
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
|
||||
></a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a href="https://docs.start9.com/about">
|
||||
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/license">
|
||||
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
|
||||
>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://docs.start9.com/careers">
|
||||
<i class="scylla-icon scylla-icon--careers"></i>Hiring
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="header-button">
|
||||
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="header-search-box">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav-toggle" data-toggle="side-nav">
|
||||
<div class="side-nav-toggle__button">
|
||||
<img src="../../../_static/img/menu.svg" alt="Menu" />
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<section class="layout ">
|
||||
<div class="content large-order-2">
|
||||
|
||||
|
||||
<div class="pre-content">
|
||||
<div class="pre-content__left"><div class="breadcrumbs">
|
||||
<span class="bread__item">
|
||||
<a
|
||||
href="../../../"
|
||||
class="bread__highlight"
|
||||
>
|
||||
<i class="fas fa-home"></i> Start9 Docs</a
|
||||
></span
|
||||
>
|
||||
|
||||
<span class="bread__item"
|
||||
><a href="../">Service Packaging Guide</a></span
|
||||
>
|
||||
|
||||
<span class="bread__item bread__item--last">Service Wrapper</span>
|
||||
</div></div>
|
||||
<div class="pre-content__right"><ul
|
||||
class="dropdown menu scylla-dropdown scylla-dropdown--contribute"
|
||||
data-dropdown-menu
|
||||
>
|
||||
<li class="scylla-dropdown__item">
|
||||
<a class="scylla-dropdown__title" href="#">
|
||||
<div class="scylla-dropdown__title--body">
|
||||
<i class="icon fa fa-github" aria-hidden="true"></i>
|
||||
Contribute
|
||||
</div>
|
||||
<i class="chevron scylla-icon scylla-icon--chevron-right"></i>
|
||||
</a>
|
||||
<ul class="menu scylla-dropdown__content">
|
||||
<li>
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/issues/new?title=Issue in page Service Wrapper&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/contributing/services/wrapper%0A%0A%23%23%23%20Problem%0A%0A%23%23%23%20%20Suggest%20a%20fix"
|
||||
target="_blank"
|
||||
>Report a doc issue
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a
|
||||
href="https://github.com/Start9Labs/documentation/edit/master/docs/source/contributing/services/wrapper.rst"
|
||||
target="_blank"
|
||||
>Edit this page
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="https://docs.start9.com/contributing/" target="_blank"
|
||||
>Learn how to contribute
|
||||
<i class="icon fa fa-external-link" aria-hidden="true"></i
|
||||
></a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<div class="section" id="service-wrapper">
|
||||
<span id="id1"></span><h1>Service Wrapper<a class="headerlink" href="#service-wrapper" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Each service is bound with a wrapper repository, which contains everything you need to build a service.</p>
|
||||
<p>The purpose of this repo is:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Denote any dependencies required to run and build the project</p></li>
|
||||
<li><p>To define the necessary, <code class="docutils literal notranslate"><span class="pre">config_rules.yaml</span></code>, <code class="docutils literal notranslate"><span class="pre">config_spec.yaml</span></code> and <code class="docutils literal notranslate"><span class="pre">manifest.yaml</span></code> options</p></li>
|
||||
<li><p>To build the project into the <code class="docutils literal notranslate"><span class="pre">.s9pk</span></code> format digestible to EmbassyOS</p></li>
|
||||
<li><p>Link to the source project as a git submodule</p></li>
|
||||
<li><p>Define the docker file for running the project on EmbassyOS</p></li>
|
||||
<li><p>Provide documentation for the project, especially user runbook instructions</p></li>
|
||||
<li><p>symlink of <code class="docutils literal notranslate"><span class="pre">instructions.md</span></code> from <code class="docutils literal notranslate"><span class="pre">docs</span></code> directory to wrapper repo root, if included</p></li>
|
||||
</ul>
|
||||
<div class="section" id="file-structure">
|
||||
<h2>File Structure<a class="headerlink" href="#file-structure" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The project structure should be used as a model:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>├── Dockerfile
|
||||
├── Makefile <span class="o">(</span>optional<span class="o">)</span>
|
||||
├── README.md
|
||||
├── config_rules.yaml
|
||||
├── config_spec.yaml
|
||||
├── <submodule_project_dir>
|
||||
├── docker_entrypoint.sh
|
||||
├── docs
|
||||
│ └── instructions.md
|
||||
└── manifest.yaml
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="submodule">
|
||||
<h2>Submodule<a class="headerlink" href="#submodule" title="Permalink to this headline">¶</a></h2>
|
||||
<p><a class="reference external" href="https://www.git-scm.com/book/en/v2/Git-Tools-Submodules">Git submodules</a> allow use of another project while in the working project directory. Setting up this feature enables linking of the source service repository so that its context is available.</p>
|
||||
<p>Run <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">submodule</span> <span class="pre">add</span> <span class="pre"><link_to_source_project></span></code></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="content-navigation">
|
||||
<div class="navigation navigation--prev">
|
||||
<a class="navigation__link" href="../overview/">
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="navigation__title">
|
||||
<span class="colored">PREVIOUS</span> <br />Service Package Overview
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="navigation navigation--next">
|
||||
<a class="navigation__link" href="../manifest/">
|
||||
<div class="navigation__title">
|
||||
<span class="colored">NEXT</span> <br />Service Manifest
|
||||
</div>
|
||||
<button class="navigation__button">
|
||||
<i class="scylla-icon scylla-icon--chevron-right"></i>
|
||||
</button>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div
|
||||
class="sidebar-left large-order-1"
|
||||
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
|
||||
<button class="collapsible-button">
|
||||
<i class="scylla-icon scylla-icon--chevron-left"></i>
|
||||
</button>
|
||||
<div class="side-nav-content">
|
||||
<div class="side-nav__search">
|
||||
<div class="search-box">
|
||||
<ci-search></ci-search>
|
||||
</div>
|
||||
</div>
|
||||
<div class="side-nav__versions">
|
||||
|
||||
</div>
|
||||
<div class="side-nav__content">
|
||||
<p class="caption"><span class="caption-text">Getting Started</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/introduction/">Introduction</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/purchasing/">Purchasing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../getting-started/diy/">DIY Guide</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/initial-setup/">Initial Setup</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../user-manual/connecting/">Connecting</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/embassy-config/">Config Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/updating/">Updating EmbassyOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/wifi/">Setting up WiFi</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/power/">Power</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/notifications/">Notifications</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3 has-children"><a class="reference internal" href="../../../user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="../../../user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../user-manual/general/lan-setup/mobile/">Mobile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/general/forgot-password/">Forgot Password</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/installing/">Install / Uninstall</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/backups/">Backups</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/service-config/">Service Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/logs/">Viewing Logs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Misc Guides</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/available-services/">Available Services</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/mac/">MacOS</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/windows/">Windows</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/linux/">Linux</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/android/">Android</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-os/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../misc-guides/tor-firefox/desktop/">Desktop</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../../misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/android/">Android</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../../misc-guides/tor-firefox/ios/">iOS</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Contributing</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Service Packaging Guide</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label for="toctree-checkbox-9"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="../overview/">Overview</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Wrapper</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manifest/">Manifest</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../docker/">Docker</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../makefile/">Makefile</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../config/">Config</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../properties/">Properties</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../instructions/">Instructions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../backups/">Backups</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../embassyos/">EmbassyOS</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Support</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../support/FAQ/">Frequently Asked Questions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label for="toctree-checkbox-10"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/general-faq/">General</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/embassy-faq/">Embassy (Device, OS, and DIY)</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/usage-faq/">Basic Usage</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/setup-faq/">Setup and Troubleshooting</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/services-faq/">Services</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/bitcoin-faq/">Bitcoin and Lightning Network</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/030-faq/">EmbassyOS Version 0.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../support/FAQ/dev-faq/">Contributing & Development</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/concepts/">Concepts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../support/contact/">Contact</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-right large-order-3">
|
||||
<div class="secondary-side-nav custom-scroll-bar">
|
||||
<div class="secondary-side-nav__content">
|
||||
<p class="topic-title">On this page</p>
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">Service Wrapper</a><ul>
|
||||
<li><a class="reference internal" href="#file-structure">File Structure</a></li>
|
||||
<li><a class="reference internal" href="#submodule">Submodule</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-group">
|
||||
<div class="footer-top">
|
||||
<a class="footer-logo" href="https://start9.com"
|
||||
><img
|
||||
src="../../../_static/img/icon-transparent.png"
|
||||
alt="Logo"
|
||||
/></a>
|
||||
<div class="footer-links">
|
||||
<a class="footer-links__link" href="https://docs.start9.com/">Docs</a>
|
||||
<a
|
||||
class="footer-links__link"
|
||||
href="https://start9.com/#community"
|
||||
>Contact Us</a
|
||||
>
|
||||
<a class="footer-links__link" href="https://start9.com/"
|
||||
>About Us</a
|
||||
>
|
||||
</div>
|
||||
<div class="footer-actions">
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://twitter.com/start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Twitter feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/twitter.png"
|
||||
alt="Twitter Icon"
|
||||
/>
|
||||
</span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://t.me/start9_labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Telegram channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/telegram.png"
|
||||
alt="Telegram Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://matrix.to/#/!lMnRwPWnyQvOfAoEnD:matrix.start9labs.com"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="User Matrix channel"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/matrix.svg"
|
||||
alt="Matrix Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://medium.com/@start9labs"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="Medium feed"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/medium.png"
|
||||
alt="Medium Icon"
|
||||
/></span>
|
||||
</a>
|
||||
<a
|
||||
class="footer-actions__link"
|
||||
href="https://github.com/Start9Labs/"
|
||||
target="_blank"
|
||||
><span
|
||||
data-tooltip
|
||||
tabindex="1"
|
||||
title="GitHub page"
|
||||
data-position="bottom"
|
||||
>
|
||||
<img
|
||||
src="../../../_static/img/icons/github.png"
|
||||
alt="GitHub Icon"
|
||||
/></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-bottom__copyright"> © 2021, Start9 Labs, Inc. All rights reserved.
|
||||
</div>
|
||||
<div class="footer-bottom__last-updated">
|
||||
Last updated on 13 Dec 2021.
|
||||
</div>
|
||||
<div class="footer-bottom__version">
|
||||
Powered by
|
||||
<a href="http://sphinx-doc.org/">Sphinx 2.4.5</a> &
|
||||
<a href="https://sphinx-theme.scylladb.com/"
|
||||
>ScyllaDB Theme 1.0.6</a
|
||||
>
|
||||
</div>
|
||||
<!-- <p class="footer-bottom__canary">We have never received a secret government request to hand over user information.</p> -->
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<noscript>
|
||||
<iframe
|
||||
src="https://www.googletagmanager.com/ns.html?id=GTM-T8P2JP"
|
||||
height="0"
|
||||
width="0"
|
||||
style="display: none; visibility: hidden"
|
||||
></iframe>
|
||||
</noscript>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user