restructure to account for new theme, add new build process, update readme

This commit is contained in:
Lucy Cifferello
2021-12-13 23:02:47 -07:00
parent 4e59b06c85
commit 1e756e5cfa
669 changed files with 61332 additions and 245 deletions

View File

@@ -0,0 +1,666 @@
<!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> 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">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 Backups&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-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/user-manual/managing-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="backups">
<h1>Backups<a class="headerlink" href="#backups" title="Permalink to this headline"></a></h1>
<p>Creating frequent service backups is critical. If anything happens to your Embassy, these backups are your only path to recovering your data.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Backups are encrypted using your Embassy master password. If you forget your password, you lose your backups.</p>
</div>
<div class="section" id="creating-a-backup">
<h2>Creating A Backup<a class="headerlink" href="#creating-a-backup" title="Permalink to this headline"></a></h2>
<p>To begin the backup process:</p>
<ol class="arabic simple">
<li><p>Enter a USB drive with sufficient capacity into a USB port on the device. The blue ports are USB 3.0. The black ports are USB 2.0.</p></li>
<li><p>Navigate to the <cite>Services</cite> sub menu from the main dashboard menu.</p></li>
<li><p>Select the service to be backed-up.</p></li>
<li><p>Select the floppy disc icon next to the <cite>Last Backup</cite> menu item. If a backup was never completed, this should say “never”.</p></li>
</ol>
<div class="figure align-default" id="id1">
<a class="reference internal image-reference" href="../../../_images/bitcoin_view.png"><img alt="Bitcoin Core Service Sub Menu" src="../../../_images/bitcoin_view.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Bitcoin Core Service Sub Menu</span><a class="headerlink" href="#id1" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="5">
<li><p>In the modal prompt, select the available disc space. If no option is marked as available, ensure the USB drive has enough space and that it is properly inserted.</p></li>
</ol>
<div class="figure align-default" id="id2">
<a class="reference internal image-reference" href="../../../_images/bitcoin_backup_view_storage.png"><img alt="Bitcoin Core Service Backup Storage" src="../../../_images/bitcoin_backup_view_storage.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Backup menu with available storage space</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</div>
<div class="figure align-default" id="id3">
<a class="reference internal image-reference" href="../../../_images/bitcoin_backup_view_no_storage.png"><img alt="Bitcoin Core Service Backup No Storage" src="../../../_images/bitcoin_backup_view_no_storage.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Backup menu with no available storage disc</span><a class="headerlink" href="#id3" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="6">
<li><p>Enter the master password to encrypt the backup.</p></li>
<li><p>“Creating Backup…” will appear on the service sub menu while the backup is in process.</p></li>
</ol>
<div class="figure align-default" id="id4">
<a class="reference internal image-reference" href="../../../_images/bitcoin_creating_backup.png"><img alt="Bitcoin Core Service Backup No Storage" src="../../../_images/bitcoin_creating_backup.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Creating Backup</span><a class="headerlink" href="#id4" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="8">
<li><p>A notification will emit when the backup has successfully completed.</p></li>
<li><p>The <cite>Last Backup</cite> menu item in the service will now indicate the date and time at which the last backup was made.</p></li>
</ol>
</div>
<div class="section" id="restoring-a-backup">
<h2>Restoring A Backup<a class="headerlink" href="#restoring-a-backup" title="Permalink to this headline"></a></h2>
<p>To begin the backup restore process:</p>
<ol class="arabic simple">
<li><p>Enter the same USB stick used to originally backup the service.</p></li>
<li><p>Navigate to the <cite>Services</cite> sub menu from the main dashboard menu.</p></li>
<li><p>Select the service to be backed-up.</p></li>
<li><p>Select the <cite>Restore from backup</cite> menu item.</p></li>
</ol>
<div class="figure align-default" id="id5">
<a class="reference internal image-reference" href="../../../_images/restore_backup_menu.png"><img alt="Restore backup from Services tab" src="../../../_images/restore_backup_menu.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Restore backup from Services tab</span><a class="headerlink" href="#id5" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="5">
<li><p>In the modal prompt, select the same disc used to originally back up the service. If no option is marked as available, ensure the USB drive is properly inserted.</p></li>
</ol>
<div class="figure align-default" id="id6">
<a class="reference internal image-reference" href="../../../_images/restore_backup_submenu.png"><img alt="Restore backup submenu" src="../../../_images/restore_backup_submenu.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Restore backup sub-menu options</span><a class="headerlink" href="#id6" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="6">
<li><p>Note the warning that restoring will wipe current data.</p></li>
</ol>
<div class="figure align-default" id="id7">
<a class="reference internal image-reference" href="../../../_images/backup_warning.png"><img alt="Backup warning message" src="../../../_images/backup_warning.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Backup warning message</span><a class="headerlink" href="#id7" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="7">
<li><p>Enter the master password to decrypt the backup and select <cite>Restore</cite>.</p></li>
</ol>
<div class="figure align-default" id="id8">
<a class="reference internal image-reference" href="../../../_images/decrypt_backup.png"><img alt="Decrypt backup" src="../../../_images/decrypt_backup.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Decrypt backup view</span><a class="headerlink" href="#id8" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="8">
<li><p>“Restoring Backup…” will appear on the service sub menu while the restoration is in process.</p></li>
</ol>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The service might be momentarily unreachable as it starts back up. This is expected behavior.</p>
</div>
<div class="figure align-default" id="id9">
<a class="reference internal image-reference" href="../../../_images/restoring_backup.png"><img alt="Restoring backup" src="../../../_images/restoring_backup.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Restoring backup view</span><a class="headerlink" href="#id9" title="Permalink to this image"></a></p>
</div>
<ol class="arabic simple" start="9">
<li><p>A notification will emit when the backup restoration has successfully completed.</p></li>
</ol>
</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 />Instructions
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../service-config/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Service Config
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="../installing/">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="../service-config/">Service 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="../logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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="#">Backups</a><ul>
<li><a class="reference internal" href="#creating-a-backup">Creating A Backup</a></li>
<li><a class="reference internal" href="#restoring-a-backup">Restoring A Backup</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"> &#169; 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> &amp;
<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>

