Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 10:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

change embassyOS to StartOS & nuance (#357)

Browse Source 
* change embassyOS to StartOS & nuance

* Update conf.py

* Update manifest.rst

* say start9 instead of embassy in two links

* progress

* scrubbed faqs - basic-use, lightning, service-packaging, services, startos

* add a few fixes

* more

* more 'embassy' cleanup

* more

* the last of embassy (aside from sdk and cli commands, links, etc)

* some fixes

* update icon, logo, and theme

* Update site/source/user-manual/upgrade-hardware/upgrade-pro.rst

* Update site/source/developer-docs/packaging.rst

* Update site/source/developer-docs/specification/config-spec.rst

* Update site/source/learn/concepts/networks.rst

* Update site/source/learn/concepts/networks.rst

* Update site/source/user-manual/customize.rst

* Update site/source/support/faq/faq-basic-use.rst

* Update site/source/user-manual/upgrade-hardware/naspi-upgrade.rst

* Update site/source/user-manual/upgrade-hardware/upgrade-pro.rst

* Update site/source/support/faq/faq-bitcoin.rst

* Update site/source/support/faq/faq-bitcoin.rst

* Update site/source/support/faq/faq-general.rst

* Update site/source/support/faq/faq-general.rst

* Update site/source/support/faq/faq-general.rst

* Update site/source/support/faq/faq-general.rst

* Update site/source/support/faq/faq-services.rst

* Update site/source/support/faq/faq-general.rst

* Update site/source/support/faq/faq-startos.rst

* Update site/source/support/faq/faq-troubleshooting.rst

* Update site/source/support/faq/faq-startos.rst

* Minor fixes

* Fix build errors, ready to roll

* Add Beethoven

* More fixes

* More nother fix

* More nother fixes agin

* Remove sentence

* cards instead

---------

Co-authored-by: Matt Hill <matthewonthemoon@gmail.com>
Co-authored-by: Shadowy Super Coder <musashidisciple@proton.me>
Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
Co-authored-by: kn0wmad <39687477+kn0wmad@users.noreply.github.com>
Co-authored-by: agent <kn0wmad@protonmail.com>
This commit is contained in:
BitcoinMechanic
2023-05-23 12:58:32 -07:00
committed by GitHub
parent 404182cffa
commit 60f83aa683
130 changed files with 879 additions and 1030 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
site/source/developer-docs/advanced/dev-tools/embassy-cli.rst
View File

@@ -1,12 +1,12 @@
.. _embassy-cli:
==============================
Embassy Command Line Interface
StartOS Command Line Interface
==============================
.. 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.
When interacting with StartOS directly, you will invariably want to use ``embassy-cli``. Embassy-CLI can control StartOS 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...
@@ -14,14 +14,14 @@ In order to use Embassy-CLI, you will first need to authorize yourself with the
embassy-cli auth login
and enter your Embassy Master Password at the prompt.
and enter your StartOS Master Password at the prompt.
You can enter ``embassy-cli help`` or ``embassy-cli <option> help`` to get an overview of capabilities:
.. code-block:: bash
Embassy CLI
Embassy-CLI
USAGE:
embassy-cli [OPTIONS] <SUBCOMMAND>
@@ -47,6 +47,6 @@ You can enter ``embassy-cli help`` or ``embassy-cli <option> help`` to get an ov
net Network information
notification Control UI notifications
package Interact with packages
server embassyOS operations and information
server StartOS operations and information
ssh Manage SSH keys
wifi Manage WiFi networks

16
site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst
View File

@@ -1,21 +1,21 @@
.. _embassy-sdk:
===========
Embassy SDK
===========
=========
Start SDK
=========
The embassyOS embedded Software Development Kit (SDK), is a CLI (Command Line Interface) tool that aids in building and packaging services you wish to deploy to the Embassy.
The StartOS embedded Software Development Kit (SDK), is a CLI (Command Line Interface) tool that aids in building and packaging services you wish to deploy to StartOS.
It helps validate that the necessary components of the package exist, and package all of those components into a special file type (``s9pk``) that is understood by embassyOS.
It helps validate that the necessary components of the package exist, and package all of those components into a special file type (``s9pk``) that is understood by StartOS.
Installation
============
You can install this component on any system, without needing to run embassyOS, by running the following command:
You can install this component on any system, without needing to run StartOS, by running the following command:
.. code-block::
git clone -b latest --recursive https://github.com/Start9Labs/embassy-os.git && cd embassy-os/backend && ./install-sdk.sh
git clone -b latest --recursive https://github.com/Start9Labs/start-os.git && cd embassy-os/backend && ./install-sdk.sh
Next, initialize the SDK and verify the installation was successful:
@@ -63,7 +63,7 @@ And load it by running:
embassy-sdk pack
----------------
This command takes the necessary package components and assembles them into the `s9pk` file format needed to install a service on embassyOS. It expects the following files to exist:
This command takes the necessary package components and assembles them into the `s9pk` file format needed to install a service on StartOS. It expects the following files to exist:
- Manifest
- Instructions

6
site/source/developer-docs/advanced/dev-tools/embassyd.rst
View File

@@ -1,14 +1,14 @@
.. _embassyd:
==============
Embassy Daemon
StartOS Daemon
==============
.. 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.
``embassyd`` is the daemon that runs everything that could be considered embassyOS.
``embassyd`` is the daemon that runs everything that could be considered StartOS.
When SSH'd into your Embassy, you may see the status of EmbassyD with the following:
When SSH'd into your Start9 server, you may see the status of EmbassyD with the following:
.. code-block:: bash

2
site/source/developer-docs/advanced/dev-tools/service-container.rst
View File

@@ -4,7 +4,7 @@
Service Containers
==================
For simplicity, embassyOS is designed to be completely operated via the :ref:`WebUI <web-ui>`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands.
For simplicity, StartOS is designed to be completely operated via the :ref:`WebUI <web-ui>`, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands.
.. warning:: The following guide is for those that have advanced command line skills, or those who are being guided by a Start9 support technician. Nothing you do inside a container is supported unless under the direction of Start9. Here be dragons!!

6
site/source/developer-docs/advanced/index.rst
View File

@@ -4,7 +4,7 @@
Advanced
========
This section included advanced commands for working with packages in embassyOS.
This section included advanced commands for working with packages in StartOS.
.. raw:: html
@@ -19,7 +19,7 @@ This section included advanced commands for working with packages in embassyOS.
:class: large-4
:anchor: View
embassyOS developer CLI tools
StartOS developer CLI tools
.. topic-box::
:title: Service Containers
@@ -28,7 +28,7 @@ This section included advanced commands for working with packages in embassyOS.
:class: large-4
:anchor: View
How to interact with containers on the Embassy
How to interact with containers on the StartOS
.. raw:: html