mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
Big refactor, many minor fixes (#441)
* Big refactor, many minor fixes * Link fixes, icon edits * Index and ToC fixes * update icons in theme lib and add to device guides index * WIP - refactor Initial setup, LAN, FF, others * First draft ready, many fixes and edits * Ooops - minor edits and changes on initial setup * Add change password guide (try 2). * Remove change password menu item from guides * Fix display bug, think different --------- Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Co-authored-by: gStart9 <george@start9labs.com>
This commit is contained in:
kn0wmad
@@ -3,28 +3,24 @@
|
||||
=============
|
||||
Common Issues
|
||||
=============
|
||||
Sometimes things don't go as planned. Check here for solutions to common problems with StartOS.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Sometimes things don't go as planned. Check here for solutions to common problems with StartOS.
|
||||
|
||||
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 `Contact us <https://start9.com/contact>`_ for assistance.
|
||||
|
||||
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 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 "start.local".
|
||||
----------------------------------------------------------------
|
||||
|
||||
* Confirm that the server is plugged into both power and Ethernet.
|
||||
|
||||
* Confirm the the server emitted two :ref:`sounds<sounds>` when powering on: a bep and a chime.
|
||||
@@ -37,7 +33,6 @@ If you still cannot connect, try logging into your router (the directions for wh
|
||||
|
||||
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 my server via its xxxxxxxxxxxxxxxxxx.onion (Tor) address
|
||||
@@ -48,8 +43,8 @@ I am unable to reach my server via its xxxxxxxxxxxxxxxxxx.onion (Tor) address
|
||||
#. **If Tor Browser works** - It means the issue is either with the Tor daemon on your device or with the browser settings.
|
||||
|
||||
#. **Solutions**
|
||||
#. 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 you are not yet running a Tor daemon on your device, follow :ref:`these instructions <connecting-tor>`. 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 <connecting-ff>` to work with .onion URLs.
|
||||
|
||||
#. **If Tor Browser does not work** - It means there is an issue with your server or with the Tor network.
|
||||
|
||||
@@ -67,5 +62,58 @@ I am unable to reach my server via its xxxxxxxxxxxxxxxxxx.onion (Tor) address
|
||||
|
||||
I'm having an issue with a particular Service
|
||||
---------------------------------------------
|
||||
|
||||
If a Service is crashing or acting up in some way, check the :ref:`Documentation<service-guides>` and :ref:`FAQ<faq-services>` for that particular Service. You can also check the "Logs" (on the service page), which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels <https://start9.com/contact>`_ for immediate assistance.
|
||||
|
||||
.. _sounds-bepchime:
|
||||
|
||||
Server Models With Speakers
|
||||
---------------------------
|
||||
Server Lite, Server Pure, and Server One (2022 and older) have an internal speaker and may provide the following audio feedback:
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEP.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "bep" - 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" - Server is ready
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/FLATLINE.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* "flatline" - Server initialization failed / no network connection
|
||||
|
||||
.. raw:: HTML
|
||||
|
||||
<audio controls>
|
||||
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
|
||||
Your browser does not support the audio element.
|
||||
</audio>
|
||||
|
||||
* Beethoven's 5th - Something has gone wrong and Diagnostic Mode has been launched on ``http://start.local``, please check here for solutions.
|
||||
|
||||
Raspberry Pi Lights
|
||||
-------------------
|
||||
Server Lite has 2 status lights:
|
||||
|
||||
- Red - Power. This will be on solid when powered up and running normally.
|
||||
- Green - SD Card. This will display when there is SD Card activity, such as during OS installation. It may be off, flashing, or on solid during normal operation.
|
||||
|
||||
Server One (2022) has 2 additional lights:
|
||||
|
||||
- Blue power button - Power. This will be on solid when powered up and running normally.
|
||||
- Blue drive light - SSD. This will display when there is SSD activity. It may be off, flashing, or on solid during normal operation.
|
||||
|
||||
45
site/source/support/concepts/bitcoin-lightning.rst
Normal file
45
site/source/support/concepts/bitcoin-lightning.rst
Normal file
@@ -0,0 +1,45 @@
|
||||
.. _bitcoin-lightning:
|
||||
|
||||
=====================
|
||||
Bitcoin and Lightning
|
||||
=====================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _bitcoin:
|
||||
|
||||
Bitcoin
|
||||
-------
|
||||
Bitcoin is a revolutionary piece of software that allows users to exchange value all over the world, without the permission of a third party. Entire web sites, books, podcasts, and other resources exist on Bitcoin. A fantastic compilation of resources can be found `here <https://lopp.net/bitcoin>`_.
|
||||
|
||||
.. _bitcoin-node:
|
||||
|
||||
Bitcoin Node
|
||||
------------
|
||||
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>`_.
|
||||
|
||||
.. _btc-wallets:
|
||||
|
||||
Bitcoin Wallets
|
||||
---------------
|
||||
The word "wallet" has come to mean a lot of things in Bitcoin world, depending on who you ask and what software you are using. There are (1) software "wallets", (2) hardware "wallets", (3) seed "wallets", and (4) branch "wallets".
|
||||
|
||||
(1) SOFTWARE WALLETS - (such as FullyNoded and Specter) Software applications capable of interfacing with hardware wallets (see below), interfacing with one or more nodes, as well as address creation, transaction creation, transaction broadcasting, and transaction display. Most software wallets are also capable of creating and storing public/private keypairs, granting them properties of both hardware wallets (see below) and seed wallets (see below). When we say "wallet", we are referring to software applications that possess a user interface for interacting with the Bitcoin network. If a wallet is capable of creating, storing and using private keys, it should be referred to as just a wallet with signer ability.
|
||||
|
||||
(2) HARDWARE WALLETS - (such as ColdCard and Trezor) Physical devices that create and store public/private keypairs, exporting the public keys, NEVER exporting the private keys, and using the private keys to sign transactions on demand. Hardware wallets must interface with a software wallet in order to be useful to a user. For this reason, some have proposed renaming hardware wallets to "hardware signers" for clarity.
|
||||
|
||||
(3) SEED WALLETS - Basically just the root of a hierarchical deterministic tree of keypairs. It usually takes the form of a mnemonic phrase of 12 or 24 words. Why people refer to their mnemonic seed as a "wallet" is confusing. Just call it a seed.
|
||||
|
||||
(4) BRANCH WALLETS - This is how Specter uses the word wallet, and it is causing a lot of confusion. Whenever you create a new "wallet" in specter, you are actually creating a new hierarchical deterministic branch of your mnemonic seed - or in the case of multisig, multiple seeds. The branch you create can be based on "purpose" (segwit, non-segwit, single-sig, multi-sig, etc), "coin type" (Bitcoin, Dogecoin, etc), or "account" (for personal accounting). Change any of these parameters, and you have yourself a new wallet, which again is just a different branch of the same mnemonic seed that potentially abides by a different set of rules. Perhaps a better name for this concept is "bank". Instead of "wallets", you should be able to create different "banks" from your seed.
|
||||
|
||||
.. _lightning-network:
|
||||
|
||||
Lightning Network
|
||||
-----------------
|
||||
The Lightning Network is a "payment layer" that sits on top of the Bitcoin blockchain, which it uses for final settlement. This allows Bitcoin to scale without affecting the security of the protocol layer. It is easiest to think of Lightning Network as a system that allows anyone to use their Bitcoin to have a running tab (think bar tab) of money they owe each other. For example, 2 friends may have a "channel" (tab) between them that they use for exchanging value. The channel keeps track of who owes what. Those payments can be settled at any time on the Bitcoin blockchain if either or both parties decide to close out. One big incentive to use Lightning is that payments are extremely fast and fees are extremely low. Check out this `introductory video explanation <https://www.youtube.com/watch?v=rrr_zPmEiME>`_.
|
||||
|
||||
`Learn more about Lightning <https://lopp.net/lightning>`_.
|
||||
18
site/source/support/concepts/index.rst
Normal file
18
site/source/support/concepts/index.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
.. _concepts:
|
||||
|
||||
========
|
||||
Concepts
|
||||
========
|
||||
|
||||
An overview of the ideas and technologies surrounding Start9 and StartOS.
|
||||
|
||||
`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
|
||||
|
||||
open-source
|
||||
networks
|
||||
self-hosting
|
||||
start9-startos
|
||||
bitcoin-lightning
|
||||
93
site/source/support/concepts/networks.rst
Normal file
93
site/source/support/concepts/networks.rst
Normal file
@@ -0,0 +1,93 @@
|
||||
.. _networks:
|
||||
|
||||
========
|
||||
Networks
|
||||
========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _lan:
|
||||
|
||||
LAN
|
||||
---
|
||||
A Local Area Network (LAN) is a computer network that interconnects computers within a limited area such as a residence, school, laboratory, university campus, or office building.
|
||||
|
||||
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.
|
||||
|
||||
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, 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 StartOS, **you** are the CA, and **you** sign your own certificate. No third party required!
|
||||
|
||||
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 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 ``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.
|
||||
|
||||
.. _ssl:
|
||||
|
||||
SSL
|
||||
---
|
||||
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.
|
||||
|
||||
SSL certificates are what enable websites to move from HTTP to HTTPS, which increases security and makes browsers happy (a happy 'green lock' icon, instead of an angry 'red unlocked' one in the URL bar). Using the Secure Sockets Layer protocol, HTTPS enabled websites use certificates to establish authenticated and encrypted links between networked computers. This is the standard technology for keeping an internet connection secure and safeguarding any sensitive data that is being sent between two devices, preventing third parties from reading and modifying any personal information transferred. These certificates also verify ownership of a website.
|
||||
|
||||
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 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 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`.
|
||||
|
||||
|
||||
.. _tor:
|
||||
|
||||
Tor
|
||||
---
|
||||
The Onion Router, or Tor, is a free and open source software that enables anonymous communication. By routing Internet traffic through a worldwide, volunteer overlay network of nodes, requests are bundled in layers of encryption like the layers of an onion. The request is relayed across nodes, decrypting a layer only to reveal the next relay destination, until the request meets its final destination, without revealing the source IP address.
|
||||
|
||||
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 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 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>`__.
|
||||
|
||||
.. youtube:: 6czcc1gZ7Ak
|
||||
:width: 100%
|
||||
|
||||
.. _tor-browser:
|
||||
|
||||
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 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 StartOS dashboard.
|
||||
|
||||
.. _hidden-service:
|
||||
|
||||
Tor Hidden Service
|
||||
------------------
|
||||
A Tor Hidden Service is essentially just software or a website that is only broadcast on the Tor network. These are identified by a long, random public key, and end with the ``.onion`` suffix.
|
||||
|
||||
For example, you can visit http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion to view the Start9 homepage on Tor.
|
||||
|
||||
In order to reach a Tor Hidden Service, you must use a browser that can handle ``.onion`` domains, such as `The Tor Browser <https://www.torproject.org/download/>`_ or by configuring :ref:`Firefox <connecting-ff>`.
|
||||
34
site/source/support/concepts/open-source.rst
Normal file
34
site/source/support/concepts/open-source.rst
Normal file
@@ -0,0 +1,34 @@
|
||||
.. _open-source:
|
||||
|
||||
===========
|
||||
Open Source
|
||||
===========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
The Internet was built on free and publicly available code, with the values of collaboration, peer review, communication, and openness built into its very foundation. This decentralized model has since evolved into the open source movement, which leverages these values to discover innovative ways to solve problems across boundaries and industries.
|
||||
|
||||
Open source software centers around the concept of user freedoms: freedom to view, use, modify, and redistribute the code to suit the needs of the user. While this does not necessarily mean free to use, it generally leads to software that is be better, cheaper, and more flexible on account of it being freely accessible, openly modifiable, and easily shared.
|
||||
|
||||
If anyone can inspect, modify, and distribute the code, bugs tend to be more rapidly identified and resolved, while security vulnerabilities are also more quickly audited and exposed. Community driven development efforts enable diverse collaboration which increases project reliability and longevity.
|
||||
|
||||
On the opposite end of the spectrum from open source software is proprietary, or closed source, software. Closed source software is strictly moderated, cannot legally be altered, copied, or distributed, and is paid for to be used as intended without modification. Only the owners of the code have the right to access the code.
|
||||
|
||||
As a company founded on the principles of freedom, openness, and decentralization, every service we support is open source. We are committed to acitively contributing to the future of this vibrant and passionate ecosystem.
|
||||
|
||||
Open Source ideas explained in `Lego <https://www.youtube.com/watch?v=a8fHgx9mE5U>`_.
|
||||
|
||||
.. youtube:: a8fHgx9mE5U
|
||||
:width: 100%
|
||||
|
||||
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 simple and accesible.
|
||||
|
||||
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 StartOS. You could just as easily configure Lightning to use another Bitcoin node located somewhere else!
|
||||
30
site/source/support/concepts/self-hosting.rst
Normal file
30
site/source/support/concepts/self-hosting.rst
Normal file
@@ -0,0 +1,30 @@
|
||||
.. _self-hosting:
|
||||
|
||||
=======
|
||||
Hosting
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
The Client-Server Model
|
||||
-----------------------
|
||||
|
||||
The Internet currently works on an idea known as the "client-server model." This basically means that a server, which is just a computer, "serves" (hence the name) software and data from which clients (also computers, often including phones these days), can request access to. This is also known as "hosting." Servers are often referred to as "The Cloud." The Cloud is literally just **someone else's computer.** A model of this can be seen below:
|
||||
|
||||
.. figure:: /_static/images/concepts/client-server.png
|
||||
:width: 30%
|
||||
:alt: Client-Server Model
|
||||
|
||||
We can quickly realize the problem with a model like this. The server has **ALL** the power. The client is completely dependent on the server for any data it stores there, or any server-side software it uses. This may mean your pictures (Google Photos, iCloud), your files/documents (Dropbox, Google Drive, OneDrive), your social media (Facebook, Instagram, Twitter), and even your ability to do basic communication (Messenger, Signal, Telegram, WhatsApp).
|
||||
|
||||
"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. 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:
|
||||
|
||||
.. youtube:: dc741XwqlyU
|
||||
:width: 100%
|
||||
127
site/source/support/concepts/start9-startos.rst
Normal file
127
site/source/support/concepts/start9-startos.rst
Normal file
@@ -0,0 +1,127 @@
|
||||
.. _start9-concepts:
|
||||
|
||||
=======================
|
||||
Start9 Server & StartOS
|
||||
=======================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
.. _server:
|
||||
|
||||
Server Lite
|
||||
-----------
|
||||
Server Lite 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 SD card, speaker, and passive cooling. The Server Lite comes pre-loaded with :ref:`StartOS<start-os>`. For more details, check out the `Server Lite tech specs <https://store.start9.com/products/server-lite>`_.
|
||||
|
||||
Server One
|
||||
----------
|
||||
Server One is a plug 'n' play hardware device, based on the `Intel NUC <https://en.wikipedia.org/wiki/Next_Unit_of_Computing>`_, 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 Server 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/>`_. Pro features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. The Server 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 built to simplify open source software hosting. 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.
|
||||
|
||||
Start9 currently supports the Raspberry Pi, and most x86_64 and ARM hardware architectures. Our wonderful community is constantly adding to the list of `known good hardware <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-startos/66>`_ and we hope to add official support for more platforms soon! Drop in our `community channels <https://start9.com/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 `Contact Support <https://start9.com/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 StartOS.
|
||||
|
||||
.. _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.
|
||||
@@ -53,7 +53,7 @@ You can only follow someone who has an account on a Mastodon server that support
|
||||
|
||||
What does it mean when Vaultwarden says "This browser requires HTTPS to use the web vault" upon creating an account or loging in to my Vaultwarden onion?
|
||||
---------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
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>`.
|
||||
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<connecting-ff>`.
|
||||
|
||||
Can the browser extension be used with Bitwarden hosted on StartOS?
|
||||
-------------------------------------------------------------------
|
||||
|
||||
@@ -3,8 +3,7 @@
|
||||
=======
|
||||
Support
|
||||
=======
|
||||
|
||||
View frequently asked questions, troubleshoot common issues, or contact support.
|
||||
View frequently asked questions, troubleshoot common issues, or contact support. If you can't find what you need, please `reach out <https://start9.com/contact>`_. We're here to help your server work for you!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -30,15 +29,6 @@ View frequently asked questions, troubleshoot common issues, or contact support.
|
||||
|
||||
Answers to Frequently Asked Questions from StartOS users
|
||||
|
||||
.. topic-box::
|
||||
:title: Contact
|
||||
:link: https://start9.com/contact
|
||||
:icon: scylla-icon scylla-icon--support
|
||||
:class: large-5
|
||||
:anchor: Get help
|
||||
|
||||
Get help from Start9 and the community directly
|
||||
|
||||
.. topic-box::
|
||||
:title: External Support
|
||||
:link: external-support
|
||||
@@ -48,15 +38,25 @@ View frequently asked questions, troubleshoot common issues, or contact support.
|
||||
|
||||
Get help for third party apps that connect to your StartOS services
|
||||
|
||||
.. topic-box::
|
||||
:title: Contact Us
|
||||
:link: https://start9.com/contact
|
||||
:icon: scylla-icon scylla-icon--contact-us
|
||||
:class: large-5
|
||||
:anchor: Reach Out
|
||||
|
||||
Join us in our community channels or get support
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 3
|
||||
:hidden:
|
||||
|
||||
common-issues
|
||||
faq/index
|
||||
concepts/index
|
||||
external-support
|
||||
|
||||
Reference in New Issue
Block a user