View 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> Managing Services | 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">Managing Services</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 Managing Services&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-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/user-manual/managing-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="managing-services">
<span id="id1"></span><h1>Managing Services<a class="headerlink" href="#managing-services" title="Permalink to this headline"></a></h1>
<p>Services are self-hosted, open source projects made compatible for EmbassyOS. Each service has been independently developed by members of the open source community. The Embassy enables configuration, customization and a one click install.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Some services require configuration before starting up. You can only connect to and use a service once it is in a <em>running</em> state.</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installing/">Install / Uninstall</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installing/#installing">Installing</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/#updating">Updating</a></li>
<li class="toctree-l2"><a class="reference internal" href="installing/#uninstalling">Uninstalling</a></li>
</ul>
</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><ul>
<li class="toctree-l2"><a class="reference internal" href="backups/#creating-a-backup">Creating A Backup</a></li>
<li class="toctree-l2"><a class="reference internal" href="backups/#restoring-a-backup">Restoring A Backup</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="service-config/">Service 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="logs/">Viewing Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="managing-deps/">Managing Dependencies</a></li>
</ul>
</div>
</div>
<div class="content-navigation">
<div class="navigation navigation--prev">
<a class="navigation__link" href="../general/forgot-password/">
<button class="navigation__button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="navigation__title">
<span class="colored">PREVIOUS</span> <br />Forgot Password
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="installing/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Install / Uninstall
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../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="../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../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="../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="../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Managing Services</a><input checked="" 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="installing/">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="service-config/">Service 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="logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../contributing/services/">Service Packaging Guide</a><input 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="../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/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 &amp; 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>
</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"> &#169; 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> &amp;
<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>

