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

Feat/re arrange (#475)

Browse Source 
* move things around a lot

* move up a layer

* some edits

* rename some paths
This commit is contained in:
Matt Hill
2023-08-15 13:31:05 -06:00
committed by GitHub
parent 3f8d6b8c02
commit adcff208ac
76 changed files with 1223 additions and 1278 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
site/source/getting-started/configuring-ff.rst Normal file
View File

@@ -0,0 +1,52 @@
.. _connecting-ff:
===================
Configuring Firefox
===================
Firefox is a privacy-focused browser that can be configured to resolve LAN (`.local`) URLs and Tor (`.onion`) URLs without affecting normal browser functionality. We highly recommend using Firefox for connecting to your server and its installed services.
.. note:: For iOS, we recommend Safari instead of Firefox. That is because on iOS, all browsers use Safari under the hood anyway, so it is preferable not to stack unnecessary software on top of it.
Select your OS:
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Linux
:link: ../../../../guides/device-guides/linux/ff-linux
:icon: scylla-icon scylla-icon--linux
:class: large-4
:anchor: View
Configuring Firefox on Linux
.. topic-box::
:title: Mac
:link: ../../../../guides/device-guides/mac/ff-mac
:icon: scylla-icon scylla-icon--apple
:class: large-4
:anchor: View
Configuring Firefox on Mac
.. topic-box::
:title: Windows
:link: ../../../../guides/device-guides/windows/ff-windows
:icon: scylla-icon scylla-icon--windows
:class: large-4
:anchor: View
Configuring Firefox on Windows
.. topic-box::
:title: Android
:link: ../../../../guides/device-guides/android/ff-android
:icon: scylla-icon scylla-icon--android
:class: large-4
:anchor: View
Configuring Firefox on Android

20
site/source/getting-started/connecting-lan.rst Normal file
View File

@@ -0,0 +1,20 @@
.. _connecting-lan:
==================
Connecting Locally
==================
When connected to the same Local Area Network (LAN) as your server, you can use its `.local` URLs for fast and secure connections.
All clients
-----------
#. Ensure your client device (phone/laptop) is connected to the same Local Area Network (LAN) as your server. This usually means your server and your client device are using the same router, either by ethernet or WiFi
#. Follow instructions to :ref:`trust your server's Root CA<trust-ca>`
Windows Only
------------
On Windows, it is currently necessary to install Bonjour Print Services in order to access the `.local` URLs of your installed services. With the release of StartOS v0.4.0, it will no longer be necessary.
#. Simply install Bonjour Print Services from Apple: https://support.apple.com/kb/DL999
.. warning:: Bonjour can be unreliable. If your `local` URLs suddenly stop working, you may need to uninstall and re-install Bonjour. Go to `System Settings > Remove Programs`, uninstall Bonjour `and` Bonjour Print Services, re-install Bonjour Print Services from the link above, then restart Windows.

76
site/source/getting-started/connecting-tor.rst Normal file
View File

@@ -0,0 +1,76 @@
.. _connecting-tor:
===================
Connecting Remotely
===================
You can connect to your server from anywhere in the world, privately and anonymously, by using its unique Tor Address (`.onion` URL)
.. note:: It is normal for Tor connections to be slow or unreliable at times
Running Tor Natively on Your Phone/Computer (Recommended)
---------------------------------------------------------
Select your OS below:
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Linux
:link: ../../../../guides/device-guides/linux/tor-linux
:icon: scylla-icon scylla-icon--linux
:class: large-4
:anchor: View
Running Tor on Linux
.. topic-box::
:title: Mac
:link: ../../../../guides/device-guides/mac/tor-mac
:icon: scylla-icon scylla-icon--apple
:class: large-4
:anchor: View
Running Tor on Mac
.. topic-box::
:title: Windows
:link: ../../../../guides/device-guides/windows/tor-windows
:icon: scylla-icon scylla-icon--windows
:class: large-4
:anchor: View
Running Tor on Windows
.. topic-box::
:title: Android
:link: ../../../../guides/device-guides/android/tor-android
:icon: scylla-icon scylla-icon--android
:class: large-4
:anchor: View
Running Tor on Android
.. topic-box::
:title: iOS
:link: ../../../../guides/device-guides/ios/tor-ios
:icon: scylla-icon scylla-icon--ios
:class: large-4
:anchor: View
Running Tor on iOS
Using The Tor Browser
---------------------
Using the official Tor Browser allows you to access `.onion` URLs without additional configuration. However, accessing clearnet (`.com`, `.org`, ect) websites will also be routed over Tor, making them slower, and `.local` URLs cannot be accessed at all.
* Linux, Mac, Windows, Android
* `Tor Browser <https://torproject.org/download/>`_
* iOS
* iOS lacks a well-functioning Tor Browser. Instead, we recommend :ref:`using Safari with Orbot<tor-ios>`.

67
site/source/getting-started/index.rst Normal file
View File

@@ -0,0 +1,67 @@
.. _getting-started:
===============
Getting Started
===============
The guides below are considered mandatory for a safe and smooth experience with StartOS
.. 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: View
Step by step instructions for setting up your server
.. topic-box::
:title: Trusting your Root CA
:link: trust-ca
:icon: scylla-icon scylla-icon--testing
:class: large-4
:anchor: View
Use encryption for a secure connection to your server
.. topic-box::
:title: Configuring Firefox
:link: configuring-ff
:icon: scylla-icon scylla-icon--integrations
:class: large-4
:anchor: View
Configure Firefox for optimal Local and Tor connectivity
.. topic-box::
:title: Connecting Locally
:link: connecting-lan
:icon: scylla-icon scylla-icon--networking
:class: large-4
:anchor: View
Connect to your server while on the same LAN
.. topic-box::
:title: Connecting Remotely
:link: connecting-tor
:icon: scylla-icon scylla-icon--networking
:class: large-4
:anchor: View
Connect to your server remotely using Tor
.. toctree::
:hidden:
:maxdepth: 2
initial-setup
trust-ca
configuring-ff
connecting-lan
connecting-tor

74
site/source/getting-started/initial-setup.rst Normal file
View File

@@ -0,0 +1,74 @@
.. _initial-setup:
=============
Initial Setup
=============
Follow the instructions below to set up your server for the first time.
#. Connect your server to power and Ethernet
#. From a client device (desktop/laptop/phone), open a browser and visit ``http://start.local``. Your client must be connected to the same Local Area Network (LAN) as your server. This usually means they are using the same router, either by ethernet or WiFi
.. note:: If you are `not` using a Raspberry Pi, you can also plug a monitor and keyboard into the server.
#. Select ``Start Fresh``
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 50%
:alt: Fresh Setup
#. Select your storage drive. In most cases, there will be only one
.. 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 a few minutes
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 50%
:alt: SSD Initialization
#. Click the ``Download`` button to download a file containing the URLs (`.local` and `.onion`) and Root CA of your server. Keep this file for future reference.
.. note:: If you connected a monitor, you will `not` see the download button
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 50%
:alt: Setup Complete
#. Setup complete! Click ``Login to StartOS`` to access your new server
.. 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.

73
site/source/getting-started/trust-ca.rst Normal file
View File

@@ -0,0 +1,73 @@
.. _trust-ca:
=====================
Trusting Your Root CA
=====================
Download and trust your server's Root Certificate Authority (Root CA) to enable encrypted communications locally and enhance speeds over Tor.
Download Your Server's Root CA
------------------------------
Your server's Root CA was included in the downloaded file at the end of initial setup. If you do not have that file, you can find your server's Root CA inside the StartOS dashboard.
#. Navigate to `System > Root CA` and click `Download Certificate`
.. figure:: /_static/images/ssl/lan_setup.png
:width: 40%
:alt: LAN setup menu item
Trust Your Server's Root CA
---------------------------
Select your OS:
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Linux
:link: ../../../../guides/device-guides/linux/ca-linux/
:icon: scylla-icon scylla-icon--linux
:class: large-4
:anchor: View
Trust your Root CA on Linux
.. topic-box::
:title: Mac
:link: ../../../../guides/device-guides/mac/ca-mac
:icon: scylla-icon scylla-icon--apple
:class: large-4
:anchor: View
Trust your Root CA on Mac
.. topic-box::
:title: Windows
:link: ../../../../guides/device-guides/windows/ca-windows
:icon: scylla-icon scylla-icon--windows
:class: large-4
:anchor: View
Trust your Root CA on Windows
.. topic-box::
:title: Android
:link: ../../../../guides/device-guides/android/ca-android
:icon: scylla-icon scylla-icon--android
:class: large-4
:anchor: View
Trust your Root CA on Android
.. topic-box::
:title: iOS
:link: ../../../../guides/device-guides/ios/ca-ios
:icon: scylla-icon scylla-icon--ios
:class: large-4
:anchor: View
Trust your Root CA on iOS