mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-01 21:13:10 +00:00
Feat/re arrange (#475)
* move things around a lot * move up a layer * some edits * rename some paths
This commit is contained in:
Matt Hill
@@ -1,37 +0,0 @@
|
||||
.. _getting-started:
|
||||
|
||||
===============
|
||||
Getting Started
|
||||
===============
|
||||
Welcome to Sovereign Computing! Follow the 2 guides below to get up and running with your personal server.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Initial Setup
|
||||
:link: initial-setup
|
||||
:icon: scylla-icon scylla-icon--home
|
||||
:class: large-4
|
||||
:anchor: Start
|
||||
|
||||
Plug in, turn on, opt out
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: trust-ca
|
||||
:icon: scylla-icon scylla-icon--testing
|
||||
:class: large-4
|
||||
:anchor: Setup
|
||||
|
||||
Securely integrate your clients
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
initial-setup
|
||||
trust-ca
|
||||
@@ -1,97 +0,0 @@
|
||||
.. _initial-setup:
|
||||
|
||||
=============
|
||||
Initial Setup
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Power On
|
||||
--------
|
||||
#. Connect your server to power and Ethernet.
|
||||
|
||||
.. caution:: If you built StartOS from `source <https://github.com/start9labs/start-os>`_, it may take up to 20 minutes to first initialize.
|
||||
|
||||
#. Power the device on and select which mode you would like to continue in on the tab below:
|
||||
|
||||
You can either boot your server as-is (headless mode) or add a monitor, mouse, and keyboard (kiosk mode). Server Lite (Raspberry Pi) is currently headless **only**. Headless is the default and recommended option. All control of your server can be done from your computer or mobile device.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Headless Mode
|
||||
|
||||
Ensure the device you are using (desktop/laptop or mobile) is connected to the same network as your server.
|
||||
|
||||
.. caution:: Sometimes a router will have a "guest WiFi network," which might be different than the network your server is placed on via ethernet.
|
||||
|
||||
Visit ``http://start.local`` from your web browser.
|
||||
|
||||
.. group-tab:: Kiosk Mode
|
||||
|
||||
Once your server boots, if you've attached a monitor, keyboard and mouse, you can set it up using the graphical kiosk mode. A familiar browser interface will display the StartOS setup page.
|
||||
|
||||
#. Select "Start Fresh."
|
||||
|
||||
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
|
||||
:width: 50%
|
||||
:alt: Fresh Setup
|
||||
|
||||
.. note:: The "Recover" button is used for :ref:`hardware upgrades <upgrade-hardware>`, :ref:`restoring from backup <backup-restore>`, data migration, or disaster recovery.
|
||||
|
||||
#. Select your storage drive
|
||||
|
||||
.. figure:: /_static/images/setup/screen4-select_storage.jpg
|
||||
:width: 50%
|
||||
:alt: Select Drive
|
||||
|
||||
#. Create a master password for your server and click "Finish."
|
||||
|
||||
.. warning:: Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT.
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.jpg
|
||||
:width: 50%
|
||||
:alt: Create New Password
|
||||
|
||||
#. StartOS will initialize. This can take up to a few minutes.
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 50%
|
||||
:alt: SSD Initialization
|
||||
|
||||
#. You are now hosting your own private server!
|
||||
|
||||
.. tip:: If you are in headless mode, click "Download This Page" to save your server address and certificate info to your computer.
|
||||
|
||||
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
|
||||
:width: 50%
|
||||
:alt: Setup Complete
|
||||
|
||||
#. Next, you will need to :ref:`Trust Your Root CA<trust-ca>` on the device you are connecting from. This is required and your server will not work properly with another device until complete.
|
||||
|
||||
.. figure:: /_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg
|
||||
:width: 50%
|
||||
:alt: Setup Complete
|
||||
|
||||
.. _setup-troubleshooting:
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
If you are experiencing issues with setup, try the following:
|
||||
|
||||
#. Confirm that the server is plugged into both power and Ethernet
|
||||
#. Confirm your phone/computer is **not** connected to a "Guest" network
|
||||
#. Confirm your phone/computer is not using a VPN, or that if you are, that it allows LAN connections, such as the examples below:
|
||||
|
||||
- Mullvad - Go to "Settings -> VPN Settings -> Local Network Sharing"
|
||||
- ProtonVPN - Go to "Preferences -> Connection -> Allow LAN Connections"
|
||||
|
||||
#. Visit or refresh (ctrl+shift+R - Linux/Windows, cmd+shift+R - Mac) the start.local page in a web browser
|
||||
#. To avoid networking issues, it is recommended to use your `primary` router, not an extender or mesh router.
|
||||
#. Very rarely, your firewall settings may block mDNS. In this case:
|
||||
|
||||
- From your browser, navigate to your router configuration settings. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand.
|
||||
- Once in the router config settings, find the section that lists the devices on your network. You should see a device labeled ``start``. Take note of the associated IP address and enter it into your browser's URL field to enter the setup.
|
||||
|
||||
You can always to `reach out to support <https://start9.com/contact>`_ if you need a hand.
|
||||
@@ -1,18 +0,0 @@
|
||||
.. _trust-ca:
|
||||
|
||||
=============
|
||||
Trust Root CA
|
||||
=============
|
||||
Trust your server's Root CA to achieve encrypted communications on LAN, access services on LAN, and enhance connection speeds over Tor. Select the OS of the device you are accessing your server with:
|
||||
|
||||
.. caution:: This is a required step, and you server will not work properly until it is complete
|
||||
|
||||
:ref:`Integrate Linux devices<lan-linux>`
|
||||
|
||||
:ref:`Integrate Mac devices <lan-mac>`
|
||||
|
||||
:ref:`Integrate Windows devices <lan-windows>`
|
||||
|
||||
:ref:`Integrate Android devices <lan-android>`
|
||||
|
||||
:ref:`Integrate iOS devices <lan-ios>`
|
||||
@@ -3,35 +3,18 @@
|
||||
===========
|
||||
User Manual
|
||||
===========
|
||||
Welcome to the StartOS user manual. Here you will discover all that your server can do!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Getting Started
|
||||
:link: getting-started
|
||||
:icon: scylla-icon scylla-icon--getting-started
|
||||
:class: large-4
|
||||
:anchor: Begin
|
||||
|
||||
Get started with your Start9 server
|
||||
|
||||
.. topic-box::
|
||||
:title: StartOS Overview
|
||||
:link: overview
|
||||
:icon: scylla-icon scylla-icon--roadmap
|
||||
:class: large-4
|
||||
:anchor: Explore
|
||||
|
||||
Get the lay of the sovereign land
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
:includehidden:
|
||||
:maxdepth: 1
|
||||
|
||||
getting-started/index
|
||||
overview/index
|
||||
dashboard-overview
|
||||
change-password
|
||||
managing-services
|
||||
backup-restore/index
|
||||
customize
|
||||
updating
|
||||
sessions
|
||||
ssh
|
||||
wifi
|
||||
alt-registries
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
.. _connecting-ff:
|
||||
|
||||
=====================
|
||||
Firefox Configuration
|
||||
=====================
|
||||
Select your OS below to configure Firefox for encrypted sessions and Tor compatability. See our :ref:`Device Guides<device-guides>` section for all your client's setup guides.
|
||||
|
||||
:ref:`Linux<ff-linux>`
|
||||
:ref:`Mac<ff-mac>`
|
||||
:ref:`Windows<ff-windows>`
|
||||
:ref:`Android<ff-android>`
|
||||
@@ -1,60 +0,0 @@
|
||||
.. _connecting-lan:
|
||||
|
||||
===============
|
||||
LAN Connections
|
||||
===============
|
||||
Whenever you are connected to the same Local Area Network (LAN) as your Start9 server, 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!
|
||||
|
||||
Select your OS below to connect via LAN. See our :ref:`Device Guides<device-guides>` section for all your client's setup guides.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Linux
|
||||
:link: ../../../../guides/device-guides/dg-linux/lan-linux
|
||||
:icon: scylla-icon scylla-icon--linux
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Linux devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Mac
|
||||
:link: ../../../../guides/device-guides/dg-mac/lan-mac
|
||||
:icon: scylla-icon scylla-icon--apple
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Mac devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Windows
|
||||
:link: ../../../../guides/device-guides/dg-windows/lan-windows
|
||||
:icon: scylla-icon scylla-icon--windows
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Windows devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Android
|
||||
:link: ../../../../guides/device-guides/dg-android/lan-android
|
||||
:icon: scylla-icon scylla-icon--android
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Android devices
|
||||
|
||||
.. topic-box::
|
||||
:title: iOS
|
||||
:link: ../../../../guides/device-guides/dg-ios/lan-ios
|
||||
:icon: scylla-icon scylla-icon--ios
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate iOS devices
|
||||
|
||||
@@ -1,32 +0,0 @@
|
||||
.. _connecting-tor:
|
||||
|
||||
===============
|
||||
Tor Connections
|
||||
===============
|
||||
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 connections can sometimes be unreliable and have higher latency than normal internet connections.
|
||||
|
||||
Select your OS below to connect via Tor. See our :ref:`Device Guides<device-guides>` section for all your client's setup guides.
|
||||
|
||||
:ref:`Linux<tor-linux>`
|
||||
|
||||
:ref:`Mac<tor-mac>`
|
||||
|
||||
:ref:`Windows<tor-windows>`
|
||||
|
||||
:ref:`Android<tor-android>`
|
||||
|
||||
:ref:`iOS<tor-ios>`
|
||||
|
||||
Using 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
|
||||
|
||||
* `Tor Browser <https://torproject.org/download/>`_
|
||||
|
||||
* iOS
|
||||
|
||||
* iOS lacks a well-functioning Tor Browser. Use :ref:`Firefox<tor-ios>`.
|
||||
@@ -1,41 +0,0 @@
|
||||
.. _connecting:
|
||||
|
||||
===================
|
||||
Network Connections
|
||||
===================
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Connecting Over LAN
|
||||
:link: connecting-lan
|
||||
:icon: scylla-icon scylla-icon--home
|
||||
:class: large-5
|
||||
:anchor: Setup
|
||||
|
||||
Local Area Network connections are fast and secure and do not even require Internet access.
|
||||
|
||||
.. topic-box::
|
||||
:title: Connecting Over Tor
|
||||
:link: connecting-tor
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:class: large-5
|
||||
:anchor: Setup
|
||||
|
||||
Leverage Tor to connect to your Start9 server privately and anonymously from anywhere in the world.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
connecting-lan
|
||||
connecting-tor
|
||||
connecting-ff
|
||||
@@ -1,22 +0,0 @@
|
||||
.. _overview:
|
||||
|
||||
================
|
||||
StartOS Overview
|
||||
================
|
||||
Welcome to StartOS! Get familiar with your server by discovering all the available features.
|
||||
|
||||
.. toctree::
|
||||
:includehidden:
|
||||
:maxdepth: 1
|
||||
|
||||
dashboard-overview
|
||||
change-password
|
||||
managing-services
|
||||
backup-restore/index
|
||||
customize
|
||||
updating
|
||||
connecting/index
|
||||
sessions
|
||||
ssh
|
||||
wifi
|
||||
alt-registries
|
||||
Reference in New Issue
Block a user