diff --git a/site/03-todo.md b/site/03-todo.md index 05807fd..c40e6c6 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -1,16 +1,18 @@ # ToDo -- Transfer HTML or refactor: Roadmap -- Document diagnostic UI -- Update principles, privacy, about, etc -- Footer links need update (or removal?) -- Add screenshots and details -- Verify ALL links and TOCs -- Add / verify ALL links in the UI go to the right place in docs -- There are many issues that should be closed by 0.3 docs release, check that this is the case (some issues await new processes in order to test) -- Update all guides in services -- Launch versioned site/docs to start9.com -- Address build errors +- [ ] Refactor and update Roadmap +- [ ] Document colours +- [ ] Document diagnostic UI +- [ ] Update principles, privacy, about, etc +- [ ] Footer links need update (or removal?) +- [ ] Add screenshots and details +- [ ] Verify ALL links and TOCs + - [ ] Check all menus behave and display as expected +- [ ] Add / verify ALL links in the UI go to the right place in docs +- [ ] Update all guides in service repos +- [ ] Address build errors +- [ ] Launch versioned site/docs to start9.com +- [ ] There are many issues that should be closed by 0.3 docs release, check that this is the case (some issues await new processes in order to test) diff --git a/site/source/_static/images/walkthrough/sessions0.svg b/site/source/_static/images/walkthrough/sessions0.svg new file mode 100644 index 0000000..0dbd2bb Binary files /dev/null and b/site/source/_static/images/walkthrough/sessions0.svg differ diff --git a/site/source/learn/concepts/embassy.rst b/site/source/learn/concepts/embassy.rst index 8b432d1..44ed836 100644 --- a/site/source/learn/concepts/embassy.rst +++ b/site/source/learn/concepts/embassy.rst @@ -34,6 +34,18 @@ Services -------- The server-side software available on EmbassyOS are referred to as "Services." It's important to distinguish the difference between *services* and *applications*. Applications are generally *client-side*. This means that they are either standalone software, or they reach out to a server in order to operate. Services are *server-side*. These generally run 24/7, waiting for commands from a user via an application. +.. _sessions: + +Session +------- +A session is simply a logged-in connection to your Embassy. You can view your :ref:`Active Sessions`, and kill one if you suspect it is not legitimate, or no longer use it. + +.. _service-container: + +Service Container +----------------- +Each service is compartmentalilzed into its own "container," at this time, this normally means a `Docker `_ container. There are several reasons for this, including security, ease of use, and maintenance. + .. _service-dependencies: Dependencies @@ -70,3 +82,5 @@ Health Checks One of the most critical duties of a sysadmin or devops engineer is to build systems to monitor health. For example, a simple health check that monitors the availability of an LND node could mean the difference between that node having a poor reputation or a great one. Sometimes, it is not obvious when a service is unhealthy, especially since “health” is a subjective term depending on the subject. For example, is your Bitcoin node “healthy” if it is not fully synced? Is it healthy if the user interface is unreachable but everything else is working ok? In EmbassyOS 0.3.0, package developers define what constitutes health and implement health checks according to subjective criteria that are then displayed to the user in easily digestible messages, complete with icons and colors. Even better, health checks are completely arbitrary and turing complete, meaning they can include anything, including config options and internal or external dependencies! For example, a Lightning wallet package developer could say “this service is only healthy if (1) it is fully synced, (2) Bitcoin is fully synced, (3) LND is fully synced, and (4) if and only if the user has opted for real-time pricing from a third party website, that third party website must be reachable.” Enormous power. + + diff --git a/site/source/support/dev-docs/dev-tools/embassy-cli.rst b/site/source/support/dev-docs/dev-tools/embassy-cli.rst new file mode 100644 index 0000000..a1ce625 --- /dev/null +++ b/site/source/support/dev-docs/dev-tools/embassy-cli.rst @@ -0,0 +1,52 @@ +.. _embassy-cli: + +=========== +Embassy-CLI +=========== + +.. warning:: This is for advanced users only!! Anything you do while SSH'd into your Embassy is NOT SUPPORTED, unless under the guidance of a Start9 technician. + +When interacting with Embassy directly, you will invariably want to use ``embassy-cli``. Embassy-CLI can control EmbassyOS in many of the same ways that the UI can, but with finer controls and deeper insights. + +In order to use Embassy-CLI, you will first need to authorize yourself with the following command... + + .. code-block:: bash + + embassy-cli auth login + + and enter your Embassy Master Password at the prompt. + + +You can enter ``embassy-cli help`` or ``embassy-cli