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:
BIN
site/source/_static/images/config/password_change_ui-1.png
Normal file
BIN
site/source/_static/images/config/password_change_ui-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 87 KiB |
BIN
site/source/_static/images/config/password_change_ui-2.png
Normal file
BIN
site/source/_static/images/config/password_change_ui-2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 79 KiB |
BIN
site/source/_static/images/config/password_change_ui-3.png
Normal file
BIN
site/source/_static/images/config/password_change_ui-3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 55 KiB |
BIN
site/source/_static/images/config/password_change_ui-4.png
Normal file
BIN
site/source/_static/images/config/password_change_ui-4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
@@ -1,63 +1,74 @@
|
||||
.. _torff-android:
|
||||
.. _ff-android:
|
||||
|
||||
======================================
|
||||
Configuring Firefox for Tor on Android
|
||||
======================================
|
||||
===============================
|
||||
Configuring Firefox for Android
|
||||
===============================
|
||||
Mozilla provides some of the most flexible, secure, and freedom-principled applications for using the web. We highly recommend completing all configuration below.
|
||||
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor for Android<tor-android>`. Please visit this section before proceeding as it is required for Firefox to properly work with Tor.
|
||||
.. caution:: Setups may strongly vary across different Android forks
|
||||
|
||||
.. note:: Setups may strongly vary across different Android forks. We have made specific mention of GrapheneOS which has been tested on Pixel 5 and Pixel 6. Configuring Firefox for Tor is not currently possible on CalyxOS or LineageOS v20.
|
||||
LAN Config
|
||||
----------
|
||||
|
||||
Once Tor is setup on your system, you can proceed to setup Firefox:
|
||||
|
||||
Configure Tor
|
||||
-------------
|
||||
Once you have :ref:`setup your Root CA<lan-android>` and :ref:`Tor is running on your device<tor-android>`, you can proceed to configure Firefox:
|
||||
|
||||
#. Download `Firefox Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta>`_ from the Play Store, or `Fennec <https://f-droid.org/en/packages/org.mozilla.fennec_fdroid/>`_ from F-Droid.
|
||||
|
||||
.. note:: Regular Firefox offered in the Play Store will not work - be sure to use Firefox Beta.
|
||||
.. caution:: Regular Firefox offered in the Play Store will not allow this configuration - be sure to use Firefox Beta.
|
||||
|
||||
#. Next, download a `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here <https://start9.com/assets/proxy.pac>`_.
|
||||
#. Next, download the `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here <https://start9.com/assets/proxy.pac>`_.
|
||||
|
||||
#. Navigate to ``about:config`` in the Firefox URL bar.
|
||||
|
||||
.. figure:: /_static/images/tor/about_config.png
|
||||
:width: 50%
|
||||
:width: 30%
|
||||
:alt: Firefox about config
|
||||
|
||||
#. You are going to have to change a few options in here. First, type ``network.proxy.type`` into the search bar, and set the value to ``2``.
|
||||
|
||||
.. figure:: /_static/images/tor/network_proxy_type.png
|
||||
:width: 50%
|
||||
:width: 30%
|
||||
:alt: Firefox network proxy type setting screenshot
|
||||
|
||||
#. (This step is for GrapheneOS only): Head to *Settings -> Apps -> Firefox Beta -> Permissions -> Photos and videos -> Configure Storage Scopes -> ADD FILE* then navigate to where you placed the proxy.pac file.
|
||||
#. (This step is for GrapheneOS users **only**): Head to *Settings -> Apps -> Firefox Beta -> Permissions -> Photos and videos -> Configure Storage Scopes -> ADD FILE* then navigate to where you placed the proxy.pac file.
|
||||
|
||||
.. figure:: /_static/images/tor/storage-scopes-proxy.jpg
|
||||
:width: 30%
|
||||
:width: 15%
|
||||
|
||||
#. (All users): Search for ``network.proxy.autoconfig_url``, and set the value to ``file:///storage/emulated/0/Download/proxy.pac``. This is the default location of a the proxy.pac file downloaded in step 2, although your path may vary.
|
||||
|
||||
.. figure:: /_static/images/tor/autoconfig_url.png
|
||||
:width: 50%
|
||||
:width: 30%
|
||||
:alt: Firefox autoconfig url setting screenshot
|
||||
|
||||
#. Search for ``network.proxy.socks_remote_dns``, and set the value to ``true``.
|
||||
|
||||
.. figure:: /_static/images/tor/socks_remote_dns.png
|
||||
:width: 50%
|
||||
:width: 30%
|
||||
:alt: Firefox socks remote dns setting screenshot
|
||||
|
||||
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``.
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_allowlist_mobile.png
|
||||
:width: 50%
|
||||
:width: 30%
|
||||
:alt: Firefox whitelist onions screenshot
|
||||
|
||||
#. Finally, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_insecure_websockets_droid.png
|
||||
:width: 50%
|
||||
:width: 30%
|
||||
:alt: Firefox allow insecure websockets over https
|
||||
|
||||
#. 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 your Start9 services' ``.onion`` addresses, as well as use integrations, such as the :ref:`Bitwarden<vaultwarden-service>` browser extension.
|
||||
|
||||
|
||||
Install StartOS as a PWA
|
||||
------------------------
|
||||
Depending on your version of Firefox, you may be prompted to "Add to Home screen", when visiting your main UI. If you do this, you can access your UI as a Progressive Web App (PWA), meaining that all browser context is removed, and StartOS will behave as a native Android app!
|
||||
|
||||
If you are not prompted, or skipped that screen, simply go to the **Kebab (Settings) Menu > Install** while visiting your server's UI to complete the action.
|
||||
49
site/source/guides/device-guides/dg-android/index.rst
Normal file
49
site/source/guides/device-guides/dg-android/index.rst
Normal file
@@ -0,0 +1,49 @@
|
||||
.. _dg-android:
|
||||
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. At minimum, you will want to set up your Root CA in the first guide.
|
||||
|
||||
.. tip:: 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 are available even with no Internet access!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: lan-android
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Trust your Start9 server's Root Certificate Authority in order to create encrypted connections.
|
||||
|
||||
.. topic-box::
|
||||
:title: Setup Orbot
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-android
|
||||
:class: large-4
|
||||
:anchor: Run Tor
|
||||
|
||||
Run Tor natively (in the background) on your Android device. This will enable apps to communicate with your Start9 server via the Tor Network, remotely.
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-android
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Config
|
||||
|
||||
Configure Firefox for an optimal experience with your server.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
lan-android
|
||||
tor-android
|
||||
ff-android
|
||||
54
site/source/guides/device-guides/dg-android/lan-android.rst
Normal file
54
site/source/guides/device-guides/dg-android/lan-android.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
.. _lan-android:
|
||||
|
||||
=============================
|
||||
Trust Your Root CA on Android
|
||||
=============================
|
||||
Complete this guide to download your Start9 server's Root Certificate Authority (CA), and trust it on your client device (Android). This allows you to use encrypted ``https`` connections to your ``.local`` (LAN) and ``.onion`` (tor) server addresses, access services on LAN, and enhances performance on tor. The self-signed certificate was created by your server when you perfomed the initial setup, and applies to your server's main UI connection, as well as all service connections.
|
||||
|
||||
.. note:: This guide applies to most Android phones running Android v13+, as well as phones running CalyxOS, GrapheneOS, or LineageOS (v19+).
|
||||
|
||||
Download Root CA
|
||||
----------------
|
||||
First, download your Start9 server's Root CA, if you have not already.
|
||||
|
||||
- Navigate to *System > LAN*, then click "Download Certificate".
|
||||
|
||||
.. figure:: /_static/images/ssl/lan_setup.png
|
||||
:width: 40%
|
||||
:alt: LAN setup menu item
|
||||
|
||||
Alternatively, you can download to another machine, then transfer the file to your device.
|
||||
|
||||
Trust Root CA
|
||||
-------------
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Android v13+
|
||||
|
||||
Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your custom-named ``adjective-noun.local.crt`` certificate.
|
||||
|
||||
.. figure:: /_static/images/ssl/android/droidLAN2.png
|
||||
:width: 15%
|
||||
:alt: Install certificate
|
||||
|
||||
.. group-tab:: Android v12
|
||||
|
||||
.. caution:: 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 unique ``adjective-noun.local.crt`` certificate.
|
||||
|
||||
.. figure:: /_static/images/ssl/android/droidLAN0.png
|
||||
:width: 15%
|
||||
:alt: Install certificate
|
||||
|
||||
.. _lan-ff-android:
|
||||
|
||||
Configure Firefox
|
||||
-----------------
|
||||
On some devices, it may be necessary to also activate this setting in Firefox / Fennec:
|
||||
|
||||
#. Tap **Kebab Menu > Settings > About Firefox** and tap the Firefox icon 5 times to enable "developer mode."
|
||||
|
||||
#. Go back to **Kebab Menu > Settings > Secret Settings** (at the bottom), and tap "Use third party CA certificates" to enable the use of your system-wide Root CA.
|
||||
|
||||
You're now ready to browse your service UIs with encryption, either via the browser, or with native client apps. For Mozilla apps, such as Firefox, you will need to follow the :ref:`Firefox Config <ff-android>` guide, which we highly recommend.
|
||||
@@ -3,44 +3,42 @@
|
||||
======================
|
||||
Running Tor on Android
|
||||
======================
|
||||
|
||||
Some apps, such as :ref:`Tor Browser<tor-browser>`, have Tor built in. They do not require additional software or configurations to utilize Tor. Most apps, however, do not have Tor built in. They require an app called Orbot to be installed in order to utilize the Tor Network.
|
||||
|
||||
Running Orbot
|
||||
-------------
|
||||
|
||||
Orbot is a system wide proxy for your Android device that enables communications over Tor.
|
||||
Orbot is a system-wide proxy for your Android device that enables communications over Tor.
|
||||
|
||||
#. Download and install Orbot from the `Play Store <https://play.google.com/store/apps/details?id=org.torproject.android>`_, or from `F-Droid <https://f-droid.org/packages/org.torproject.android>`_ (must open with F-Droid app). Then launch the app.
|
||||
|
||||
.. tip:: When using F-Droid, you will want to activate the Guardian Project repository by visiting the ``Settings`` menu (bottom right) -> ``Repositories`` -> ``Guardian Project Official Releases``
|
||||
.. note:: When using F-Droid, you will need to activate the Guardian Project repository by visiting the ``Settings`` menu (bottom right) -> ``Repositories`` -> ``Guardian Project Official Releases``
|
||||
|
||||
.. figure:: /_static/images/tor/orbot0.png
|
||||
:width: 30%
|
||||
:width: 20 %
|
||||
:alt: Orbot
|
||||
|
||||
#. Tap "Start VPN".
|
||||
|
||||
.. figure:: /_static/images/tor/orbot1.png
|
||||
:width: 30%
|
||||
:width: 20 %
|
||||
:alt: Orbot starting
|
||||
|
||||
#. Orbot will start up the Tor service. Once complete, you will see:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot2.png
|
||||
:width: 30%
|
||||
:width: 20 %
|
||||
:alt: Orbot running
|
||||
|
||||
#. Open the kebab menu in the bottom right hand corner and select `Settings`:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_menu.png
|
||||
:width: 30%
|
||||
:width: 20 %
|
||||
:alt: Orbot settings
|
||||
|
||||
#. Make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_settings.png
|
||||
:width: 30%
|
||||
:width: 20 %
|
||||
:alt: Orbot menu
|
||||
|
||||
#. That's it, you're now running a Tor client on your Android device! Certain apps, such as Firefox, Fennec, and DuckDuckGo will now work after you configure them to use Tor's local proxy. Other apps do not have sophisticated proxy configurations and require that Orbot be running in VPN mode.
|
||||
@@ -53,13 +51,13 @@ To utilize Tor, some apps require that Orbot be running in VPN mode. This means
|
||||
#. Disable Private DNS on your device. Navigate to: ``Settings > Network & Internet > Advanced > Private DNS > Off`` and toggle Private DNS to "off".
|
||||
|
||||
.. figure:: /_static/images/tor/private_dns_off.png
|
||||
:width: 30%
|
||||
:width: 20%
|
||||
:alt: Private DNS off
|
||||
|
||||
#. Tap `Select Apps`, and add the apps you want to utilize Tor.
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_apps.png
|
||||
:width: 30%
|
||||
:width: 20%
|
||||
:alt: Orbot apps
|
||||
|
||||
Examples of applications that need this feature for remote access are:
|
||||
@@ -69,7 +67,7 @@ Examples of applications that need this feature for remote access are:
|
||||
- Nextcloud
|
||||
|
||||
.. figure:: /_static/images/tor/orbot2.png
|
||||
:width: 30%
|
||||
:width: 20%
|
||||
:alt: Orbot running
|
||||
|
||||
You can also add the following browsers to the Tor-Enabled Apps list to easily access Tor addresses (`.onion` URLs):
|
||||
39
site/source/guides/device-guides/dg-ios/index.rst
Normal file
39
site/source/guides/device-guides/dg-ios/index.rst
Normal file
@@ -0,0 +1,39 @@
|
||||
.. _dg-ios:
|
||||
|
||||
===
|
||||
iOS
|
||||
===
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
.. tip:: 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 are available even with no Internet access!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: lan-ios
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Trust your Start9 server's Root Certificate Authority in order to create encrypted connections.
|
||||
|
||||
.. topic-box::
|
||||
:title: Setup Orbot
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-ios
|
||||
:class: large-4
|
||||
:anchor: Run Tor
|
||||
|
||||
Run Tor natively (in the background) on your iOS device. This will enable apps to communicate with your Start9 server via the Tor Network, remotely.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
lan-ios
|
||||
tor-ios
|
||||
@@ -1,16 +1,16 @@
|
||||
.. _lan-ios:
|
||||
|
||||
================================
|
||||
Trusting Your Server's CA on iOS
|
||||
================================
|
||||
=========================
|
||||
Trust Your Root CA on iOS
|
||||
=========================
|
||||
Complete this guide to download your Start9 server's Root Certificate Authority (CA), and trust it on your client device (iOS). This allows you to use encrypted ``https`` connections to your ``.local`` (LAN) and ``.onion`` (tor) server addresses, access services on LAN, and enhances performance on tor. The self-signed certificate was created by your server when you perfomed the initial setup, and applies to your server's main UI connection, as well as all service connections.
|
||||
|
||||
This applies to iOS v15 and v16. For older versions, see the `v14 guide </0.3.1.x/user-manual/connecting/connecting-lan/lan-os/lan-ios>`_.
|
||||
|
||||
|
||||
#. Download the certificate to your Downloads folder
|
||||
|
||||
.. note::
|
||||
In order to do this, open Safari and visit your Start9 server's .local URL while connected to WiFi, but make sure it is prefixed with `http://` and not `https://`.
|
||||
In order to do this, open Safari and visit your Start9 server's .local URL while connected to WiFi, but make sure it is prefixed with ``http://`` and not ``https://``.
|
||||
|
||||
Log in using your password, then click the hamburger (3 lines) menu at the top right, select System > LAN > Download Certificate. It may say `This website is trying to download a configuration profile. Do you want to allow this?` Click `Allow`.
|
||||
|
||||
@@ -84,4 +84,5 @@ This applies to iOS v15 and v16. For older versions, see the `v14 guide </0.3.1
|
||||
|
||||
.. figure:: /_static/images/ssl/ios/trust_4.png
|
||||
:width: 20%
|
||||
:alt: Profiles
|
||||
:alt: Profiles
|
||||
|
||||
29
site/source/guides/device-guides/dg-ios/tor-ios.rst
Normal file
29
site/source/guides/device-guides/dg-ios/tor-ios.rst
Normal file
@@ -0,0 +1,29 @@
|
||||
.. _tor-ios:
|
||||
|
||||
==================
|
||||
Running Tor on iOS
|
||||
==================
|
||||
|
||||
Running Orbot
|
||||
-------------
|
||||
Orbot is a system-wide proxy for your Android device that enables communications over Tor.
|
||||
|
||||
#. Download and install `Orbot from the Apple appstore <https://apps.apple.com/us/app/orbot/id1609461599>`_.
|
||||
#. Open Orbot and tap on "Settings".
|
||||
#. Activate the "Disable Orbot for non-onion traffic" setting:
|
||||
|
||||
.. figure:: /_static/images/tor/ios-orbot-settings-oniononlymode.png
|
||||
:width: 25%
|
||||
:alt: iOS Orbot -> Settings -> Onion-Only Mode
|
||||
|
||||
#. Go back to the main screen and click "Start" and you will see Tor connect:
|
||||
|
||||
.. figure:: /_static/images/tor/ios-orbot-connecting-full.png
|
||||
:width: 35%
|
||||
:alt: iOS Orbot Connecting to Tor
|
||||
|
||||
#. Apps will now work transparently when requesting onion urls!
|
||||
|
||||
Access Onionsites
|
||||
-----------------
|
||||
Once Orbot is setup on your system as you've just done, you don't need any browser configuration. All browsers in iOS are Safari under the hood, and this Orbot configuration enables access to ``.onion`` URLs. Regular clearnet requests will not use tor.
|
||||
@@ -10,8 +10,7 @@ Linux Network Folder
|
||||
|
||||
Setup Network Folder
|
||||
--------------------
|
||||
|
||||
.. note:: This guide is for Ubuntu only. For Linux Mint, click on "Mint", or for different distros such as Arch, Debian, Pop-OS, PureOS, etc, click "Other Linux" below.
|
||||
.. note:: This guide is for Ubuntu only. For Linux Mint, select "Mint", or for different distros such as Arch, Debian, Pop-OS, PureOS, etc, select "Other Linux" below.
|
||||
|
||||
.. tabs::
|
||||
|
||||
129
site/source/guides/device-guides/dg-linux/ff-linux.rst
Normal file
129
site/source/guides/device-guides/dg-linux/ff-linux.rst
Normal file
@@ -0,0 +1,129 @@
|
||||
.. _ff-linux:
|
||||
|
||||
============================
|
||||
Configuring Firefox on Linux
|
||||
============================
|
||||
Mozilla provides some of the most flexible, secure, and freedom-principled applications for using the web. We highly recommend completing all configuration below.
|
||||
|
||||
LAN Config
|
||||
----------
|
||||
This guide applies to Firefox, Firefox ESR, Librewolf, and Thunderbird. Mozilla apps need to be configured to use the certificate store of your device. To find out why Mozilla does this differently, you can read their `blog post <https://blog.mozilla.org/security/2019/02/14/why-does-mozilla-maintain-our-own-root-certificate-store/>`_ on the topic (TLDR: for security purposes).
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
|
||||
|
||||
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Debian/Ubuntu
|
||||
|
||||
For each Mozilla-based application (Firefox, Firefox ESR, LibreWolf, Thunderbird, etc) you plan on using, you will need to complete the following guide. This is in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store.
|
||||
|
||||
#. Select the hamgurger menu, then *Settings*, then search for "*security devices*", then select "*Security Devices...*"
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-1.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #1
|
||||
|
||||
#. When the Device Manager dialog window opens, select "*Load*"
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-2.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #2
|
||||
|
||||
#. Give the Module Name a title such as "*System CA Trust Module*" and for the Module filename, paste in ``/usr/lib/x86_64-linux-gnu/pkcs11/p11-kit-trust.so`` and hit *OK*:
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-3.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #3
|
||||
|
||||
#. Verify that the new module shows up on the left hand side and select *OK* at the bottom right:
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-4.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #4
|
||||
|
||||
.. group-tab:: Arch/Garuda
|
||||
|
||||
.. group-tab:: CentOS/Fedora
|
||||
|
||||
Now restart Firefox (or other Mozilla application), and log in to your server using ``https``. You should now see this symbol indicating a secure connection:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. tip:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. You will need to remove it by clicking the lock and then "Connection not secure":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 1)
|
||||
|
||||
Then click "Remove Exception":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 2)
|
||||
|
||||
You should now see that the website is trusted as in the final step show above.
|
||||
|
||||
Tor Config
|
||||
----------
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor<tor-linux>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
|
||||
|
||||
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_allowlist.png
|
||||
:width: 60%
|
||||
:alt: Firefox whitelist onions screenshot
|
||||
|
||||
#. Next, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_insecure_websockets.png
|
||||
:width: 60%
|
||||
:alt: Firefox allow insecure websockets over https
|
||||
|
||||
#. Download a `Proxy Auto Config` file to inform Firefox how to use the Tor daemon running on your computer. You can get Start9's standard file from a terminal, by using:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sudo wget -P /etc/tor https://start9.com/assets/proxy.pac
|
||||
|
||||
|
||||
#. Now, back in your Firefox web browser, select ``Settings`` from the right-hand hamburger menu:
|
||||
|
||||
.. figure:: /_static/images/tor/os_ff_settings.png
|
||||
:width: 30%
|
||||
:alt: Firefox options screenshot
|
||||
|
||||
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_search.png
|
||||
:width: 60%
|
||||
:alt: Firefox search screenshot
|
||||
|
||||
#. This should open a menu that will allow you to configure your proxy settings. Select ``Automatic proxy configuration URL`` and paste in the path to your PAC file from earlier, prefixed with ``file://``. For example:
|
||||
|
||||
.. code-block::
|
||||
|
||||
file:///etc/tor/proxy.pac
|
||||
|
||||
#. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_proxy.png
|
||||
:width: 60%
|
||||
:alt: Firefox proxy settings screenshot
|
||||
|
||||
#. Click ``OK`` and then restart Firefox for the changes to take effect.
|
||||
|
||||
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can access tor service :ref:`WebUIs <web-ui>`, and use client integrations such as :ref:`Vaultwarden<vaultwarden-service>` apps and extensions. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_.
|
||||
|
||||
If you still encounter issues, `contact support <https://start9.com/contact>`_.
|
||||
|
||||
59
site/source/guides/device-guides/dg-linux/index.rst
Normal file
59
site/source/guides/device-guides/dg-linux/index.rst
Normal file
@@ -0,0 +1,59 @@
|
||||
.. _dg-linux:
|
||||
|
||||
=====
|
||||
Linux
|
||||
=====
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. At minimum, you will want to set up your Root CA in the first guide.
|
||||
|
||||
.. tip:: 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 are available even with no Internet access!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: lan-linux
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Trust your Start9 server's Root Certificate Authority in order to create encrypted connections.
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Configuration
|
||||
:link: backup-linux
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: Setup
|
||||
|
||||
Configure a Network Folder on your Linux machine (or attached external drive) to receive StartOS backups.
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-linux
|
||||
:class: large-4
|
||||
:anchor: Run Tor
|
||||
|
||||
Run Tor natively (in the background) on your Linux device. This will enable apps to communicate with your Start9 server via the Tor Network, remotely.
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-linux
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Config
|
||||
|
||||
Configure Firefox for an optimal experience with your server.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
lan-linux
|
||||
backup-linux
|
||||
tor-linux
|
||||
ff-linux
|
||||
83
site/source/guides/device-guides/dg-linux/lan-linux.rst
Normal file
83
site/source/guides/device-guides/dg-linux/lan-linux.rst
Normal file
@@ -0,0 +1,83 @@
|
||||
.. _lan-linux:
|
||||
|
||||
================================
|
||||
Trusting Your Start9 CA on Linux
|
||||
================================
|
||||
Complete this guide to download your Start9 server's Root Certificate Authority (CA), and trust it on your client device (Windows). This allows you to use encrypted ``https`` connections to your ``.local`` (LAN) and ``.onion`` (tor) server addresses, access services on LAN, and enhances performance on tor. The self-signed certificate was created by your server when you perfomed the initial setup, and applies to your server's main UI connection, as well as all service connections.
|
||||
|
||||
.. caution:: If you cannot connect following this guide, you may be using an application (such as Firefox) that is installed in a jailed environment, such as an appimage, flatpak, or snap. Please try an alternate install method if so.
|
||||
|
||||
Download Root CA
|
||||
----------------
|
||||
First, download your Start9 server's Root CA, if you have not already.
|
||||
|
||||
- Navigate to *System > LAN*, then click "Download Certificate".
|
||||
|
||||
.. figure:: /_static/images/ssl/lan_setup.png
|
||||
:width: 40%
|
||||
:alt: LAN setup menu item
|
||||
|
||||
Alternatively, you can download to another machine, then transfer the file to your device.
|
||||
|
||||
Trust Root CA
|
||||
-------------
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Debian/Ubuntu
|
||||
|
||||
These instructions will work for most Debian-based Linux distributions, such as Debian, Linux Mint, PopOS, Ubuntu, etc.
|
||||
|
||||
#. Perform the following commands in the Terminal:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo apt update
|
||||
sudo apt install -y ca-certificates p11-kit
|
||||
|
||||
#. Move into 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:
|
||||
|
||||
.. caution:: BE CERTAIN to replace ``adjective-noun`` with your server's unique hostname in the 3rd and 4th commands below!
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cd ~/Downloads
|
||||
sudo mkdir -p /usr/share/ca-certificates/start9
|
||||
sudo cp "adjective-noun.local.crt" /usr/share/ca-certificates/start9/
|
||||
sudo bash -c "echo 'start9/adjective-noun.local.crt' >> /etc/ca-certificates.conf"
|
||||
sudo update-ca-certificates
|
||||
|
||||
In the output it should say ``1 added`` if it was successful. For most applications, you will now be able to securely connect via ``https``. We highly recommend continuing on to our :ref:`Configuring Firefox <ff-linux>` guide.
|
||||
|
||||
.. group-tab:: Arch/Garuda
|
||||
|
||||
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 "<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
|
||||
|
||||
First, ensure mDNS resolution is turned on so you can reach your server:
|
||||
|
||||
Ensure ``MulticastDNS=Yes`` is set in /etc/systemd/resolved.conf and then restart systemd-resolved:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo systemctl restart systemd-resolved
|
||||
|
||||
Trust your server's CA certificate:
|
||||
|
||||
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 "<custom-address>.crt" /etc/pki/ca-trust/source/anchors/
|
||||
sudo update-ca-trust
|
||||
|
||||
You're now ready to browse your service UIs with encryption, either via the browser, or with native client apps. For Mozilla apps, such as Firefox, you will need to follow the :ref:`Firefox Config <lan-ff>` guide, which we highly recommend.
|
||||
81
site/source/guides/device-guides/dg-mac/ff-mac.rst
Normal file
81
site/source/guides/device-guides/dg-mac/ff-mac.rst
Normal file
@@ -0,0 +1,81 @@
|
||||
.. _ff-mac:
|
||||
|
||||
==========================
|
||||
Configuring Firefox on Mac
|
||||
==========================
|
||||
Here we will add your Start9 server's Root CA (Certificate Authority) to your system's certificate trust store to ensure that applications can verify connections to your services.
|
||||
|
||||
LAN Config
|
||||
----------
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
|
||||
|
||||
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
Now restart Firefox (or other Mozilla application), and log in to your server using ``https``. You should now see this symbol indicating a secure connection:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. tip:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. You will need to remove it by clicking the lock and then "Connection not secure":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 1)
|
||||
|
||||
Then click "Remove Exception":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 2)
|
||||
|
||||
You should now see that the website is trusted as in the final step show above.
|
||||
|
||||
Tor Config
|
||||
----------
|
||||
.. caution::
|
||||
This guide assumes you have completed :ref:`setting up Tor<tor-mac>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
|
||||
|
||||
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_allowlist.png
|
||||
:width: 60%
|
||||
:alt: Firefox whitelist onions screenshot
|
||||
|
||||
#. Next, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_insecure_websockets.png
|
||||
:width: 60%
|
||||
:alt: Firefox allow insecure websockets over https
|
||||
|
||||
#. Now go to the right-hand hamburger menu and select ``Settings``:
|
||||
|
||||
.. figure:: /_static/images/tor/os_ff_settings.png
|
||||
:width: 30%
|
||||
:alt: Firefox options screenshot
|
||||
|
||||
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_search.png
|
||||
:width: 60%
|
||||
:alt: Firefox search screenshot
|
||||
|
||||
#. Check the option labeled ``Use System Proxy Settings``
|
||||
|
||||
#. Check the box labeled ``Proxy DNS when using SOCKS v5``:
|
||||
|
||||
.. figure:: /_static/images/tor/firefox_proxy.png
|
||||
:width: 60%
|
||||
:alt: Firefox proxy settings screenshot
|
||||
|
||||
#. Click ``OK`` and then restart Firefox for the changes to take effect.
|
||||
|
||||
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_.
|
||||
|
||||
If you still encounter issues, `contact support <https://start9.com/contact>`_.
|
||||
69
site/source/guides/device-guides/dg-mac/index.rst
Normal file
69
site/source/guides/device-guides/dg-mac/index.rst
Normal file
@@ -0,0 +1,69 @@
|
||||
.. _dg-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. At minimum, you will want to set up your Root CA in the first guide.
|
||||
|
||||
.. tip:: 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 are available even with no Internet access!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: lan-mac
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Trust your Start9 server's Root Certificate Authority in order to create encrypted connections.
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Configuration
|
||||
:link: backup-mac
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: Setup
|
||||
|
||||
Configure a Network Folder on your Mac (or attached external drive) to receive StartOS backups.
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-mac
|
||||
:class: large-4
|
||||
:anchor: Run Tor
|
||||
|
||||
Run Tor natively (in the background) on your Mac. This will enable apps to communicate with your Start9 server via the Tor Network, remotely.
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-mac
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Config
|
||||
|
||||
Configure Firefox for an optimal experience with your server.
|
||||
|
||||
.. topic-box::
|
||||
:title: Screensharing
|
||||
:link: screenshare-mac
|
||||
:icon: scylla-icon scylla-icon--workshop
|
||||
:class: large-4
|
||||
:anchor: Share Screen
|
||||
|
||||
Guide to allow screensharing with a Start9 Support Tech.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
lan-mac
|
||||
backup-mac
|
||||
tor-mac
|
||||
ff-mac
|
||||
screenshare-mac
|
||||
@@ -3,6 +3,7 @@
|
||||
================================
|
||||
Trusting Your Start9 CA on macOS
|
||||
================================
|
||||
Complete this guide to download your Start9 server's Root Certificate Authority (CA), and trust it on your client device (Mac). This allows you to use encrypted ``https`` connections to your ``.local`` (LAN) and ``.onion`` (tor) server addresses, access services on LAN, and enhances performance on tor. The self-signed certificate was created by your server when you perfomed the initial setup, and applies to your server's main UI connection, as well as all service connections.
|
||||
|
||||
#. In your Start9 server's UI, navigate to **System** -> **LAN**
|
||||
|
||||
@@ -55,6 +56,4 @@ Trusting Your Start9 CA on macOS
|
||||
|
||||
.. tip:: If the keychain console did not show the certificate as trusted, press "Command + spacebar" and type “Keychain Access”, and hit enter to re-open it.
|
||||
|
||||
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.
|
||||
You're now ready to browse your service UIs with encryption, either via the browser, or with native client apps. For Mozilla apps, such as Firefox, you will need to follow the :ref:`Firefox Config <lan-ff>` guide, which we highly recommend.
|
||||
@@ -1,18 +1,12 @@
|
||||
.. _dg-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
|
||||
|
||||
* :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 StartOS backups.
|
||||
.. _screenshare-mac:
|
||||
|
||||
=============
|
||||
Screensharing
|
||||
-------------
|
||||
You may run into an issue and want to have a support call where we ask you to share your screen with us. While we understand if you'd rather not do this, it can make troubleshooting issues a lot easier. We will send you a Jitsi link and from there you can share your screen. If it doesn't work, please see the following instructions:
|
||||
=============
|
||||
|
||||
.. warning:: BE CERTAIN you are communicating with an official Start9 team member. Do not be fooled by impostors. If you are unsure, please `contact us <https://start9.com/contact>`_.
|
||||
|
||||
You may run into an issue and want to have a support call where we ask you to share your screen with us. While we understand if you'd rather not do this, it can make troubleshooting issues a lot easier. We will direct you on how you can share your screen. If it doesn't work, please see the following instructions:
|
||||
|
||||
.. tabs::
|
||||
|
||||
@@ -114,7 +114,7 @@ Enable Tor System-wide
|
||||
|
||||
cat /usr/local/var/log/tor.log || sudo cat /opt/homebrew/var/log/tor.log
|
||||
|
||||
If you'd like to setup Firefox to use Tor you can follow :ref:`this guide<torff-mac>`.
|
||||
If you'd like to setup Firefox to use Tor you can follow :ref:`this guide<ff-mac>`.
|
||||
|
||||
.. group-tab:: Pre-Ventura
|
||||
|
||||
@@ -176,4 +176,4 @@ Enable Tor System-wide
|
||||
|
||||
cat /usr/local/var/log/tor.log || sudo cat /opt/homebrew/var/log/tor.log
|
||||
|
||||
If you'd like to setup Firefox to use Tor you can follow :ref:`this guide<torff-mac>`.
|
||||
If you'd like to setup Firefox to use Tor you can follow :ref:`this guide<ff-mac>`.
|
||||
@@ -1,9 +1,8 @@
|
||||
.. _torff-windows:
|
||||
|
||||
======================================
|
||||
Configuring Firefox for Tor on Windows
|
||||
======================================
|
||||
.. _ff-windows:
|
||||
|
||||
==============================
|
||||
Configuring Firefox on Windows
|
||||
==============================
|
||||
.. caution:: This guide assumes you have completed :ref:`setting up Tor<tor-windows>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
|
||||
59
site/source/guides/device-guides/dg-windows/index.rst
Normal file
59
site/source/guides/device-guides/dg-windows/index.rst
Normal file
@@ -0,0 +1,59 @@
|
||||
.. _dg-windows:
|
||||
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. At minimum, you will want to set up your Root CA in the first guide.
|
||||
|
||||
.. tip:: 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 are available even with no Internet access!
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Trust Root CA
|
||||
:link: lan-windows
|
||||
:icon: scylla-icon scylla-icon--partners
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Trust your Start9 server's Root Certificate Authority in order to create encrypted connections.
|
||||
|
||||
.. topic-box::
|
||||
:title: Backup Configuration
|
||||
:link: backup-windows
|
||||
:icon: scylla-icon scylla-icon--cloud
|
||||
:class: large-4
|
||||
:anchor: Setup
|
||||
|
||||
Configure a Network Folder on your Windows machine (or attached external drive) to receive StartOS backups.
|
||||
|
||||
.. topic-box::
|
||||
:title: Connect to Tor Network
|
||||
:icon: scylla-icon scylla-icon--networking
|
||||
:link: tor-windows
|
||||
:class: large-4
|
||||
:anchor: Run Tor
|
||||
|
||||
Run Tor natively (in the background) on your Windows device. This will enable apps to communicate with your Start9 server via the Tor Network, remotely.
|
||||
|
||||
.. topic-box::
|
||||
:title: Configure Firefox
|
||||
:link: ff-windows
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Config
|
||||
|
||||
Configure Firefox for an optimal experience with your server.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:hidden:
|
||||
|
||||
lan-windows
|
||||
backup-windows
|
||||
tor-windows
|
||||
ff-windows
|
||||
@@ -3,20 +3,36 @@
|
||||
==================================
|
||||
Trusting Your Start9 CA On Windows
|
||||
==================================
|
||||
Complete this guide to download your Start9 server's Root Certificate Authority (CA), and trust it on your client device (Windows). This allows you to use encrypted ``https`` connections to your ``.local`` (LAN) and ``.onion`` (tor) server addresses, access services on LAN, and enhances performance on tor. The self-signed certificate was created by your server when you perfomed the initial setup, and applies to your server's main UI connection, as well as all service connections.
|
||||
|
||||
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.
|
||||
|
||||
.. note:: Recently many users who have run through the following instructions have successfully connected to their Start9 server via LAN only to have it stop working a few days or weeks later. We believe this to be due to a recent change in Windows. When this happens the fix is to simply reinstall Bonjour and Bonjour Print Services. A solution is being worked on and Bonjour will not be necessary to connect to your Start9 server for much longer.
|
||||
.. note:: Some users who run through the following instructions have successfully connected to their LAN services only to have them stop working weeks or months later. We believe this to be due to a change in Windows. When this happens the fix is to simply reinstall Bonjour and Bonjour Print Services. A solution is being worked on and Bonjour will not be necessary to connect to your Start9 server for much longer.
|
||||
|
||||
Download Root CA
|
||||
----------------
|
||||
First, download your Start9 server's Root CA, if you have not already.
|
||||
|
||||
- Navigate to *System > LAN*, then click "Download Certificate".
|
||||
|
||||
.. figure:: /_static/images/ssl/lan_setup.png
|
||||
:width: 40%
|
||||
:alt: LAN setup menu item
|
||||
|
||||
Alternatively, you can download to another machine, then transfer the file to your device.
|
||||
|
||||
Trust Root CA
|
||||
-------------
|
||||
|
||||
#. Install `Bonjour Print Services <https://support.apple.com/kb/DL999>`_ on your Windows machine.
|
||||
|
||||
.. tip:: If you are experiencing issues after installing Bonjour, you might have had a previous or failed install. To fix:
|
||||
|
||||
#. Check out this video: https://www.youtube.com/watch?v=9ECCB3bqNDQ
|
||||
#. Uninstall Bonjour and Bonjour Print Services completely via *system settings > remove programs*
|
||||
#. Reinstall Bonjour Printer Driver package (download at https://support.apple.com/kb/DL999?locale=en_US)
|
||||
#. Restart Windows
|
||||
#. Note: Uninstalling Bonjour via the setup package seems to be not enough to solve the issue. Bonjour must be uninstalled via windows system settings.
|
||||
#. Check out this video: https://www.youtube.com/watch?v=9ECCB3bqNDQ
|
||||
#. Uninstall Bonjour and Bonjour Print Services completely via *system settings > remove programs*
|
||||
#. Reinstall Bonjour Printer Driver package (download at https://support.apple.com/kb/DL999?locale=en_US)
|
||||
#. Restart Windows
|
||||
#. Note: Uninstalling Bonjour via the setup package seems to be not enough to solve the issue. Bonjour must be uninstalled via windows system settings.
|
||||
|
||||
#. Back in Windows, click the “Start” menu, type “mmc”, and select "Run as administrator" to access the Windows Management Console.
|
||||
|
||||
@@ -92,4 +108,4 @@ Unfortunately, Windows does not have mDNS alias support built-in, which is neces
|
||||
:width: 20%
|
||||
:alt: Console settings
|
||||
|
||||
You're now ready to browse your service UIs with encryption, either via the browser, or with native client apps. You may wish to :ref:`configure Firefox<lan-ff>` and/or :ref:`Thunderbird<lan-thunderbird>` next.
|
||||
You're now ready to browse your service UIs with encryption, either via the browser, or with native client apps. For Mozilla apps, such as Firefox, you will need to follow the :ref:`Firefox Config <lan-ff>` guide, which we highly recommend.
|
||||
67
site/source/guides/device-guides/index.rst
Normal file
67
site/source/guides/device-guides/index.rst
Normal file
@@ -0,0 +1,67 @@
|
||||
.. _device-guides:
|
||||
|
||||
=============
|
||||
Device Guides
|
||||
=============
|
||||
Guides for integrating your devices with your Start9 server.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Linux
|
||||
:link: dg-linux
|
||||
:icon: scylla-icon scylla-icon--linux
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Linux devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Mac
|
||||
:link: dg-mac
|
||||
:icon: scylla-icon scylla-icon--apple
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Mac devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Windows
|
||||
:link: dg-windows
|
||||
:icon: scylla-icon scylla-icon--windows
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Windows devices
|
||||
|
||||
.. topic-box::
|
||||
:title: Android
|
||||
:link: dg-android
|
||||
:icon: scylla-icon scylla-icon--android
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate Android devices
|
||||
|
||||
.. topic-box::
|
||||
:title: iOS
|
||||
:icon: scylla-icon scylla-icon--ios
|
||||
:link: dg-ios
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate iOS devices
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
dg-linux/index
|
||||
dg-mac/index
|
||||
dg-windows/index
|
||||
dg-android/index
|
||||
dg-ios/index
|
||||
16
site/source/guides/index.rst
Normal file
16
site/source/guides/index.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
.. _guides:
|
||||
|
||||
======
|
||||
Guides
|
||||
======
|
||||
Guides for integrating your client devices with your Start9 server, building your own server (DIY), upgrading hardware, password resets, and more.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
device-guides/index
|
||||
service-guides/index
|
||||
upgrade-hardware/index
|
||||
flashing/index
|
||||
reset-password
|
||||
misc-guides/index
|
||||
12
site/source/guides/misc-guides/index.rst
Normal file
12
site/source/guides/misc-guides/index.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
.. _misc-guides:
|
||||
|
||||
===========
|
||||
Misc Guides
|
||||
===========
|
||||
These guides are for setting up individual applications that may need a manual configuration. These are only needed in rare cases.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-ff
|
||||
lan-thunderbird
|
||||
112
site/source/guides/misc-guides/lan-ff.rst
Normal file
112
site/source/guides/misc-guides/lan-ff.rst
Normal file
@@ -0,0 +1,112 @@
|
||||
.. _lan-ff:
|
||||
|
||||
==================================
|
||||
Trusting Your Start9 CA in Firefox
|
||||
==================================
|
||||
This guide applies to Firefox, Firefox ESR, and Librewolf. Mozilla apps need to be configured to use the certificate store of your device. To find out why Mozilla does this differently, you can read their `blog post <https://blog.mozilla.org/security/2019/02/14/why-does-mozilla-maintain-our-own-root-certificate-store/>`_ on the topic.
|
||||
|
||||
.. caution:: You will first need to complete the :ref:`Trust Root CA <trust-ca>` guide for your device before continuing.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. group-tab:: Linux
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
|
||||
|
||||
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
Most Debian-based distributions (Debian, Linux Mint, PopOS, Ubuntu, etc) will require the following setup. If you run Arch, CentOS, Garuda, Fedora, etc, then you may skip all the way down to :ref:`Restart Firefox<restart-ff>`.
|
||||
|
||||
For each Mozilla-based application (Firefox, Firefox ESR, LibreWolf, Thunderbird, etc) you plan on using, you will need to complete the following guide. This is in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store.
|
||||
|
||||
#. Select the hamgurger menu, then *Settings*, then search for "*security devices*", then select "*Security Devices...*"
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-1.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #1
|
||||
|
||||
#. When the Device Manager dialog window opens, select "*Load*"
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-2.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #2
|
||||
|
||||
#. Give the Module Name a title such as "*System CA Trust Module*" and for the Module filename, paste in ``/usr/lib/x86_64-linux-gnu/pkcs11/p11-kit-trust.so`` and hit *OK*:
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-3.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #3
|
||||
|
||||
#. Verify that the new module shows up on the left hand side and select *OK* at the bottom right:
|
||||
|
||||
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-4.png
|
||||
:width: 60%
|
||||
:alt: Mozilla application p11kit trust #4
|
||||
|
||||
.. _restart-ff:
|
||||
|
||||
Now restart Firefox (or other Mozilla application), and log in to your server using ``https``. You should now see this symbol indicating a secure connection:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. tip:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. You will need to remove it by clicking the lock and then "Connection not secure":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 1)
|
||||
|
||||
Then click "Remove Exception":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 2)
|
||||
|
||||
You should now see that the website is trusted as in the final step show above.
|
||||
|
||||
.. group-tab:: Mac/Windows
|
||||
|
||||
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
|
||||
|
||||
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
#. Now restart Firefox and you should now see this symbol indicating a secure connection:
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
|
||||
:width: 80%
|
||||
:alt: Firefox security settings
|
||||
|
||||
.. note:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. To remove it, click the lock and go to "Connection not secure":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 1)
|
||||
|
||||
Then click "Remove Exception":
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
|
||||
:width: 80%
|
||||
:alt: Firefox - Remove security exception (Part 2)
|
||||
|
||||
You should now see that the website is trusted as in the final step show above.
|
||||
|
||||
.. group-tab:: Android
|
||||
|
||||
#. To setup in Firefox Beta or Fennec, tap the kebab menu, then go to *Settings > About Firefox Beta* and tap the Firefox logo five times until it says "Debug menu enabled."
|
||||
|
||||
#. Return to *Settings > Secret Settings* and enable "Use third party CA certificates".
|
||||
|
||||
.. group-tab:: iOS
|
||||
|
||||
No additional configuration for iOS is required, as all iOS browsers are really Safari under the hood.
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@
|
||||
======================================
|
||||
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.
|
||||
.. caution:: You will first need to complete :ref:`device-guides` for your client before continuing. Take special note of the Thunderbird-specific instructions there.
|
||||
|
||||
.. tabs::
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
.. _reset-password:
|
||||
|
||||
===================
|
||||
Reset Your Password
|
||||
===================
|
||||
==============
|
||||
Password Reset
|
||||
==============
|
||||
If you forgot or lost your StartOS master password, you can use this guide to reset it. If you simply want to change your password, that can be done via the web-UI by following the :ref:`change password guide<change-password>`.
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
@@ -3,7 +3,6 @@
|
||||
==============
|
||||
Service Guides
|
||||
==============
|
||||
|
||||
These guides will help you to setup external tools to connect or interact with specific :ref:`Services<managing-services>`.
|
||||
|
||||
.. toctree::
|
||||
@@ -10,7 +10,7 @@ If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace
|
||||
|
||||
.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
|
||||
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<connecting-ff>`
|
||||
|
||||
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
|
||||
#. On the Alby welcome screen, select **Get Started**.
|
||||
@@ -9,7 +9,7 @@ Alby
|
||||
|
||||
Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over connecting via LNbits which allows allocation of funds.
|
||||
|
||||
Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
|
||||
Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<connecting-ff>`
|
||||
|
||||
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
|
||||
#. On the Alby welcome screen, select **Get Started**.
|
||||
@@ -66,7 +66,7 @@ Make sure you are already :ref:`running Tor<connecting-tor>` on your system and
|
||||
:width: 45%
|
||||
:alt: alby-lnbits-fields-complete
|
||||
|
||||
.. tip:: Make sure to include the http:// at the start of the address. If it is not working make sure that you are already :ref:`running Tor<connecting-tor>` on your system and that your browser is :ref:`configured to use Tor.<tor-firefox>`
|
||||
.. tip:: Make sure to include the http:// at the start of the address. If it is not working make sure that you are already :ref:`running Tor<connecting-tor>` on your system and that your browser is :ref:`configured to use Tor.<connecting-ff>`
|
||||
|
||||
#. Once connected you should see the following success page:
|
||||
|
||||
@@ -10,7 +10,7 @@ If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace
|
||||
|
||||
.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
|
||||
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
|
||||
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<connecting-ff>`
|
||||
|
||||
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
|
||||
#. On the Alby welcome screen, select **Get Started**.
|
||||
@@ -39,7 +39,7 @@ If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace
|
||||
:width: 50%
|
||||
:alt: alby-lnd-rest-entered
|
||||
|
||||
.. note:: If this does not work, please ensure that :ref:`Tor is running on your system<connecting-tor>` and that :ref:`Firefox is configured to use it.<tor-firefox>` If you can't get this to work it's OK to use the Companion App - but you will have a better experience with your Start9 server elsewhere if you take the time to get Tor running on your devices.
|
||||
.. note:: If this does not work, please ensure that :ref:`Tor is running on your system<connecting-tor>` and that :ref:`Firefox is configured to use it.<connecting-ff>` If you can't get this to work it's OK to use the Companion App - but you will have a better experience with your Start9 server elsewhere if you take the time to get Tor running on your devices.
|
||||
|
||||
#. Once connection is completed you will see a success page that displays the balance of your LND node in Sats.
|
||||
|
||||
@@ -21,7 +21,7 @@ If you are looking to connect the `Alby <https://github.com/getAlby/lightning-br
|
||||
Setting up LNbits
|
||||
-----------------
|
||||
|
||||
.. note:: You will need a Tor enabled browser. We suggest using Firefox which will need to have been setup to use Tor - if you have yet to do this please see our guide :ref:`here<tor-firefox>`. This also requires having :ref:`native tor setup<tor-os>`.
|
||||
.. note:: You will need a Tor enabled browser. We suggest using Firefox which will need to have been setup to use Tor - if you have yet to do this please see our guide :ref:`here<connecting-ff>`. This also requires having :ref:`native tor setup<connecting-tor>`.
|
||||
|
||||
#. Start by ensuring that you have LNbits installed already as well as LND or Core Lightning (CLN). You also need your lightning node to have at least one channel set up otherwise payments will not work. If you have not set up a channel yet, please follow :ref:`this guide<lightning-intro>`.
|
||||
|
||||
@@ -16,7 +16,7 @@ Desktop Integrations
|
||||
--------------------
|
||||
Many Linux distributions ship with a Desktop Environment (DE) that supports Nextcloud account integration directly for use with their built-in calendars and other applications. It is recommended to try these first for the best possible experience with your particular flavor of Linux.
|
||||
|
||||
You will first need to :ref:`add your Root CA to your system<lan-linux-system>`.
|
||||
You will first need to :ref:`add your Root CA to your system<lan-linux>`.
|
||||
|
||||
The following desktop environments support integrated account syncing, including Nextcloud:
|
||||
|
||||
@@ -66,7 +66,7 @@ If you wish to use a standalone client for Calendar and Contacts, we recommend M
|
||||
1. Install the Contacts and Calendar apps in Nextcloud.
|
||||
2. Make sure you are on Thunderbird version 102.3.0 or greater and then import your LAN certificate:
|
||||
|
||||
- First, follow the :ref:`instructions for adding your Root CA to your system<lan-linux-system>` and then the :ref:`Thunderbird-specific instructions<lan-thunderbird>`.
|
||||
- First, follow the :ref:`instructions for adding your Root CA to your system<lan-linux>` and then the :ref:`Thunderbird-specific instructions<lan-thunderbird>`.
|
||||
|
||||
3. Download the `TBSync` and `Provider for CalDAV & CardDAV` add-ons by searching for them in the "Tools -> Add-ons and Themes" menu.
|
||||
4. Go back to "Tools -> Add-ons and Themes -> Extensions" and click the 'wrench' icon next to TBSync.
|
||||
@@ -15,7 +15,7 @@ Browser Extension
|
||||
|
||||
If connecting via Tor (i.e using the .onion address) the Bitwarden browser extension will only work with a Tor enabled browser. You can use Firefox (recommended), Tor Browser or Brave Browser.
|
||||
|
||||
#. If you choose Firefox, you will need to :ref:`setup Tor on your device <tor-os>` and :ref:`configure Firefox to use Tor <tor-firefox>`. If using Brave you will just need to :ref:`setup Tor on your device <tor-os>`. With Tor Browser, everything will just work right out of the box.
|
||||
#. If you choose Firefox, you will need to :ref:`setup Tor on your device <connecting-tor>` and :ref:`configure Firefox to use Tor <connecting-ff>`. If using Brave you will just need to :ref:`setup Tor on your device <connecting-tor>`. With Tor Browser, everything will just work right out of the box.
|
||||
|
||||
.. tip:: We recommend using Firefox as it is the most compatible browser with Start9 Servers.
|
||||
|
||||
@@ -62,7 +62,6 @@ Guides for migrating or upgrading your server's hardware.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
LND migration <lnd-migration>
|
||||
SSD upgrade <drive-upgrade>
|
||||
@@ -26,7 +26,16 @@
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
|
||||
Get started with your Start9 server
|
||||
Setup, understand, and utilize your personal server
|
||||
|
||||
.. topic-box::
|
||||
:title: Guides
|
||||
:link: guides
|
||||
:icon: scylla-icon scylla-icon--circe
|
||||
:class: large-4
|
||||
:anchor: Connect
|
||||
|
||||
Integrate your devices and tools
|
||||
|
||||
.. topic-box::
|
||||
:title: Support
|
||||
@@ -44,23 +53,14 @@
|
||||
:class: large-4
|
||||
:anchor: Build your own
|
||||
|
||||
Guides for builders, hackers, and tinkerers
|
||||
|
||||
.. topic-box::
|
||||
:title: Learn
|
||||
:link: learn
|
||||
:icon: scylla-icon scylla-icon--webinars
|
||||
:class: large-4
|
||||
:anchor: Get started
|
||||
|
||||
Read our FAQ, watch videos, and understand platform concepts
|
||||
Recommendations for builders, hackers, and tinkerers
|
||||
|
||||
.. topic-box::
|
||||
:title: Developer Docs
|
||||
:link: developer-docs
|
||||
:icon: scylla-icon scylla-icon--open-source
|
||||
:class: large-4
|
||||
:anchor: View
|
||||
:anchor: Hack
|
||||
|
||||
Package a service for the Marketplace
|
||||
|
||||
@@ -79,11 +79,11 @@
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
:maxdepth: 5
|
||||
:hidden:
|
||||
|
||||
user-manual/index
|
||||
guides/index
|
||||
support/index
|
||||
diy/index
|
||||
learn/index
|
||||
developer-docs/index
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
.. _learn:
|
||||
|
||||
=====
|
||||
Learn
|
||||
=====
|
||||
|
||||
Here you will find information on concepts that will help you understand the technologies used by and relevant to your device, as well as find answers to common questions, and a video library with a wide array of content, from educational to how-to.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Concepts
|
||||
:link: concepts
|
||||
:icon: scylla-icon scylla-icon--operator
|
||||
:class: large-4
|
||||
:anchor: Learn
|
||||
|
||||
An overview of the ideas and technologies surrounding Start9 and StartOS.
|
||||
|
||||
.. topic-box::
|
||||
:title: FAQ
|
||||
:link: ../support/faq
|
||||
:icon: scylla-icon scylla-icon--monitoring
|
||||
:class: large-4
|
||||
:anchor: Get Answers
|
||||
|
||||
Answers to Frequently Asked Questions from StartOS users.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
</div></div>
|
||||
|
||||
|
||||
.. This is for the side navigation display
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
concepts/index
|
||||
../support/faq/index
|
||||
|
||||
@@ -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.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user