View 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> Install / Uninstall | 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">Install / Uninstall</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 Install / Uninstall&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-services/installing%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/user-manual/managing-services/installing.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="install-uninstall">
<h1>Install / Uninstall<a class="headerlink" href="#install-uninstall" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Some services have <a class="reference internal" href="../managing-deps/#managing-dependencies"><span class="std std-ref">dependencies</span></a> on other services. Adding, updating, or removing a service can sometimes have requirements or consequences for other services. Your Embassy will inform you of these issues along the way.</p>
</div>
<div class="section" id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline"></a></h2>
<p>To add a new service, find its listing inside the Service Marketplace: <em>Marketplace &gt; [Service Name] &gt; Install</em>.</p>
<p>Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes.</p>
<p>After installation, you can view the services instructions by navigating to <em>Services &gt; [Service Name] &gt; Instructions</em></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You can only start and use a service once its dependencies are met, its <a class="reference internal" href="../service-config/#service-config"><span class="std std-ref">configuration</span></a> complete, and is in a <em>running</em> state.</p>
</div>
</div>
<div class="section" id="updating">
<h2>Updating<a class="headerlink" href="#updating" title="Permalink to this headline"></a></h2>
<p>To see if an update is available for a service, you can click the <em>refresh</em> button inside the dashboard of the installed service or by visiting its listing in the Service Marketplace.</p>
<p>If an update is available, simply click “Update” and confirm the action.</p>
</div>
<div class="section" id="uninstalling">
<h2>Uninstalling<a class="headerlink" href="#uninstalling" title="Permalink to this headline"></a></h2>
<p>To remove a service, navigate to <em>Services &gt; [Service Name] &gt; Uninstall</em>.</p>
</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 />Managing Services
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../instructions/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Instructions
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="../service-config/">Service 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="../logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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="#">Install / Uninstall</a><ul>
<li><a class="reference internal" href="#installing">Installing</a></li>
<li><a class="reference internal" href="#updating">Updating</a></li>
<li><a class="reference internal" href="#uninstalling">Uninstalling</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"> &#169; 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> &amp;
<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>

View File

@@ -0,0 +1,576 @@
<!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> Instructions | 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">Instructions</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 Instructions&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-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/user-manual/managing-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="instructions">
<h1>Instructions<a class="headerlink" href="#instructions" title="Permalink to this headline"></a></h1>
<p>To view the instructions for a particular service, navigate to <em>Services &gt; [Service Name] &gt; Instructions</em>.</p>
<div class="figure align-default" id="id1">
<a class="reference internal image-reference" href="../../../_images/bitcoin_instructions1.png"><img alt="Bitcoin instructions menu item" src="../../../_images/bitcoin_instructions1.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Instructions menu item</span><a class="headerlink" href="#id1" title="Permalink to this image"></a></p>
</div>
<div class="figure align-default" id="id2">
<a class="reference internal image-reference" href="../../../_images/bitcoin_instructions_view.png"><img alt="Bitcoin instructions view" src="../../../_images/bitcoin_instructions_view.png" style="width: 90%;" /></a>
<p class="caption"><span class="caption-text">Instructions view</span><a class="headerlink" href="#id2" title="Permalink to this image"></a></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For advanced instructions and integration guides, visit the wrapper repository for an <a class="reference internal" href="../../../misc-guides/available-services/#available-services"><span class="std std-ref">available service</span></a>.</p>
</div>
</div>
<div class="content-navigation">
<div class="navigation navigation--prev">
<a class="navigation__link" href="../installing/">
<button class="navigation__button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="navigation__title">
<span class="colored">PREVIOUS</span> <br />Install / Uninstall
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../backups/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="../installing/">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="../service-config/">Service 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="../logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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>
</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"> &#169; 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> &amp;
<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>

View File

@@ -0,0 +1,565 @@
<!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> Viewing Logs | 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">Viewing Logs</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 Viewing Logs&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-services/logs%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/user-manual/managing-services/logs.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="viewing-logs">
<h1>Viewing Logs<a class="headerlink" href="#viewing-logs" title="Permalink to this headline"></a></h1>
<p>Naviage to <em>Services &gt; [Service Name] &gt; Logs</em></p>
<p>Every service emits logs while it is in a <em>running</em> state. Logs give an <em>under-the-hood</em> glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all.</p>
</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 />Properties
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../managing-deps/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Managing Dependencies
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="../installing/">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="../service-config/">Service 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="#">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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>
</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"> &#169; 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> &amp;
<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>

View File

