From c9970043b36320e8a3bc698d28a431baa81c18ed Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Fri, 3 Dec 2021 13:32:29 -0700 Subject: [PATCH 01/84] 0.3.0 docs init --- site/source/getting-started/diy.rst | 70 +---------------------------- 1 file changed, 2 insertions(+), 68 deletions(-) diff --git a/site/source/getting-started/diy.rst b/site/source/getting-started/diy.rst index 0894eef..044afe4 100644 --- a/site/source/getting-started/diy.rst +++ b/site/source/getting-started/diy.rst @@ -14,7 +14,6 @@ By popular demand, we are pleased to present this "Do it Yourself" (DIY) guide f .. warning:: This DIY guide has directions for EmbassyOS version 0.2.x. When 0.3.0 launches it will REQUIRE hardware updates, which you can find `here `__. Please keep in mind that version 0.3.x is not yet available for purchase or DIY!! Please stay tuned to our community channels for updates. - Motivation ========== @@ -30,73 +29,8 @@ There are four reasons you might prefer to build your own Embassy instead of pur #. You just like building things. -Building EmbassyOS Versions 0.2.x -================================= - -Hardware: Components --------------------- - -#. `Raspberry Pi 4B (8GB) `_ -#. `Power supply for Raspberry Pi 4B `_ -#. Case for Raspberry Pi 4B (`passive cooling recommended `_ `*`) -#. `High endurance microSD `_ (recommended 128GB or more) -#. `GPIO mini speaker/buzzer `_ (We simply include an Amazon search here, as vendors often sell out) -#. Ethernet cable -#. MicroSD → USB adapter (or you may have a microSD port on your computer) - -`*` If you use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan `_. - -Hardware: Assembly Instructions -------------------------------- - -#. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`. - - .. figure:: /_static/images/diy/pins.png - :width: 60% - :alt: Speaker board spec - -That's it. Place the Raspberry Pi 4 board (with speaker attached), into its case. - -Getting EmbassyOS: Purchasing ------------------------------ - -You can purchase EmbassyOS `here `_. This is by far the easiest path to get up and running. - -Depending on your Internet speed, the download should take between 5 and 30 minutes. - -Getting EmbassyOS: Building from Source ---------------------------------------- - -If you have the proper tooling and are comfortable using the command line, you can build EmbassyOS from `source `_, which is made available under the `Start9 Personal Use License `_. - -Thanks to our community members who have kindly put together these guides! - -* A comprehensive and user friendly guide by `Bitcoin Mechanic `_ -* A technically focused guide by `t0mmysm1th `_ - -Installing EmbassyOS --------------------- - -Whether you purchase EmbassyOS from us or build it yourself, you need to flash it onto a microSD card. - -#. Download `balenaEtcher `_ onto your Mac, Windows, or Linux computer. -#. Insert the microSD card into your computer, either directly or using an adapter. -#. Open balenaEtcher. -#. Click `Select Image`, then find and select your copy of EmbassyOS. -#. Click `Select Target`, then find and select your micro SD card. -#. Click `Flash!` You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal. - - .. figure:: /_static/images/diy/balena.png - :width: 60% - :alt: Balena Etcher Dashboard - -#. Once the image is flashed and verified, you may remove the micro SD, insert it into your Embassy, and power up the device. -#. The Embassy is now ready for use, and you may following the normal :ref:`setup ` instructions. ``*`` - -``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete. - -.. Building EmbassyOS Versions 0.3.x -.. ================================= +Building an Embassy +=================== .. Hardware: Components .. -------------------- From cf7ea7519e6fcc39462d0735a5b5a17526edca1c Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Fri, 3 Dec 2021 20:06:19 -0700 Subject: [PATCH 02/84] Layout init --- source/03-index.md | 125 +++++++++++++++++++++++++++++++++++++++++++++ source/index.rst | 48 +++++++++++++++++ 2 files changed, 173 insertions(+) create mode 100644 source/03-index.md create mode 100644 source/index.rst diff --git a/source/03-index.md b/source/03-index.md new file mode 100644 index 0000000..4bc04d1 --- /dev/null +++ b/source/03-index.md @@ -0,0 +1,125 @@ +Table of Contents + +# Getting Started +- Introduction + - Purchasing + - Initial Setup + - Device-specific Setup Guides + - Linux + - Mac + - Windows + - Android + - iOS + - Walkthrough + - Tabs Overview + - Updating EOS + - Services Basics + - User Manual + - Basic Config + - Name Your Embassy + - WiFi Setup + - Running Tor + - Desktop + - Linux + - Mac + - Windows + - Mobile + - Android + - iOS + - Browser + - FF Desktop + - FF Mobile + - LAN Setup + - Desktop + - Linux + - Mac + - Windows + - Mobile + - Android + - iOS + - Known Limitations + - Desktop + - Linux + - Mac + - Windows + - Mobile + - Android + - iOS + - Services + - Currently Available Services + - Managing Services + - Install / Uninstall + - Instructions + - Interfaces + - Config + - Backups + - Properties + - Logs + - Dependencies + - Troubleshooting + - Connection + - Embassy + - Hardware + - Software + - Services + +# Tune & Guides +- DIY Guide + - Hardware + - EmbassyOS +- Migrating to Embassy + - From Umbrel +- Advanced Configurations + - SSH Setup + - SSH over Tor + - Exec into a Service + - Change Marketplace +- EmbassyOS +- Service-specific Guides + - Connecting External Services + - Bitcoin Wallets + - FullyNoded + - Specter + - Sparrow + - Lightning Wallets + - Spark + - Zap + - Zeus + +# Knowledgebase + - Concepts + - Open Source + - Self-Hosting + - Start9 + - EmbassyOS + - Bitcoin/Lightning + - LAN + - SSL + - Tor + - FAQ + - General + - Embassy + - Device + - OS + - DIY + - Basic Usage + - Services + - Bitcoin and Lightning Network + - Contact + +# Developer Documentation + - Service Packaging Guide + - Overview + - Wrapper + - Manifest + - Docker + - Makefile + - Config + - Properties + - Instructions + - Backups + - Submission Process + - Service Packaging Walkthrough (Hello-World Example) + - Development FAQ + - Contributing + - Service Packaging diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..e19b472 --- /dev/null +++ b/source/index.rst @@ -0,0 +1,48 @@ +#################### +Start9 Documentation +#################### + +Welcome!! + +Here you will find guidance and information about the Embassy personal server and its operating system, EmbassyOS. If you identify an error with the docs or would like to contribute to them, please use the GitHub link at the top of this page. + +.. toctree:: + :maxdepth: 2 + :caption: Getting Started + + getting-started/introduction + getting-started/purchasing + getting-started/diy + +.. toctree:: + :maxdepth: 2 + :caption: User Manual + + user-manual/initial-setup + user-manual/connecting + user-manual/general/index + user-manual/managing-services/index + +.. toctree:: + :maxdepth: 2 + :caption: Misc Guides + + misc-guides/available-services + misc-guides/bitcoin-cli + misc-guides/tor-os/index + misc-guides/tor-firefox/index + +.. toctree:: + :maxdepth: 2 + :caption: Contributing + + contributing/services/index + contributing/embassyos + +.. toctree:: + :maxdepth: 2 + :caption: Support + + support/FAQ/index + support/concepts + support/contact From 4dc72ad62038f49bb96fbb698a720ff7bdcaabf7 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Sun, 5 Dec 2021 20:51:03 -0700 Subject: [PATCH 03/84] Scaffolding init --- source/03-index.md | 156 ++++++++++++++++++++++----------------------- source/index.rst | 52 +++++++-------- 2 files changed, 100 insertions(+), 108 deletions(-) diff --git a/source/03-index.md b/source/03-index.md index 4bc04d1..643a94f 100644 --- a/source/03-index.md +++ b/source/03-index.md @@ -1,90 +1,87 @@ -Table of Contents - -# Getting Started -- Introduction +# User Manual +- Getting Started + - Introduction - Purchasing - Initial Setup - - Device-specific Setup Guides + - Device-specific Setup Guides