mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +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
Binary file not shown.
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 4.2 KiB |
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
|
Before Width: | Height: | Size: 305 KiB After Width: | Height: | Size: 305 KiB |
|
Before Width: | Height: | Size: 506 KiB After Width: | Height: | Size: 506 KiB |
|
Before Width: | Height: | Size: 1021 KiB After Width: | Height: | Size: 1021 KiB |
|
Before Width: | Height: | Size: 460 KiB After Width: | Height: | Size: 460 KiB |
|
Before Width: | Height: | Size: 782 KiB After Width: | Height: | Size: 782 KiB |
|
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 1.3 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 1.0 MiB After Width: | Height: | Size: 1.0 MiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 162 KiB After Width: | Height: | Size: 162 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 40 KiB |
@@ -5,8 +5,8 @@
|
||||
{% block extrahead %}
|
||||
<meta name="twitter:card" content="summary">
|
||||
<meta name="twitter:site" content="@start9labs">
|
||||
<meta name="og:title" content="Start9 Embassy Personal Server">
|
||||
<meta name="og:title" content="Start9 Personal Servers">
|
||||
<meta property="og:image" content="https://docs.start9.com/images/icon.png" />
|
||||
<meta name="og:description"
|
||||
content="Start9 documentation for sovereign computing with embassyOS">
|
||||
content="Start9 documentation for sovereign computing with StartOS">
|
||||
{% endblock %}
|
||||
@@ -95,7 +95,7 @@ html_theme_options = {
|
||||
"conf_py_path": "site/source/",
|
||||
"banner_button_text": "Learn more",
|
||||
"banner_button_url": "https://start9labs.medium.com/announcing-embassyOS-0-3-0-f3d2d2ea016f",
|
||||
"banner_title_text": "embassyOS 0.3.0 is now available 🥳",
|
||||
"banner_title_text": "StartOS 0.3.0 is now available 🥳",
|
||||
"hide_banner": "true",
|
||||
"hide_edit_this_page_button": "false",
|
||||
"hide_sidebar_index": "true",
|
||||
@@ -103,7 +103,7 @@ html_theme_options = {
|
||||
"github_issues_repository": "Start9Labs/documentation",
|
||||
"github_repository": "Start9Labs/documentation",
|
||||
"navigation_depth": 3,
|
||||
"site_description": "Start9 documentation for sovereign computing with embassyOS",
|
||||
"site_description": "Start9 documentation for sovereign computing with StartOS",
|
||||
}
|
||||
|
||||
# Last updated format
|
||||
@@ -137,4 +137,4 @@ html_favicon = "_static/favicon.ico"
|
||||
|
||||
html_js_files = ["custom.js"]
|
||||
|
||||
# exclude_patterns = ['user-manual/forgot-password.rst']
|
||||
# exclude_patterns = ['user-manual/forgot-password.rst']
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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!!
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Developer Docs
|
||||
==============
|
||||
|
||||
Welcome to the Service Packaging documentation for embassyOS. If you are here, you have heard the call to help empower users with sovereign computing!
|
||||
Welcome to the Service Packaging documentation for StartOS. If you are here, you have heard the call to help empower users with sovereign computing!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Service Packaging
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on :ref:`embassyOS<embassy-os>` "services." This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on embassyOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package.
|
||||
Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on :ref:`StartOS<start-os>` "services." This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on StartOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package.
|
||||
|
||||
Check out the :ref:`glossary <glossary>` to get acquainted with unfamiliar terms. The bottom of this guide also includes :ref:`support <packaging-support>` links, including a master checklist.
|
||||
|
||||
@@ -26,7 +26,7 @@ Steps
|
||||
#. :ref:`Create the file structure <create-file-structure>`
|
||||
#. :ref:`Format the package <format-package>`
|
||||
|
||||
#. :ref:`Test the service on embassyOS <testing>`
|
||||
#. :ref:`Test the service on StartOS <testing>`
|
||||
#. :ref:`Submit and/or distribute <submission-and-distribution>`
|
||||
|
||||
.. _choosing-software:
|
||||
@@ -34,9 +34,9 @@ Steps
|
||||
Choosing Software
|
||||
=================
|
||||
|
||||
Almost any type of open source software can be run on embassyOS. No matter what programming language, framework, database or interface the service has, it can be adapted for embassyOS. This is made possible by the power of Docker containers (don't worry, we'll get to this). We do have a few recommendations for choosing a service that will perform optimally across platforms:
|
||||
Almost any type of open source software can be run on StartOS. No matter what programming language, framework, database or interface the service has, it can be adapted for StartOS. This is made possible by the power of Docker containers (don't worry, we'll get to this). We do have a few recommendations for choosing a service that will perform optimally across platforms:
|
||||
|
||||
#. It either has a web user interface (it can be interacted with in a web browser), or is server software that external applications or internal services can connect to. Please keep in mind that embassyOS users are not expected to have SSH and/or CLI access.
|
||||
#. It either has a web user interface (it can be interacted with in a web browser), or is server software that external applications or internal services can connect to. Please keep in mind that StartOS users are not expected to have SSH and/or CLI access.
|
||||
|
||||
- The interfaces supported are: HTTP, TCP, and REST APIs
|
||||
|
||||
@@ -51,7 +51,7 @@ Development Environment
|
||||
|
||||
A basic development and testing environment includes:
|
||||
|
||||
#. An Embassy One or Pro with latest `embassyOS <https://github.com/start9labs/embassy-os/releases>`_
|
||||
#. A Start9 server or VM running the latest `StartOS <https://github.com/Start9Labs/start-os/releases>`_
|
||||
|
||||
- Use your own hardware to `DIY <https://start9.com/latest/diy>`_
|
||||
- Purchase a device from the `Start9 Store <https://store.start9.com>`_
|
||||
@@ -142,7 +142,7 @@ These tools may or may not be necessary, depending on your environment and the p
|
||||
|
||||
Dependencies - Required
|
||||
.......................
|
||||
- `Docker <https://docs.docker.com/get-docker/>`_ - Docker is currently the only supported containerization method for embassyOS. This declares the necessary environment and building stages for your package to run. Install the desktop GUI or via the command line:
|
||||
- `Docker <https://docs.docker.com/get-docker/>`_ - Docker is currently the only supported containerization method for StartOS. This declares the necessary environment and building stages for your package to run. Install the desktop GUI or via the command line:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@@ -163,7 +163,7 @@ Dependencies - Required
|
||||
docker buildx install
|
||||
docker buildx create --use
|
||||
|
||||
- Rust & Cargo - Cargo is the package management solution for the Rust programming language. It is needed to build the Embassy SDK. The following will install both Rust and Cargo:
|
||||
- Rust & Cargo - Cargo is the package management solution for the Rust programming language. It is needed to build the Start SDK. The following will install both Rust and Cargo:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@@ -176,11 +176,11 @@ Dependencies - Required
|
||||
|
||||
cargo --version
|
||||
|
||||
- Embassy SDK - embassyOS has an embedded Software Development Kit (SDK). You can install this component on any system, without needing to run embassyOS.
|
||||
- Start SDK - StartOS has an embedded Software Development Kit (SDK). You can install this component on any system, without needing to run StartOS.
|
||||
|
||||
.. 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 start-os/backend && ./install-sdk.sh
|
||||
|
||||
Initialize sdk & verify install
|
||||
|
||||
@@ -207,7 +207,7 @@ Dependencies - Required
|
||||
|
||||
Demo with Hello World
|
||||
=====================
|
||||
Check your environment setup by building a demo project and installing it to embassyOS.
|
||||
Check your environment setup by building a demo project and installing it to StartOS.
|
||||
|
||||
#. Get Hello World
|
||||
|
||||
@@ -225,7 +225,7 @@ Check your environment setup by building a demo project and installing it to emb
|
||||
make
|
||||
|
||||
#. Sideload & Run
|
||||
- In the embassyOS web UI menu, navigate to `Embassy -> Settings -> Sideload Service`
|
||||
- In the StartOS web UI menu, navigate to `System -> Sideload Service`
|
||||
- Drag and drop or select the ``hello-world.s9pk`` from your filesystem to install
|
||||
- Once the service has installed, navigate to `Services -> Hello World` and click "Start"
|
||||
- Once the Health Check is successful, click "Launch UI" and verify you see the Hello World page
|
||||
@@ -234,13 +234,13 @@ Check your environment setup by building a demo project and installing it to emb
|
||||
|
||||
Package the service
|
||||
===================
|
||||
The package file produced by this process has a ``s9pk`` extension. This file is what is installed to run a service on embassyOS.
|
||||
The package file produced by this process has a ``s9pk`` extension. This file is what is installed to run a service on StartOS.
|
||||
|
||||
.. _build-a-dockerfile:
|
||||
|
||||
Build a Dockerfile
|
||||
..................
|
||||
A Dockerfile defines the recipe for building the environment to run a service. Currently, embassyOS only supports one Dockerfile per project (i.e. no Docker compose), so it should include any necessary database configurations. There are several methods to build a Dockerfile for your service.
|
||||
A Dockerfile defines the recipe for building the environment to run a service. Currently, StartOS only supports one Dockerfile per project (i.e. no Docker compose), so it should include any necessary database configurations. There are several methods to build a Dockerfile for your service.
|
||||
|
||||
First, check to see if the upstream project has already built one. This is usually your best source for finding Docker images that are compatible with ARM. Next, you can:
|
||||
|
||||
@@ -363,13 +363,13 @@ Testing
|
||||
|
||||
#. Drag and drop:
|
||||
|
||||
- In the embassyOS web UI menu, navigate to `Embassy -> Settings -> Sideload Service`
|
||||
- In the StartOS web UI menu, navigate to `System -> Sideload Service`
|
||||
|
||||
- Drag and drop or select the ``<package>.s9pk`` from your filesystem to install
|
||||
|
||||
#. Use the CLI:
|
||||
|
||||
- Create a config file with the IP address of the device running embassyOS:
|
||||
- Create a config file with the IP address of the device running StartOS:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@@ -410,8 +410,8 @@ The ``s9pk`` file can be uploaded for distribution to any website, repository, o
|
||||
Advanced configuration
|
||||
======================
|
||||
|
||||
Scripting on embassyOS
|
||||
......................
|
||||
Scripting on StartOS
|
||||
....................
|
||||
|
||||
Start9 has developed a highly extensible scripting API for developers to create the best possible user experience. This is your toolkit for creating the most powerful service possible by enabling features such as:
|
||||
|
||||
@@ -440,7 +440,7 @@ You may like to use this handy :ref:`Checklist <packaging-checklist>` to be sure
|
||||
Glossary
|
||||
========
|
||||
|
||||
`service` - open software applications that run on embassyOS
|
||||
`service` - open software applications that run on StartOS
|
||||
|
||||
`package` - the composed set of a Docker image, a service manifest, and service instructions, icon, and license, that are formatted into a file with the `s9pk` extension using `embassy-sdk`
|
||||
|
||||
@@ -448,17 +448,17 @@ Glossary
|
||||
|
||||
`scripts` - a set of developer APIs that enable advanced configuration options for services
|
||||
|
||||
`embassy-sdk` - the Software Development Toolkit used to package and verify services for embassyOS
|
||||
`embassy-sdk` - the Software Development Toolkit used to package and verify services for StartOS
|
||||
|
||||
`open source software` - computer software that is released under a license in which the copyright holder grants users the rights to use, study, change, and distribute the software and its source code to anyone and for any purpose
|
||||
|
||||
`upstream project` - the original, source project code that is used as the base for a service
|
||||
|
||||
`embassyOS` - a browser-based, graphical operating system for a personal server
|
||||
`StartOS` - a browser-based, graphical operating system for a personal server
|
||||
|
||||
`eOS` - shorthand for embassyOS
|
||||
`eOS` - shorthand for StartOS
|
||||
|
||||
`s9pk` - the file extension for the packaged service artifact needed to install and run a service on embassyOS
|
||||
`s9pk` - the file extension for the packaged service artifact needed to install and run a service on StartOS
|
||||
|
||||
|
||||
:ref:`Back to Top <service-packaging>`
|
||||
|
||||
@@ -6,7 +6,7 @@ Backups
|
||||
|
||||
Backups are defined by the service developer in the backups section of the Manifest. By default, this action is a command executed within a Docker container.
|
||||
|
||||
embassyOS provides a system utility for creating backups. This system utility is the `duplicity <https://en.wikipedia.org/wiki/Duplicity_(software)>`_ library that is run inside the Docker image entitled _compat_.
|
||||
StartOS provides a system utility for creating backups. This system utility is the `duplicity <https://en.wikipedia.org/wiki/Duplicity_(software)>`_ library that is run inside the Docker image entitled _compat_.
|
||||
|
||||
The path to be backed up can be specified in the Manifest. In the create backup example below, it is the last argument:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Checklist
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
This guide outlines a checklist of steps to complete in order to package a service for embassyOS. For a more in depth example, visit the :ref:`build your first package <service-packaging>` guide.
|
||||
This guide outlines a checklist of steps to complete in order to package a service for StartOS. For a more in depth example, visit the :ref:`build your first package <service-packaging>` guide.
|
||||
|
||||
Packaging
|
||||
---------
|
||||
@@ -30,7 +30,7 @@ Packaging
|
||||
Testing:
|
||||
--------
|
||||
|
||||
1. Sideload ``<package-id>.s9pk`` onto an Embassy
|
||||
1. Sideload ``<package-id>.s9pk`` onto StartOS
|
||||
2. Install package using embassy-cli
|
||||
3. Start package using embassy-cli, or in the UI
|
||||
4. Check logs to see if errors
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
Compat Image
|
||||
============
|
||||
|
||||
With the release of embassyOS v0.3.0, system utility Docker images are preloaded for service packager convenience.
|
||||
With the release of StartOS v0.3.0, system utility Docker images are preloaded for service packager convenience.
|
||||
|
||||
The ``Compat`` image is a backwards compatible Docker image that hosts embassyOS features used in the v0.2.x series. It was created as a convenience for service packagers to help migrate their service configurations from 0.2.x to 0.3.0.
|
||||
The ``Compat`` image is a backwards compatible Docker image that hosts StartOS features used in the v0.2.x series. It was created as a convenience for service packagers to help migrate their service configurations from 0.2.x to 0.3.0.
|
||||
|
||||
It exposes functionality to make use of:
|
||||
|
||||
|
||||
@@ -7,9 +7,9 @@ Config Spec
|
||||
Introduction
|
||||
============
|
||||
|
||||
Most self-hosted applications require the user to tell the application how to behave using a config file in a specific format, environment variables, command-line arguments, or some combination of these inputs. One of the coolest features of embassyOS is that the services' configuration will be available to the user as a slick GUI that always produces a valid configuration no matter how little experience or skill the user has.
|
||||
Most self-hosted applications require the user to tell the application how to behave using a config file in a specific format, environment variables, command-line arguments, or some combination of these inputs. One of the coolest features of StartOS is that the services' configuration will be available to the user as a slick GUI that always produces a valid configuration no matter how little experience or skill the user has.
|
||||
|
||||
With embassyOS, this means a services' configuration requires a file to define the particular format to ensure it integrates smoothly with the user interface. This format enables clean handling of improper values and dependency management.
|
||||
With StartOS, this means a services' configuration requires a file to define the particular format to ensure it integrates smoothly with the user interface. This format enables clean handling of improper values and dependency management.
|
||||
|
||||
This file defines the *structure* of the service's native config and should be curated according to the ``ConfigSpec`` type, which is a detailed mapping of the configuration options with acceptable values, defined patterns, and defaults.
|
||||
|
||||
@@ -150,7 +150,7 @@ Example
|
||||
List
|
||||
----
|
||||
|
||||
The list type describes an array of values. The values must consist of the same subtype, which can be any of the ValueSpec types available in the embassyOS config specification.
|
||||
The list type describes an array of values. The values must consist of the same subtype, which can be any of the ValueSpec types available in the StartOS config specification.
|
||||
Lists of any type do not contain the default for each item in list. The list *itself* can have a default. If no default is provided, ``null`` will be the assumed value.
|
||||
|
||||
Range is loosely based off mathematical range syntax, with infinity replaced with ``*``:
|
||||
@@ -358,7 +358,7 @@ Examples
|
||||
Pointer
|
||||
--------
|
||||
|
||||
The pointer type *points* to a config value on another service installed on embassyOS (ie. package subtype) or to the embassyOS system (ie. system subtype). When pointing to another service, the ``selector`` field indicates the path to the desired config variable.
|
||||
The pointer type *points* to a config value on another service installed on StartOS (ie. package subtype) or to the StartOS system (ie. system subtype). When pointing to another service, the ``selector`` field indicates the path to the desired config variable.
|
||||
|
||||
.. code-block::
|
||||
:caption: ValueSpec Type
|
||||
@@ -396,7 +396,7 @@ Union
|
||||
|
||||
This type describes a necessary dependency. Multiple variants can be expressed to enable the user the option to connect to another service (internal dependency) or outside source (external dependency).
|
||||
|
||||
For example, the Bitcoin Proxy service is united with an instance of Bitcoin. Three variants are defined: internal, external, and a quick connect. In this case, internal refers to the Bitcoin Core instance running on embassyOS, and defines the RPC credentials necessary for connecting; external refers to a Bitcoin Core node running on a different device, and defines the RPC credentials necessary for connecting; quick connect refers to yet another method of connecting to a Bitcoin Core node, optimized for convenience.
|
||||
For example, the Bitcoin Proxy service is united with an instance of Bitcoin. Three variants are defined: internal, external, and a quick connect. In this case, internal refers to the Bitcoin Core instance running on StartOS, and defines the RPC credentials necessary for connecting; external refers to a Bitcoin Core node running on a different device, and defines the RPC credentials necessary for connecting; quick connect refers to yet another method of connecting to a Bitcoin Core node, optimized for convenience.
|
||||
|
||||
Default is required and corresponds to one of the variants.
|
||||
|
||||
@@ -438,7 +438,7 @@ Example
|
||||
id: type
|
||||
name: Type
|
||||
description: |
|
||||
- Internal: The Bitcoin Core service installed to your Embassy
|
||||
- Internal: The Bitcoin Core service installed on your server
|
||||
- External: A Bitcoin Core node running on a different device
|
||||
- Quick Connect: A Quick Connect URL for an unpruned Bitcoin Core node
|
||||
variant-names:
|
||||
|
||||
@@ -9,18 +9,18 @@ Background
|
||||
|
||||
When it comes to running your own server, managing dependencies is perhaps the most difficult part. The term "dependency hell" emerged from this sentiment. Even the best developers have lost significant amounts of time trying to find, correct, or clarify documentation for dependencies or dependency configuration. Individuals who manage their own servers have specific technical skills and are willing to devote the time and effort necessary to maintain them. Companies have entire departments dedicated to this task.
|
||||
|
||||
Some other personal server products aimed at non-technical individuals tackle this problem by simply hard coding dependencies. Since embassyOS is a platform for running all open-source, self-hosted software, it is not possible to hard code every possible service, service dependency, and service dependency configuration forever. Instead, Start9 built a new, unprecedented operating system that touts a generalized, intuitive approach to dependency management and service configuration. embassyOS enables users to easily and selectively install, uninstall, and update any service they want without getting stuck in dependency hell.
|
||||
Some other personal server products aimed at non-technical individuals tackle this problem by simply hard coding dependencies. Since StartOS is a platform for running all open-source, self-hosted software, it is not possible to hard code every possible service, service dependency, and service dependency configuration forever. Instead, Start9 built a new, unprecedented operating system that touts a generalized, intuitive approach to dependency management and service configuration. StartOS enables users to easily and selectively install, uninstall, and update any service they want without getting stuck in dependency hell.
|
||||
|
||||
This may sound cool or neat, but it is more than that: *it's novel*. This has never been done before.
|
||||
|
||||
The key to making the system work is a new, domain-specific-language (DSL) and set of standards that are used by developers to define the rules and requirements of their services. Run in the context of embassyOS, these rules and requirements appear as simple UI elements, such as inputs, toggles, and drop downs, and they are enforced by validations and clear user instructions. Using this system, what previously required serious time and expertise, can now be done by anyone in a matter of seconds.
|
||||
The key to making the system work is a new, domain-specific-language (DSL) and set of standards that are used by developers to define the rules and requirements of their services. Run in the context of StartOS, these rules and requirements appear as simple UI elements, such as inputs, toggles, and drop downs, and they are enforced by validations and clear user instructions. Using this system, what previously required serious time and expertise, can now be done by anyone in a matter of seconds.
|
||||
|
||||
This DSL is utilized in the :ref:`config rules <config_rules>` and :ref:`dependencies <service-dependencies>` key in the service manifest.
|
||||
|
||||
Context
|
||||
-------
|
||||
|
||||
Many services depend on other libraries and services on embassyOS (such as Bitcoin), sometimes even a particular version of those services. These need to be specified by the developers so that embassyOS can handle installing these dependencies under the hood.
|
||||
Many services depend on other libraries and services on StartOS (such as Bitcoin), sometimes even a particular version of those services. These need to be specified by the developers so that StartOS can handle installing these dependencies under the hood.
|
||||
|
||||
Requirement
|
||||
-----------
|
||||
@@ -38,7 +38,7 @@ Only the type of requirement must be defined. Requirement types include:
|
||||
Advanced Configuration
|
||||
----------------------
|
||||
|
||||
If a dependency requires a more advanced configuration, rule checks and auto configurations can be implemented. These functions utilize a preloaded Docker image within embassyOS entitled _compat_. This system utility provides the mechanisms for checking dependency configuration compatibility by providing a file with the defined rules as input.
|
||||
If a dependency requires a more advanced configuration, rule checks and auto configurations can be implemented. These functions utilize a preloaded Docker image within StartOS entitled _compat_. This system utility provides the mechanisms for checking dependency configuration compatibility by providing a file with the defined rules as input.
|
||||
|
||||
In this case, each dependency contains a set of rules that need to be fulfilled as true if the dependency is to be properly installed. The "config rules" here are for auto-configuring dependencies - the action defined by the rule will be executed if the service is auto configured with defaults during initial setup. This simplifies and streamlines the user experience. The interface should provide suggestions for the behavior if the denoted rule cannot be met with previous configurations.
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Each service boils down to a Docker image. We're not going to dive into Docker s
|
||||
|
||||
The image is immutable, meaning that when the service is updated, the image is replaced with a completely new image containing the updated features.
|
||||
|
||||
When installed, the service image is mounted to the embassyOS image. This path is defined in the :ref:`manifest <service_manifest>` configuration file:
|
||||
When installed, the service image is mounted to the StartOS image. This path is defined in the :ref:`manifest <service_manifest>` configuration file:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
@@ -43,12 +43,12 @@ When installed, the service image is mounted to the embassyOS image. This path i
|
||||
io-format: yaml
|
||||
...
|
||||
|
||||
In embassyOS, the mount specified in the Manifest gets bound to ``/embassy-data/package-data/volumes/main/<service-id>``.
|
||||
In StartOS, the mount specified in the Manifest gets bound to ``/embassy-data/package-data/volumes/main/<service-id>``.
|
||||
|
||||
Volumes
|
||||
-------
|
||||
|
||||
Volumes are the mechanism for persisting data generated by and used by Docker containers. In embassyOS, services can declare as one or many volumes in the Manifest:
|
||||
Volumes are the mechanism for persisting data generated by and used by Docker containers. In StartOS, services can declare as one or many volumes in the Manifest:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
|
||||
@@ -6,25 +6,25 @@ Instructions
|
||||
|
||||
Within each wrapper repository, a file should exist that includes instructions for a service. This file should include any pertinent documentation, instructions, external integrations, or other details about the service that users or developers might find relevant.
|
||||
|
||||
This markdown formatted file will be rendered in the "Instructions" section within the service page on embassyOS:
|
||||
This markdown formatted file will be rendered in the "Instructions" section within the service page on StartOS:
|
||||
|
||||
.. figure:: /_static/images/services/service-instruct.png
|
||||
:width: 80%
|
||||
:alt: Embassy Pages Instructions
|
||||
:alt: Start9 Pages Instructions
|
||||
|
||||
Below is the markdown file for Embassy Pages' instructions, as shown above:
|
||||
Below is the markdown file for Start9 Pages' instructions, as shown above:
|
||||
|
||||
.. code-block::
|
||||
|
||||
# Embassy Pages
|
||||
# Start9 Pages
|
||||
|
||||
## About
|
||||
|
||||
Embassy Pages is a simple web server that uses directories inside File Browser to serve Tor websites. Your website could be a blog, a resume, a portfolio, a business landing page, a product brochure, or just a set of static folders and/or files that you want to share with the world.
|
||||
Start9 Pages is a simple web server that uses directories inside File Browser to serve Tor websites. Your website could be a blog, a resume, a portfolio, a business landing page, a product brochure, or just a set of static folders and/or files that you want to share with the world.
|
||||
|
||||
When you first install Embassy Pages, there will be a default Homepage hosted at the root, <tor-address>.onion. You can change the behavior of this page, and you can also create Subdomain websites. For example, one site could be hello.<tor-address>.onion and another could be goodbye.<tor-address>.onion. What is served from the Homepage and each Subdomain is totally up to you.
|
||||
When you first install Start9 Pages, there will be a default Homepage hosted at the root, <tor-address>.onion. You can change the behavior of this page, and you can also create Subdomain websites. For example, one site could be hello.<tor-address>.onion and another could be goodbye.<tor-address>.onion. What is served from the Homepage and each Subdomain is totally up to you.
|
||||
|
||||
Self-hosting Tor websites using Embassy Pages is easy, permissionless, and censorship-resistant; there are no trusted third parties involved.
|
||||
Self-hosting Tor websites using Start9 Pages is easy, permissionless, and censorship-resistant; there are no trusted third parties involved.
|
||||
Anyone can do it. No one can stop it.
|
||||
|
||||
## Instructions
|
||||
@@ -37,18 +37,18 @@ Below is the markdown file for Embassy Pages' instructions, as shown above:
|
||||
|
||||
2. Inside `Config`, you can create one or more Subdomains, giving each a unique name.
|
||||
|
||||
3. To serve a personal website, simply upload the website directory to File Browser. Then, inside the settings for a particular page (either your Homepage or a Subdomain), enter the path to that directory. For example, a path of websites/blog would tell Embassy Pages that it can find the blog website inside the websites directory in File Browser.
|
||||
3. To serve a personal website, simply upload the website directory to File Browser. Then, inside the settings for a particular page (either your Homepage or a Subdomain), enter the path to that directory. For example, a path of websites/blog would tell Start9 Pages that it can find the blog website inside the websites directory in File Browser.
|
||||
|
||||
4. A list of all your Subdomains can be found inside the Properties section of your Embassy Pages service.
|
||||
4. A list of all your Subdomains can be found inside the Properties section of your Start9 Pages service.
|
||||
|
||||
## Restore from Backup
|
||||
|
||||
1. In `Config`, select "Restore from Backup".
|
||||
2. After the restoration completes, navigate to the Marketplace.
|
||||
3. Downgrade Embassy Pages.
|
||||
4. Upgrade Embassy Pages to the latest version.
|
||||
5. Start Embassy Pages.
|
||||
6. Embassy Pages is now successfully restored!
|
||||
3. Downgrade Start9 Pages.
|
||||
4. Upgrade Start9 Pages to the latest version.
|
||||
5. Start Start9 Pages.
|
||||
6. Start9 Pages is now successfully restored!
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
@@ -30,7 +30,7 @@ Terms:
|
||||
|
||||
**Procedure**: A procedure is run during times that we would like to do an operation. An operation would include actions such as getting or setting a service's configuration file.
|
||||
|
||||
**Effects**: A TypeScript object that is used to interact with embassyOS. See the `full definition here <https://deno.land/x/embassyd_sdk/types.ts>`__.
|
||||
**Effects**: A TypeScript object that is used to interact with StartOS. See the `full definition here <https://deno.land/x/embassyd_sdk/types.ts>`__.
|
||||
|
||||
This new process enabled faster service configuration operations. Previously, Docker was used to preform these actions; however, Docker containers took a long time to spin up.
|
||||
|
||||
@@ -73,7 +73,7 @@ How to Setup
|
||||
set:
|
||||
type: script
|
||||
|
||||
4. Fill in the todos in the above template to match the expected Effect parameter defined by the `exported type <https://deno.land/x/embassyd_sdk@v0.3.3.0.5/types.ts#L32>`_. This type describes how to call functions that interact with embassyOS.
|
||||
4. Fill in the todos in the above template to match the expected Effect parameter defined by the `exported type <https://deno.land/x/embassyd_sdk@v0.3.3.0.5/types.ts#L32>`_. This type describes how to call functions that interact with StartOS.
|
||||
5. In the build process for packaging the final s9pk, include the following step. **The location of the js is important, and can't be changed**. It must exist at `scripts/embassy.js` in the root of the project's wrapper repository.
|
||||
|
||||
.. code:: bash
|
||||
|
||||
@@ -17,9 +17,9 @@ This file describes the service and it's requirements. It is used to:
|
||||
|
||||
Each time a service is updated, the Manifest should be updated to include the new version, release notes, and any pertinent updates to the install, uninstall, or restoration flows. All this information is displayed in the marketplace listing, and the optionally denoted alerts will be displayed when appropriate to provide the user with more information.
|
||||
|
||||
There is nothing you need to do as a developer to set up Tor for running a service. This is *completely* handled by embassyOS - a Tor address will be automatically generated when the service is installed. Just define an interface with a tor config in the Manifest file. You do, however, need to ensure the service is in fact capable of running over Tor.
|
||||
There is nothing you need to do as a developer to set up Tor for running a service. This is *completely* handled by StartOS - a Tor address will be automatically generated when the service is installed. Just define an interface with a tor config in the Manifest file. You do, however, need to ensure the service is in fact capable of running over Tor.
|
||||
|
||||
The Manifest is also responsible for outlining service :ref:`dependencies <dependencies-spec>`. By defining rules using the :ref:`embassyOS DSL specification <config_rules>`, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. embassyOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest!
|
||||
The Manifest is also responsible for outlining service :ref:`dependencies <dependencies-spec>`. By defining rules using the :ref:`StartOS DSL specification <config_rules>`, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. StartOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest!
|
||||
|
||||
Formatting
|
||||
----------
|
||||
@@ -38,7 +38,7 @@ Below are the types and sub-type definitions, with necessary elaborations. Any i
|
||||
id: String
|
||||
# A human readable service title
|
||||
title: String
|
||||
# Service version - accepts up to four digits, where the last confirms to revisions necessary for embassyOS - see documentation: https://github.com/Start9Labs/emver-rs. This value will change with each release of the service.
|
||||
# Service version - accepts up to four digits, where the last confirms to revisions necessary for StartOS - see documentation: https://github.com/Start9Labs/emver-rs. This value will change with each release of the service.
|
||||
version: Number
|
||||
# Release notes for the update - can be a string, paragraph or URL
|
||||
release-notes: String
|
||||
@@ -54,9 +54,9 @@ Below are the types and sub-type definitions, with necessary elaborations. Any i
|
||||
marketing-site: String
|
||||
# The series of commands to build the project into an s9pk for arm64/v8. In this case we are using a Makefile with the simple build command "make".
|
||||
build: List<String>
|
||||
# Minimum required version of embassyOS
|
||||
# Minimum required version of StartOS
|
||||
min-os-version: Number
|
||||
# Human readable descriptors for the service. These are used throughout the embassyOS user interface, primarily in the marketplace.
|
||||
# Human readable descriptors for the service. These are used throughout the StartOS user interface, primarily in the marketplace.
|
||||
description:
|
||||
# This is the first description visible to the user in the marketplace.
|
||||
short: String
|
||||
@@ -180,13 +180,13 @@ Below are the types and sub-type definitions, with necessary elaborations. Any i
|
||||
ui: Boolean
|
||||
# Denotes the protocol specifications used by this interface
|
||||
protocols: List<String>
|
||||
# Alerts: omitting these will result in using the default alerts in embassyOS, except for start, which has no default.
|
||||
# Alerts: omitting these will result in using the default alerts in StartOS, except for start, which has no default.
|
||||
alerts:
|
||||
install-alert: String
|
||||
uninstall-alert: String
|
||||
restore-alert: String
|
||||
start-alert: String
|
||||
# Specifies how backups should be run for this service. The default embassyOS provided option is to use the duplicity backup library on a system image (compat)
|
||||
# Specifies how backups should be run for this service. The default StartOS provided option is to use the duplicity backup library on a system image (compat)
|
||||
backup:
|
||||
create:
|
||||
type: String
|
||||
@@ -293,7 +293,7 @@ Examples
|
||||
|
||||
- `Hello World <https://github.com/Start9Labs/hello-world-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Filebrowser <https://github.com/Start9Labs/filebrowser-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Embassy-pages <https://github.com/Start9Labs/embassy-pages-wrapper/blob/master/manifest.toml>`__
|
||||
- `Photoview <https://github.com/Start9Labs/embassyOS-photoview-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Start9-pages <https://github.com/Start9Labs/start9-pages-wrapper/blob/master/manifest.toml>`__
|
||||
- `Photoview <https://github.com/Start9Labs/photoview-wrapper/blob/master/manifest.yaml>`__
|
||||
- `BTCPay Server <https://github.com/Start9Labs/btcpayserver-wrapper/blob/master/manifest.yaml>`__
|
||||
- `Synapse <https://github.com/Start9Labs/synapse-wrapper/blob/master/manifest.yaml>`__
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Package Bundle
|
||||
==============
|
||||
|
||||
All assets get bundled into a custom filetype with an extension of ``.s9pk``, short for Start9 Package. This is the file that will be downloaded from a marketplace. When the user clicks a service's "Install" button, embassyOS unpacks and installs the service.
|
||||
All assets get bundled into a custom filetype with an extension of ``.s9pk``, short for Start9 Package. This is the file that will be downloaded from a marketplace. When the user clicks a service's "Install" button, StartOS unpacks and installs the service.
|
||||
|
||||
The minimum necessary files for this bundle are:
|
||||
|
||||
|
||||
@@ -9,9 +9,9 @@ Each service is bound with a wrapper repository, which contains everything you n
|
||||
The purpose of this repo is:
|
||||
|
||||
- To define the necessary Manifest and configuration options (ie. config spec and rules)
|
||||
- To build the project into the ``.s9pk`` format digestible to embassyOS
|
||||
- To build the project into the ``.s9pk`` format digestible to StartOS
|
||||
- Link to the source project as a git submodule
|
||||
- Define the Dockerfile for running the project on embassyOS
|
||||
- Define the Dockerfile for running the project on StartOS
|
||||
- Provide documentation for the project, especially user runbook instructions
|
||||
|
||||
File Structure
|
||||
|
||||
@@ -8,7 +8,7 @@ DIY Guidelines (Raspberry Pi)
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Start9 is committed to ensuring that sovereign computing is accessible. It will always be possible to build your own Start9 server similar to the ones we sell. This guide is to build a device exactly like Start9's Server One, available for purchase on the `Start9 Store <https://store.start9.com/products/server-one>`_.
|
||||
Start9 is committed to ensuring that StartOS is accessible. It will always be possible to build your own Start9 server similar to the ones we sell. Below you will find the requirements to build a Server Lite, based on the Raspberry Pi.
|
||||
|
||||
For more guidance or to share your experience with others, please `head to our community forum <https://community.start9.com/>`_. Want to support sovereign computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
|
||||
@@ -18,8 +18,17 @@ Hardware Requirements
|
||||
|
||||
- Power Supply (20w - 5v/4a recommended)
|
||||
|
||||
- SD Card (128GB or 256GB recommended)
|
||||
- SD Card (64GB minimum, 128GB or 256GB recommended - "High Endurance" highly recommended)
|
||||
|
||||
.. warning:: It is possible, but no longer recommended, to flash the OS to a small SD card and attach an external SSD. If you insist on doing this, you **MUST** provide adequeate power via a USB hub or, preferably, a powered expansion board, such as those sold by Geekworm. See the `Community Hub <https://community.start9.com/c/hacking/>`_ for more info.
|
||||
|
||||
Flash and Install StartOS
|
||||
-------------------------
|
||||
After building your hardware build, you will need a copy of StartOS. Head over to our :ref:`Flashing (Raspberry Pi) Guide <flashing-pi>` to complete your build.
|
||||
.. topic-box::
|
||||
:title: Flashing (Raspberry Pi)
|
||||
:link: /user-manual/flashing/flashing-pi/
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash StartOS for use on a Raspberry Pi
|
||||
|
||||
@@ -8,7 +8,7 @@ DIY Guidelines (x86_64)
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Start9 is committed to ensuring that sovereign computing is accessible. This guide is to install StartOS on **most** x86_64 platforms (your mileage will vary). The x86_64-based Server One and Server Pure are available for purchase on the `Start9 Store <https://store.start9.com/products>`_.
|
||||
Start9 is committed to ensuring that StartOS is accessible. This guide is to install StartOS on **most** x86_64 platforms (your mileage will vary). The x86_64-based Server One and Server Pure are available for purchase on the `Start9 Store <https://store.start9.com/products>`_.
|
||||
|
||||
For more guidance or to share your experience with others, please `head to our community forum <https://community.start9.com/>`_. Want to support sovereign computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
|
||||
@@ -39,4 +39,11 @@ If you intend to run Bitcoin or store any meaningful amount of data, you will ne
|
||||
|
||||
Flash and Install StartOS
|
||||
-------------------------
|
||||
After building your hardware, you will need a copy of StartOS. Head over to our :ref:`Flashing (x86_64) Guide <flashing-x86>` to complete your Start9 server build.
|
||||
.. topic-box::
|
||||
:title: Flashing (x86_64)
|
||||
:link: /user-manual/flashing/flashing-x86/
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash StartOS for use on an x86_64 machine
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
===
|
||||
DIY
|
||||
===
|
||||
Here you will find guidelines for building your own Start9 server! Currently, StartOS is known to work well on the Raspberry Pi and on **most** x86_64 platforms (desktops, laptops, mini PCs, servers, and virtual machines). ARM builds are also available, but are relativey untested.
|
||||
Here you will find guidelines for building your own Start9 server! Currently, StartOS is known to work well on the Raspberry Pi and on **most** x86_64 platforms (desktops, laptops, mini PCs, servers, and virtual machines). ARM builds are also available, but are relatively untested.
|
||||
|
||||
Motivation
|
||||
----------
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
.. hero-box::
|
||||
:title: Welcome
|
||||
|
||||
Here you will find information on embassyOS, including DIY guides, user manuals, and developer docs. Welcome to the era of sovereign computing. Anyone can do it. No one can stop it.
|
||||
Here you will find information on StartOS, including DIY guides, user manuals, and developer docs. Welcome to the era of sovereign computing. Anyone can do it. No one can stop it.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Get started with your Embassy
|
||||
Get started with your Start9 server
|
||||
|
||||
.. topic-box::
|
||||
:title: Support
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -8,42 +8,42 @@ Common Issues
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Sometimes things don't go as planned. Check here for solutions to common problems with your Embassy.
|
||||
Sometimes things don't go as planned. Check here for solutions to common problems with StartOS.
|
||||
|
||||
Embassy will not boot
|
||||
StartOS will not boot
|
||||
---------------------
|
||||
|
||||
If the device will not power on at all (no lights whatsoever), then the only issues could be that the Pi is not getting the power it needs, or it is completely dead (extremely rare). If you sourced your own parts, please ensure that the power supply meets the minimum required specifications in the :ref:`DIY Guide<diy>`. If you received your device from us and it will not power up at all, please :ref:`Contact us<contact>` for assistance.
|
||||
|
||||
Embassy boots into "Diagnostic Mode"
|
||||
StartOS boots into "Diagnostic Mode"
|
||||
------------------------------------
|
||||
|
||||
Diagnostic Mode is a new UI that will launch in the event that no drive, or an incorrect drive (such as one from another Embassy) has been plugged into Embassy. Simply plug your external drive in and reboot (power off and on again).
|
||||
Diagnostic Mode is a new UI that will launch in the event that no drive, or an incorrect drive (such as one from another StartOS server) has been plugged into your server. Simply plug your external drive in and reboot (power off and on again).
|
||||
|
||||
.. _setup-troubleshoot:
|
||||
|
||||
During initial setup, I am unable to connect to "embassy.local".
|
||||
During initial setup, I am unable to connect to "start.local".
|
||||
----------------------------------------------------------------
|
||||
|
||||
* Confirm that your Embassy is plugged into both power and Ethernet.
|
||||
* Confirm that the server is plugged into both power and Ethernet.
|
||||
|
||||
* Confirm the Embassy emitted two :ref:`sounds<sounds>` when powering on: a bep and a chime.
|
||||
* Confirm the the server emitted two :ref:`sounds<sounds>` when powering on: a bep and a chime.
|
||||
|
||||
* Confirm your phone is **not** connected to a “Guest” network
|
||||
|
||||
* Confirm your phone is **not** using a VPN.
|
||||
|
||||
If you still cannot connect, try logging into your router (the directions for which can be found with a simple web search for your router model and 'how to log in'). Once you are in your router, find the device labeled 'Embassy,' and visit it's associated IP address, which will look something like: ``192.168.1.9``
|
||||
If you still cannot connect, try logging into your router (the directions for which can be found with a simple web search for your router model and 'how to log in'). Once you are in your router, find the device labeled ``start``, and visit it's associated IP address, which will look something like: ``192.168.1.9``
|
||||
|
||||
I am unable to reach Embassy via it's embassy-xxxxxxxx.local (LAN) address
|
||||
I am unable to reach my server via its *<custom-address>.local* (LAN) address
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
Make sure you have successfully followed the :ref:`LAN Setup<connecting-lan>` instructions for your device. If you are using Windows, your problem is almost certainly with Bonjour - follow the directions to reinstall, even if you have already done so. If you still cannot connect, try all the solutions listed under :ref:`initial setup <setup-troubleshoot>`.
|
||||
|
||||
I am unable to reach Embassy via it's xxxxxxxxxxxxxxxxxx.onion (Tor) address
|
||||
I am unable to reach my server via its xxxxxxxxxxxxxxxxxx.onion (Tor) address
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
#. **Test** - Try connecting to your Embassy using the preferred :ref:`Tor Browser <tor-browser>`.
|
||||
#. **Test** - Try connecting to your server using the preferred :ref:`Tor Browser <tor-browser>`.
|
||||
|
||||
#. **If Tor Browser works** - It means the issue is either with the Tor daemon on your device or with the browser settings.
|
||||
|
||||
@@ -51,19 +51,19 @@ I am unable to reach Embassy via it's xxxxxxxxxxxxxxxxxx.onion (Tor) address
|
||||
#. If you are not yet running a Tor daemon on your device, follow :ref:`these instructions <tor-os>`. If you are already running a Tor daemon, restart it, or in the case of Android, restart your phone.
|
||||
#. If you are using Firefox, ensure it has been :ref:`properly configured <tor-firefox>` to work with .onion URLs.
|
||||
|
||||
#. **If Tor Browser does not work** - It means there is an issue with your Embassy or with the Tor network.
|
||||
#. **If Tor Browser does not work** - It means there is an issue with your server or with the Tor network.
|
||||
|
||||
#. **Test** - Try visiting your Embassy over :ref:`LAN<connecting-lan>` from a non-Tor browser such as Firefox, Chrome, or Safari.
|
||||
#. **Test** - Try visiting your server over :ref:`LAN<connecting-lan>` from a non-Tor browser such as Firefox, Chrome, or Safari.
|
||||
|
||||
#. **If LAN works** - it means the issue is an issue your Embassy's Tor connection.
|
||||
#. **If LAN works** - it means the issue is an issue your server's Tor connection.
|
||||
|
||||
#. **Solutions**
|
||||
#. Check if there are any ongoing network-wide service issues with Tor at `the Tor Project status page <https://status.torproject.org/issues/>`_
|
||||
#. Wait an hour or so to allow Tor on your Embassy to fix itself.
|
||||
#. Restart your Embassy through the UI (Embassy -> Restart).
|
||||
#. **If LAN does not work** - It means your Embassy is experiencing general networking issues.
|
||||
#. Wait an hour or so to allow Tor on your server to fix itself.
|
||||
#. Restart your server through the UI (System -> Restart).
|
||||
#. **If LAN does not work** - It means your server is experiencing general networking issues.
|
||||
|
||||
#. **Solutions** - Power cycle your Embassy by unplugging it and plugging it back in, then wait a few minutes before trying to connect again.
|
||||
#. **Solutions** - Power cycle your server by unplugging it and plugging it back in, then wait a few minutes before trying to connect again.
|
||||
|
||||
I'm having an issue with a particular Service
|
||||
---------------------------------------------
|
||||
|
||||
@@ -21,9 +21,9 @@ Community Channels
|
||||
|
||||
* `Matrix <https://matrix.to/#/#community:matrix.start9labs.com>`_ - Community channel that will gradually replace Telegram (now bridged to Telegram for convenience).
|
||||
|
||||
* `Matrix Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ - Primary channel for collaboration on embassyOS development and service packaging.
|
||||
* `Matrix Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ - Primary channel for collaboration on StartOS development and service packaging.
|
||||
|
||||
* `Matrix Tor (Tor required) <https://matrix.to/#/!iRwnQntcjpWfLxdgav:matrix.privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion?via=matrix.start9labs.com&via=matrix.privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion&via=oayal5vhil3zhj7ylixvpi4nr2xvhypdnenji4sx5q4kvaotevjvsxad.onion>`_ - Tor-only community channel for Embassy users
|
||||
* `Matrix Tor (Tor required) <https://matrix.to/#/!iRwnQntcjpWfLxdgav:matrix.privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion?via=matrix.start9labs.com&via=matrix.privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion&via=oayal5vhil3zhj7ylixvpi4nr2xvhypdnenji4sx5q4kvaotevjvsxad.onion>`_ - Tor-only community channel for StartOS users
|
||||
|
||||
Social Media
|
||||
------------
|
||||
@@ -33,3 +33,9 @@ Social Media
|
||||
* `Twitter <https://twitter.com/start9labs>`_
|
||||
|
||||
* `GitHub <https://github.com/start9labs>`_
|
||||
|
||||
Email
|
||||
-----
|
||||
* security@start9.com - for reporting sensitive information or security concerns.
|
||||
|
||||
* affiliate@start9.com - for those interested in becoming a Start9 affiliate.
|
||||
|
||||
@@ -11,8 +11,8 @@ External Support
|
||||
If you ever need direct support from the developers or community of a particular service or integration, you can find it here.
|
||||
|
||||
|
||||
Embassy Services
|
||||
----------------
|
||||
Start9 Sponsored Services
|
||||
-------------------------
|
||||
|
||||
Bitcoin Core
|
||||
============
|
||||
|
||||
@@ -10,40 +10,36 @@ Basic Use FAQ
|
||||
|
||||
Is it easy to use?
|
||||
------------------
|
||||
Yes! The Embassy is designed to be plugged into power and internet, and after a short setup, is immediately ready to use. Getting Services is as easy as getting apps for a smartphone.
|
||||
Yes! A Start9 server is designed to be plugged into power and internet, and after a short setup, is immediately ready to use. Getting Services is as easy as getting apps for a smartphone.
|
||||
As with anything new, you should expect to spend a little time learning the functions and features, and keep in mind that some Services may be more complex to understand and use than others.
|
||||
|
||||
So I can run my own cloud?
|
||||
--------------------------
|
||||
Yes! No special skills or knowledge are required to host all your own services and replace those previously thought "necessary" for modern digital life.
|
||||
|
||||
Can I run multiple Embassies?
|
||||
-----------------------------
|
||||
Can I run multiple Start9 servers?
|
||||
----------------------------------
|
||||
Yes, but there is currently no way to synchronize or federate them. We are working on ways to make this possible in the future.
|
||||
|
||||
Can I still use my VPN?
|
||||
-----------------------
|
||||
The short answer is yes, but they can cause some conflicts when accessing your Embassy. If you need to troubleshoot, turning off your VPN is a good place to start. The following VPNs are known to not interfere with the proper settings:
|
||||
The short answer is yes, but they can cause some conflicts when accessing your server. If you need to troubleshoot, turning off your VPN is a good place to start. The following VPNs are known to not interfere with the proper settings:
|
||||
|
||||
- Mullvad - Go to "Settings -> VPN Settings -> Local Network Sharing" - enable this option to be able to access your Embassy's ``.local`` addresses.
|
||||
- ProtonVPN - Go to "Preferences -> Connection -> Allow LAN Connections" - enable this option to be able to access your Embassy's ``.local`` addresses.
|
||||
- IVPN - Go to "Settings -> IVPN Firewall -> LAN settings -> Allow LAN traffic when IVPN firewall is enabled" - enable this option to be able to access your Embassy's ``.local`` addresses.
|
||||
- Mullvad - Go to "Settings -> VPN Settings -> Local Network Sharing" - enable this option to be able to access your server's ``.local`` addresses.
|
||||
- ProtonVPN - Go to "Preferences -> Connection -> Allow LAN Connections" - enable this option to be able to access your server's ``.local`` addresses.
|
||||
- IVPN - Go to "Settings -> IVPN Firewall -> LAN settings -> Allow LAN traffic when IVPN firewall is enabled" - enable this option to be able to access your server's ``.local`` addresses.
|
||||
|
||||
What if I forget my Embassy password?
|
||||
What if I forget my StartOS password?
|
||||
-------------------------------------
|
||||
Please follow the :ref:`password reset guide<reset-password>`.
|
||||
|
||||
My Embassy is set up, now what?
|
||||
-------------------------------
|
||||
Check out the :ref:`Dashboard Overview<dashboard-overview>` for some details on your Embassy. You can now access your Embassy and find the Services you want from the "Marketplace" tab, then clicking "Install." The Service will let you know if you need any "dependencies," or pre-requisite Services, first. After you have a Service installed, don't forget to "Start" the service.
|
||||
|
||||
Can I move my Embassy to another location? What happens when I do this?
|
||||
Can I move my server to another location? What happens when I do this?
|
||||
------------------------------------------------------------------------
|
||||
Yes, you can move the Embassy to another network. Your service tor addresses will remain the same. Remember that you can only access via LAN if you are accessing with a device on the same network as your Embassy.
|
||||
Yes, you can move your server to another network. Your service tor addresses will remain the same. Remember that you can only access via LAN if you are accessing with a device on the same network as your server.
|
||||
|
||||
What's the advantage of using the .local address over the .onion address?
|
||||
-------------------------------------------------------------------------
|
||||
If you are in your home/office network with an Embassy, it is both faster and more private since the connection never leaves your household/office. The downside is that it won't work if you're on the go.
|
||||
If you are in your home/office network with your server, it is both faster and more private since the connection never leaves your household/office. The downside is that it won't work if you're on the go.
|
||||
|
||||
Can I use the .local addresses over the Tor Browser?
|
||||
----------------------------------------------------
|
||||
@@ -53,9 +49,9 @@ Can I use .local addresses on Android?
|
||||
--------------------------------------
|
||||
This will depend on your Android device. This support was added in Android 12. For custom ROMs, such as Calyx and Graphene, version 13 is required.
|
||||
|
||||
Can I have multiple users on my Embassy?
|
||||
Can I have multiple users on StartOS?
|
||||
----------------------------------------
|
||||
Currently, the Embassy itself is designed for a single user. There is no way to grant others access to your Embassy without sharing your personal, master password, which is not recommended. There are certain services, however, such as Bitwarden, File Browser, and Mastodon, that do support multiple users (aka multi-tenancy, aka the Uncle Jim model) where people who trust you (and vice versa) can create their own, personal accounts for these services on your Embassy. Just remind them that they are trusting you with their data, and that it might be preferable for them to take the final leap of self-sovereignty and get an Embassy of their own.
|
||||
Currently, StartOS itself is designed for a single user. There is no way to grant others access to your server without sharing your personal, master password, which is not recommended. There are certain services, however, such as Bitwarden, File Browser, and Mastodon, that do support multiple users (aka multi-tenancy, aka the Uncle Jim model) where people who trust you (and vice versa) can create their own, personal accounts for these services. Just remind them that they are trusting you with their data, and that it might be preferable for them to take the final leap of self-sovereignty and get a server of their own.
|
||||
|
||||
Multi-tenancy is a desired future OS feature. Stay tuned.
|
||||
|
||||
@@ -65,7 +61,7 @@ Unfortunately, Orbot can be finicky. The best solution to connection issues is
|
||||
|
||||
If I uninstall a service, then re-install it, does any data remain?
|
||||
-------------------------------------------------------------------
|
||||
No. When uninstalling a service, you completely destroy everything associated with it. This is because each service runs in it's own 'container', which includes all the required software and operating system environment that it needs to function. When uninstalling, this container is wiped from your Embassy's system, and with it, any associated service data that you have not backed up.
|
||||
No. When uninstalling a service, you completely destroy everything associated with it. This is because each service runs in it's own 'container', which includes all the required software and operating system environment that it needs to function. When uninstalling, this container is wiped from StartOS, and with it, any associated service data that you have not backed up.
|
||||
|
||||
This can be useful, as you may want to wipe a service and start anew. For example, you might want to receive a fresh Tor .onion address, or to spin up a new Lightning node. However, if you do this, YOU MUST BE 100% CERTAIN THAT YOU ARE PREPARED TO LOSE ALL DATA for this service. Also, keep in mind that other services may depend on the service you are uninstalling.
|
||||
|
||||
@@ -73,24 +69,24 @@ Do I need to delete existing backups before doing a new backup? Or does a new ba
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
No, you don't need to delete the old backups. The technology we use updates the existing backup. This is known as a "diff-based" model, where the "difference" in backups is what is recorded.
|
||||
|
||||
Can I clone my Embassy SSD for backup purposes?
|
||||
Can I clone my SSD for backup purposes?
|
||||
-----------------------------------------------
|
||||
.. warning:: **DO NOT do this if you are running LND or CLN**. If you clone the SSD, then go back to running LND or CLN, and you *ever* try to restore the SSD, there is a good chance you will lose *all your channel funds*. Also, if you try to use the SSD for a 2nd Embassy, that will also result in loss of funds. This has nothing to do with Start9 or the Embassy; it is inherent to the architecture of Lightning.
|
||||
.. warning:: **DO NOT do this if you are running LND or CLN**. If you clone the SSD, then go back to running LND or CLN, and you *ever* try to restore the SSD, there is a good chance you will lose *all your channel funds*. Also, if you try to use the SSD for a 2nd server, that will also result in loss of funds. This has nothing to do with Start9 or StartOS; it is inherent to the architecture of Lightning.
|
||||
|
||||
It is neither necessary, nor recommended to do this. The backup solution available in embassyOS (v0.3.0+) allows all data to be written to another drive remotely, and this can mean another SSD, attached to a computer on your network. You may also do a backup to a local drive if it has external power. Please follow the directions in the backup UI for more details.
|
||||
It is neither necessary, nor recommended to do this. The backup solution available in StartOS (v0.3.0+) allows all data to be written to another drive remotely, and this can mean another SSD, attached to a computer on your network. You may also do a backup to a local drive if it has external power. Please follow the directions in the backup UI for more details.
|
||||
|
||||
Why would I even buy this when I can just build it for free?
|
||||
------------------------------------------------------------
|
||||
(1) You will get white glove support in your preferred format, from email to text chat to screen sharing conference calls.
|
||||
|
||||
(2) Supporting the project. Buying an Embassy from Start9 is your way of supporting the development of the project. And it's not just out of gratitude, but rather, a recognition that if the project isn't funded, the cool software stops coming.
|
||||
(2) Supporting the project. Buying a server from Start9 is your way of supporting the development of the project. And it's not just out of gratitude, but rather, a recognition that if the project isn't funded, the cool software stops coming.
|
||||
|
||||
(3) Convenience. This is the big one. It's true, some people will choose to use the software without buying an Embassy, but most will not. Very few people on Earth are comfortable using the command line, compiling code, and configuring an OS. Furthermore, hardware is necessary. Sure, some people already have a Raspberry Pi, and others may try to re-purpose an old laptop, but many people would be choosing between buying the Embassy hardware components themselves and assembling vs buying pre-assembled at a reasonable markup.
|
||||
(3) Convenience. This is the big one. It's true, some people will choose to use the software without buying a server, but most will not. Very few people on Earth are comfortable using the command line, compiling code, and configuring an OS. Furthermore, hardware is necessary. Sure, some people already have a Raspberry Pi, and others may try to re-purpose an old laptop, but many people would be choosing between buying the hardware components themselves and assembling vs buying pre-assembled at a reasonable markup.
|
||||
|
||||
Bottom line...We are charging a very marginal rate for something incredibly powerful, and we think the convenience of a plug-and-play device, free service marketplace, and free white glove support is where the money is. Anyone could build their own couches too, but here is a reason furniture stores exist. How much is your time worth?
|
||||
|
||||
The fastest way to get support is via our :ref:`Community channels<contact>`. Please do not hesitate to reach out!
|
||||
|
||||
I bought an Embassy before Q3 2022 and it came with a 'product key,' what is that?
|
||||
----------------------------------------------------------------------------------
|
||||
I bought a server from Start9 before Q3 2022 and it came with a 'product key,' what is that?
|
||||
--------------------------------------------------------------------------------------------
|
||||
This will entitle you to white glove support as well as future benefits yet to be announced. Newer products ship with a similar (anonymous) key for these purposes.
|
||||
|
||||
@@ -10,7 +10,7 @@ Bitcoin FAQ
|
||||
|
||||
Why does the Bitcoin service take so long to be ready?
|
||||
------------------------------------------------------
|
||||
On first install, the Bitcoin service must verify the entire history of transactions in order to verify transactions going forward. This can take up to a week depending on your internet connection. On a fast connection, you can expect 3-4 days. You can continue to use your Embassy normally in the meantime.
|
||||
On first install, the Bitcoin service must verify the entire history of transactions in order to verify transactions going forward. This can take up to a week depending on your internet connection. On a fast connection, you can expect 3-4 days. You can continue to use your server normally in the meantime.
|
||||
You can learn more about the Initial Block Download in `this video <https://www.youtube.com/watch?v=OrYDehC-8TU>`_.
|
||||
|
||||
.. youtube:: OrYDehC-8TU
|
||||
@@ -18,11 +18,11 @@ You can learn more about the Initial Block Download in `this video <https://www.
|
||||
|
||||
Can the IBD (Initial Block Download) be made faster? Or can wait times be improved?
|
||||
------------------------------------------------------------------------------------
|
||||
IBD was made significantly faster with the new hardware scheme of version 0.3.0 and up. Going forward the only way to improve IBD speeds will be on more powerful hardware, such as Embassy Pro.
|
||||
IBD was made significantly faster with the new hardware scheme of version 0.3.0 and up. Going forward the only way to improve IBD speeds will be on more powerful hardware.
|
||||
|
||||
Does the Embassy run a full archival Bitcoin node or a pruned one?
|
||||
------------------------------------------------------------------
|
||||
Previous Embassy versions (pre-0.3.0) only allowed a pruned node, but the option is now yours. In the Bitcoin Config, find the section on pruning, and set to 'Manual' or 'Automatic' to to prune to specified sizes, or turn pruning off entirely for a full archival node. Please keep in mind that a full archival node will take up between 400-500GB of your drive as of 2022.
|
||||
Does StartOS run a full archival Bitcoin node or a pruned one?
|
||||
--------------------------------------------------------------
|
||||
Previous versions of StartOS (pre-0.3.0) only allowed a pruned node, but the option is now yours. In the Bitcoin Config, find the section on pruning, and set to 'Manual' or 'Automatic' to to prune to specified sizes, or turn pruning off entirely for a full archival node. Please keep in mind that a full archival node will take up between 400-500GB of your drive as of 2022.
|
||||
|
||||
What actions, specifically, are only possible with an archival, or 'unpruned' node?
|
||||
-----------------------------------------------------------------------------------
|
||||
@@ -32,11 +32,11 @@ Many wallets also do not yet support pruned nodes, which is one big reason that
|
||||
|
||||
Is it insecure to run a pruned node?
|
||||
------------------------------------
|
||||
As a user, pruned nodes and archival nodes provide you the same security. In a larger sense, if 100% of people ran pruned nodes, the security of the network could be in dire circumstances and be put at risk if no nodes kept history, as then no one could bootstrap new nodes. The reality however, is that most Embassy owners are new node operators, so there is no net systemic risk introduced if users decide to run a pruned node.
|
||||
As a user, pruned nodes and archival nodes provide you the same security. In a larger sense, if 100% of people ran pruned nodes, the security of the network could be in dire circumstances and be put at risk if no nodes kept history, as then no one could bootstrap new nodes. The reality however, is that most StartOS users are new node operators, so there is no net systemic risk introduced if users decide to run a pruned node.
|
||||
|
||||
The Bitcoin Service is different from the GUI version I am used to using (bitcoin-qt). How do I use this like I used to?
|
||||
-------------------------------------------------------------------------------------------------------------------------
|
||||
At present, the Embassy does not offer its own node visualization tool. You can view certain properties about your node inside the "Properties" section, but not in an animated GUI. If you want to use bitcoin-cli, you may do so by adding an SSH key onto your Embassy and :ref:`exec-ing into the bitcoind docker container<service-container>`. Otherwise, the main way to actually *use* your node is through a wallet. The QT GUI is not usable because it cannot be served through the browser (which is necessary here), and last we checked, the QT desktop client was incapable of connecting to a remote node over Tor.
|
||||
At present, StartOS does not offer its own node visualization tool. You can view certain properties about your node inside the "Properties" section, but not in an animated GUI. If you want to use bitcoin-cli, you may do so by adding an SSH key to your server and :ref:`exec-ing into the bitcoind docker container<service-container>`. Otherwise, the main way to actually *use* your node is through a wallet. The QT GUI is not usable because it cannot be served through the browser (which is necessary here), and last we checked, the QT desktop client was incapable of connecting to a remote node over Tor.
|
||||
|
||||
Is a wallet vulnerable to hacking if it's always online??
|
||||
---------------------------------------------------------
|
||||
@@ -44,7 +44,7 @@ Funds are not stored on the node typically. The node simply serves as a source
|
||||
|
||||
Most successful attacks seem to be either fake/doctored software or a social attack (tricking you into installing some malware or giving your seed outright or something like that).
|
||||
Keep in mind, however, the more value there is out there to steal, the more sophisticated attacks will get automated (bots, crawlers etc). So its not just the risk profile of today, but also tomorrow you have to consider. That's why something like a hardware wallet or dedicated mobile device for key signing is a good idea.
|
||||
Even if your wallet is plugged into your Embassy, whether your wallet is hot or cold depends on the hardware that stores the keys.
|
||||
Even if your wallet is plugged into your server, whether your wallet is hot or cold depends on the hardware that stores the keys.
|
||||
|
||||
How does Bitcoin Proxy request (and verify) data when that data is needed by some app using it?
|
||||
-----------------------------------------------------------------------------------------------
|
||||
@@ -52,24 +52,24 @@ Proxy fetches blocks from your pruned node if it still has them, and fetches the
|
||||
|
||||
How do I use Bitcoin Core as a wallet?
|
||||
--------------------------------------
|
||||
Bitcoin Core is a full node that also contains wallet functionality. Some will be familiar with Bitcoin-QT, which is a Bitcoin Core GUI that for a long time was the only available wallet. This is currently not compatible with the Embassy.
|
||||
Bitcoin Core is a full node that also contains wallet functionality. Some will be familiar with Bitcoin-QT, which is a Bitcoin Core GUI that for a long time was the only available wallet. This is currently not compatible with StartOS.
|
||||
You can use the wallet in Bitcoin Core, however it is for advanced users and is only available in the command line via SSH.
|
||||
|
||||
It is helpful to think of the Bitcoin Core service on the Embassy as your own personal Bitcoin Server. This is your own verified source of truth of the Bitcoin ledger, that requires no permission for you to set up and own. The job of your Bitcoin server is to verify that the transactions you want to make and receive are valid.
|
||||
There are modern wallets that have the ability to use your personal Bitcoin node as a source of truth, and with the advantages of additional security and advanced features. This also follows the Unix mantra of "do one thing and do it well." The recommended way to use Bitcoin with your Embassy’s Bitcoin node is with an external wallet.
|
||||
It is helpful to think of the Bitcoin Core service on StartOS as your own personal Bitcoin Server. This is your own verified source of truth of the Bitcoin ledger, that requires no permission for you to set up and own. The job of your Bitcoin server is to verify that the transactions you want to make and receive are valid.
|
||||
There are modern wallets that have the ability to use your personal Bitcoin node as a source of truth, and with the advantages of additional security and advanced features. This also follows the Unix mantra of "do one thing and do it well." The recommended way to use your Bitcoin node is with an external wallet.
|
||||
The available wallets are listed in the following FAQ.
|
||||
|
||||
Which wallets can I use that sync with my Embassy Bitcoin and/or Lightning nodes?
|
||||
---------------------------------------------------------------------------------
|
||||
Which wallets can I use that integrate with my Bitcoin and/or Lightning nodes?
|
||||
------------------------------------------------------------------------------
|
||||
Please see the :ref:`Bitcoin Service Guides<bitcoin-service>` for all the current options.
|
||||
|
||||
I want to use my hardware signer, such as Coldcard or Trezor, with my Embassy. How does this work?
|
||||
---------------------------------------------------------------------------------------------------
|
||||
I want to use my hardware signer, such as Coldcard or Trezor, with my Bitcoin node. How does this work?
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
You do not use hardware signers directly with your node. Hardware signers interface with wallets, and wallets interface with nodes.
|
||||
|
||||
Node (Embassy) <— Wallet (Specter, Sparrow, Electrum) <— Hardware signer (Coldcard, Trezor)
|
||||
Node (on StartOS) <— Wallet (Specter, Sparrow, Electrum) <— Hardware signer (Coldcard, Trezor)
|
||||
|
||||
You would use your hardware signer with your wallet, then instruct that wallet to use Embassy as its node.
|
||||
You would use your hardware signer with your wallet, then instruct that wallet to use your Bitcoin node as its node.
|
||||
|
||||
- Nodes are for interacting with the Bitcoin network: enforcing consensus rules, validating and relaying blocks/transactions, and broadcasting transactions.
|
||||
|
||||
@@ -77,4 +77,4 @@ You would use your hardware signer with your wallet, then instruct that wallet t
|
||||
|
||||
- Signers are for generating and storing keys, as well as signing transactions.
|
||||
|
||||
The reason there is so much confusion about these 3 concepts is that the Bitcoin Core Node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and most wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, a node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on the Embassy).
|
||||
The reason there is so much confusion about these 3 concepts is that the Bitcoin Core Node comes with its own Wallet (which you should not use), and that wallet is also a signer. In fact, most wallets double as signers, and most wallets do NOT support connecting to your own node. So, most wallets are actually serving as a wallet, a node, and a signer, which might be convenient, but it is neither trustless nor maximally secure. Ideally, you are using a wallet that supports both integrating with a hardware signer (like Coldcard or Trezor) AND a backend node (like on StartOS).
|
||||
|
||||
@@ -10,9 +10,10 @@ Contributing FAQ
|
||||
|
||||
We ❤️ contributions!
|
||||
|
||||
How can I contribute to embassyOS?
|
||||
----------------------------------
|
||||
Please follow the guide `here <https://github.com/Start9Labs/embassy-os/blob/master/CONTRIBUTING.md>`_ and reach out to the `Community Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ channel on Matrix with any questions.
|
||||
|
||||
How can I contribute to StartOS?
|
||||
--------------------------------
|
||||
Please follow the guide `here <https://github.com/Start9Labs/start-os/blob/master/CONTRIBUTING.md>`_ and reach out to the `Community Dev <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_ channel on Matrix with any questions.
|
||||
|
||||
Do I need to be a professional developer or have coding experience to contribute?
|
||||
---------------------------------------------------------------------------------
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
.. _faq-embassy:
|
||||
|
||||
===========
|
||||
Embassy FAQ
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Can I run embassyOS on a VPS or VM?
|
||||
-----------------------------------
|
||||
Yes! The :ref:`DIY Guide <diy>` will take you through the setup steps.
|
||||
|
||||
Is it possible to use embassyOS on my own hardware?
|
||||
---------------------------------------------------
|
||||
Yes! The :ref:`DIY Guide <diy>` will take you through the setup steps. This option is great for people who already own the necessary hardware or who live outside the US and want to save on shipping and customs fees.
|
||||
|
||||
Additionally, embassyOS is available for you to download or build from source under the Start9 Personal Use `License <https://start9.com/license>`_, for free. The caveat is that you will miss out on the perks that come along with purchasing from us, such as white-glove support, and others, which will grow over time.
|
||||
|
||||
Do I plug my Embassy into my computer?
|
||||
---------------------------------------
|
||||
No. Your Embassy only needs to be plugged into power and internet, just like your router. You can set it up right by your router and, similar to a router, generally forget about it.
|
||||
|
||||
Do I plug in a monitor, keyboard, and mouse?
|
||||
--------------------------------------------
|
||||
Typically, no. It is not necessary or recommended to do this as embassyOS runs in "headless" mode - meaning that you will access it from your computer or mobile device. However, we have recently added "Kiosk Mode," which allows the installation (and use) of embassyOS with a monitor/keyboard/mouse. For directions on setting this up, please check out the :ref:`x86_64 DIY Guide <diy-x86>`.
|
||||
|
||||
How much storage does Embassy have?
|
||||
-----------------------------------
|
||||
Currently, Embassy ships with a 1 or 2TB SSD, but you may use a larger drive if you prefer. We advise against HDDs at this time for perfomance reasons.
|
||||
|
||||
Are my Internet requests anonymous and secure?
|
||||
----------------------------------------------
|
||||
embassyOS and every service on our Marketplace serve their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up Embassy. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them.
|
||||
|
||||
Does Start9 have access to my Embassy's encryption keys?
|
||||
--------------------------------------------------------
|
||||
No. Your keys are generated on your device using the password you create so we CAN NOT, nor would we like to, see your private keys.
|
||||
|
||||
Can multiple Embassies be setup to run redundantly in physically separate locations?
|
||||
------------------------------------------------------------------------------------
|
||||
Currently no, but we have plans for a feature that will enable Embassies to provide encrypted, automated backup services for one another.
|
||||
|
||||
How does Embassy compare to other Bitcoin nodes or personal servers?
|
||||
--------------------------------------------------------------------
|
||||
The cheapest way to run a Bitcoin/Lightning node is to buy a Raspberry Pi (or equivalent), download or compile embassyOS for free, and host everything on Tor. This takes even technical people significant time to accomplish. On the other end of the spectrum is something like Embassy, which "just works". In between is stuff like MyNode, Nodl, RoninDojo, Umbrel, and Raspiblitz, which all require some degree of command line effort and network configuration. The biggest benefit of Embassy is that it is infinitely extensible to all of open-source, self-hosted software. The service listing will expand enormously over time in ways the other platforms may choose not to, or have difficulty implementing.
|
||||
|
||||
Would you consider (Umbrel, Nodl, RoninDojo, etc) a competitor to Embassy, or are they different enough to be compatible?
|
||||
--------------------------------------------------------------------------------------------------------------------------
|
||||
Other node devices are competitors, and there are distinct trade-offs to each platform, but we are definitely moving toward the same future, which is a win for everyone!
|
||||
|
||||
One difference with Start9 is that we began with a plan to create an OS for general-purpose sovereign hosting of server-side software. No other project in the space (that we know of) started this way. There's also no reason you can't use more than one device. As an example, some users prefer Embassy for their data and RoninDojo for their Bitcoin stack.
|
||||
|
||||
Some other things that embassyOS offers that others do not:
|
||||
|
||||
- Graphical configuration of services (instead of command line)
|
||||
- System backups (pretty important)
|
||||
- Encrypted connection over the home network (https)
|
||||
- Health Checks for quick-glance understanding of the status of your services
|
||||
- Unique user experiences created by service-packagers, including "Actions" (custom commands at the click of a button!)
|
||||
|
||||
From an architectural perspective, embassyOS is a true operating system, giving you the ability to understand and control what is going on. Many other systems are black boxes offering little insight or agency to you. If something goes wrong, you'll have to put in your engineer hat and go command line diving. Lastly, our team is very responsive and helpful. We pride ourselves on providing incredible customer support.
|
||||
|
||||
Since it is often requested, we have put together an :ref:`Umbrel comparison guide<umbrel-compare>`
|
||||
|
||||
How can I migrate from Umbrel to Embassy and keep my lightning channels intact?
|
||||
-------------------------------------------------------------------------------
|
||||
We've created a guide to help you `transform your Umbrel's bitcoin stack into an Embassy <https://community.start9.com/t/howto-migrate-from-umbrel-0-5-x-to-embassy/56>`_.
|
||||
|
||||
Alternatively, if you have an Umbrel and an Embassy and they're on the same network, you can just select *Services > Lightning Network Daemon > Actions > Import from Umbrel* in your Embassy's web interface and your LND settings and channels will be automatically migrated.
|
||||
|
||||
Can I mine Bitcoin with this?
|
||||
-----------------------------
|
||||
You do **not** want to do that.
|
||||
|
||||
Does Embassy only work over Tor? No http or VPN?
|
||||
-------------------------------------------------
|
||||
Embassy's current primary communication is over Tor. In many cases we use HTTP over Tor (they are not mutually exclusive), you can see this by navigating to the Tor address in a browser and see the “http” in front of it. A VPN is a feature we're exploring as an alternative to Tor to make things faster without meaningfully impacting privacy. You can also connect directly via LAN if you are on the same network as your device.
|
||||
|
||||
What if someone gets physical access to my device, can they read the contents? Is it encrypted?
|
||||
-----------------------------------------------------------------------------------------------
|
||||
The data is currently encrypted at rest, but not in a way that would prevent a sophisticated attacker from accessing it. This is a step towards better security in the near future. At-rest encryption on servers is a serious challenge, because of the need for remote availability. For example, you may not be at home to enter an encryption password following a power outage, leaving you without access to your server.
|
||||
|
||||
Services like Bitwarden, however, do not store plaintext information, so your passwords will not be compromised unless they know your master password.
|
||||
|
||||
Why http and not https for .onion websites?
|
||||
-------------------------------------------
|
||||
When visiting a Tor V3 URL (.onion website), your communications are end-to-end encrypted and onion-routed by default. There is no added benefit to using https. See this `article <https://community.torproject.org/onion-services/advanced/https/>`_ from the Tor Project for more details.
|
||||
@@ -10,110 +10,106 @@ General FAQ
|
||||
|
||||
What is Start9 Labs?
|
||||
--------------------
|
||||
Start9 Labs is a small, but quickly growing group of builders based in Denver, CO (with a global team) that build Embassy and embassyOS.
|
||||
Start9 Labs is a small, but quickly growing group of builders based in Denver, CO (with a global team) that build Start9 servers and StartOS.
|
||||
|
||||
What is Embassy?
|
||||
----------------
|
||||
Embassy is a "shelf-top" personal server running embassyOS software.
|
||||
What is a Start9 server?
|
||||
------------------------
|
||||
A Start9 server is a "shelf-top" personal computer running StartOS as its operating system.
|
||||
|
||||
The internet as we know it is organized into questioners, or clients, and answerers, or servers. When you open a mobile email app, say Gmail, the app (client) begins asking questions: "have I received new mail?", "what are my last 50 messages?", "what drafts am I in the midst of writing?", and so on. Your app's questions are sent to and heard by a Google-run server which then provides answers back to the client and are subsequently displayed to the screen.
|
||||
|
||||
Embassy is exactly that: your very own "answerer", just like Google's, except managed simply and with ease by and for you alone.
|
||||
A server is exactly that: your very own "answerer", just like Google's, except managed simply and with ease by and for you alone.
|
||||
|
||||
In other words, it is a generalized private personal server capable of running all sorts of self hosted open source software.
|
||||
|
||||
When you see your credit card information on your banking app, your messages in your texting app, your passwords in your password management app, all of that information comes from somewhere in the cloud: some server run by some company somewhere on the planet. Who can see the data stored in that server? Who can edit it? It's not always clear, but the increasingly common practice of selling your data to advertisers and the high-profile cyber-security breaches of the last decade suggest a pessimistic outlook.
|
||||
|
||||
One thing is for certain though: if you control your server, then you control your data. Your finances, your communications, all of it is actually yours -- and only yours -- with Embassy.
|
||||
One thing is for certain though: if you control your server, then you control your data. Your finances, your communications, all of it is actually yours -- and only yours.
|
||||
|
||||
Why do I care?
|
||||
--------------
|
||||
As an example, let's talk about the password manager, Bitwarden. It may help convey the concept of a personal server. Currently, if you sign up with Bitwarden, your passwords are stored on a physical device (aka server) owned and operated by the Bitwarden team. Your phone or laptop sends requests to their server when you want to do anything: create an account, create a new password, retrieve existing passwords, etc. Your passwords are stored on their device, encrypted with your Bitwarden password. They are the custodian of your passwords, similar to getting a safe deposit box at the bank. The bank keeps your valuables in their vault, presumably they don't know what's in the box, and any time you want access to your box, you ask the bank for permission. This is exactly how a hosted Bitwarden experience works, as well as just about everything on the internet.
|
||||
|
||||
When you install Bitwarden on your Embassy, by contrast, it's like building your own safe deposit box in a private bunker whose location is only known to you and whose keys only you posses. You create an account with yourself, store your passwords with yourself, etc. You are your own custodian. This same concept can be applied to just about everything on the Internet, without losing the convenience of the custodial model, which is what we are out to accomplish. This may sound cool, or neat, but it is so much more than that. The custodial data model is amongst the greatest threats to human liberty the world has ever seen.
|
||||
When you install Bitwarden on StartOS, by contrast, it's like building your own safe deposit box in a private bunker whose location is only known to you and whose keys only you posses. You create an account with yourself, store your passwords with yourself, etc. You are your own custodian. This same concept can be applied to just about everything on the Internet, without losing the convenience of the custodial model, which is what we are out to accomplish. This may sound cool, or neat, but it is so much more than that. The custodial data model is amongst the greatest threats to human liberty the world has ever seen.
|
||||
|
||||
This `podcast <https://www.youtube.com/watch?v=aylDowaSdzU>`_ may help expound upon why this is important.
|
||||
|
||||
.. youtube:: aylDowaSdzU
|
||||
:width: 100%
|
||||
|
||||
How does Embassy work?
|
||||
How does StartOS work?
|
||||
----------------------
|
||||
embassyOS (see next question) is based on Linux and handles all operations of your Embassy device. This core element of the technology stack is what enables you to set up, login, access your Embassy's dashboard, and install services.
|
||||
StartOS (see next question) is based on Linux and handles all operations on your server. This core element of the technology stack is what enables you to set up, login, access your server's dashboard, and install services.
|
||||
|
||||
One of these operations is creating and managing Tor addresses, which are uniquely attributed to each service you download, as well as to the Embassy device itself. You can see your uniquely generated Tor address when you complete the setup process using the Setup App. This address is how you view your Embassy's dashboard, which is actually just a website served up from your Embassy itself! It is authenticated, of course, so only you can access it.
|
||||
One of these operations is creating and managing Tor addresses, which are uniquely attributed to each service you download, as well as to the server itself. You can see your uniquely generated Tor address when you complete the setup process using the Setup App. This address is how you view your server's dashboard, which is actually just a website hosted by your server itself! It is authenticated, of course, so only you can access it.
|
||||
|
||||
You can connect to and manage your Embassy from any mobile device, desktop computer, or laptop computer. This is accomplished right through the browser by visiting your Embassy's private and unique URL.
|
||||
You can connect to and manage your server from any mobile device, desktop computer, or laptop computer. This is accomplished right through the browser by visiting your server's private and unique URL.
|
||||
|
||||
Once on Embassy's web page, you can choose what services to install. Then, each installed service also receives its own private and unique URL, such that you can access it from the browser or any mobile app that supports using it as a backend.
|
||||
Once on your server's web page (the StartOS dashboard), you can choose what services to install. Then, each installed service also receives its own private and unique URL, such that you can access it from the browser or any mobile app that supports using it as a backend.
|
||||
|
||||
The list of services will grow rapidly over the coming months and years, such that many things you currently do using cloud-based third party servers can be just as easily accomplished using your own personal cloud serving your own personal apps and storing your own private data. No trusted third parties at all.
|
||||
|
||||
What is embassyOS?
|
||||
------------------
|
||||
embassyOS is a new kind of Operating System (OS). It is a built from the ground up to allow anyone to easily run their own "cloud," become independent from Big Tech, and own their own data. embassyOS allows anyone to easily host their own software services.
|
||||
What is StartOS?
|
||||
----------------
|
||||
StartOS is a new kind of Linux Operating System (OS). It is a built from the ground up to allow anyone to easily run their own "cloud," become independent from Big Tech, and own their own data. StartOS allows anyone to easily host their own software services.
|
||||
|
||||
embassyOS is custom-built Linux distribution with a suite of software tools which make it easy to:
|
||||
StartOS is custom-built Linux distribution with a suite of software tools which make it easy to:
|
||||
|
||||
* Install, uninstall, and upgrade services from a Marketplace (similar to your phone's app store)
|
||||
* Manage and run services that YOU own and control
|
||||
* Upgrade your Embassy software with the latest features and security updates
|
||||
* Upgrade StartOS with the latest features and security updates
|
||||
* Backup services, and restore from backups if needed
|
||||
|
||||
It includes:
|
||||
|
||||
* a custom application management layer, specialized for installing, running, and backing up .s9pk packaged services
|
||||
* a layer responsible for Embassy specific operations, such as Tor, Backups, and Notifications
|
||||
* a layer responsible for StartOS specific operations, such as Tor, Backups, and Notifications
|
||||
* a system of :ref:`Health Checks<health-checks>` for simple monitoring
|
||||
* an SDK for developers, including an "Actions" API to simplify complex operations for the common user
|
||||
* and much, much more. Please see the corresponding :ref:`Concepts<embassy-os>` section.
|
||||
* and much, much more. Please see the corresponding :ref:`Concepts<start-os>` section.
|
||||
|
||||
The `.s9pk` extension is Start9's custom package format based on `tar`. It encompasses the necessary components to compress, host, and install a service on a Marketplace registry.
|
||||
|
||||
What are embassyOS Services?
|
||||
----------------------------
|
||||
What are StartOS Services?
|
||||
--------------------------
|
||||
A Service can be any piece of software added to the Marketplace. Unlike "apps," services are (usually) "server-side" software, meaning they are intended to run 24/7/365 and listen for requests from your clients (apps). All services are "self-hosted," meaning that you are in complete control of your data. This means you can run your own "cloud!" Learn more about managing services :ref:`here <managing-services>` and see our currently `Available Services <https://marketplace.start9.com/>`_.
|
||||
|
||||
Does the Embassy ship worldwide?
|
||||
--------------------------------
|
||||
We ship everywhere that DHL ships. Please consider that in some countries, the VAT and Customs fees are so ridiculous that they cost as much as Embassy itself or more. You may wish to consider buying your hardware locally and building your own device, downloading embassyOS from our github, and `donating <https://donate.start9.com/>`_ to us. Please see the :ref:`DIY<diy>` page for details.
|
||||
Does Start9 ship worldwide?
|
||||
---------------------------
|
||||
We ship everywhere that DHL ships. Please consider that in some countries, the VAT and Customs fees are so ridiculous that they cost as much as the server itself. You may wish to consider buying your hardware locally and building your own device, downloading StartOS from our github, and `donating <https://donate.start9.com/>`_ to us. Please see the :ref:`DIY<diy>` page for details.
|
||||
|
||||
Does the Embassy have international electrical plugs?
|
||||
-----------------------------------------------------
|
||||
Do you have international electrical plugs?
|
||||
-------------------------------------------
|
||||
Power supplies for EU, AU, US, and UK are available.
|
||||
|
||||
Is the power supply that comes with Embassy 220v compatible?
|
||||
------------------------------------------------------------
|
||||
Yes.
|
||||
Is the power supply 220v compatible?
|
||||
------------------------------------
|
||||
Yes. Start9 server power supplies are rated for 100-240V.
|
||||
|
||||
Is the software Open Source?
|
||||
Does StartOS have a license?
|
||||
----------------------------
|
||||
Yes! embassyOS is open source under the `Start9 Personal Use License <https://start9.com/latest/about/license>`_. Some of our other projects are currently open sourced under MIT. You can find these in the Start9 `GitHub repository <https://github.com/Start9Labs>`_.
|
||||
|
||||
Can you tell me about the License?
|
||||
----------------------------------
|
||||
embassyOS is published under our own Start9 Non-Commercial License, which has similar properties to many open source licenses with the exception that users cannot in any way, either through products or services, commercialize the source code, and any changes to the code or derivative works of the code are treated in the same manner. This means people will be welcome to access the source code, download it, use it, run it, fork it, change it, improve it - whatever they want - except sell it or sell services related to it.
|
||||
StartOS is published under our own Start9 Non-Commercial License, which has similar properties to many open source licenses with the exception that users cannot in any way, either through products or services, commercialize the source code, and any changes to the code or derivative works of the code are treated in the same manner. This means people will be welcome to access the source code, download it, use it, run it, fork it, change it, improve it - whatever they want - except sell it or sell services related to it.
|
||||
|
||||
Is there a product warranty?
|
||||
----------------------------
|
||||
Yes! The full warranty for a device purchased from us is located on the insert in the box (1 year). Furthermore, Start9 commits, to the best of our ability, to serving Embassy users. We will resolve any issue encountered with our provided hardware or software in a personalized manner. We strive to provide highly available, quality customer service.
|
||||
Yes! The full warranty for a device purchased from us is located on the insert in the box (1 year). Furthermore, Start9 commits, to the best of our ability, to serving our users. We will resolve any issue encountered with our provided hardware or software in a personalized manner. We strive to provide highly available, quality customer service.
|
||||
|
||||
What kind of Internet connection is required to use Embassy?
|
||||
------------------------------------------------------------
|
||||
In general, any modern Internet connection is usually fine. We have had reports from users on rural satellite connections with high latency (ping), and low up/download speeds who had issues accessing via Tor. You can check your internet connection at `SpeedTest <https://speedtest.net>`_ to find your ping and speed. If your ping is higher than 200ms and/or your speeds are lower than 5Mbps, you may want to host your Embassy somewhere with a better connection. Please don't hesitate to contact us with any questions.
|
||||
What kind of Internet connection does a server require?
|
||||
-------------------------------------------------------
|
||||
In general, any modern Internet connection is usually fine. We have had reports from users on rural satellite connections with high latency (ping), and low up/download speeds who had issues accessing via Tor. You can check your internet connection at `SpeedTest <https://speedtest.net>`_ to find your ping and speed. If your ping is higher than 200ms and/or your speeds are lower than 5Mbps, you may want to locate your server somewhere with a better connection. Please don't hesitate to contact us with any questions.
|
||||
|
||||
I run a business, can I use an Embassy for tasks such as password management and file sharing?
|
||||
----------------------------------------------------------------------------------------------
|
||||
Absolutely. Embassy would be a great addition to any business as it is easy to use and provides services that you control, with no subscription fees.
|
||||
I run a business, can I use StartOS for tasks such as password management and file sharing?
|
||||
-------------------------------------------------------------------------------------------
|
||||
Absolutely. A Start9 server would be a great addition to any business as it is easy to use and provides services that you control, with no subscription fees.
|
||||
|
||||
With the addition of `BTCPay Server <https://btcpayserver.org/>`_, you can even run your own payment processor and accept cryptocurrency payments with no third party necessary!
|
||||
|
||||
What are you using for a store backend? Do you store my data?
|
||||
--------------------------------------------------------------
|
||||
Here is our exact situation currently:
|
||||
Embassy device sales are processed through Shopify, which we do not like, but it was expedient in the early days, especially for shipping, so we went with it. Aside from a master list of email addresses for those who have explicitly opted in to our mailing list, all customer data is contained within Shopify. We do not duplicate it anywhere. We are asking Shopify to delete our customer data, but they claim it will take upward of 3 months to comply and we of course have no guarantee the data will actually be deleted permanently. This is partly why we exist...as such, we will be moving off of Shopify and onto a self-hosted solution, where Start9 alone controls our customer data for Embassy purchases, which we will delete as a matter of policy following a short grace period after delivery.
|
||||
Server sales are processed through Shopify, which we do not like, but it was expedient in the early days, especially for shipping, so we went with it. Aside from a master list of email addresses for those who have explicitly opted in to our mailing list, all customer data is contained within Shopify. We do not duplicate it anywhere. We are asking Shopify to delete our customer data, but they claim it will take upward of 3 months to comply and we of course have no guarantee the data will actually be deleted permanently. This is partly why we exist...as such, we will be moving off of Shopify and onto a self-hosted solution, where Start9 alone controls our customer data for purchases, which we will delete as a matter of policy following a short grace period after delivery.
|
||||
|
||||
In summary: (1) the shipping data we currently have is stored in Shopify (2) we are asking Shopify to delete all our customer data (3) we will be migrating off of Shopify (4) going forward, we alone will control customer data and will purge it regularly (5) you can always assemble the hardware yourself and just download embassyOS for free.
|
||||
In summary: (1) the shipping data we currently have is stored in Shopify (2) we are asking Shopify to delete all our customer data (3) we will be migrating off of Shopify (4) going forward, we alone will control customer data and will purge it regularly (5) you can always assemble the hardware yourself and just download StartOS for free.
|
||||
|
||||
We are currently working on a better solution.
|
||||
|
||||
|
||||
@@ -29,8 +29,8 @@ How is that fee estimation calculated?
|
||||
--------------------------------------
|
||||
The commitment fees are automatically negotiated every few blocks with your peer. They are on chain txs like all channel closes but they are not broadcast until you attempt to close the channel.
|
||||
|
||||
What would happen if I shut down an Embassy that is running a Lightning node with open channels?
|
||||
------------------------------------------------------------------------------------------------
|
||||
What would happen if I shut down StartOS while it is running a Lightning node with open channels?
|
||||
-------------------------------------------------------------------------------------------------
|
||||
It is REALLY IMPORTANT to understand that if Lightning services are shut off for long periods of time (several days or more) it is possible for your peers to cheat you out of money. If you are not prepared to LOSE ALL THE MONEY IN YOUR CHANNELS, KEEP YOUR NODE RUNNING.
|
||||
That said, malicious actors on the network right now are probably sparse, and you may choose to only open channels with friends that may be a lot nicer to you if your node is not active.
|
||||
|
||||
@@ -38,12 +38,12 @@ Is there a solution to this?
|
||||
----------------------------
|
||||
Yes, the concept of a Watchtower was originally conceptualized in the LN whitepaper. A Watchtower is simply a lightning node to which you can give the authority to monitor transactions associated with your open payment channels.
|
||||
|
||||
Is it possible to run Core Lightning and LND in parallel on Embassy?
|
||||
Is it possible to run Core Lightning and LND in parallel on StartOS?
|
||||
--------------------------------------------------------------------
|
||||
Yes, you may run both. They will operate in their own environments and allow you to run services that depend on either.
|
||||
|
||||
How do I connect my Lightning wallet or mobile app to my Embassy?
|
||||
-----------------------------------------------------------------
|
||||
How do I connect my Lightning wallet or mobile app to my Start9 server?
|
||||
-----------------------------------------------------------------------
|
||||
Please see the :ref:`Lightning Service Guides<lightning-service>` section for more details.
|
||||
|
||||
Are my addresses, channels, and balances all stored in LND or in RTL? Core Lightning or Spark, etc?
|
||||
@@ -52,17 +52,17 @@ This is all on LND, including on-chain funds, and RTL (or ThunderhHub, Zap, etc)
|
||||
|
||||
How do I find my LND seed so I can write it down to backup?
|
||||
-----------------------------------------------------------
|
||||
All LND backups are best done via Embassy's backup flow. It is not supported to use a seed as backup; LND does not expose this. Everything crucial is backed up by our backup system so you do not need your seed. The seed is ONLY for the onchain wallet and does not backup your channel state.
|
||||
All LND backups are best done via StartOS's backup flow. It is not supported to use a seed as backup; LND does not expose this. Everything crucial is backed up by our backup system so you do not need your seed. The seed is ONLY for the onchain wallet and does not backup your channel state.
|
||||
|
||||
To clarify some of the reasons for this choice:
|
||||
|
||||
First off, Lightning is fundamentally different than on-chain/Layer1(L1) bitcoin. There is no way to compress all of that information down into a single 24 word seed in such a way that it will continue to work throughout your usage of the Lightning Network.
|
||||
|
||||
So, what is the LND seed *for*? In short, the seed is only used for the Layer1 portion of the funds you have locked up in LND. Due to the live nature of LND and lightning nodes in general, we tend to discourage keeping any significant amounts of money in the onchain portion of your wallet. Given that we cannot actually recover the Layer2(L2) funds with that seed, we needed to have a more holistic way to backup LND funds such that the backup would encompass the ability to get L2 funds back. The Embassy backup system does this, and this approach also happens to be a perfectly valid backup of your L1 funds as well. While Bitcoin users have been trained that the 24 word seed can be used to recover all of their funds, it is important to state that lightning does not and cannot work this way. Exposing the seed gives you two separate things to keep track of in order to recover your funds instead of just one.
|
||||
So, what is the LND seed *for*? In short, the seed is only used for the Layer1 portion of the funds you have locked up in LND. Due to the live nature of LND and lightning nodes in general, we tend to discourage keeping any significant amounts of money in the onchain portion of your wallet. Given that we cannot actually recover the Layer2(L2) funds with that seed, we needed to have a more holistic way to backup LND funds such that the backup would encompass the ability to get L2 funds back. The StartOS backup system does this, and this approach also happens to be a perfectly valid backup of your L1 funds as well. While Bitcoin users have been trained that the 24 word seed can be used to recover all of their funds, it is important to state that lightning does not and cannot work this way. Exposing the seed gives you two separate things to keep track of in order to recover your funds instead of just one.
|
||||
|
||||
Is there a way to use the channel backups made within RTL?
|
||||
----------------------------------------------------------
|
||||
The only backup flow we officially support is through Embassy's backup system. This does include the channel backups created automatically by LND, but it must be understood that backups in Lightning are very different than they are on Layer 1 Bitcoin. If you restore from backup all your channels will close, and there is a potential, albeit small, probability for you to lose funds.
|
||||
The only backup flow we officially support is through StartOS's backup system. This does include the channel backups created automatically by LND, but it must be understood that backups in Lightning are very different than they are on Layer 1 Bitcoin. If you restore from backup all your channels will close, and there is a potential, albeit small, probability for you to lose funds.
|
||||
|
||||
When attempting to add new peer, RTL says "server is still in the process of starting," but chain state seems to be fully up to date. What can I do?
|
||||
-----------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
@@ -8,15 +8,15 @@ Packaging FAQ
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Do I need programming experience to package a service for embassyOS?
|
||||
--------------------------------------------------------------------
|
||||
Do I need programming experience to package a service for StartOS?
|
||||
------------------------------------------------------------------
|
||||
It would be helpful, but is not a pre-requisite. Linux, dev-ops, and/or systems administration experience would all be helpful as well. Keep in mind that everyone has to start somewhere, and perhaps your journey to development begins with packaging a service for eOS!
|
||||
|
||||
What considerations are there when choosing a service for packaging?
|
||||
--------------------------------------------------------------------
|
||||
There are several things you will want to consider. Requirements include:
|
||||
|
||||
#. Most importantly, pick a service you are passionate about seeing on embassyOS
|
||||
#. Most importantly, pick a service you are passionate about seeing on StartOS
|
||||
#. Make sure it is :ref:`Open Source <open-source>`
|
||||
#. A service that incorporates a 'self-hosting' option, or is capable of being self-hosted
|
||||
|
||||
@@ -34,7 +34,7 @@ Config files can be empty( ``{}`` ), if you do not require config. `File Browse
|
||||
|
||||
How can my service access the data directory of another service?
|
||||
----------------------------------------------------------------
|
||||
#. Provider service needs to expose datadir to other services on embassy
|
||||
#. Provider service needs to expose datadir to other services on StartOS
|
||||
#. Consumer services needs to list the provider service as a dependency AND set a particular config value, stating that it wants data from that particular service
|
||||
|
||||
Check out `LND <https://github.com/Start9Labs/lnd-wrapper/blob/master/manifest.yaml>`_ and `RTL <https://github.com/Start9Labs/ride-the-lightning-wrapper/blob/master/manifest.yaml>`_ as an example.
|
||||
|
||||
@@ -10,7 +10,7 @@ Services FAQ
|
||||
|
||||
What if I cannot connect to a Service?
|
||||
--------------------------------------
|
||||
Please make sure the service is started by viewing it in the Services tab in the Embassy dashboard menu. A green indicator bar should be visible.
|
||||
Please make sure the service is started by viewing it in the Services tab in the StartOS dashboard menu. A green indicator bar should be visible.
|
||||
|
||||
Can it be used as a firewall?
|
||||
-----------------------------
|
||||
@@ -18,15 +18,15 @@ Potentially. The PiHole service is on our wishlist.
|
||||
|
||||
Will there be a VPN?
|
||||
--------------------
|
||||
We are looking into adding Wireguard as a service for VPN access when you are not home. A client-to-client Embassy VPN may also be possible in the future.
|
||||
We are looking into adding Wireguard as a service for VPN access when you are not home. A client-to-client StartOS VPN may also be possible in the future.
|
||||
|
||||
Will there be an email server?
|
||||
------------------------------
|
||||
We do hope to add this functionality one day, however it has some technical challenges, and is not currently a high priority. If you would like to tackle this and help us get a self-hosted email server on the Embassy, please reach out in our `Matrix Community Dev Channel <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_, and we will be happy to help in any way that we can.
|
||||
We do hope to add this functionality one day, however it has some technical challenges, and is not currently a high priority. If you would like to tackle this and help us get a self-hosted email server on StartOS, please reach out in our `Matrix Community Dev Channel <https://matrix.to/#/#community-dev:matrix.start9labs.com>`_, and we will be happy to help in any way that we can.
|
||||
|
||||
Can the Embassy run 'X' Service??
|
||||
Can StartOS run 'X' Service??
|
||||
---------------------------------
|
||||
Potentially. Here is a `comprehensive list <https://github.com/awesome-selfhosted/awesome-selfhosted>`_ of self-hosted services, any of which can theoretically be run on embassyOS.
|
||||
Potentially. Here is a `comprehensive list <https://github.com/awesome-selfhosted/awesome-selfhosted>`_ of self-hosted services, any of which can theoretically be run on StartOS.
|
||||
To get a general idea of what is required of an app, answer these questions:
|
||||
|
||||
1. Is it designed to be self-hosted?
|
||||
@@ -35,14 +35,14 @@ To get a general idea of what is required of an app, answer these questions:
|
||||
4. Does it ship with it's own web interface? Or is there a Tor-enabled client app?
|
||||
5. Is there someone willing to put in the time to package it up?
|
||||
|
||||
If all answers are yes, then it can run on embassyOS.
|
||||
If all answers are yes, then it can run on StartOS.
|
||||
|
||||
Packing up a service for the Embassy does not require extensive development skills. If you are interested in doing do, please see our :ref:`Developer Docs <developer-docs>`.
|
||||
Packing up a service for StartOS does not require extensive development skills. If you are interested in doing do, please see our :ref:`Developer Docs <developer-docs>`.
|
||||
|
||||
We are aggressively moving away from service development in favor of a more community driven approach. Meaning you, an app development team, or anyone else on Earth, can bring the Service they want to an Embassy Marketplace. You don't need our permission.
|
||||
We are aggressively moving away from service development in favor of a more community driven approach. Meaning you, an app development team, or anyone else on Earth, can bring the service they want to a Marketplace registry so anyone can run it on StartOS. You don't need our permission.
|
||||
|
||||
Does the Embassy operate as a Tor relay node?
|
||||
---------------------------------------------
|
||||
Does StartOS operate as a Tor relay node?
|
||||
-----------------------------------------
|
||||
No, currently it does not, but we plan to add that functionality in the near future.
|
||||
|
||||
Are files on File Browser encrypted on disk?
|
||||
@@ -51,11 +51,11 @@ Yes, but not in a way that would prevent a sophisticated attacker.
|
||||
|
||||
Can others use my Cups instance? How does that work?
|
||||
----------------------------------------------------
|
||||
Cups does not have multiple accounts support. Each person would need their own Embassy. We are considering adding multi-account support to Cups, but it's not a priority at the moment.
|
||||
Cups does not have multiple accounts support. Each person would need their own Start9 server. We are considering adding multi-account support to Cups, but it's not a priority at the moment.
|
||||
|
||||
How can I fix issues with Sphinx?
|
||||
---------------------------------
|
||||
If you are on Android, make sure Orbot is setup correctly, and if it is, try to restart it or your device. If you still have issues, *back up your keys,* delete all app data from your phone, uninstall, restart the Sphinx service on your Embassy, then reinstall and import your keys.
|
||||
If you are on Android, make sure Orbot is setup correctly, and if it is, try to restart it or your device. If you still have issues, *back up your keys,* delete all app data from your phone, uninstall, restart the Sphinx service on your Start9 server, then reinstall and import your keys.
|
||||
|
||||
I get an error ("Unlock Wallet Failed") when trying to log in to RTL, what can I do?
|
||||
------------------------------------------------------------------------------------
|
||||
@@ -70,7 +70,7 @@ What does it mean when Vaultwarden says "This browser requires HTTPS to use the
|
||||
---------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
You will need to tell your browser to treat .onion URLs as a "secure context". You will need to follow this guide to configure :ref:`Tor on Firefox<tor-firefox>`.
|
||||
|
||||
Can the browser extension be used with Bitwarden hosted on the embassy?
|
||||
Can the browser extension be used with Bitwarden hosted on StartOS?
|
||||
-----------------------------------------------------------------------
|
||||
Yes, but only in a tor-enabled browser. Just add your .onion address as the server in the extension. Make sure that http:// is at the beginning, and NOT https://, as this will not work.
|
||||
|
||||
@@ -78,9 +78,9 @@ You can use your .local address, but remember that you will only be able to sync
|
||||
|
||||
I want to use BTCPayServer on my website, but Tor is the only option, how can visitors access my BTCPay on clearnet?
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
As the Embassy produces a Tor Hidden Service for each service, BTCPayServer is only available via Tor by default. For a brick and mortar business, this is no problem as you can use your own device for a customer to pay you on. If you run your own website, it is possible to set up a reverse proxy in order to serve BTCPay content to your clearnet visitors. A guide to doing this is available in the `BTCPayServer docs <https://docs.btcpayserver.org/Deployment/ReverseProxyToTor/#reverse-proxy-to-tor/>`_.
|
||||
As StartOS produces a Tor Hidden Service for each service, BTCPayServer is only available via Tor by default. For a brick and mortar business, this is no problem as you can use your own device for a customer to pay you on. If you run your own website, it is possible to set up a reverse proxy in order to serve BTCPay content to your clearnet visitors. A guide to doing this is available in the `BTCPayServer docs <https://docs.btcpayserver.org/Deployment/ReverseProxyToTor/#reverse-proxy-to-tor/>`_.
|
||||
|
||||
We understand that this can be a frustrating limitation, and adding clearnet support is high on our list of priorities for embassyOS. This will allow a number of services to have better interoperability with the broader Web.
|
||||
We understand that this can be a frustrating limitation, and adding clearnet support is high on our list of priorities for StartOS. This will allow a number of services to have better interoperability with the broader Web.
|
||||
|
||||
I'm having issues connecting to users or rooms in Matrix/Synapse, what can I do?
|
||||
--------------------------------------------------------------------------------
|
||||
@@ -94,7 +94,7 @@ If you had to create a custom destkop shortcut, it is likely that this was reset
|
||||
|
||||
I don't see an answer to my question regarding a certain service. Is there more documentation?
|
||||
-----------------------------------------------------------------------------------------------
|
||||
While we are intent on providing the most friendly experience possible to our customers, ultimately it will be impossible for Start9 to create documentation and tutorials for every service we make available on the Embassy. Each service *should* have its own documentation produced by the service developers themselves, and we will do our best keep track, consolidate, and link to it. Also, much of the reason good tutorials don't exist is simply because no one in the community has taken the time to produce it. If you come across something useful or write something up yourself, please let us know and we will promote it. Otherwise we will do our best to answer questions as they arise and gradually build out tutorials where they are lacking.
|
||||
While we are intent on providing the most friendly experience possible to our customers, ultimately it will be impossible for Start9 to create documentation and tutorials for every service we make available on StartOS. Each service *should* have its own documentation produced by the service developers themselves, and we will do our best keep track, consolidate, and link to it. Also, much of the reason good tutorials don't exist is simply because no one in the community has taken the time to produce it. If you come across something useful or write something up yourself, please let us know and we will promote it. Otherwise we will do our best to answer questions as they arise and gradually build out tutorials where they are lacking.
|
||||
|
||||
Please also check out these :ref:`external support channels <external-support>` for assistance.
|
||||
|
||||
|
||||
87
site/source/support/faq/faq-startos.rst
Normal file
87
site/source/support/faq/faq-startos.rst
Normal file
@@ -0,0 +1,87 @@
|
||||
.. _faq-startos:
|
||||
|
||||
===========
|
||||
StartOS FAQ
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Can I run StartOS on a VPS or VM?
|
||||
---------------------------------
|
||||
Yes! The :ref:`DIY Guide <diy>` will take you through the setup steps.
|
||||
|
||||
Is it possible to use StartOS on my own hardware?
|
||||
-------------------------------------------------
|
||||
Yes! The :ref:`DIY Guide <diy>` will take you through the setup steps. This option is great for people who already own the necessary hardware or who live outside the US and want to save on shipping and customs fees.
|
||||
|
||||
Additionally, StartOS is available for you to download or build from source under the Start9 Personal Use `License <https://start9.com/license>`_, for free. The caveat is that you will miss out on the perks that come along with purchasing from us, such as white-glove support, and others, which will grow over time.
|
||||
|
||||
Do I plug my Start9 server into my computer?
|
||||
--------------------------------------------
|
||||
No. Your Start9 server only needs to be plugged into power and internet, just like your router. You can set it up right by your router and, similar to a router, generally forget about it.
|
||||
|
||||
Do I plug in a monitor, keyboard, and mouse?
|
||||
--------------------------------------------
|
||||
Typically, no. It is not necessary or recommended to do this as StartOS runs in "headless" mode - meaning that you will access it from your computer or mobile device. However, we have recently added "Kiosk Mode," which allows the installation (and use) of StartOS with a monitor/keyboard/mouse. For directions on setting this up, please check out the :ref:`x86 DIY Guide <diy-x86>`.
|
||||
|
||||
How much storage does a Start9 server have?
|
||||
-------------------------------------------
|
||||
Currently, Start9 servers ship with a 1 or 2TB SSD, but you may use a larger drive if you prefer. We advise against HDDs at this time for perfomance reasons.
|
||||
|
||||
Are my Internet requests anonymous and secure?
|
||||
----------------------------------------------
|
||||
StartOS and every service on our Marketplace serve their own Tor Hidden Services with unique Tor addresses. The private keys used to create these addresses are generated on your phone or computer when you first set up StartOS. No one, not even Start9, has any idea what your Tor addresses are, let alone the password(s) you choose to authenticate with them.
|
||||
|
||||
Does Start9 have access to my personal Start9 server's encryption keys?
|
||||
-----------------------------------------------------------------------
|
||||
No. Your keys are generated on your device using the password you create so we CAN NOT, nor would we like to, see your private keys.
|
||||
|
||||
Can multiple Start9 servers be setup to run redundantly in physically separate locations?
|
||||
-----------------------------------------------------------------------------------------
|
||||
Currently no, but we have plans for a feature that will enable StartOS to provide encrypted, automated backups across multiple servers.
|
||||
|
||||
How does StartOS compare to other Bitcoin nodes or personal servers?
|
||||
--------------------------------------------------------------------
|
||||
The cheapest way to run a Bitcoin/Lightning node is to buy a Raspberry Pi (or equivalent), download or compile Bitcoin, LND/CLN, etc, and host everything on Tor. This takes even technical people significant time to accomplish. On the other end of the spectrum is something like StartOS, which "just works". In between is stuff like MyNode, Nodl, RoninDojo, Umbrel, and Raspiblitz, which all require some degree of command line effort and network configuration. The biggest benefit of StartOS is that it is infinitely extensible to all of open-source, self-hosted software. The service listing will expand enormously over time in ways the other platforms may choose not to, or have difficulty implementing.
|
||||
|
||||
Would you consider (Umbrel, Nodl, RoninDojo, etc) a competitor to StartOS, or are they different enough to be compatible?
|
||||
--------------------------------------------------------------------------------------------------------------------------
|
||||
Other node devices are competitors, and there are distinct trade-offs to each platform, but we are definitely moving toward the same future, which is a win for everyone!
|
||||
|
||||
One difference with Start9 is that we began with a plan to create an OS for general-purpose sovereign hosting of server-side software. No other project in the space (that we know of) started this way. There's also no reason you can't use more than one device. As an example, some users prefer StartOS for their data and RoninDojo for their Bitcoin stack.
|
||||
|
||||
Some other things that StartOS offers that others do not:
|
||||
|
||||
- Graphical configuration of services (instead of command line)
|
||||
- System backups (pretty important)
|
||||
- Encrypted connection over the home network (https)
|
||||
- Health Checks for quick-glance understanding of the status of your services
|
||||
- Unique user experiences created by service-packagers, including "Actions" (custom commands at the click of a button!)
|
||||
|
||||
From an architectural perspective, StartOS is a true operating system, giving you the ability to understand and control what is going on. Many other systems are black boxes offering little insight or agency to you. If something goes wrong, you'll have to put in your engineer hat and go command line diving. Lastly, our team is very responsive and helpful. We pride ourselves on providing incredible customer support.
|
||||
|
||||
How can I migrate from Umbrel to StartOS and keep my lightning channels intact?
|
||||
-------------------------------------------------------------------------------
|
||||
We've created a guide to help you `transform your Umbrel's bitcoin stack into a Start9 server <https://community.start9.com/t/howto-migrate-from-umbrel-0-5-x-to-embassy/56>`_.
|
||||
|
||||
Alternatively, if you have an Umbrel and a Start9 server and they're on the same network, you can just select *Services > Lightning Network Daemon > Actions > Import from Umbrel* in your Start9 server's web interface and your LND settings and channels will be automatically migrated.
|
||||
|
||||
Can I mine Bitcoin with this?
|
||||
-----------------------------
|
||||
You do **not** want to do that.
|
||||
|
||||
Does StartOS only work over Tor? No http or VPN?
|
||||
-------------------------------------------------
|
||||
StartOS's current primary communication is over Tor. In many cases we use HTTP over Tor (they are not mutually exclusive), you can see this by navigating to the Tor address in a browser and see the “http” in front of it. A VPN is a feature we're exploring as an alternative to Tor to make things faster without meaningfully impacting privacy. You can also connect directly via LAN if you are on the same network as your device.
|
||||
|
||||
What if someone gets physical access to my device, can they read the contents? Is it encrypted?
|
||||
-----------------------------------------------------------------------------------------------
|
||||
The data is currently encrypted at rest, but not in a way that would prevent a sophisticated attacker from accessing it. This is a step towards better security in the near future. At-rest encryption on servers is a serious challenge, because of the need for remote availability. For example, you may not be at home to enter an encryption password following a power outage, leaving you without access to your server.
|
||||
|
||||
Services like Bitwarden, however, do not store plaintext information, so your passwords will not be compromised unless they know your master password.
|
||||
|
||||
Why http and not https for .onion websites?
|
||||
-------------------------------------------
|
||||
When visiting a Tor V3 URL (.onion website), your communications are end-to-end encrypted and onion-routed by default. There is no added benefit to using https. See this `article <https://community.torproject.org/onion-services/advanced/https/>`_ from the Tor Project for more details.
|
||||
@@ -12,24 +12,24 @@ What do I do first?
|
||||
-------------------
|
||||
Please check out the :ref:`Initial Setup <initial-setup>` page, and follow the instructions.
|
||||
|
||||
How do I know if my Embassy is running?
|
||||
---------------------------------------
|
||||
How do I know if my server is running?
|
||||
--------------------------------------
|
||||
After plugging into power and your router, you will hear 2 distinct sounds: first, a “bep” ‐ indicating the device is powering on, and second, a “chime” ‐ indicating the device is ready for setup. You can hear these sounds on the :ref:`Initial Setup<initial-setup>` page.
|
||||
|
||||
My Embassy is really hot! Is this normal?
|
||||
------------------------------------------
|
||||
My server is really hot! Is this normal?
|
||||
-----------------------------------------
|
||||
On early devices, yes. These cases are actually doing 'double duty' as a heat sync. This means that the metal of the case is actually touching the chips on the circuit board and drawing their heat out and away. This is known as "passive cooling," as no fan (and therefore no noise) is required to cool the system.
|
||||
|
||||
You can check the chip temperature of your device under "System -> Metrics".
|
||||
|
||||
I'm trying to migrate my old Embassy data, but the device won't boot. What do I do?
|
||||
------------------------------------------------------------------------------------
|
||||
I'm trying to migrate my old server data, but the device won't boot. What do I do?
|
||||
-----------------------------------------------------------------------------------
|
||||
Remove the external drive and sd card adapter if they are plugged in. Boot the device with just the new (32GB) sd card inserted. After you hear the start-up sounds, you may plug in the external drive and old (128GB) sd card.
|
||||
|
||||
I cannot reach embassy.local after hearing the start-up sounds from Embassy. What do I do?
|
||||
-------------------------------------------------------------------------------------------
|
||||
* Ensure that you are on the same network as your Embassy. Check that it is not a "Guest" network in your router
|
||||
* Your browser might try to force https://embassy.local, delete the https:// prefix and try again with just embassy.local or http://embassy.local
|
||||
I cannot reach start.local after hearing the start-up sounds. What do I do?
|
||||
----------------------------------------------------------------------------
|
||||
* Ensure that you are on the same network as your server. Check that it is not a "Guest" network in your router
|
||||
* Your browser might try to force https://start.local, delete the https:// prefix and try again with just start.local or http://start.local
|
||||
* Try a different browser, and note that Tor Browser cannot handle .local addresses
|
||||
* Turn off your VPN if you are using one (you may turn it back on after setup), or "allow LAN connections" if your VPN has such a setting.
|
||||
* If none of the above work, check your network setup, including your router settings if they are non-standard
|
||||
@@ -38,7 +38,7 @@ I cannot reach embassy.local after hearing the start-up sounds from Embassy. Wh
|
||||
|
||||
Why do I need the Bonjour service (Windows)?
|
||||
--------------------------------------------
|
||||
A major use-case of Bonjour is wireless printing over the LAN, but your Windows machine can also use Bonjour to discover and connect with other devices on the :ref:`Local Network<lan>`. In this case your Embassy. If Windows were to add support for reaching ``.local`` addresses, as is done in Linux and Mac, this would no longer be necessary.
|
||||
A major use-case of Bonjour is wireless printing over the LAN, but your Windows machine can also use Bonjour to discover and connect with other devices on the :ref:`Local Network<lan>`. In this case your Start9 server. If Windows were to add support for reaching ``.local`` addresses, as is done in Linux and Mac, this would no longer be necessary.
|
||||
|
||||
Recent updates to Windows may obviate the need for Bonjour, but so far results are mixed.
|
||||
|
||||
@@ -48,24 +48,20 @@ This is most likely a transient networking issue that will correct itself in a f
|
||||
|
||||
1. On Android/Orbot, the most common solution is to restart your Android device.
|
||||
|
||||
2. Access your Embassy over :ref:`LAN <connecting-lan>`, and restart it from the "Embassy" menu. (Restart by removing power if you cannot access via LAN)
|
||||
2. Access your server over :ref:`LAN <connecting-lan>`, and restart it from the "System" menu. (Restart by removing power if you cannot access via LAN)
|
||||
|
||||
3. Restart your router.
|
||||
|
||||
Do I need to take any additional security precautions with my device, for example with my router/modem?
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
Nothing special is required, however, it is best practice to use good passwords, i.e. for your WiFi and your Embassy. Here's a `comic <https://xkcd.com/936/>`_ explaining how to make strong passwords, simply.
|
||||
Nothing special is required, however, it is best practice to use good passwords, i.e. for your WiFi and your server. Here's a `comic <https://xkcd.com/936/>`_ explaining how to make strong passwords, simply.
|
||||
|
||||
What if I have an unique network issue, for example, with a firewall?
|
||||
---------------------------------------------------------------------
|
||||
Embassy is designed to work as simply as possible, for as many as possible, while providing the ability to host in a private manner. If you have an agressive or custom firewall, or other custom network settings, there is a good chance that addtional configuration may be necessary. We will continue to learn about custom networking issues, update our docs with resources, and help in the :ref:`Community Channels <contact>` to the best of our ability.
|
||||
StartOS is designed to work as simply as possible, for as many as possible, while providing the ability to host in a private manner. If you have an aggressive or custom firewall, or other custom network settings, there is a good chance that addtional configuration may be necessary. We will continue to learn about custom networking issues, update our docs with resources, and help in the :ref:`Community Channels <contact>` to the best of our ability.
|
||||
|
||||
Can I use my Embassy from behind a VPN, for example, if my router has a built-in VPN?
|
||||
-------------------------------------------------------------------------------------
|
||||
Can I use my server from behind a VPN, for example, if my router has a built-in VPN?
|
||||
------------------------------------------------------------------------------------
|
||||
Yes, this is possible, but it adds complexity, which may lead to problems. You will need to understand the setup of your router/VPN and how it supports (or doesn't support) Tor/LAN connections.
|
||||
|
||||
If you are having trouble with this, you might consider letting Embassy out "in the clear," since all services are accessible over the Tor network, offering a high level of privacy. Obviously, Start9 cannot support every variation of router and network.
|
||||
|
||||
Is it true that my device has some limited functionality in regard to Embassy?
|
||||
------------------------------------------------------------------------------
|
||||
The short answer is probably not, and there are often workarounds for the few known limitations. Please see the :ref:`Limitations<limitations>` page for details on your device.
|
||||
If you are having trouble with this, you might consider letting your server out "in the clear," since all services are accessible over the Tor network, offering a high level of privacy. Obviously, Start9 cannot support every variation of router and network.
|
||||
|
||||
@@ -4,13 +4,13 @@
|
||||
FAQ
|
||||
===
|
||||
|
||||
Answers to Frequently Asked Questions from Embassy users
|
||||
Answers to Frequently Asked Questions
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
faq-general
|
||||
faq-embassy
|
||||
faq-startos
|
||||
faq-basic-use
|
||||
faq-troubleshooting
|
||||
faq-contributing
|
||||
|
||||
@@ -1,169 +0,0 @@
|
||||
.. _umbrel-compare:
|
||||
|
||||
:orphan:
|
||||
|
||||
=================
|
||||
Umbrel Comparison
|
||||
=================
|
||||
This post will attempt to do a deep dive into the features of the Umbrel 0.4.10 and Embassy 0.3.0 personal servers. Many bitcoin and lightning node operators and other privacy conscious individuals use both platforms on a daily basis, so we think this functional comparison will help when choosing which platform to use for your needs.
|
||||
|
||||
Definitions
|
||||
-----------
|
||||
|
||||
Each platform will have different terminology, so let's first agree on common terms so the comparisons can be easy to understand.
|
||||
|
||||
**Embassy “Service” vs Umbrel “App”**
|
||||
|
||||
Each platform has a different name for describing server-side applications. Start9 calls them “services”, Umbrel calls them “apps”. For the remainder of this post, we will refer to them as services, but it means the same thing.
|
||||
|
||||
**Embassy Service Marketplace vs Umbrel App Store**
|
||||
|
||||
Both platforms publish their services through a web portal that allows the user to download and install the service from directly within the OS. Start9 calls it a “service marketplace” and Umbrel calls it an “app store”. For the remainder of this post, we will refer to it as a marketplace.
|
||||
|
||||
Now on to the feature comparisons!
|
||||
|
||||
Marketplace
|
||||
-----------
|
||||
|
||||
Both platforms offer a similar experience for discovering and installing services, but beneath the surface there are some important differences.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
Each version of Umbrel contains a file called registry.json that defines the complete set of possible services and their versions that can be installed on that version of Umbrel. The Umbrel App Store is a graphical interface for examining this file in a visual way, complete with images. When you click “install”, your Umbrel reaches out to dockerhub.io to fetch the docker container for the selected service. In other words, the Umbrel App Store is actually a custom skin for dockerhub.io that exposes a subset of services defined by that version of Umbrel. There are three very important consequences to this architecture:
|
||||
|
||||
Dockerhub.io is a single point of failure and de facto dependency of Umbrel. If Dockerhub.io ever goes down or becomes compromised, it will not be possible to reliably install or update services.
|
||||
|
||||
**Embassy**
|
||||
|
||||
With Embassy, nothing is built-in or pre-installed, not even Bitcoin. This means you can easily run two Embassies: one for Bitcoin services, and another for non-Bitcoin services. Install only the services you want on each device. Packages are entirely modular and self-describing, meaning that you can even install packages to your Embassy that you get from a friend even if that package doesn’t appear on any marketplace.
|
||||
|
||||
Moreover, there is no static configuration file that details or limits the set of possible services that can be installed. Installations and updates are done a la carte and are independent of one another. If Start9 releases a new service or updates an existing service, such as an emergency security update for Bitcoin, you can get the new version without needing to update your entire Embassy or any other services.
|
||||
|
||||
Finally, anyone can host an alternative or competing marketplace, either on clearnet or over Tor, and users can switch between marketplaces inside the Embassy interface. This means that Start9 does not occupy a central position in the marketplace ecosystem. If Start9 goes down, users can switch to an alternative marketplace and continue to install and update services.
|
||||
|
||||
Available Services
|
||||
------------------
|
||||
|
||||
The reason anyone wants a personal server is the same reason anyone wants a personal computer: to do things with it! In other words, services.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
At the time of this writing, there are 46 services available on Umbrel.
|
||||
|
||||
**Embassy**
|
||||
|
||||
At the time of this writing, there are 24 services available on Embassy.
|
||||
|
||||
Service Contributions
|
||||
---------------------
|
||||
|
||||
There are several services available on both platforms, but even so these platforms are not limited to just what you can find on their respective marketplaces. Both platforms have a developer guide for packaging up your own service from your own repository.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
Umbrel uses docker containers to package up services, and can be done in any programming language. The only requirement is for the service to serve up a web page, as the regular user is never expected to have cli access on Umbrel.
|
||||
|
||||
The docker containers can be tested on a dedicated Umbrel development environment, available for both Linux and macOS, or can be tested directly on an Umbrel. Any dependencies on other services would need to be managed by the service author/developer.
|
||||
|
||||
Umbrel uses docker images pushed to Docker Hub to catalog services on the Umbrel marketplace. All services are bundled together in UmbrelOS releases, so once you submit a service to Umbrel, you would need to wait until the next UmbrelOS version release in order to see your service in the Umbrel marketplace.
|
||||
|
||||
**Embassy**
|
||||
|
||||
Embassy uses the concept of a ‘wrapper’ around a docker container to package custom services and provides detailed documentation on how to package a service for the Embassy using any desired programming language. This wrapper acts as a translation layer such that developers can take advantage of the embassyOS’ various APIs mentioned throughout this writing. Embassy will host the service over Tor and LAN without any additional configuration needed. They also provide a hello-world example to refer to when packaging a custom service.
|
||||
|
||||
Services can then be submitted to the Start9 Service Marketplace for review and distribution, or they can be hosted on any alternative marketplace.
|
||||
|
||||
Backups
|
||||
-------
|
||||
|
||||
When it comes to digital independence, there is nothing more important than maintaining good backups. If your server is stolen or destroyed, and you don’t have good backups, you can lose everything. Again, Embassy and Umbrel are entirely different when it comes to backups.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
With Umbrel, you do not have to worry about backing up LND, including your lightning payment channels. Umbrel automatically creates encrypted backups of your LND node on their own server. You can, and should, download these backups regularly to ensure you have the latest backup in case something goes wrong. You can also download a .backup file of your channels and save it locally.
|
||||
|
||||
Umbrel does not offer a means of backing up other services. If you want to back up your Bitcoin node, or your data, messages, or passwords from other services, you will need to SSH into your Umbrel, then use the command line to manually export data from each service using an over-the-air protocol such as FTP or SMB. You will need to research each service to determine exactly what data should be exported and in what format, and you will need to perform your own encryption if you want the backups to be encrypted. So except for LND, which is backed up on Umbrel’s server, it is not practical to backup your other services.
|
||||
|
||||
**Embassy**
|
||||
|
||||
With Embassy, creating a complete encrypted backup of your entire system is a matter of clicking “Create Backup” in the GUI and selecting a target destination. The destination can either be a physical hard drive or a shared network folder, basically any device that is connected to the same Local Area Network as your Embassy. Backups are encrypted using your Embassy master password.
|
||||
|
||||
You can restore from backup directly from the GUI by clicking “Restore from Backup”, selecting the drive where the backup exists, and then selecting the services you want to restore.
|
||||
|
||||
Service Configuration
|
||||
---------------------
|
||||
|
||||
Services, like client apps on your phone or computer, usually have settings. Unlike these apps, however, services often (1) do not have a user interface or (2) rely on certain settings for their boot process; meaning, by the time you might see a settings menu, it’s too late. So instead of a settings menus, services usually rely on configuration files that instruct the service not only how to initialize, but also how to function once initialization is complete. In Bitcoin, for example, configuration is accomplished by editing the bitcoin.conf file, then starting or restarting the node. Configuration files are often massive, require using the command line, and are generally not validated, meaning it is easy to make a mistake, which can cause the entire service to crash or stop functioning properly. Furthermore, config files rarely self-describe the set of possible options or values for each option, leaving users wondering what is even available to them.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
Umbrel provides sane defaults for service configurations. If the user wishes to change the defaults, they must use SSH, the command line, and a command line text editor such as vim or nano to modify whatever configuration file the service uses, such as bitcoin.conf. It is left up to the user to research the possible configuration options and modify the files without making a mistake.
|
||||
|
||||
**Embassy**
|
||||
|
||||
Embassy also provides sane defaults for service configurations. If the user wishes to change the defaults, they can do so through the Embassy GUI using a graphical form, complete with descriptions, toggles, dropdowns, and standard inputs, all fully validated to ensure no mistakes are made.
|
||||
|
||||
Health Checks
|
||||
-------------
|
||||
|
||||
Perhaps the most important (and difficult) task of a systems administrator is to constantly monitor the health and availability of their services. And it is not always obvious what constitutes health. For example, if your Bitcoin node is running, does that mean it is healthy? The answer is no. A running Bitcoin node is useless if it hasn’t fully started up or its P2P interface is unreachable. What about if your node is not fully synced. Is a partially synced Bitcoin node considered healthy? The answer is that it depends on who is asking. From LNDs perspective, a partially synced Bitcoin node is not healthy, since until Bitcoin is fully synced, LND cannot do its job. As a systems administrator, monitoring the health of your services from a variety of perspectives and use cases is a serious challenge.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
There is no health check system for services in Umbrel. It is up to the user to know what constitutes health for each service and to manually inspect logs and use SSH and the command line to determine if their services are healthy.
|
||||
|
||||
**Embassy**
|
||||
|
||||
In Embassy, package developers define what constitutes health for a given service and write scripts to test for it. Embassy performs these health checks on a continuous basis, presenting results to the user inside the GUI. Users can tell at a glance if Bitcoin is running smoothly, or if LND is satisfied with the state of Bitcoin’s health. In the event that a health check fails, Embassy can issue a notification, informing the user of the failure along with a report for how the issue was resolved or whether resolution requires further action.
|
||||
|
||||
Actions
|
||||
-------
|
||||
|
||||
In the course of running your own services, you will often enter commands into the command line to execute certain actions or scripts, such as resyncing the Bitcoin blockchain, or resetting a password. Being aware of these commands and knowing how and when to use them gives you more control over your services and are sometimes necessary for resolving issues. Here, again, we see big differences between Embassy and Umbrel.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
Umbrel does not make actions available to users. If you want to execute a command, you must use SSH and the command line. From there, you can run any command you want, but there is no guidance or protection from the operating system.
|
||||
|
||||
**Embassy**
|
||||
|
||||
In Embassy, the Actions interface allows users to execute common commands inside the GUI. Actions are developer defined and can be any command, including commands that take user input. Commands that have not been formally converted into Actions may be executed using SSH and the command line.
|
||||
|
||||
LAN SSL
|
||||
-------
|
||||
|
||||
When communicating with your personal server in a browser context, it is important to ensure that your communication is private and secure. For this reason, Both Embassy and Umbrel serve their user interfaces over Tor as V3 Hidden Service. This enables you to access your server from anywhere in the world, right from the browser, by visiting a unique .onion URL. But Tor is slow and clunky. As such, both platforms also serve their user interfaces over the Local Area Network (LAN), such that you can access your server in a more performant manner while connected to the same LAN by visiting a unique .local URL.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
Umbrel uses an unencrypted http connection for communicating over the LAN. If your LAN is secure, this is not an issue. But anyone with access to your LAN, including guests who have your WiFi password or who plug in via Ethernet, would trivially be able to sniff traffic.
|
||||
|
||||
**Embassy**
|
||||
|
||||
Embassy acts as its own Certificate Authority (CA), such that it can use an encrypted https connection for communicating over the LAN. This requires a bit of setup, namely downloading your Embassy’s SSL CA certificate and trusting it in both your device and your device’s browser. It takes a few minutes to set up, but once complete, you can be sure that no one can sniff your traffic, even if they have access to your LAN.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
Often, you will want to inspect the data of one of your services or query it for a specific value. We will refer to these values as Properties. For example, what is the sync progress of your Bitcoin node? Or what are the gRPC credentials of your LND node? Or what is the default username and password of your photo sharing service?
|
||||
|
||||
**Umbrel**
|
||||
|
||||
With Bitcoin and Lightning, Umbrel provides a beautiful GUI that displays properties in real time, such as sync progress and current block height. Umbrel does not, however, have a generalized interface for displaying arbitrary properties for any service. These properties must be obtained by using SSH and the command line.
|
||||
|
||||
**Embassy**
|
||||
|
||||
In Embassy, what qualifies as a property that is worth displaying is determined by the package developer. Embassy offers a generalized interface for presenting properties to the user, such that they can view, copy, or QR scan important values inside the GUI. Properties that are not made available by the package developer can be obtained by using SSH and the command line.
|
||||
|
||||
Notifications
|
||||
-------------
|
||||
|
||||
When it comes to running your own server, knowing what happened and when can be very important for debugging, or for resolving an issue as soon as it arises.
|
||||
|
||||
**Umbrel**
|
||||
|
||||
Umbrel does not have a notification system. If something goes wrong with your Umbrel or any of its services, you will have to figure it out from unexpected behavior.
|
||||
|
||||
**Embassy**
|
||||
|
||||
If something important happens (i.e. a service crashes, or a health check fails, or backup completes), Embassy will issue a notification. These notifications are retained and displayed chronologically inside the Notifications section of your Embassy. Some notifications also contain metadata. For example, a notification about a completed backup will contain a detailed report of that backup.
|
||||
@@ -28,7 +28,7 @@ View frequently asked questions, troubleshoot common issues, or contact support.
|
||||
:class: large-5
|
||||
:anchor: View
|
||||
|
||||
Answers to Frequently Asked Questions from Embassy users
|
||||
Answers to Frequently Asked Questions from StartOS users
|
||||
|
||||
.. topic-box::
|
||||
:title: Contact
|
||||
@@ -46,7 +46,7 @@ View frequently asked questions, troubleshoot common issues, or contact support.
|
||||
:class: large-5
|
||||
:anchor: Get help
|
||||
|
||||
Get help for third party apps that connect to your Embassy services
|
||||
Get help for third party apps that connect to your StartOS services
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ Click "Add custom registry" and enter the URL of your desired Marketplace. You m
|
||||
.. figure:: /_static/images/marketplaces/marketplace-switch1.png
|
||||
:width: 60%
|
||||
|
||||
.. note:: Currently this change will only permit the downloading of *services* from alternative marketplaces. embassyOS itself may only be obtained from Start9 (or building from source) at this time.
|
||||
.. note:: Currently this change will only permit the downloading of *services* from alternative marketplaces. StartOS itself may only be obtained from Start9 (or building from source) at this time.
|
||||
|
||||
Hosting a Registry
|
||||
------------------
|
||||
|
||||
@@ -8,14 +8,14 @@ Backup
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Backing up your Embassy is easy and secure. Backups are encrypted with your master password.
|
||||
Backing up your server is easy and secure. Backups are encrypted with your master password.
|
||||
|
||||
.. warning:: Create frequent backups to avoid loss of data!
|
||||
|
||||
Setup Device
|
||||
------------
|
||||
|
||||
Select your platform for detailed instructions on how to create a Network Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main Embassy SSD.
|
||||
Select your platform for detailed instructions on how to create a Network Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main server's SSD.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
@@ -25,7 +25,7 @@ Select your platform for detailed instructions on how to create a Network Folder
|
||||
Windows Network Folder <backup-setup/backup-windows>
|
||||
Synology Network Folder <backup-setup/backup-synology>
|
||||
TrueNAS Network Folder <backup-setup/backup-truenas>
|
||||
Physical Drive via Embassy <backup-setup/backup-physical>
|
||||
Physical Drive <backup-setup/backup-physical>
|
||||
|
||||
.. _backup-create:
|
||||
|
||||
@@ -34,20 +34,20 @@ Create Backup
|
||||
|
||||
#. Go to *System > Create Backup*
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
|
||||
#. You will see your previously created Network Folder backup location (or Physical Drive) available. Click it, then click "Create Backup".
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup2.png
|
||||
.. figure:: /_static/images/config/backup2.png
|
||||
:width: 60%
|
||||
|
||||
#. You can continue to use your Embassy while the backup is in progress.
|
||||
#. You can continue to use your server while the backup is in progress.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup3.png
|
||||
.. figure:: /_static/images/config/backup3.png
|
||||
:width: 60%
|
||||
|
||||
#. When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the System tab.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup4.png
|
||||
.. figure:: /_static/images/config/backup4.png
|
||||
:width: 60%
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
Restore
|
||||
=======
|
||||
|
||||
There are 3 different ways that you may choose to restore Embassy data, as well as a 4th option to migrate data between hardware.
|
||||
There are 3 different ways that you may choose to recover server data, as well as a 4th option to migrate/transfer data between hardware.
|
||||
|
||||
#. "Restore" *selected service data* to your currently running Embassy. This is specifically for service data.
|
||||
#. "Attach" a drive with existing Embassy data on it during setup. Use this when re-flashing your SD card, for example.
|
||||
#. "Recover" (as in, disaster recovery) all Embassy data in the event that your backup is the **only** thing you have left.
|
||||
#. "Transfer" all data from an existing Embassy. This is a total migration for use when upgrading hardware only.
|
||||
#. "Restore [individual services] from Backup" to your currently running server. This is specifically for service data.
|
||||
#. "Use Existing Drive" a drive with existing server data on it during setup. Use this when re-flashing your SD card, for example.
|
||||
#. "Restore [entire server] from Backup" (as in, disaster recovery) all server data in the event that your backup is the **only** thing you have left.
|
||||
#. "Transfer" data from an existing server. This is a total migration for use when upgrading hardware only.
|
||||
|
||||
.. warning:: If you are restoring data from a drive that you are attaching *directly to your Embassy,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Embassy One (NASPi Geekworm case with built-in power management) and Embassy Pro users can safely ignore this warning.
|
||||
.. warning:: If you are restoring data from a drive that you are attaching *directly to your server,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Server One (NASPi Geekworm case with built-in power management) and Server Pro users can safely ignore this warning.
|
||||
|
||||
Select the appropriate tab below to restore your data:
|
||||
|
||||
@@ -39,7 +39,7 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/config/restore3.png
|
||||
:width: 60%
|
||||
|
||||
It is not possible to recover services already installed on the Embassy. If you wish to recover a service that is already installed, please uninstall it first to permit recovery.
|
||||
It is not possible to recover services that are already installed. If you wish to recover a service that is already installed, please uninstall it first to permit recovery.
|
||||
|
||||
.. group-tab:: Attach
|
||||
|
||||
@@ -53,7 +53,7 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/setup/screen3-use_existing.png
|
||||
:width: 60%
|
||||
|
||||
#. Select your Embassy data drive.
|
||||
#. Select your server's data drive.
|
||||
|
||||
.. figure:: /_static/images/setup/screen4-use_existing_drive_selection.png
|
||||
:width: 60%
|
||||
@@ -63,7 +63,7 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/setup/screen5-set_password.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Your Embassy will initialize again (all previous data will be recovered).
|
||||
#. Your server will initialize again (all previous data will be recovered).
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
@@ -90,7 +90,7 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/restore/recover2.png
|
||||
:width: 60%
|
||||
|
||||
#. Enter the encryption password for the drive (this is your Embassy's master password).
|
||||
#. Enter the encryption password for the drive (this is your server's master password).
|
||||
|
||||
.. figure:: /_static/images/restore/recover3.png
|
||||
:width: 60%
|
||||
@@ -105,7 +105,7 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/restore/recover5.png
|
||||
:width: 60%
|
||||
|
||||
#. Your Embassy will now prepare and then copy the data to the new drive. The time required can vary greatly depending on how much data you are migrating and from where that data is coming. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
|
||||
#. Your server will now prepare and then copy the data to the new drive. The time required can vary greatly depending on how much data you are migrating and from where that data is coming. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
|
||||
|
||||
.. figure:: /_static/images/restore/recover6.png
|
||||
:width: 60%
|
||||
@@ -122,19 +122,19 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/transfer/transfer0.png
|
||||
:width: 60%
|
||||
|
||||
#. Plug in the drive (make sure it is powered on) of the Embassy you are migrating **from** and select it (in this example, /dev/sda). You may need to try a different USB port and hit "Refresh" if you don't see it immediately. You will see a warning about using the old drive again; read and understand it.
|
||||
#. Plug in the drive (make sure it is powered on) of the server you are migrating **from** and select it (in this example, /dev/sda). You may need to try a different USB port and hit "Refresh" if you don't see it immediately. You will see a warning about using the old drive again; read and understand it.
|
||||
|
||||
.. figure:: /_static/images/transfer/transfer1.png
|
||||
:width: 60%
|
||||
|
||||
#. Select the drive on your new Embassy (that you are migrating **onto**).
|
||||
#. Select the drive on your new server (that you are migrating **onto**).
|
||||
|
||||
.. figure:: /_static/images/transfer/transfer2.png
|
||||
:width: 60%
|
||||
|
||||
.. warning:: This will **PERMANENETLY ERASE** any existing data on that drive. If you re-using an old drive, ensure that you have first removed all your data!!
|
||||
|
||||
#. Set your new Embassy master password. *Make it good. Write it down.* Click finish.
|
||||
#. Set your new master password. *Make it good. Write it down.* Click finish.
|
||||
|
||||
.. figure:: /_static/images/transfer/transfer3.png
|
||||
:width: 60%
|
||||
@@ -142,7 +142,7 @@ Select the appropriate tab below to restore your data:
|
||||
.. figure:: /_static/images/transfer/transfer4.png
|
||||
:width: 60%
|
||||
|
||||
#. Your Embassy will now initialize and migrate the old data to the new drive. The time required can vary greatly depending on how much data you are migrating. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
|
||||
#. Your server will now initialize and migrate the old data to the new drive. The time required can vary greatly depending on how much data you are migrating. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
|
||||
|
||||
.. figure:: /_static/images/transfer/transfer5.png
|
||||
:width: 60%
|
||||
|
||||
@@ -17,7 +17,7 @@ Setup Network Folder
|
||||
|
||||
.. group-tab:: Ubuntu
|
||||
|
||||
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Linux machine, such that you may create encrypted, private backups of all your Start9 server's data.
|
||||
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Linux machine, such that you may create encrypted, private backups of all your StartOS data.
|
||||
|
||||
.. youtube:: LLIMC5P3NdY
|
||||
:width: 100%
|
||||
@@ -56,7 +56,7 @@ Setup Network Folder
|
||||
.. figure:: /_static/images/cifs/cifs-lin2.png
|
||||
:width: 60%
|
||||
|
||||
- You may name the share whatever you like, but **remember this name**, as you will need it later in your Start9 server's web UI. Here, we used ``backup-share``.
|
||||
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in the StartOS dashboard
|
||||
|
||||
- (Optional) Create a description in the "Comment" section
|
||||
|
||||
@@ -94,7 +94,7 @@ Setup Network Folder
|
||||
.. figure:: /_static/images/cifs/cifs-mint1.png
|
||||
:width: 60%
|
||||
|
||||
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in your Start9 server's web UI. In this example, we call it ``backup-share``.
|
||||
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in the StartOS dashboard. In this example, we call it ``backup-share``
|
||||
|
||||
- (Optional) Create a description in the "Comment" section
|
||||
|
||||
@@ -160,17 +160,17 @@ Setup Network Folder
|
||||
sudo ufw allow Samba
|
||||
|
||||
|
||||
Connect Your Start9 Server
|
||||
--------------------------
|
||||
Connect StartOS
|
||||
---------------
|
||||
|
||||
#. Go to *System > Create Backup*.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Open".
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup0.png
|
||||
.. figure:: /_static/images/config/backup0.png
|
||||
:width: 60%
|
||||
|
||||
#. Fill in the following fields:
|
||||
@@ -180,9 +180,9 @@ Connect Your Start9 Server
|
||||
* Username - This is your Linux username on the remote machine that you used to create the shared directory
|
||||
* Password - This is the password you set above using ``smbpasswd``
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup1.png
|
||||
.. figure:: /_static/images/config/backup1.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Save".
|
||||
|
||||
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Start9 server's data to your Linux machine or external drive!!
|
||||
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your StartOS data to your Linux machine or external drive!!
|
||||
|
||||
@@ -8,7 +8,6 @@ Mac Network Folder
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
|
||||
Setup a Network Folder
|
||||
----------------------
|
||||
|
||||
@@ -109,13 +108,13 @@ Connect Your Server
|
||||
|
||||
#. Go to the **System** tab and click **Create Backup**:
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
:alt: system-create-backup
|
||||
|
||||
#. Click **Open New**:
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup0.png
|
||||
.. figure:: /_static/images/config/backup0.png
|
||||
:width: 60%
|
||||
:alt: open-new
|
||||
|
||||
|
||||
@@ -9,17 +9,17 @@ Backup to Physical Drive
|
||||
.. youtube:: KJRO9wGOOVw
|
||||
:width: 100%
|
||||
|
||||
The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder<backup>` via your OS. However, you may use a powered external drive, or external drive via a powered USB 3.0 hub, connected directly to your Embassy if you prefer.
|
||||
The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder<backup>` via your OS. However, you may use a powered external drive, or external drive via a powered USB 3.0 hub, connected directly to your Start9 server if you prefer.
|
||||
|
||||
.. warning:: If you still choose to plug into your Embassy, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Embassy One (NASPi Geekworm case with built-in power management) and Embassy Pro users can safely ignore this warning.
|
||||
.. warning:: If you still choose to plug into your Start9 server, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One (NASPi Geekworm case with built-in power management) and Server Pro users can safely ignore this warning.
|
||||
|
||||
#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``.
|
||||
|
||||
#. If your drive is self-powered, you can plug it directly into your Embassy blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy. Then you may power it up.
|
||||
#. If your drive is self-powered, you can plug it directly into your Start9 server blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Start9 server. Then you may power it up.
|
||||
|
||||
#. Go to *System > Create Backup*
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Select your drive.
|
||||
@@ -30,12 +30,12 @@ The recommended method of backup (including with external drives) is to setup a
|
||||
.. figure:: /_static/images/config/physical-backup2.png
|
||||
:width: 60%
|
||||
|
||||
#. Enter your embassyOS master password.
|
||||
#. Enter your StartOS master password.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup3.png
|
||||
.. figure:: /_static/images/config/backup3.png
|
||||
:width: 60%
|
||||
|
||||
#. When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the System tab.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup4.png
|
||||
.. figure:: /_static/images/config/backup4.png
|
||||
:width: 60%
|
||||
|
||||
@@ -23,21 +23,21 @@ Setup Network Folder
|
||||
|
||||
#. On the rsync tab, under File Services -> turn on rsync protocol.
|
||||
|
||||
#. In the same dropdown, under "Note" will be "PC (Windows Explorer): \". This DeviceAddressName is the "Hostname" within the Embassy New Shared Folder dialog, and note that it is case sensitive and that the \ have been removed.
|
||||
#. In the same dropdown, under "Note" will be "PC (Windows Explorer): \". This DeviceAddressName is the "Hostname" within the StartOS New Network Folder dialog, and note that it is case sensitive and that the \ characters have been removed.
|
||||
|
||||
#. Back in Synonogy UI, click "File Station" and navigate so that you can see the the desired destination folder. Right click the folder, then *Properties > General*. Next to "Location" will be a folder location of the format ///, the / portion (so without the volume label) is the "Path" within the Embassy New Shared Folder dialog.
|
||||
#. Back in Synonogy UI, click "File Station" and navigate so that you can see the the desired destination folder. Right click the folder, then *Properties > General*. Next to "Location" will be a folder location of the format ///, the / portion (so without the volume label) is the "Path" within the StartOS New Network Folder dialog.
|
||||
|
||||
Connect Embassy
|
||||
Connect StartOS
|
||||
---------------
|
||||
|
||||
#. Go to *System > Create Backup*.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Open".
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup0.png
|
||||
.. figure:: /_static/images/config/backup0.png
|
||||
:width: 60%
|
||||
|
||||
#. Fill in the following fields:
|
||||
@@ -47,7 +47,7 @@ Connect Embassy
|
||||
* Username - This is the user on the remote machine that you used to create the shared directory
|
||||
* Password - This is your user (from above) password
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup1.png
|
||||
.. figure:: /_static/images/config/backup1.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Save".
|
||||
|
||||
@@ -73,17 +73,17 @@ Setup Network Folder
|
||||
Off to the right-hand side, *Permissions Type* should be set to "Basic" and *Permissions* should be set to "Full Control".
|
||||
Click **SAVE**
|
||||
|
||||
Connect Embassy
|
||||
Connect StartOS
|
||||
---------------
|
||||
|
||||
#. Go to *System > Create Backup*.
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Open".
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup0.png
|
||||
.. figure:: /_static/images/config/backup0.png
|
||||
:width: 60%
|
||||
|
||||
#. Fill in the following fields:
|
||||
|
||||
@@ -8,7 +8,7 @@ Windows Network Folder
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Windows machine (or attached drive), such that you may create encrypted, private backups of all your Embassy data.
|
||||
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Windows machine (or attached drive), such that you may create encrypted, private backups of all your StartOS data.
|
||||
|
||||
.. youtube:: wqbXRjttJQY
|
||||
:width: 100%
|
||||
@@ -48,22 +48,22 @@ Setup Network Folder
|
||||
.. figure:: /_static/images/cifs/cifs-win5.png
|
||||
:width: 60%
|
||||
|
||||
Connect Embassy
|
||||
Connect StartOS
|
||||
---------------
|
||||
|
||||
#. Return to your EmbassyUI, and go to *System > Create Backup*
|
||||
#. Return to your StartOS UI, and go to *System > Create Backup*
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup.png
|
||||
.. figure:: /_static/images/config/backup.png
|
||||
:width: 60%
|
||||
|
||||
#. Click "Open" to set up a new connection to your Shared Folder
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup0.png
|
||||
.. figure:: /_static/images/config/backup0.png
|
||||
:width: 60%
|
||||
|
||||
#. Fill out the following fields as shown below:
|
||||
|
||||
.. figure:: /_static/images/config/embassy_backup1.png
|
||||
.. figure:: /_static/images/config/backup1.png
|
||||
:width: 60%
|
||||
|
||||
- For "Hostname" - Enter your Windows computer name (this is shown after a ``\\`` in Windows)
|
||||
@@ -74,10 +74,10 @@ Connect Embassy
|
||||
If you use a "PIN" to log in to Windows, keep in mind that your password needs to be the user's full password, NOT the PIN! Office365 accounts also may **not** work, try a regular user in this case.
|
||||
|
||||
.. tip::
|
||||
If you recieve the following error:
|
||||
If you receive the following error:
|
||||
|
||||
**Filesystem I/O Error mount error(115): Operation now in progress**
|
||||
|
||||
Click Start > Settings > Network & Internet > Ethernet (or WiFi) and select the "Private" profile to treat your LAN as a trusted network that allows file sharing.
|
||||
|
||||
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Embassy data to your Windows machine or external drive!!
|
||||
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your server data to your Windows machine or external drive!!
|
||||
|
||||
@@ -19,7 +19,7 @@ In addition to the safe-keeping of a good master password, maintaining good back
|
||||
:class: large-5
|
||||
:anchor: Backup
|
||||
|
||||
Create an encrypted backup of your Embassy data.
|
||||
Create an encrypted backup of your server data.
|
||||
|
||||
.. topic-box::
|
||||
:title: Restore From Backup
|
||||
@@ -28,7 +28,7 @@ In addition to the safe-keeping of a good master password, maintaining good back
|
||||
:class: large-5
|
||||
:anchor: Restore
|
||||
|
||||
Restore your Embassy data from a previous backup.
|
||||
Restore your server data from a previous backup.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
Connecting Over LAN
|
||||
===================
|
||||
|
||||
Whenever you are connected the same Local Area Network (LAN) as your Embassy (i.e. the same WiFi network), it is best to access your Embassy's LAN Address (.local URL). LAN connections are fast and secure and do not even require Internet access!
|
||||
Whenever you are connected the same Local Area Network (LAN) as your Start9 server (i.e. the same WiFi network), it is best to access your Start9 server's LAN Address (.local URL). LAN connections are fast and secure and do not even require Internet access!
|
||||
|
||||
.. note:: Your Embassy creates its own Certificate Authority (CA) to establish trust with client devices.
|
||||
.. note:: StartOS creates its own Certificate Authority (CA) to establish trust with client devices.
|
||||
|
||||
Download Root CA
|
||||
----------------
|
||||
|
||||
First, download your Embassy's Root CA. There are two way to accomplish this:
|
||||
First, download your Start9 server's Root CA. There are two way to accomplish this:
|
||||
|
||||
Option 1
|
||||
........
|
||||
@@ -23,21 +23,21 @@ Option 2
|
||||
|
||||
Navigate to *System > LAN*, then click "Download Certificate".
|
||||
|
||||
.. figure:: /_static/images/ssl/embassy_lan_setup.png
|
||||
.. figure:: /_static/images/ssl/lan_setup.png
|
||||
:width: 60%
|
||||
:alt: LAN setup menu item
|
||||
|
||||
Trust Root CA
|
||||
-------------
|
||||
|
||||
First, instruct your **operating system** to trust your Embassy's Root CA.
|
||||
First, instruct your **operating system** to trust your Start9 server's Root CA.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-os/index
|
||||
|
||||
Then instruct your **browser** to trust your Embassy's Root CA.
|
||||
Then instruct your **browser** to trust your Start9 server's Root CA.
|
||||
|
||||
.. note:: On a Mac - this is only necessary on Firefox. Brave, Chrome and Safari will already work.
|
||||
|
||||
@@ -46,14 +46,14 @@ Then instruct your **browser** to trust your Embassy's Root CA.
|
||||
|
||||
lan-browser/index
|
||||
|
||||
**OPTIONAL**: Setup client integrations for Embassy Services (such as Nextcloud).
|
||||
**OPTIONAL**: Setup client integrations for StartOS Services (such as Nextcloud).
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-integrations/index
|
||||
|
||||
Access your Embassy LAN Address
|
||||
-------------------------------
|
||||
Access your Start9 server's LAN Address
|
||||
---------------------------------------
|
||||
|
||||
With the Root CA downloaded and trusted by both your operating system and your browser, you can now visit your Embassy's LAN Address (.local URL) over secure https. Any service that offers a LAN URL will also be securely accessible!
|
||||
With the Root CA downloaded and trusted by both your operating system and your browser, you can now visit your Start9 server's LAN Address (.local URL) over secure https. Any service that offers a LAN URL will also be securely accessible!
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
Trust CA - Browser
|
||||
==================
|
||||
|
||||
Instruct your **browser** to trust your Embassy's Root CA.
|
||||
Instruct your **browser** to trust your Start9 server's Root CA.
|
||||
|
||||
On Mac, you only need to instruct Firefox to trust your Embassy's Root CA. The other three browsers listed below will work already.
|
||||
On Mac, you only need to instruct Firefox to trust your Start9 server's Root CA. The other three browsers listed below will work already.
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-chrome-brave:
|
||||
|
||||
==========================================
|
||||
Trust Embassy CA in Chrome / Brave Browser
|
||||
==========================================
|
||||
=================================================
|
||||
Trusting Your Start9 CA in Chrome / Brave Browser
|
||||
=================================================
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing.
|
||||
|
||||
@@ -36,13 +36,13 @@ Trust Embassy CA in Chrome / Brave Browser
|
||||
:width: 60%
|
||||
:alt: Certificate Authorities
|
||||
|
||||
#. If you see "org-Start9" with a trusted “Embassy Local Root CA” listed under it, your work is already done. Open a new tab and visit your Embassy's address. The browser shouldn't give any warning pages about the certificate anymore. If it still does, quit and restart the browser using `Menu > Exit`.
|
||||
#. If you see "org-Start9" with a trusted “<custom-address> Local Root CA” listed under it, your work is already done. Open a new tab and visit your Start9 server's ``.local`` address. The browser shouldn't give any warning pages about the certificate anymore. If it still does, quit and restart the browser using `Menu > Exit`.
|
||||
|
||||
#. If you do not see "org-Start9" in the list, click "Import" and open the downloaded "Embassy Local Root CA.crt" file on your device.
|
||||
#. If you do not see "org-Start9" in the list, click "Import" and open the downloaded "<custom-address> Local Root CA.crt" file on your device.
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/chrome_authorities.png
|
||||
:width: 60%
|
||||
:alt: Chrome / Brave Import "Embassy Local Root CA.crt"
|
||||
:alt: Chrome / Brave Import "<custom-address>.crt"
|
||||
|
||||
#. Check the box for "Trust this certificate for identifying websites" and click "OK".
|
||||
|
||||
@@ -89,7 +89,7 @@ Trust Embassy CA in Chrome / Brave Browser
|
||||
:width: 40%
|
||||
:alt: Windows Certificates CA Cert Import Step 3
|
||||
|
||||
#. Navigate to the location of and select your previously dowloaded `Embassy Local CA.crt` file, and click `Open`
|
||||
#. Navigate to the location of and select your previously downloaded `<custom-address>.crt` file, and click `Open`
|
||||
|
||||
.. figure:: /_static/images/ssl/windows/windows_certificates_caimport_step4.jpg
|
||||
:width: 40%
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-ff:
|
||||
|
||||
==============================
|
||||
Trusting Embassy CA in Firefox
|
||||
==============================
|
||||
==================================
|
||||
Trusting Your Start9 CA in Firefox
|
||||
==================================
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _lan-safari:
|
||||
|
||||
=============================
|
||||
Trusting Embassy CA In Safari
|
||||
=============================
|
||||
=================================
|
||||
Trusting Your Start9 CA In Safari
|
||||
=================================
|
||||
|
||||
Once you have completed the :ref:`lan-os` steps on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now securely navigate to the LAN address for your Embassy!
|
||||
Once you have completed the :ref:`lan-os` steps on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now securely navigate to the LAN address for your Start9 server!
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Trust CA - Integrations
|
||||
=======================
|
||||
|
||||
Instruct your end-user **application** to trust your Embassy's Root CA.
|
||||
Instruct your end-user **application** to trust your Start9 server's Root CA.
|
||||
|
||||
Certain services (such as NextCloud) offer file sync, calendar/contacts sync, or other connectivity you may want to use via a desktop or mobile application. Select from the list below for supported applications.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-thunderbird:
|
||||
|
||||
==================================
|
||||
Trusting Embassy CA in Thunderbird
|
||||
==================================
|
||||
======================================
|
||||
Trusting Your Start9 CA in Thunderbird
|
||||
======================================
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing. Take special note of the Thunderbird-specific instructions there.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Trust CA - OS
|
||||
=============
|
||||
|
||||
Instruct your **operating system** to trust your Embassy's Root CA.
|
||||
Instruct your **operating system** to trust your Start9 server's Root CA.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-android:
|
||||
|
||||
==============================
|
||||
Trusting Embassy CA on Android
|
||||
==============================
|
||||
==================================
|
||||
Trusting Your Start9 CA on Android
|
||||
==================================
|
||||
|
||||
.. note:: This will work on most Android phones running Android v13+, as well as phones running CalyxOS, GrapheneOS or LineageOS (v19+).
|
||||
|
||||
@@ -10,7 +10,7 @@ Trusting Embassy CA on Android
|
||||
|
||||
.. group-tab:: Android v13+
|
||||
|
||||
Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your "Embassy Local Root CA" certificate.
|
||||
Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your "<custom-address> Local Root CA" certificate.
|
||||
|
||||
.. figure:: /_static/images/ssl/android/droidLAN2.png
|
||||
:width: 30%
|
||||
@@ -20,7 +20,7 @@ Trusting Embassy CA on Android
|
||||
|
||||
.. tip:: Some phones running Android v12 will work, others won't. It depends on the vendor. Most Androids running v12 that we have tested do work with the exception of the Samsung Galaxy S10 which does not.
|
||||
|
||||
Tap **Settings > Security > Advanced > Encryption and Credentials > Install from Storage** and select your "Embassy Local Root CA" certificate.
|
||||
Tap **Settings > Security > Advanced > Encryption and Credentials > Install from Storage** and select your "<custom-address> Local Root CA" certificate.
|
||||
|
||||
.. figure:: /_static/images/ssl/android/droidLAN0.png
|
||||
:width: 30%
|
||||
|
||||
@@ -68,7 +68,7 @@ This applies to iOS v15 and v16. For older versions, see the `v14 guide </0.3.1
|
||||
:width: 20%
|
||||
:alt: Certificate trust settings
|
||||
|
||||
#. Under "Enable full trust for root certificates", enable your "adjective-noun Local Root CA".
|
||||
#. Under "Enable full trust for root certificates", enable your "<custom-address> Local Root CA".
|
||||
|
||||
.. figure:: /_static/images/ssl/ios/trust_2.png
|
||||
:width: 20%
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
.. _lan-linux-system:
|
||||
|
||||
============================
|
||||
Trusting Embassy CA on Linux
|
||||
============================
|
||||
================================
|
||||
Trusting Your Start9 CA on Linux
|
||||
================================
|
||||
|
||||
Here we will insert your Embassy's CA certificate into Linux's trust store to ensure that applications will trust your Embassy's services.
|
||||
Here we will insert your Start9 server's CA certificate into Linux's trust store to ensure that applications will trust your Start9 server's services.
|
||||
|
||||
.. tabs::
|
||||
|
||||
@@ -20,7 +20,7 @@ Here we will insert your Embassy's CA certificate into Linux's trust store to en
|
||||
|
||||
sudo apt install -y ca-certificates p11-kit
|
||||
|
||||
.. note:: For each Mozilla-based application you plan on using, in order for them to trust your Embassy's CA certificate directly from your Linux distribution's certificate trust store, execute the following command(s):
|
||||
.. note:: For each Mozilla-based application you plan on using, in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store, execute the following command(s):
|
||||
|
||||
|
||||
If you use Firefox:
|
||||
@@ -53,34 +53,34 @@ Here we will insert your Embassy's CA certificate into Linux's trust store to en
|
||||
|
||||
mv ~/.pki ~/.pki.mozilla-old
|
||||
|
||||
Finally, we will change directory to the folder where you downloaded your Embassy's Root CA (usually `~/Downloads`), and run the following commands to add your Embassy's CA certificate to the OS trust store:
|
||||
Finally, we will change directory to the folder where you downloaded your Start9 server's Root CA (usually `~/Downloads`), and run the following commands to add your Start9 server's CA certificate to the OS trust store:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cd ~/Downloads
|
||||
sudo cp "Embassy Local CA.crt" /usr/local/share/ca-certificates/
|
||||
sudo cp "<custom-address>.crt" /usr/local/share/ca-certificates/
|
||||
sudo update-ca-certificates
|
||||
|
||||
In the output it should say ``1 added`` if it was successful.
|
||||
|
||||
.. group-tab:: Arch/Garuda
|
||||
|
||||
From the folder you have downloaded your Embassy's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo pacman -S ca-certificates
|
||||
sudo cp "Embassy Local CA.crt" /etc/ca-certificates/trust-source/anchors/
|
||||
sudo cp "<custom-address>.crt" /etc/ca-certificates/trust-source/anchors/
|
||||
sudo update-ca-trust
|
||||
|
||||
Despite no output from the last command, you can test your app right away.
|
||||
|
||||
.. group-tab:: CentOS/Fedora
|
||||
|
||||
From the folder you have downloaded your Embassy's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo yum install ca-certificates
|
||||
sudo cp "Embassy Local CA.crt" /etc/pki/ca-trust/source/anchors/
|
||||
sudo cp "<custom-address>.crt" /etc/pki/ca-trust/source/anchors/
|
||||
sudo update-ca-trust
|
||||
@@ -1,10 +1,10 @@
|
||||
.. _lan-mac:
|
||||
|
||||
==========================
|
||||
Trusting Embassy CA on Mac
|
||||
==========================
|
||||
==============================
|
||||
Trusting Your Start9 CA on Mac
|
||||
==============================
|
||||
|
||||
#. In your Embassy, head to *System* -> *Lan* -> click *Download Certificate* and save it to your Mac.
|
||||
#. In your Start9 server's UI, navigate to *System* -> *Lan* -> click *Download Certificate* and save it to your Mac.
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/mac-lan-setup0.png
|
||||
:width: 60%
|
||||
@@ -29,7 +29,7 @@ Trusting Embassy CA on Mac
|
||||
|
||||
.. note:: If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it.
|
||||
|
||||
#. Navigate to the "System" tab on the left, find the certificate, which is usually named as your server's unique "adjective-noun.local", and double click on this certificate. A second window will pop up.
|
||||
#. Navigate to the "System" tab on the left, find the certificate named "<custom-address> Local Root CA", and double click on this certificate. A second window will pop up.
|
||||
|
||||
#. Open the "Trust" dropdown and select "Always Trust" from the dropdown next to "When using this certificate".
|
||||
|
||||
@@ -39,12 +39,12 @@ Trusting Embassy CA on Mac
|
||||
|
||||
#. Close this window and enter your password to apply the settings.
|
||||
|
||||
#. The "Embassy Local Root CA" cert will now read "This certificate is marked as trusted for all users" in Keychain Access.
|
||||
#. The "<custom-address> Local Root CA" cert will now read "This certificate is marked as trusted for all users" in Keychain Access.
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/certificate_trusted.png
|
||||
:width: 60%
|
||||
:alt: Keychain menu trusted certificate
|
||||
|
||||
No additional setup is required for most browsers and you will now be able to safely connect to your Embassy over LAN.
|
||||
No additional setup is required for most browsers and you will now be able to safely connect to your Start9 server over LAN.
|
||||
|
||||
For Firefox, you will need to follow :ref:`these <lan-ff>` instructions.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-windows:
|
||||
|
||||
======================
|
||||
Trusting CA On Windows
|
||||
======================
|
||||
==================================
|
||||
Trusting Your Start9 CA On Windows
|
||||
==================================
|
||||
|
||||
Unfortunately, Windows does not have mDNS alias support built-in, which is necessary in order to visit .local addresses for any service you install on your Start9 server, so we recommend using the Bonjour service. Check out this :ref:`FAQ answer<why-bonjour>` for details.
|
||||
|
||||
@@ -86,6 +86,6 @@ Unfortunately, Windows does not have mDNS alias support built-in, which is neces
|
||||
:width: 90%
|
||||
:alt: Successful cert install
|
||||
|
||||
Your server's unique `adjective-noun Local Root CA` is now imported into Certificate folder
|
||||
Your server's unique `<custom-address> Local Root CA` is now imported into Certificate folder
|
||||
|
||||
#. You can save the settings to the console if desired, or not by pressing `Yes` or `No`. The CA certificate will remain imported to the CA certificate store either way.
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
Connecting Over Tor
|
||||
===================
|
||||
|
||||
You can connect to your Embassy from anywhere in the world, privately and anonymously, by using its unique Tor Address (.onion URL).
|
||||
You can connect to your Start9 server from anywhere in the world, privately and anonymously, by using its unique Tor Address (``.onion`` URL).
|
||||
|
||||
.. note:: Tor connection can sometimes be unreliable and have higher latency than normal internet connections.
|
||||
|
||||
Using Firefox
|
||||
-------------
|
||||
|
||||
.. tip:: This is recommended way to connect to your Embassy over Tor, but it requires some additional steps.
|
||||
.. tip:: This is the recommended way to connect to your Start9 server over Tor, but it requires some additional steps.
|
||||
|
||||
#. Run Tor (**not Tor Browser**) in the background on your connecting device.
|
||||
|
||||
@@ -20,7 +20,7 @@ Using Firefox
|
||||
|
||||
tor-os/index
|
||||
|
||||
#. Configure Firefox to handle *.onion* URLs.
|
||||
#. Configure Firefox to handle *``.onion``* URLs.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -31,7 +31,7 @@ Using Firefox
|
||||
Using TorBrowser
|
||||
-------------------
|
||||
|
||||
.. caution:: Tor Browser will allow you to use your Embassy's .onion URL without any manual configuration, however *all* connections are proxied via Tor, so you will not be able to access your Embassy's .local LAN address with it. `Using Firefox <#using-firefox>`_ is recommended over TorBrowser.
|
||||
.. caution:: Tor Browser will allow you to use your Start9 server's ``.onion`` URL without any manual configuration, however *all* connections are proxied via Tor, so you will not be able to access your Start9 server's ``.local`` LAN address with it. `Using Firefox <#using-firefox>`_ is recommended over TorBrowser.
|
||||
|
||||
* Linux, Mac, Windows, Android
|
||||
|
||||
|
||||
@@ -60,4 +60,4 @@ Once Tor is setup on your system, you can proceed to setup Firefox:
|
||||
|
||||
#. Optional but recommended: search for ``network.http.referer.hideOnionsSource`` and set the value to ``true``.
|
||||
|
||||
#. Restart Firefox, and you're all set! You should now be able to navigate to `.onion` URLs in Firefox. This means you can bookmark Cups Messenger, or other Embassy ``.onion`` addresses, as well as use the :ref:`Bitwarden<vaultwarden-service>` browser extension.
|
||||
#. Restart Firefox, and you're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can bookmark Cups Messenger, or other Start9 services' ``.onion`` addresses, as well as use the :ref:`Bitwarden<vaultwarden-service>` browser extension.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Tor - OS
|
||||
========
|
||||
|
||||
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Embassy with remotely.
|
||||
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Start9 server with remotely.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -26,7 +26,7 @@ Connecting
|
||||
:class: large-5
|
||||
:anchor: Setup
|
||||
|
||||
Leverage Tor to connect to your Embassy privately and anonymously from anywhere in the world.
|
||||
Leverage Tor to connect to your Start9 server privately and anonymously from anywhere in the world.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -8,10 +8,10 @@ Customize
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Name Your Device
|
||||
----------------
|
||||
Custom Browser Tab Title
|
||||
------------------------
|
||||
|
||||
#. Go to *System > Set Device Name*.
|
||||
#. Go to *System > Browser Tab Title*.
|
||||
|
||||
.. figure:: /_static/images/config/basic-config1.png
|
||||
:width: 60%
|
||||
@@ -21,4 +21,4 @@ Name Your Device
|
||||
|
||||
.. figure:: /_static/images/config/basic-config2.png
|
||||
:width: 60%
|
||||
:alt: Rename Embassy
|
||||
:alt: Custom browser tab
|
||||
|
||||
@@ -11,7 +11,7 @@ Dashboard Overview
|
||||
Connection Status
|
||||
-----------------
|
||||
|
||||
In the bottom left of your screen you can monitor whether or not you are connected to your Embassy.
|
||||
In the bottom left of your screen you can monitor whether or not you are connected to your server.
|
||||
|
||||
When connected it will look like this:
|
||||
|
||||
@@ -57,7 +57,7 @@ Use this tab to update services. A green icon will appear next to this tab when
|
||||
Notifications Tab
|
||||
-----------------
|
||||
|
||||
Notifications issued by embassyOS will appear in this tab. You can delete these notifications individually or all at once by clicking "Delete All".
|
||||
Notifications issued by StartOS will appear in this tab. You can delete these notifications individually or all at once by clicking "Delete All".
|
||||
|
||||
.. figure:: /_static/images/walkthrough/notiftab.png
|
||||
:width: 60%
|
||||
@@ -66,7 +66,7 @@ Notifications issued by embassyOS will appear in this tab. You can delete these
|
||||
System Tab
|
||||
-----------
|
||||
|
||||
Use this tab to customize and manage your Embassy.
|
||||
Use this tab to customize and manage StartOS.
|
||||
|
||||
.. figure:: /_static/images/walkthrough/systemtab.png
|
||||
:width: 60%
|
||||
@@ -76,7 +76,7 @@ Read below for a summary of each section within the System Tab.
|
||||
Backups
|
||||
=======
|
||||
|
||||
The Backups section allows you to create and restore :ref:`Embassy backups <backups>`.
|
||||
The Backups section allows you to create and restore :ref:`StartOS backups <backups>`.
|
||||
|
||||
Manage
|
||||
======
|
||||
@@ -86,7 +86,7 @@ The Manage section gives you access to :ref:`updating-eos`, Software Updates, De
|
||||
Insights
|
||||
========
|
||||
|
||||
The Insights section gives you basic information on your Embassy, monitoring of system resources / temperature, and logs for debugging.
|
||||
The Insights section gives you basic information on your your server, monitoring of system resources / temperature, and logs for debugging.
|
||||
|
||||
Support
|
||||
=======
|
||||
@@ -103,19 +103,19 @@ Power
|
||||
* **Restart**
|
||||
|
||||
* Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
|
||||
* A gentle *bep* will sound when the Embassy is powered back on.
|
||||
* A *chime* will sound when the Embassy is ready to use. Please be patient as a Restart will take some time.
|
||||
* A gentle *bep* will sound when the server is powered back on.
|
||||
* A *chime* will sound when the server is ready to use. Please be patient as a Restart will take some time.
|
||||
|
||||
* **Shutdown**
|
||||
|
||||
.. caution:: After a shutdown, the *only* way to turn your Embassy back on is to unplug it and plug it back in. As such, we do not recommend shutting down your Embassy when you are not physically near it. Instead, you should use the restart option.
|
||||
.. caution:: After a shutdown, the *only* way to turn your server back on is to unplug it and plug it back in. As such, we do not recommend shutting down your server when you are not physically near it. Instead, you should use the restart option.
|
||||
|
||||
* Be patient while services shut down, it may take some minutes. A *tune* will play, indicating the shutdown is complete.
|
||||
* It is now safe to unplug the Embassy from power and the ethernet cable, if connected.
|
||||
* It is now safe to unplug your server from power and the ethernet cable, if connected.
|
||||
|
||||
* **System Rebuild**
|
||||
|
||||
This action will tear down all service containers and rebuild them from scratch. No data will be deleted. This action is useful if your system gets into a bad state, and it should only be performed if you are experiencing general performance or reliability issues. It may take multiple minutes to complete. During this time, you will lose all connectivity to your Embassy.
|
||||
This action will tear down all service containers and rebuild them from scratch. No data will be deleted. This action is useful if your system gets into a bad state, and it should only be performed if you are experiencing general performance or reliability issues. It may take multiple minutes to complete. During this time, you will lose all connectivity to your server.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -4,10 +4,10 @@
|
||||
Android
|
||||
=======
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`lan-android` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-android` - Run Tor natively (in the background) on your Android device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`lan-android` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-android` - Run Tor natively (in the background) on your Android device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
|
||||
* :ref:`torff-android` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
iOS
|
||||
===
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`lan-ios` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-ios` - Run Tor natively (in the background) on your iOS device. This will allow you to use applications on your device via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`lan-ios` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-ios` - Run Tor natively (in the background) on your iOS device. This will allow you to use applications on your device via the Tor Network so they can communicate with your Start9 server.
|
||||
|
||||
@@ -4,10 +4,10 @@
|
||||
Linux
|
||||
=====
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`tor-linux` - Run Tor natively (in the background) on your Linux machine. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`tor-linux` - Run Tor natively (in the background) on your Linux machine. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
|
||||
* :ref:`torff-linux` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
|
||||
* :ref:`backup-linux` - Configure a Network Folder on your Linux machine (or an attached external drive) for Embassy backups.
|
||||
* :ref:`backup-linux` - Configure a Network Folder on your Linux machine (or an attached external drive) for StartOS backups.
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
Mac
|
||||
===
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
|
||||
* :ref:`lan-mac` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-mac` - Run Tor natively (in the background) on your Mac. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`lan-mac` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-mac` - Run Tor natively (in the background) on your Mac. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
|
||||
* :ref:`torff-mac` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
|
||||
* :ref:`backup-mac` - Configure a Network Folder on your Mac (or an attached external drive) for Embassy backups.
|
||||
* :ref:`backup-mac` - Configure a Network Folder on your Mac (or an attached external drive) for StartOS backups.
|
||||
|
||||
Screensharing
|
||||
_____________
|
||||
|
||||
@@ -4,11 +4,11 @@
|
||||
Windows
|
||||
=======
|
||||
|
||||
To optimize your device for use with your Embassy, it is recommended to complete all of the following guides.
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices.
|
||||
|
||||
* :ref:`lan-windows` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-windows` - Run Tor natively (in the background) on your Windows computer. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Embassy.
|
||||
* :ref:`lan-windows` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
|
||||
* :ref:`tor-windows` - Run Tor natively (in the background) on your Windows computer. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
|
||||
* :ref:`torff-windows` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
|
||||
* :ref:`backup-windows` - Configure a Network Folder on your Windows computer (or an attached external drive) for Embassy backups.
|
||||
* :ref:`backup-windows` - Configure a Network Folder on your Windows computer (or an attached external drive) for StartOS backups.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Device Guides
|
||||
=============
|
||||
|
||||
Guides to get connected with or improve your Embassy by device-type.
|
||||
Guides to get connected with or improve your Start9 server experience by device-type.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
@@ -8,4 +8,4 @@ iOS
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
iOS has no known limitations in regard to Embassy.
|
||||
iOS has no known limitations in regard to StartOS.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user