@@ -0,0 +1,567 @@
<!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> Managing Dependencies | 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">Managing Dependencies</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 Managing Dependencies&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-services/managing-deps%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/user-manual/managing-services/managing-deps.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="managing-dependencies">
<span id="id1"></span><h1>Managing Dependencies<a class="headerlink" href="#managing-dependencies" title="Permalink to this headline"></a></h1>
<p>Some services have dependencies on other services. A service may even require its dependency to be <em>configured</em> in a particular way.</p>
<p>Traditionally, managing dependencies was a massive headache and a huge barrier to running a personal server. But no more! The Embassys revolutionary dependency management system makes the process transparent and simple.</p>
<p>If a service has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy will inform you and offer solutions.</p>
<p>Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. But that does not necessarily mean you need to have Bitcoin installed on your Embassy. You could just as easily configure Lightning to use another Bitcoin node located somewhere else!</p>
</div>
<div class="content-navigation">
<div class="navigation navigation--prev">
<a class="navigation__link" href="../logs/">
<button class="navigation__button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="navigation__title">
<span class="colored">PREVIOUS</span> <br />Viewing Logs
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../../../misc-guides/available-services/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Available Services
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="../installing/">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="../service-config/">Service 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="../logs/">Viewing Logs</a></li>
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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>
</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"> &#169; 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> &amp;
<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>

View File

@@ -0,0 +1,571 @@
<!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> 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">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 Properties&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-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/user-manual/managing-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="properties">
<h1>Properties<a class="headerlink" href="#properties" title="Permalink to this headline"></a></h1>
<p>Navigate to <em>Services &gt; [Service Name] &gt; Properties</em></p>
<p>Properties are both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful.</p>
<p>Properties may be accompanied by one or more of the following:</p>
<ul class="simple">
<li><p>a <em>help</em> icon for further explanation.</p></li>
<li><p>a <em>copy</em> icon for copying the value to your clipboard.</p></li>
<li><p>a <em>QR</em> icon for viewing the value as a QR code.</p></li>
</ul>
</div>
<div class="content-navigation">
<div class="navigation navigation--prev">
<a class="navigation__link" href="../service-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
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../logs/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Viewing Logs
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="../installing/">Install / Uninstall</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>
<li class="toctree-l2"><a class="reference internal" href="../service-config/">Service 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="../logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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>
</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"> &#169; 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> &amp;
<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>

View File

@@ -0,0 +1,567 @@
<!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 Config | 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="../">Managing Services</a></span
>
<span class="bread__item bread__item--last">Service Config</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 Config&&body=I%20would%20like%20to%20report%20an%20issue%20in%20page%20https://docs.start9.com/user-manual/managing-services/service-config%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/user-manual/managing-services/service-config.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-config">
<span id="id1"></span><h1>Service Config<a class="headerlink" href="#service-config" title="Permalink to this headline"></a></h1>
<p>Navigate to <em>Services &gt; [Service Name] &gt; Config</em></p>
<p>After installation or update, some services require configuration before they can be started.</p>
<p>Traditionally, configuring services was a massive headache and a huge barrier to running a personal server. But no more! The Embassys revolutionary service config system makes the process transparent, simple, and safe.</p>
<p>Config options are defined by the service developer and can be almost anything. They are represented as simple UI elements - such as toggles and drop downs - and they include explanations and validations, such that users understand their purpose and are prevented from making mistakes.</p>
</div>
<div class="content-navigation">
<div class="navigation navigation--prev">
<a class="navigation__link" href="../backups/">
<button class="navigation__button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="navigation__title">
<span class="colored">PREVIOUS</span> <br />Backups
</div>
</a>
</div>
<div class="navigation navigation--next">
<a class="navigation__link" href="../properties/">
<div class="navigation__title">
<span class="colored">NEXT</span> <br />Properties
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../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="../../general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../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="../../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="../../general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="../../general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../">Managing Services</a><input checked="" 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 class="current">
<li class="toctree-l2"><a class="reference internal" href="../installing/">Install / Uninstall</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>
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Service 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="../logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../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>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../contributing/services/">Service Packaging Guide</a><input 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="../../../contributing/services/overview/">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/wrapper/">Wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/manifest/">Manifest</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/docker/">Docker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/makefile/">Makefile</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/config/">Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../contributing/services/backups/">Backups</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing/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 &amp; 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>
</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"> &#169; 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> &amp;
<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>