mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
change embassyOS to StartOS & nuance (#357)
* 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
@@ -18,7 +18,7 @@ Bitcoin is a revolutionary piece of software that allows users to exchange value
|
||||
|
||||
Bitcoin Node
|
||||
------------
|
||||
The Embassy can optionally run a Bitcoin node. When most people say "Bitcoin node" what they mean is a "validating node", meaning that the node is capable of enforcing the consensus rules of Bitcoin by accepting, validating, and relaying every transaction and block produced by the network. Fully validating nodes are necessary for Bitcoin to exist and function properly. They protect the network from attackers attempting to bypass the consensus rules. When you run a Bitcoin node, you are "being your own bank."
|
||||
StartOS can optionally run a Bitcoin node. When most people say "Bitcoin node" what they mean is a "validating node", meaning that the node is capable of enforcing the consensus rules of Bitcoin by accepting, validating, and relaying every transaction and block produced by the network. Fully validating nodes are necessary for Bitcoin to exist and function properly. They protect the network from attackers attempting to bypass the consensus rules. When you run a Bitcoin node, you are "being your own bank."
|
||||
|
||||
Here is a video explaining the importance of `running a node <https://www.youtube.com/watch?v=oX0Yrv-6jVs>`_.
|
||||
|
||||
|
||||
@@ -1,126 +0,0 @@
|
||||
.. _embassy-concepts:
|
||||
|
||||
=====================
|
||||
Embassy Devices & eOS
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. youtube:: GfMvXJxYamw
|
||||
:width: 100%
|
||||
|
||||
.. _embassy:
|
||||
|
||||
Embassy One
|
||||
-----------
|
||||
Embassy One is a plug 'n' play hardware device, based on the `Raspberry Pi <https://www.raspberrypi.org/>`_, assembled in-house by Start9. The current iteration features an internal SSD, speaker, active cooling, and power management in a custom AIO (all-in-one) case. Embassy One comes pre-loaded with :ref:`embassyOS<embassy-os>`. For more details, check out the `Embassy One tech specs <https://store.start9.com/products/embassy-one>`_.
|
||||
|
||||
Embassy Pro
|
||||
-----------
|
||||
Embassy Pro is a plug 'n' play hardware device, based on the `Librem Mini <https://puri.sm/products/librem-mini/>`_, built by `Purism <https://puri.sm/about/>`_. The Pro features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. Embassy Pro comes pre-loaded with :ref:`embassyOS<embassy-os>`. For more details, check out the `Embassy Pro tech specs <https://store.start9.com/products/embassy-pro>`_.
|
||||
|
||||
.. _embassy-os:
|
||||
|
||||
embassyOS
|
||||
---------
|
||||
embassyOS (eOS) is a Linux-based operating system custom built for self-hosting open source software. eOS has a range of features that allow anyone to run their own server software without needing all of the traditionally required systems administration skills. Features such as advanced dependency management, sensible default configuration with potential for customization, and a sleek GUI make for a smooth user experience with minimal reliance on the developers for people with all levels of technical expertise.
|
||||
|
||||
Currently, 2 builds of eOS exist, one for the Raspberry Pi (Embassy One) and one for x86_64 (Embassy Pro). We currently only support the Raspberry Pi and Librem Mini hardware platforms, however with some minor tweaking, our builds should work on many other ARM and x86_64 devices. We hope to officially support more platforms soon, and we highly encourage hacking and community builds! Drop in our :ref:`community channels<contact>` to learn more and collaborate!!
|
||||
|
||||
.. _sounds:
|
||||
|
||||
Embassy Sounds
|
||||
--------------
|
||||
embassyOS emits several sounds for user feedback and troubleshooting. Below is the current library of potential sounds and their prospective meaning:
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEP.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "bep" - Embassy is starting up
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/CHIME.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "chime" - Embassy is ready
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "shutdown" - Embassy is shutting down
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "Beethoven" - An error has occurred. Check your "Notifications" tab for more info, or :ref:`Contact Support<contact>`
|
||||
|
||||
.. _services-eos:
|
||||
|
||||
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:
|
||||
|
||||
Sessions
|
||||
--------
|
||||
A session is simply a logged-in connection to your Embassy. You can view your :ref:`Active Sessions<session-management>`, and kill one if you suspect it is not legitimate, or no longer use it.
|
||||
|
||||
.. _service-container:
|
||||
|
||||
Service Container
|
||||
-----------------
|
||||
Each service is compartmentalized into its own "container." At this time, this normally means a `Docker <https://docker.com>`_ container, however embassyOS is modular and other options will be available soon. There are several reasons for doing this, including security, ease of use, and maintenance.
|
||||
|
||||
.. _service-dependencies:
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
A software dependency is a code library or package that is reused in a new piece of software. The benefit of software dependencies is that they allow developers to more quickly deliver software by building on previous work. Software may even require its dependency to be configured in a particular way.
|
||||
|
||||
Traditionally, managing dependencies has been a massive headache and has served as a huge barrier to running a personal server. But no more! The embassyOS dependency management system makes the process transparent and simple.
|
||||
|
||||
If a service has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy device will inform you and provide an automated solution, giving details of what will be done so you can make an informed decision before taking action.
|
||||
|
||||
Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. However, this 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!
|
||||
|
||||
.. _web-ui:
|
||||
|
||||
Web User Interface (UI)
|
||||
-----------------------
|
||||
A User Interface (UI) is the way in which the user interacts with some software. Typically, this is achieved through a graphical interface (GUI). A WebUI is a website that is served specifically for a user to issue commands or view data. A great example of this is embassyOS itself, which serves a WebUI for the user to add/remove services, make configurations, etc. This is your main point of contact with eOS.
|
||||
|
||||
.. _interfaces:
|
||||
|
||||
Service Interfaces
|
||||
------------------
|
||||
In embassyOS, each installed service creates its own Tor Hidden Service URL. For some services, such as File Browser, the URL represents a website that can be visited in the browser; for other services, such as Bitcoin, the URL has to be input into a native client wallet such as Fully Noded, Sparrow, or Specter.
|
||||
|
||||
Certain services, such as Bitcoin, actually have multiple interfaces. Bitcoin has an RPC interface, a P2P interface, and could potentially even have a graphical interface, such as a dashboard displaying important node information. Using the same URL for these various interfaces is not only confusing, but it could also potentially pose a security vulnerability. For example, a user may want to share their P2P interface address with someone for peering, but would not want to give out their UI address, which is for private use only.
|
||||
|
||||
As such, embassyOS permits services to have multiple interfaces, each receiving its own Tor address and/or LAN address. Users can then view and access all interfaces for a given service inside the "Interfaces" section of the service dashboard.
|
||||
|
||||
.. _health-checks:
|
||||
|
||||
Health Checks
|
||||
-------------
|
||||
One of the most critical duties of a sysadmin or devops engineer is to build mechanisms to monitor the health of systems. 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 properly?
|
||||
|
||||
In embassyOS, package developers define what constitutes health and implement health checks according to subjective criteria. These health checks 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.
|
||||
@@ -4,9 +4,9 @@
|
||||
Concepts
|
||||
========
|
||||
|
||||
An overview of the ideas and technologies surrounding Start9 Labs and Embassy.
|
||||
An overview of the ideas and technologies surrounding Start9 and StartOS.
|
||||
|
||||
`Start9 <https://start9.com>`_ and our :ref:`Embassy<embassy>` products (powered by :ref:`embassyOS<embassy-os>`) "stand on the shoulders of giants." Over the past several decades, technologies have been developed by individuals and companies without which these ground-breaking devices could not exist. Below you will find some select ideas and software which will help you understand what Embassy is and how it works.
|
||||
`Start9 <https://start9.com>`_ and our :ref:`products<start9-concepts>` (powered by :ref:`StartOS<start-os>`) "stand on the shoulders of giants." Over the past several decades, technologies have been developed by individuals and companies without which these ground-breaking devices could not exist. Below you will find some select ideas and software which will help you understand what StartOS is and how it works.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -14,5 +14,5 @@ An overview of the ideas and technologies surrounding Start9 Labs and Embassy.
|
||||
open-source
|
||||
networks
|
||||
self-hosting
|
||||
embassy
|
||||
start9-startos
|
||||
bitcoin-lightning
|
||||
|
||||
@@ -16,25 +16,25 @@ A Local Area Network (LAN) is a computer network that interconnects computers wi
|
||||
|
||||
Devices on a LAN are private and protected, such that only devices connected to the same Ethernet or WiFi network can see or communicate with them.
|
||||
|
||||
Your Embassy is hosted on the LAN and is reachable by visiting its ``embassy.local`` URL (for setup, and ``embassy-xxxxxxxx.local`` after setup) in the browser while also connected to the LAN.
|
||||
You can reach your StartOS dashboard by visiting ``start.local`` for initial setup, and ``<custom-address>.local`` after setup from any browser while also connected to the LAN.
|
||||
|
||||
.. note:: Any device connected to a LAN can inspect all communications on that LAN. To avoid snooping, your Embassy's LAN communications are encrypted using :ref:`ssl`, which requires :ref:`additional setup <connecting-lan>`.
|
||||
.. note:: Any device connected to a LAN can inspect all communications on that LAN. To avoid snooping, LAN communications are encrypted using :ref:`ssl`, which requires :ref:`additional setup <connecting-lan>`.
|
||||
|
||||
.. _lan-cert:
|
||||
|
||||
LAN Certificate
|
||||
---------------
|
||||
When you visit an SSL website (one with the ``https://`` prefix), the connection is secured using SSL/TLS encryption. The website will present your browser with an SSL certificate showing that the owner of the website has been authenticated by a recognized Certificate Authority (CA). In the case of your Embassy, **you** are the CA, and **you** sign your own certificate. No third party required!
|
||||
When you visit an SSL website (one with the ``https://`` prefix), the connection is secured using SSL/TLS encryption. The website will present your browser with an SSL certificate showing that the owner of the website has been authenticated by a recognized Certificate Authority (CA). In the case of StartOS, **you** are the CA, and **you** sign your own certificate. No third party required!
|
||||
|
||||
Your certificate is created when you initially setup your Embassy, or migrate to a new version of the OS, such as 0.3.0.
|
||||
Your certificate is created when you initially setup StartOS, or migrate to a new version of the OS, such as 0.3.0.
|
||||
|
||||
.. _mdns:
|
||||
|
||||
MDNS
|
||||
----
|
||||
Multicast Domain Name System (MDNS) is a protocol that resolves a human-readable hostname to an IP address on a small network, such as the home or office network you might host your Embassy on.
|
||||
Multicast Domain Name System (MDNS) is a protocol that resolves a human-readable hostname to an IP address on a small network, such as the home or office network where you host your Start9 server.
|
||||
|
||||
This is known as a "zeroconf," or zero-configuration service, meaning that you can instantly visit a human-recognizable domain name, such as ``embassy.local`` from your network.
|
||||
This is known as a "zeroconf," or zero-configuration service, meaning that you can instantly visit a human-recognizable domain name, such as ``start.local`` from your network.
|
||||
|
||||
This domain is not broadcast outside of your local network, so it is as private and secure as your LAN.
|
||||
|
||||
@@ -42,7 +42,7 @@ This domain is not broadcast outside of your local network, so it is as private
|
||||
|
||||
SSL
|
||||
---
|
||||
Remote connections to your Embassy (when you are on the go) are handled via :ref:`tor<tor>`. Visiting websites on the Tor network can be slow and cumbersome. We wanted to provide a better user experience when accessing your Embassy at home. That's why we created an address for the Embassy that can be accessed on your Local Area Network (:ref:`LAN<lan>`).
|
||||
Remote connections to your server (when you are on the go) are handled via :ref:`tor<tor>`. Visiting websites on the Tor network can be slow and cumbersome. We wanted to provide a better user experience when accessing your server at home. That's why we created an address for StartOS that can be accessed on your Local Area Network (:ref:`LAN<lan>`).
|
||||
|
||||
By default, this ``.local`` address is served like a regular website, over HTTP. Browsers make it noticeable when visiting a site over HTTP in the URL bar - it could be red, show an unlocked lock, or warn that the connection is not secure.
|
||||
|
||||
@@ -50,9 +50,9 @@ SSL certificates are what enable websites to move from HTTP to HTTPS, which incr
|
||||
|
||||
Valid SSL certificates are typically issued and obtained from Certificate Authorities. These trusted third parties generate and distribute certificates, signing them with their trusted private key, which allows the clients who use them to verify their authenticity. Websites obtain a certificate from a CA then load it onto their website's hosting service or server, allowing the website to load over HTTPS and have all traffic to and from the website be encrypted and secure.
|
||||
|
||||
We decided to have the Embassy act as a Certificate Authority (CA). It creates a self-signed certificate, which means that the private key used to sign the digital certificate is the Embassy's own private key instead of a third party's.
|
||||
We decided to have StartOS act as a Certificate Authority (CA). It creates a self-signed certificate, which means that the private key used to sign the digital certificate is your server's own private key instead of a third party's.
|
||||
|
||||
When you setup SSL for your Embassy and client device, the certificate communicates to the client (a browser) that the server (Embassy) demonstrated ownership of the domain (``embassy-xxxxxxxx.local``) to the certificate authority (created on the Embassy) at the time of certificate issuance (during the setup process). The Embassy dashboard can then be accessed from a home network (LAN) using a secure HTTPS connection! You own this entire stack and no third party can interfere.
|
||||
When you setup SSL for StartOS and a client device, the certificate communicates to the client (a browser) that the server demonstrated ownership of the domain (``<custom-address>.local``) to the certificate authority at the time of certificate issuance (during the setup process). The StartOS dashboard can then be accessed from a home network (LAN) using a secure HTTPS connection! You own this entire stack and no third party can interfere.
|
||||
|
||||
For more information on how to setup your devices to enable this feature visit :ref:`connecting-lan`.
|
||||
|
||||
@@ -65,9 +65,9 @@ The Onion Router, or Tor, is a free and open source software that enables anonym
|
||||
|
||||
If a malicious third party were to intercept a request, they would see a garbled mess of the remaining onion encryption, and would only know that it came from some onion node and was heading to some other onion node. The contents, source, and destination of the message are completely anonymous.
|
||||
|
||||
When you use Tor to communicate with services running on the Embassy, all of the traffic is onion-routed and encrypted, and there are no Tor exit nodes involved - it's completely private with no configuration needed.
|
||||
When you use Tor to communicate with services running on StartOS, all of the traffic is onion-routed and encrypted, and there are no Tor exit nodes involved - it's completely private with no configuration needed.
|
||||
|
||||
Furthermore, every service on the Embassy has a different Tor address, including the device itself. This is done for privacy purposes - should one Tor address be exposed, the others will not be compromised. In actuality, Tor addresses are ed25519 keys, which means they also provide all the benefits of cryptographically secure private/public keys.
|
||||
Furthermore, every service on StartOS has a different Tor address, including the device itself. This is done for privacy purposes - should one Tor address be exposed, the others will not be compromised. In actuality, Tor addresses are ed25519 keys, which means they also provide all the benefits of cryptographically secure private/public keys.
|
||||
|
||||
Here's an introductory video on `Tor <https://www.youtube.com/watch?v=6czcc1gZ7Ak>`__.
|
||||
|
||||
@@ -78,9 +78,9 @@ Here's an introductory video on `Tor <https://www.youtube.com/watch?v=6czcc1gZ7A
|
||||
|
||||
Tor Browser
|
||||
-----------
|
||||
The Tor Browser is a version of Firefox specifically made for use with the Tor Network. Tor Browser has Tor built-in, so that you do not need to be running Tor natively in order to use the network. This makes it a great browser for use with your Embassy.
|
||||
The Tor Browser is a version of Firefox specifically made for use with the Tor Network. Tor Browser has Tor built-in, so that you do not need to be running Tor natively in order to use the network. This makes it a great browser for use with your server.
|
||||
|
||||
.. caution:: Tor Browser has some advanced security and privacy settings, which can be useful, but please keep in mind that if you raise them from the standard level, you may be unable to use some websites, such as your Embassy UI.
|
||||
.. caution:: Tor Browser has some advanced security and privacy settings, which can be useful, but please keep in mind that if you raise them from the standard level, you may be unable to use some websites, such as your StartOS dashboard.
|
||||
|
||||
.. _hidden-service:
|
||||
|
||||
|
||||
@@ -27,8 +27,8 @@ Dependencies
|
||||
------------
|
||||
A software dependency is a code library or package that is reused in a new piece of software. The benefit of software dependencies is that they allow developers to more quickly deliver software by building on previous work. Software may even require its dependency to be configured in a particular way.
|
||||
|
||||
Traditionally, managing dependencies has been a massive headache and has served as a huge barrier to running a personal server. But no more! The embassyOS dependency management system makes the process simple and accesible.
|
||||
Traditionally, managing dependencies has been a massive headache and has served as a huge barrier to running a personal server. But no more! The StartOS dependency management system makes the process simple and accesible.
|
||||
|
||||
If a service has one or more dependencies, or a dependency needs to be configured in a particular way, your Embassy device will inform you and provide an automated solution, giving details of what will be done so you can make an informed decision before taking action.
|
||||
If a service has one or more dependencies, or a dependency needs to be configured in a particular way, StartOS will inform you and provide an automated solution, giving details of what will be done so you can make an informed decision before taking action.
|
||||
|
||||
Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. This 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!
|
||||
Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. This does not necessarily mean you need to have Bitcoin installed on StartOS. You could just as easily configure Lightning to use another Bitcoin node located somewhere else!
|
||||
|
||||
@@ -22,7 +22,7 @@ We can quickly realize the problem with a model like this. The server has **ALL
|
||||
"Self-Hosting"
|
||||
--------------
|
||||
|
||||
Since a server is "just a computer," one might ask why we can't just host our own data and software. Unfortunately, running a server is no trivial task, and typically requires Linux and systems administration skills. That is, until now. embassyOS was designed specifically to allow anyone to be able to run their own server-side software and host their own data, with no special tech skills or excessive effort.
|
||||
Since a server is "just a computer," one might ask why we can't just host our own data and software. Unfortunately, running a server is no trivial task, and typically requires Linux and systems administration skills. That is, until now. StartOS was designed specifically to allow anyone to be able to run their own server-side software and host their own data, with no special tech skills or excessive effort.
|
||||
|
||||
For an overview, please check out the video below:
|
||||
|
||||
|
||||
123
site/source/learn/concepts/start9-startos.rst
Normal file
123
site/source/learn/concepts/start9-startos.rst
Normal file
@@ -0,0 +1,123 @@
|
||||
.. _start9-concepts:
|
||||
|
||||
=======================
|
||||
Start9 Server & StartOS
|
||||
=======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _server:
|
||||
|
||||
Server One
|
||||
----------
|
||||
Server One is a plug 'n' play hardware device, based on the `Raspberry Pi <https://www.raspberrypi.org/>`_, assembled in-house by Start9. The current iteration features an internal SSD, speaker, active cooling, and power management in a custom AIO (all-in-one) case. The One comes pre-loaded with :ref:`StartOS<start-os>`. For more details, check out the `Server One tech specs <https://store.start9.com/products/server-one>`_.
|
||||
|
||||
Server Pro
|
||||
----------
|
||||
Server Pro is a plug 'n' play hardware device, based on the `Librem Mini <https://puri.sm/products/librem-mini/>`_, built by `Purism <https://puri.sm/about/>`_. The Pro features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. The Pro comes pre-loaded with :ref:`StartOS<start-os>`. For more details, check out the `Server Pro tech specs <https://store.start9.com/products/server-pro>`_.
|
||||
|
||||
.. _start-os:
|
||||
|
||||
StartOS
|
||||
-------
|
||||
StartOS is a Linux-based operating system custom built for self-hosting open source software. It has a range of features that allow anyone to run their own server software without needing all of the traditionally required systems administration skills. Features such as advanced dependency management, sensible default configuration with potential for customization, and a sleek GUI make for a smooth user experience with minimal reliance on the developers for people with all levels of technical expertise.
|
||||
|
||||
Currently, 2 builds of StartOS exist, one for the Raspberry Pi (Server One) and one for x86 (Server Pro). We currently only support the Raspberry Pi and Librem Mini hardware platforms, however with some minor tweaking, our builds should work on many other ARM and x86 devices. We hope to officially support more platforms soon, and we highly encourage hacking and community builds! Drop in our :ref:`community channels<contact>` to learn more and collaborate!!
|
||||
|
||||
.. _sounds:
|
||||
|
||||
Server Sounds
|
||||
-------------
|
||||
On some models (Server Lite, 2022 Server One, and Server Pure), StartOS emits sounds for user feedback and troubleshooting. Below is the current library of potential sounds and their prospective meaning:
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEP.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "bep" - StartOS is starting up
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/CHIME.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "chime" - StartOS is ready
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "shutdown" - StartOS is shutting down
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "Beethoven" - An error has occurred. Check your "Notifications" tab for more info, or :ref:`Contact Support<contact>`
|
||||
|
||||
.. _services-eos:
|
||||
|
||||
Services
|
||||
--------
|
||||
The server-side software available on StartOS 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:
|
||||
|
||||
Sessions
|
||||
--------
|
||||
A session is simply a logged-in connection to the StartOS dashboard. You can view your :ref:`Active Sessions<session-management>`, and kill one if you suspect it is not legitimate, or no longer use it.
|
||||
|
||||
.. _service-container:
|
||||
|
||||
Service Container
|
||||
-----------------
|
||||
Each service is compartmentalized into its own "container." At this time, this normally means a `Docker <https://docker.com>`_ container, however StartOS is modular and other options will be available soon. There are several reasons for doing this, including security, ease of use, and maintenance.
|
||||
|
||||
.. _service-dependencies:
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
A software dependency is a code library or package that is reused in a new piece of software. The benefit of software dependencies is that they allow developers to more quickly deliver software by building on previous work. Software may even require its dependency to be configured in a particular way.
|
||||
|
||||
Traditionally, managing dependencies has been a massive headache and has served as a huge barrier to running a personal server. But no more! The StartOS dependency management system makes the process transparent and simple.
|
||||
|
||||
If a service has one or more dependencies, or a dependency needs to be configured in a particular way, StartOS will inform you and provide an automated solution, giving details of what will be done so you can make an informed decision before taking action.
|
||||
|
||||
Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. However, this does not necessarily mean you need to have Bitcoin installed on StartOS. You could just as easily configure Lightning to use another Bitcoin node located somewhere else!
|
||||
|
||||
.. _web-ui:
|
||||
|
||||
Web User Interface (UI)
|
||||
-----------------------
|
||||
A User Interface (UI) is the way in which the user interacts with some software. Typically, this is achieved through a graphical interface (GUI). A WebUI is a website that is served specifically for a user to issue commands or view data. A great example of this is StartOS itself, which serves a WebUI for the user to add/remove services, make configurations, etc. This is your main point of contact with eOS.
|
||||
|
||||
.. _interfaces:
|
||||
|
||||
Service Interfaces
|
||||
------------------
|
||||
In StartOS, each installed service creates its own Tor Hidden Service URL. For some services, such as File Browser, the URL represents a website that can be visited in the browser; for other services, such as Bitcoin, the URL has to be input into a native client wallet such as Fully Noded, Sparrow, or Specter.
|
||||
|
||||
Certain services, such as Bitcoin, actually have multiple interfaces. Bitcoin has an RPC interface, a P2P interface, and could potentially even have a graphical interface, such as a dashboard displaying important node information. Using the same URL for these various interfaces is not only confusing, but it could also potentially pose a security vulnerability. For example, a user may want to share their P2P interface address with someone for peering, but would not want to give out their UI address, which is for private use only.
|
||||
|
||||
As such, StartOS permits services to have multiple interfaces, each receiving its own Tor address and/or LAN address. Users can then view and access all interfaces for a given service inside the "Interfaces" section of the service dashboard.
|
||||
|
||||
.. _health-checks:
|
||||
|
||||
Health Checks
|
||||
-------------
|
||||
One of the most critical duties of a sysadmin or devops engineer is to build mechanisms to monitor the health of systems. 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 properly?
|
||||
|
||||
In StartOS, package developers define what constitutes health and implement health checks according to subjective criteria. These health checks 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.
|
||||
@@ -19,7 +19,7 @@ Learn
|
||||
:class: large-4
|
||||
:anchor: Learn
|
||||
|
||||
An overview of the ideas and technologies surrounding Start9 Labs and Embassy.
|
||||
An overview of the ideas and technologies surrounding Start9 and StartOS.
|
||||
|
||||
.. topic-box::
|
||||
:title: FAQ
|
||||
@@ -28,7 +28,7 @@ Learn
|
||||
:class: large-4
|
||||
:anchor: Get Answers
|
||||
|
||||
Answers to Frequently Asked Questions from Embassy users.
|
||||
Answers to Frequently Asked Questions from StartOS users.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Articles
|
||||
========
|
||||
|
||||
Articles featuring Start9 Labs and/or Embassy
|
||||
Articles featuring Start9 Labs and/or StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: March 11, 2021 - Start9 Labs Pitches a Private At-Home Server. And It Works
|
||||
@@ -20,6 +20,6 @@ Articles featuring Start9 Labs and/or Embassy
|
||||
:link: https://www.coindesk.com/tech/2020/07/08/start9-labs-pitches-a-private-at-home-server-and-it-works/
|
||||
:anchor: Coindesk
|
||||
|
||||
Start9 Labs' Embassy server sets up its own private internet network and comes with its own operating system. We tried it.
|
||||
Start9's StartOS sets up its own private internet network and comes with its own operating system. We tried it.
|
||||
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Podcasts
|
||||
========
|
||||
|
||||
Podcasts featuring Start9 Labs and/or Embassy
|
||||
Podcasts featuring Start9 Labs and StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: September 16, 2022 - RaspiFUD or fact? Bitcoin nodes and security
|
||||
@@ -44,7 +44,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://is2-ssl.mzstatic.com/image/thumb/Podcasts/62/f0/38/ps.tbxsjaqa.jpg/626x0w.webp
|
||||
:anchor: Declare Your Independence
|
||||
|
||||
David Croisant (Start9 Labs) comes on to talk about embassyOS version 0.3.0, "self-hosting," freedom tech, "Uncle Jim" model, rebuilding the Internet, pirate communications, etc...
|
||||
David Croisant (Start9 Labs) comes on to talk about StartOS version 0.3.0, "self-hosting," freedom tech, "Uncle Jim" model, rebuilding the Internet, pirate communications, etc...
|
||||
|
||||
.. topic-box::
|
||||
:title: February 24, 2022 - SLP352 Matt Hill
|
||||
@@ -52,7 +52,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://i0.wp.com/stephanlivera.com/wp-content/uploads/2022/02/SLP352-WP-Thumbnail.png
|
||||
:anchor: Stephan Livera Podcast
|
||||
|
||||
embassyOS & Making Self-Sovereignty Tech Cheaper Than The Alternatives
|
||||
StartOS & Making Self-Sovereignty Tech Cheaper Than The Alternatives
|
||||
|
||||
.. topic-box::
|
||||
:title: January 25, 2022 - On The Record with Start9
|
||||
@@ -60,7 +60,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://i3.ytimg.com/vi/jMV_DWAMtmc/maxresdefault.jpg
|
||||
:anchor: On The Record
|
||||
|
||||
Start9 demo the latest version of embassyOS
|
||||
Start9 demo the latest version of StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: November 29, 2021 - Episode #101: Securing your own data with Matt Hill of Start9
|
||||
@@ -68,10 +68,10 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://www.agoristnexus.com/wp-content/uploads/2021/11/paste-147-750x450.png
|
||||
:anchor: Agorist Nexus
|
||||
|
||||
In this episode Brandon and Dag speak with Matt Hill of Start9 Labs about securing your own data with Embassy
|
||||
In this episode Brandon and Dag speak with Matt Hill of Start9 Labs about securing your own data with StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: November 22, 2021 - Episode #287: embassyOS v0.3.0, building out the independent stack, and philosophy with Matt Hill
|
||||
:title: November 22, 2021 - Episode #287: StartOS v0.3.0, building out the independent stack, and philosophy with Matt Hill
|
||||
:link: https://talesfromthecrypt.libsyn.com/287-embassyOS-v030-building-out-the-independent-stack-and-philosophy-with-matt-hill
|
||||
:image: https://assets.libsyn.com/secure/content/63745304
|
||||
:anchor: Tales From The Crypt
|
||||
@@ -84,7 +84,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://assets.libsyn.com/secure/item/21234746
|
||||
:anchor: The Bitcoin Matrix
|
||||
|
||||
Matt Hill sits down with Cedric to discuss Start9, building technology for the individual, the Embassy personal server, and how you can leverage the dark net for private Bitcoin, Lightning Network, data, messaging and social media
|
||||
Matt Hill sits down with Cedric to discuss Start9, building technology for the individual, the Start9 personal server, and how you can leverage the dark net for private Bitcoin, Lightning Network, data, messaging and social media
|
||||
|
||||
.. topic-box::
|
||||
:title: October 5, 2021 - Anarchast Episode 566
|
||||
@@ -92,7 +92,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://i1.sndcdn.com/avatars-h52MnISbZ9tcP7DC-4nV1iQ-t500x500.jpg
|
||||
:anchor: Anarchast
|
||||
|
||||
Today we are introduced to David from Start9 to get a demo of their potentially world changing project -- the Embassy! Become a Digital Sovereign with Start9
|
||||
Today we are introduced to David from Start9 to get a demo of their potentially world changing operating system -- StartOS! Become a Digital Sovereign with Start9
|
||||
|
||||
.. topic-box::
|
||||
:title: August 18, 2021 - The Survival Podcast Episode 2937
|
||||
@@ -180,7 +180,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://i.ytimg.com/vi/QYYY9Iw1aXE/hq720.jpg?sqp=-oaymwEcCNAFEJQDSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLCbQy80EnPsOR1s_pW_xYzY64Ufcw
|
||||
:anchor: Tucson Bitcoin
|
||||
|
||||
Lucy Cifferello explains how Start9 is a company dedicated to lowering the bar of entry into Self-Sovereignty. Their flagship product, The Embassy, allows for one click installs of privacy oriented apps
|
||||
Lucy Cifferello explains how Start9 is a company dedicated to lowering the bar of entry into Self-Sovereignty. Their flagship software, StartOS, allows for one click installs of privacy oriented apps
|
||||
|
||||
.. topic-box::
|
||||
:title: March 12, 2021 - Interview with David Croisant
|
||||
@@ -196,7 +196,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://m.media-amazon.com/images/I/41-qTKOsR-L._SL500_.jpg
|
||||
:anchor: The Bitcoin Path
|
||||
|
||||
Jon talk with Matt about sovereign computing, privacy, and the Start9 Embassy personal server
|
||||
Jon talk with Matt about sovereign computing, privacy, and the Start9's StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: December 29, 2020 - Inteview with Matt Hill
|
||||
@@ -204,7 +204,7 @@ Podcasts featuring Start9 Labs and/or Embassy
|
||||
:image: https://assets.libsyn.com/secure/content/63745304
|
||||
:anchor: Tales From The Crypt
|
||||
|
||||
Marty sits down with Matt Hill to discuss: Founding Start9 Labs - The Embassy - Routing around Apple's App Store - Why personal hardware is an imperative moving forward - Self-sovereign surveillance - Making all of this easy
|
||||
Marty sits down with Matt Hill to discuss: Founding Start9 Labs, StartOS, and Routing around Apple's App Store - Why personal hardware is an imperative moving forward - Self-sovereign surveillance - Making all of this easy
|
||||
|
||||
.. topic-box::
|
||||
:title: September 29, 2020 - Sovereignty in a Box
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Videos
|
||||
======
|
||||
|
||||
Videos featuring Start9 Labs and/or Embassy devices.
|
||||
Videos featuring Start9 Labs and StartOS
|
||||
|
||||
.. topic-box::
|
||||
:title: May 20, 2022 - Bitcoin & Owning Your Data with David Croisant
|
||||
@@ -20,7 +20,7 @@ Videos featuring Start9 Labs and/or Embassy devices.
|
||||
:image: https://bullbitcoin.com/images/logo-bullbitcoin-hd-crop.png
|
||||
:anchor: Bitcoin Summer In Montreal
|
||||
|
||||
Matt Hill, CEO of Start9 labs, talks about the Embassy product and sovereign computing
|
||||
Matt Hill, CEO of Start9 labs, talks about the StartOS and sovereign computing
|
||||
|
||||
.. topic-box::
|
||||
:title: August 28, 2020 - Computing and Bitcoin
|
||||
@@ -29,13 +29,3 @@ Videos featuring Start9 Labs and/or Embassy devices.
|
||||
:anchor: Bit Block Boom
|
||||
|
||||
Matt Hill discusses the importance of building decentralized computing infrastructure and provides a glimpse of the future of personal computing.
|
||||
|
||||
|
||||
|
||||
.. This is quite old and now irrelevant, leaving out for now
|
||||
.. :title: July 27, 2020 - How to Set Up the START9 Embassy Personal Server With the Fully Noded App
|
||||
.. :image: https://i.ytimg.com/vi/YMStLevc034/maxresdefault.jpg
|
||||
.. :link: https://www.coindesk.com/tech/2020/07/08/start9-labs-pitches-a-private-at-home-server-and-it-works/
|
||||
.. :anchor: Bitcoin Magazine
|
||||
|
||||
.. This Bitcoin Magazine breakdown video is all about the Start9 Embassy. The Embassy is a radical, uncompromising, plug-and-play private server
|
||||
|
||||
Reference in New Issue
Block a user