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

641
docs/_build/dirhtml/index.html vendored Normal file
View File

@@ -0,0 +1,641 @@
<!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> Start9 Documentation | Start9 Docs
</title>
<meta name="description" content="Start9 Product Documentation and Education Guides" />
<link
rel="icon"
href="_static/img/favicon.ico"
type="image/x-icon"
/>
<link
rel="icon"
href="_static/img/favicon-32x32.png"
sizes="32x32"
/>
<link
rel="icon"
href="_static/img/favicon-228x228.png"
sizes="192x192"
/>
<link
rel="apple-touch-icon"
href="_static/img/favicon-228x228.png"
/>
<meta
name="msapplication-TileImage"
href="_static/img/favicon-228x228.png"
/>
<link rel="canonical" href="https://docs.start9.com/" />
<link rel="author" href="mailto:support@start9labs.com" />
<!-- connect to domain of font files -->
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<!-- optionally increase loading priority -->
<link
rel="preload"
as="style"
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
/>
<!-- async CSS -->
<link
rel="stylesheet"
media="print"
onload="this.onload=null;this.removeAttribute('media');"
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
/>
<!-- no-JS fallback -->
<noscript>
<link
rel="stylesheet"
href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100;0,200;0,300;0,400;0,500;0,700;1,400&display=swap"
/>
</noscript>
<link
rel="stylesheet"
href="_static/css/main.css"
type="text/css"
/>
<link
rel="stylesheet"
href="_static/pygments.css"
type="text/css"
/> <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<script
type="text/javascript"
id="documentation_options"
data-url_root="#"
src="_static/documentation_options.js"
></script>
<script
type="text/javascript"
src="_static/js/runtime.bundle.js"
></script>
<script
type="text/javascript"
src="_static/js/main.bundle.js"
></script> <script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script> <script src="_static/language_data.js"></script> <script src="_static/clipboard.min.js"></script> <script src="_static/copybutton.js"></script>
<!-- Google Tag Manager -->
<script>
(function (w, d, s, l, i) {
w[l] = w[l] || [];
w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
var f = d.getElementsByTagName(s)[0],
j = d.createElement(s),
dl = l != "dataLayer" ? "&l=" + l : "";
j.async = true;
j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
f.parentNode.insertBefore(j, f);
})(window, document, "script", "dataLayer", "GTM-T8P2JP");
</script>
<!-- End Google Tag Manager -->
<!-- Marketo -->
<script type="text/javascript">
(function () {
var didInit = false;
function initMunchkin() {
if (didInit === false) {
didInit = true;
Munchkin.init("791-QBF-350");
}
}
var s = document.createElement("script");
s.type = "text/javascript";
s.async = true;
s.src = "//munchkin.marketo.net/munchkin.js";
s.onreadystatechange = function () {
if (this.readyState == "complete" || this.readyState == "loaded") {
initMunchkin();
}
};
s.onload = initMunchkin;
document.getElementsByTagName("head")[0].appendChild(s);
})();
</script>
<!-- End Marketo -->
<!-- Expertrec -->
<script>
var id = "e2077224-9ccf-11e9-a0c9-0242ac130002";
var ci_search = document.createElement("script");
ci_search.type = "text/javascript";
ci_search.async = true;
ci_search.src = "https://cse.expertrec.com/api/js/ci_common.js?id=" + id;
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(ci_search, s);
</script>
<!-- End Expertrec -->
<!-- Font Awesome -->
<script
src="https://kit.fontawesome.com/b1870adf6a.js"
crossorigin="anonymous"
></script>
<!-- End Font Awesome -->
</head>
<body>
<header class="header">
<div class="header-logo">
<a class="header-logo__img" href="https://start9.com/">
<img
src="_static/img/logo.png"
alt="Start9 Logo"
/>
</a>
<span class="header-logo__bar"></span>
<a class="header-logo__text" href="https://docs.start9.com/">
Documentation
</a>
</div>
<div class="header-navigation">
<ul
class="dropdown menu scylla-dropdown scylla-dropdown--header"
data-dropdown-menu
>
<li class="scylla-dropdown__item">
<a href="#" class="scylla-dropdown__title"
>Contributing <i class="chevron scylla-icon scylla-icon--triangle-down"></i
></a>
<ul class="menu scylla-dropdown__content">
<li>
<a href="https://docs.start9.com/developing"
><i class="scylla-icon scylla-icon--apps"></i>Developer</a
>
</li>
<li>
<a href="https://docs.start9.com/service-packaging"
><i class="scylla-icon scylla-icon--open-source"></i>Service Packaging</a
>
</li>
</ul>
</li>
<li class="scylla-dropdown__item">
<a href="#" class="scylla-dropdown__title"
>About <i class="chevron scylla-icon scylla-icon--triangle-down"></i
></a>
<ul class="menu scylla-dropdown__content">
<li>
<a href="https://docs.start9.com/about">
<i class="scylla-icon scylla-icon--enterprise"></i>Company</a
>
</li>
<li>
<a href="https://docs.start9.com/license">
<i class="scylla-icon scylla-icon--whitepapers"></i>License</a
>
</li>
<li>
<a href="https://docs.start9.com/careers">
<i class="scylla-icon scylla-icon--careers"></i>Hiring
</a>
</li>
</ul>
</li>
</ul>
<div class="header-button">
<a href="https://store.start9.com" class="button" target="_blank">Purchase</a>
</div>
</div>
<div class="header-search-box">
<div class="search-box">
<ci-search></ci-search>
</div>
</div>
<div class="side-nav-toggle" data-toggle="side-nav">
<div class="side-nav-toggle__button">
<img src="_static/img/menu.svg" alt="Menu" />
</div>
</div>
</header>
<section class="layout layout--full-width">
<div class="content large-order-2">
<div class="landing landing--floating">
<div class="hero">
<div class="hero-wrapper">
<div class="hero__img">
<img src="/_static/img/icons/docs_info.png" />
</div>
<div class="hero-header">
<h1 class="hero__title">Welcome to the Start9 Documentation</h1>
<div class="hero__text">
<div class="docutils container">
<p>Here you will find guidance and information about the Start9 Embassy personal server and its operating system, EmbassyOS.</p>
</div>
</div>
<a href="https://docs.start9.com/getting-started/introduction/"><button class="hero__button button"><i class="icon scylla-icon scylla-icon--monitoring" aria-hidden="true"></i>Start here</button></a>
</div></div></div><div class="landing__content landing__content"><div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
<div class="cell topic-box large-6">
<a class="card" href="getting-started/purchasing">
<div class="topic-box__head">
<div class="topic-box__icon">
<i class="scylla-icon scylla-icon--bitcoin" style="color:#23263b !important;"></i>
</div>
<h3 class="topic-box__title">Purchasing</h3>
</div>
<div class="topic-box__body">
<div class="docutils container">
<p>Learn about how you can purchase Start9 products.</p>
</div>
<div class="topic-box__anchor">Learn more</div>
</div>
</a></div>
<div class="cell topic-box large-6">
<a class="card" href="https://www.youtube.com/channel/UCGEw4HJDvOn3Oy8ykR36P7Q" target="_blank">
<div class="topic-box__head">
<div class="topic-box__icon">
<i class="scylla-icon scylla-icon--webinars" style="color:#23263b !important;"></i>
</div>
<h3 class="topic-box__title">Videos</h3>
</div>
<div class="topic-box__body">
<div class="docutils container">
<p>Check out our how to and informational videos.</p>
</div>
<div class="topic-box__anchor">Learn more <i class="fa fa-external-link" aria-hidden="true"></i></div>
</div>
</a></div>
<div class="cell topic-box large-6">
<a class="card" href="support">
<div class="topic-box__head">
<div class="topic-box__icon">
<i class="scylla-icon scylla-icon--support" style="color:#23263b !important;"></i>
</div>
<h3 class="topic-box__title">Support</h3>
</div>
<div class="topic-box__body">
<div class="docutils container">
<p>Read our FAQ and learn about platform concepts.</p>
</div>
<div class="topic-box__anchor">Learn more</div>
</div>
</a></div>
<div class="cell topic-box large-6">
<a class="card" href="getting-started/diy">
<div class="topic-box__head">
<div class="topic-box__icon">
<i class="scylla-icon scylla-icon--integrations" style="color:#23263b !important;"></i>
</div>
<h3 class="topic-box__title">DIY</h3>
</div>
<div class="topic-box__body">
<div class="docutils container">
<p>Get started yourself with our Do It Yourself guide</p>
</div>
<div class="topic-box__anchor">Learn more</div>
</div>
</a></div>
<div class="cell topic-box large-6">
<a class="card" href="about">
<div class="topic-box__head">
<div class="topic-box__icon">
<i class="scylla-icon scylla-icon--about-team" style="color:#23263b !important;"></i>
</div>
<h3 class="topic-box__title">About</h3>
</div>
<div class="topic-box__body">
<div class="docutils container">
<p>Explore Start9s mission and philosophy.</p>
</div>
<div class="topic-box__anchor">Learn more</div>
</div>
</a></div>
<div class="cell topic-box large-6">
<a class="card" href="contributing">
<div class="topic-box__head">
<div class="topic-box__icon">
<i class="scylla-icon scylla-icon--apps" style="color:#23263b !important;"></i>
</div>
<h3 class="topic-box__title">Contribute</h3>
</div>
<div class="topic-box__body">
<div class="docutils container">
<p>Learn about developing for EmbassyOS or contribute to packing services for the marketplace.</p>
</div>
<div class="topic-box__anchor">Learn more</div>
</div>
</a></div>
</div></div></div></div><div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</div>
<div
class="sidebar-left hide-for-large large-order-1"
> <div id="side-nav" class="side-nav custom-scroll-bar" data-closable data-toggler=".show">
<button class="collapsible-button">
<i class="scylla-icon scylla-icon--chevron-left"></i>
</button>
<div class="side-nav-content">
<div class="side-nav__search">
<div class="search-box">
<ci-search></ci-search>
</div>
</div>
<div class="side-nav__versions">
</div>
<div class="side-nav__content">
<p class="caption"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting-started/introduction/">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/purchasing/">Purchasing</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/diy/">DIY Guide</a></li>
</ul>
<p class="caption"><span class="caption-text">User Manual</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user-manual/initial-setup/">Initial Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="user-manual/connecting/">Connecting</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="user-manual/general/">General</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label for="toctree-checkbox-1"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l2"><a class="reference internal" href="user-manual/general/embassy-config/">Config Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/general/updating/">Updating EmbassyOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/general/wifi/">Setting up WiFi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="user-manual/general/developer-options/">Developer Options</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label for="toctree-checkbox-2"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l3"><a class="reference internal" href="user-manual/general/developer-options/ssh-setup/">SSH Setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="user-manual/general/developer-options/alt-marketplace/">Alternative Marketplace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/general/power/">Power</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/general/notifications/">Notifications</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="user-manual/general/lan-setup/">LAN Setup</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label for="toctree-checkbox-3"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l3 has-children"><a class="reference internal" href="user-manual/general/lan-setup/desktop/">Desktop</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label for="toctree-checkbox-4"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l4"><a class="reference internal" href="user-manual/general/lan-setup/computer-setup/">Computer Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="user-manual/general/lan-setup/browser-setup/">Browser Setup</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="user-manual/general/lan-setup/mobile/">Mobile</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/general/forgot-password/">Forgot Password</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="user-manual/managing-services/">Managing Services</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label for="toctree-checkbox-5"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/installing/">Install / Uninstall</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/instructions/">Instructions</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/backups/">Backups</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/service-config/">Service Config</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/properties/">Properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/logs/">Viewing Logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-manual/managing-services/managing-deps/">Managing Dependencies</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Misc Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="misc-guides/available-services/">Available Services</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc-guides/bitcoin-cli/">Using Bitcoin-Cli</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="misc-guides/tor-os/">Running Tor</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label for="toctree-checkbox-6"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l2"><a class="reference internal" href="misc-guides/tor-os/mac/">MacOS</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc-guides/tor-os/windows/">Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc-guides/tor-os/linux/">Linux</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc-guides/tor-os/android/">Android</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc-guides/tor-os/ios/">iOS</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="misc-guides/tor-firefox/">Configuring Firefox for Tor</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label for="toctree-checkbox-7"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l2"><a class="reference internal" href="misc-guides/tor-firefox/desktop/">Desktop</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="misc-guides/tor-firefox/mobile/">Mobile</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label for="toctree-checkbox-8"><i class="scylla-icon scylla-icon--expand"></i></label><div class="break"></div><ul>
<li class="toctree-l3"><a class="reference internal" href="misc-guides/tor-firefox/android/">Android</a></li>
<li class="toctree-l3"><a class="reference internal" href="misc-guides/tor-firefox/ios/">iOS</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Contributing</span></p>
<ul>
<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>
</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>