diff --git a/site/source/_static/images/config/password_change_ui-1.png b/site/source/_static/images/config/password_change_ui-1.png new file mode 100644 index 0000000..4be1685 Binary files /dev/null and b/site/source/_static/images/config/password_change_ui-1.png differ diff --git a/site/source/_static/images/config/password_change_ui-2.png b/site/source/_static/images/config/password_change_ui-2.png new file mode 100644 index 0000000..05432d4 Binary files /dev/null and b/site/source/_static/images/config/password_change_ui-2.png differ diff --git a/site/source/_static/images/config/password_change_ui-3.png b/site/source/_static/images/config/password_change_ui-3.png new file mode 100644 index 0000000..b4b1f23 Binary files /dev/null and b/site/source/_static/images/config/password_change_ui-3.png differ diff --git a/site/source/_static/images/config/password_change_ui-4.png b/site/source/_static/images/config/password_change_ui-4.png new file mode 100644 index 0000000..28f3150 Binary files /dev/null and b/site/source/_static/images/config/password_change_ui-4.png differ diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst b/site/source/guides/device-guides/dg-android/ff-android.rst similarity index 55% rename from site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst rename to site/source/guides/device-guides/dg-android/ff-android.rst index b1e1ca4..8b4e707 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst +++ b/site/source/guides/device-guides/dg-android/ff-android.rst @@ -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`. 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` and :ref:`Tor is running on your device`, you can proceed to configure Firefox: #. Download `Firefox Beta `_ from the Play Store, or `Fennec `_ 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 `_. +#. Next, download the `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here `_. #. 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` 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. diff --git a/site/source/guides/device-guides/dg-android/index.rst b/site/source/guides/device-guides/dg-android/index.rst new file mode 100644 index 0000000..d56c58b --- /dev/null +++ b/site/source/guides/device-guides/dg-android/index.rst @@ -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 + +
+ +
+ +.. 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 diff --git a/site/source/guides/device-guides/dg-android/lan-android.rst b/site/source/guides/device-guides/dg-android/lan-android.rst new file mode 100644 index 0000000..0afe5fb --- /dev/null +++ b/site/source/guides/device-guides/dg-android/lan-android.rst @@ -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 ` guide, which we highly recommend. diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst b/site/source/guides/device-guides/dg-android/tor-android.rst similarity index 87% rename from site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst rename to site/source/guides/device-guides/dg-android/tor-android.rst index ab55913..f485940 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst +++ b/site/source/guides/device-guides/dg-android/tor-android.rst @@ -3,44 +3,42 @@ ====================== Running Tor on Android ====================== - Some apps, such as :ref:`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 `_, or from `F-Droid `_ (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): diff --git a/site/source/guides/device-guides/dg-ios/index.rst b/site/source/guides/device-guides/dg-ios/index.rst new file mode 100644 index 0000000..78ecd47 --- /dev/null +++ b/site/source/guides/device-guides/dg-ios/index.rst @@ -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 + +
+ +
+ +.. 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 diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-ios.rst b/site/source/guides/device-guides/dg-ios/lan-ios.rst similarity index 81% rename from site/source/user-manual/connecting/connecting-lan/lan-os/lan-ios.rst rename to site/source/guides/device-guides/dg-ios/lan-ios.rst index e1c2b9a..4c76217 100644 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-ios.rst +++ b/site/source/guides/device-guides/dg-ios/lan-ios.rst @@ -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 `_. - #. 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 `_. +#. 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. diff --git a/site/source/user-manual/backups/backup-setup/backup-linux.rst b/site/source/guides/device-guides/dg-linux/backup-linux.rst similarity index 97% rename from site/source/user-manual/backups/backup-setup/backup-linux.rst rename to site/source/guides/device-guides/dg-linux/backup-linux.rst index dceaadd..f84b9cd 100644 --- a/site/source/user-manual/backups/backup-setup/backup-linux.rst +++ b/site/source/guides/device-guides/dg-linux/backup-linux.rst @@ -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:: diff --git a/site/source/guides/device-guides/dg-linux/ff-linux.rst b/site/source/guides/device-guides/dg-linux/ff-linux.rst new file mode 100644 index 0000000..33d3ece --- /dev/null +++ b/site/source/guides/device-guides/dg-linux/ff-linux.rst @@ -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 `_ 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`. 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 `, and use client integrations such as :ref:`Vaultwarden` apps and extensions. You can test this by going to Start9's ``.onion`` homepage, `here `_. + +If you still encounter issues, `contact support `_. + diff --git a/site/source/guides/device-guides/dg-linux/index.rst b/site/source/guides/device-guides/dg-linux/index.rst new file mode 100644 index 0000000..9617e54 --- /dev/null +++ b/site/source/guides/device-guides/dg-linux/index.rst @@ -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 + +
+ +
+ +.. 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 diff --git a/site/source/guides/device-guides/dg-linux/lan-linux.rst b/site/source/guides/device-guides/dg-linux/lan-linux.rst new file mode 100644 index 0000000..e98f713 --- /dev/null +++ b/site/source/guides/device-guides/dg-linux/lan-linux.rst @@ -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 ` 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 ".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 ".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 ` guide, which we highly recommend. diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-linux.rst b/site/source/guides/device-guides/dg-linux/tor-linux.rst similarity index 100% rename from site/source/user-manual/connecting/connecting-tor/tor-os/tor-linux.rst rename to site/source/guides/device-guides/dg-linux/tor-linux.rst diff --git a/site/source/user-manual/backups/backup-setup/backup-mac.rst b/site/source/guides/device-guides/dg-mac/backup-mac.rst similarity index 100% rename from site/source/user-manual/backups/backup-setup/backup-mac.rst rename to site/source/guides/device-guides/dg-mac/backup-mac.rst diff --git a/site/source/guides/device-guides/dg-mac/ff-mac.rst b/site/source/guides/device-guides/dg-mac/ff-mac.rst new file mode 100644 index 0000000..c685352 --- /dev/null +++ b/site/source/guides/device-guides/dg-mac/ff-mac.rst @@ -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`. 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 `_. + +If you still encounter issues, `contact support `_. diff --git a/site/source/guides/device-guides/dg-mac/index.rst b/site/source/guides/device-guides/dg-mac/index.rst new file mode 100644 index 0000000..31a706c --- /dev/null +++ b/site/source/guides/device-guides/dg-mac/index.rst @@ -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 + +
+ +
+ +.. 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 diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst b/site/source/guides/device-guides/dg-mac/lan-mac.rst similarity index 79% rename from site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst rename to site/source/guides/device-guides/dg-mac/lan-mac.rst index 1214234..168f5d5 100644 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst +++ b/site/source/guides/device-guides/dg-mac/lan-mac.rst @@ -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 ` 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 ` guide, which we highly recommend. diff --git a/site/source/user-manual/device-guides/dg-mac.rst b/site/source/guides/device-guides/dg-mac/screenshare-mac.rst similarity index 70% rename from site/source/user-manual/device-guides/dg-mac.rst rename to site/source/guides/device-guides/dg-mac/screenshare-mac.rst index 2803e7c..c66db55 100644 --- a/site/source/user-manual/device-guides/dg-mac.rst +++ b/site/source/guides/device-guides/dg-mac/screenshare-mac.rst @@ -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 `_. + +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:: diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-mac.rst b/site/source/guides/device-guides/dg-mac/tor-mac.rst similarity index 99% rename from site/source/user-manual/connecting/connecting-tor/tor-os/tor-mac.rst rename to site/source/guides/device-guides/dg-mac/tor-mac.rst index 8557702..858a873 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-mac.rst +++ b/site/source/guides/device-guides/dg-mac/tor-mac.rst @@ -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`. + If you'd like to setup Firefox to use Tor you can follow :ref:`this guide`. .. 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`. + If you'd like to setup Firefox to use Tor you can follow :ref:`this guide`. diff --git a/site/source/user-manual/backups/backup-setup/backup-windows.rst b/site/source/guides/device-guides/dg-windows/backup-windows.rst similarity index 100% rename from site/source/user-manual/backups/backup-setup/backup-windows.rst rename to site/source/guides/device-guides/dg-windows/backup-windows.rst diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst b/site/source/guides/device-guides/dg-windows/ff-windows.rst similarity index 94% rename from site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst rename to site/source/guides/device-guides/dg-windows/ff-windows.rst index 932d4c8..36fa9b5 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst +++ b/site/source/guides/device-guides/dg-windows/ff-windows.rst @@ -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`. 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. diff --git a/site/source/guides/device-guides/dg-windows/index.rst b/site/source/guides/device-guides/dg-windows/index.rst new file mode 100644 index 0000000..c327e0e --- /dev/null +++ b/site/source/guides/device-guides/dg-windows/index.rst @@ -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 + +
+ +
+ +.. 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 diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-windows.rst b/site/source/guides/device-guides/dg-windows/lan-windows.rst similarity index 66% rename from site/source/user-manual/connecting/connecting-lan/lan-os/lan-windows.rst rename to site/source/guides/device-guides/dg-windows/lan-windows.rst index 1d4e671..9756503 100644 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-windows.rst +++ b/site/source/guides/device-guides/dg-windows/lan-windows.rst @@ -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` 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 `_ 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` and/or :ref:`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 ` guide, which we highly recommend. diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-windows.rst b/site/source/guides/device-guides/dg-windows/tor-windows.rst similarity index 100% rename from site/source/user-manual/connecting/connecting-tor/tor-os/tor-windows.rst rename to site/source/guides/device-guides/dg-windows/tor-windows.rst diff --git a/site/source/guides/device-guides/index.rst b/site/source/guides/device-guides/index.rst new file mode 100644 index 0000000..61b3511 --- /dev/null +++ b/site/source/guides/device-guides/index.rst @@ -0,0 +1,67 @@ +.. _device-guides: + +============= +Device Guides +============= +Guides for integrating your devices with your Start9 server. + +.. raw:: html + +
+ +
+ +.. 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 diff --git a/site/source/user-manual/flashing/flashing-firmware.rst b/site/source/guides/flashing/flashing-firmware.rst similarity index 100% rename from site/source/user-manual/flashing/flashing-firmware.rst rename to site/source/guides/flashing/flashing-firmware.rst diff --git a/site/source/user-manual/flashing/flashing-pi.rst b/site/source/guides/flashing/flashing-pi.rst similarity index 100% rename from site/source/user-manual/flashing/flashing-pi.rst rename to site/source/guides/flashing/flashing-pi.rst diff --git a/site/source/user-manual/flashing/flashing-x86.rst b/site/source/guides/flashing/flashing-x86.rst similarity index 100% rename from site/source/user-manual/flashing/flashing-x86.rst rename to site/source/guides/flashing/flashing-x86.rst diff --git a/site/source/user-manual/flashing/index.rst b/site/source/guides/flashing/index.rst similarity index 100% rename from site/source/user-manual/flashing/index.rst rename to site/source/guides/flashing/index.rst diff --git a/site/source/guides/index.rst b/site/source/guides/index.rst new file mode 100644 index 0000000..b5a42e0 --- /dev/null +++ b/site/source/guides/index.rst @@ -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 diff --git a/site/source/guides/misc-guides/index.rst b/site/source/guides/misc-guides/index.rst new file mode 100644 index 0000000..bc23b6c --- /dev/null +++ b/site/source/guides/misc-guides/index.rst @@ -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 diff --git a/site/source/guides/misc-guides/lan-ff.rst b/site/source/guides/misc-guides/lan-ff.rst new file mode 100644 index 0000000..df04188 --- /dev/null +++ b/site/source/guides/misc-guides/lan-ff.rst @@ -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 `_ on the topic. + +.. caution:: You will first need to complete the :ref:`Trust Root 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`. + + 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. + + diff --git a/site/source/user-manual/connecting/connecting-lan/lan-thunderbird.rst b/site/source/guides/misc-guides/lan-thunderbird.rst similarity index 86% rename from site/source/user-manual/connecting/connecting-lan/lan-thunderbird.rst rename to site/source/guides/misc-guides/lan-thunderbird.rst index 229e8be..903fe1b 100644 --- a/site/source/user-manual/connecting/connecting-lan/lan-thunderbird.rst +++ b/site/source/guides/misc-guides/lan-thunderbird.rst @@ -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:: diff --git a/site/source/user-manual/reset-password.rst b/site/source/guides/reset-password.rst similarity index 87% rename from site/source/user-manual/reset-password.rst rename to site/source/guides/reset-password.rst index 0a4c16e..819f102 100644 --- a/site/source/user-manual/reset-password.rst +++ b/site/source/guides/reset-password.rst @@ -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`. .. contents:: :depth: 2 diff --git a/site/source/user-manual/service-guides/bitcoin/bitcoin-cli.rst b/site/source/guides/service-guides/bitcoin/bitcoin-cli.rst similarity index 100% rename from site/source/user-manual/service-guides/bitcoin/bitcoin-cli.rst rename to site/source/guides/service-guides/bitcoin/bitcoin-cli.rst diff --git a/site/source/user-manual/service-guides/bitcoin/bitcoin-integrations.rst b/site/source/guides/service-guides/bitcoin/bitcoin-integrations.rst similarity index 100% rename from site/source/user-manual/service-guides/bitcoin/bitcoin-integrations.rst rename to site/source/guides/service-guides/bitcoin/bitcoin-integrations.rst diff --git a/site/source/user-manual/service-guides/bitcoin/blockchain-copy.rst b/site/source/guides/service-guides/bitcoin/blockchain-copy.rst similarity index 100% rename from site/source/user-manual/service-guides/bitcoin/blockchain-copy.rst rename to site/source/guides/service-guides/bitcoin/blockchain-copy.rst diff --git a/site/source/user-manual/service-guides/bitcoin/index.rst b/site/source/guides/service-guides/bitcoin/index.rst similarity index 100% rename from site/source/user-manual/service-guides/bitcoin/index.rst rename to site/source/guides/service-guides/bitcoin/index.rst diff --git a/site/source/user-manual/service-guides/index.rst b/site/source/guides/service-guides/index.rst similarity index 99% rename from site/source/user-manual/service-guides/index.rst rename to site/source/guides/service-guides/index.rst index d1a8ca7..10843a0 100644 --- a/site/source/user-manual/service-guides/index.rst +++ b/site/source/guides/service-guides/index.rst @@ -3,7 +3,6 @@ ============== Service Guides ============== - These guides will help you to setup external tools to connect or interact with specific :ref:`Services`. .. toctree:: diff --git a/site/source/user-manual/service-guides/jellyfin/index.rst b/site/source/guides/service-guides/jellyfin/index.rst similarity index 100% rename from site/source/user-manual/service-guides/jellyfin/index.rst rename to site/source/guides/service-guides/jellyfin/index.rst diff --git a/site/source/user-manual/service-guides/jellyfin/jellyfin-clients.rst b/site/source/guides/service-guides/jellyfin/jellyfin-clients.rst similarity index 100% rename from site/source/user-manual/service-guides/jellyfin/jellyfin-clients.rst rename to site/source/guides/service-guides/jellyfin/jellyfin-clients.rst diff --git a/site/source/user-manual/service-guides/lightning/alby-cln.rst b/site/source/guides/service-guides/lightning/alby-cln.rst similarity index 98% rename from site/source/user-manual/service-guides/lightning/alby-cln.rst rename to site/source/guides/service-guides/lightning/alby-cln.rst index 5d1003a..667f3f4 100644 --- a/site/source/user-manual/service-guides/lightning/alby-cln.rst +++ b/site/source/guides/service-guides/lightning/alby-cln.rst @@ -10,7 +10,7 @@ If you'd like to connect via `LNbits ` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.` +#. Make sure you are already :ref:`running Tor` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.` #. Download the Alby extension by visiting the `Alby Github `_, selecting your browser, and installing. #. On the Alby welcome screen, select **Get Started**. diff --git a/site/source/user-manual/service-guides/lightning/alby-lnbits.rst b/site/source/guides/service-guides/lightning/alby-lnbits.rst similarity index 97% rename from site/source/user-manual/service-guides/lightning/alby-lnbits.rst rename to site/source/guides/service-guides/lightning/alby-lnbits.rst index fcbf106..3e09f9c 100644 --- a/site/source/user-manual/service-guides/lightning/alby-lnbits.rst +++ b/site/source/guides/service-guides/lightning/alby-lnbits.rst @@ -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` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.` +Make sure you are already :ref:`running Tor` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.` #. Download the Alby extension by visiting the `Alby Github `_, 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` 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` on your system and that your browser is :ref:`configured to use Tor.` + .. 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` on your system and that your browser is :ref:`configured to use Tor.` #. Once connected you should see the following success page: diff --git a/site/source/user-manual/service-guides/lightning/alby-lnc.rst b/site/source/guides/service-guides/lightning/alby-lnc.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/alby-lnc.rst rename to site/source/guides/service-guides/lightning/alby-lnc.rst diff --git a/site/source/user-manual/service-guides/lightning/alby-lnd.rst b/site/source/guides/service-guides/lightning/alby-lnd.rst similarity index 88% rename from site/source/user-manual/service-guides/lightning/alby-lnd.rst rename to site/source/guides/service-guides/lightning/alby-lnd.rst index 4e3408c..595f879 100644 --- a/site/source/user-manual/service-guides/lightning/alby-lnd.rst +++ b/site/source/guides/service-guides/lightning/alby-lnd.rst @@ -10,7 +10,7 @@ If you'd like to connect via `LNbits ` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.` +#. Make sure you are already :ref:`running Tor` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.` #. Download the Alby extension by visiting the `Alby Github `_, 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 ` and that :ref:`Firefox is configured to use it.` 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` and that :ref:`Firefox is configured to use it.` 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. diff --git a/site/source/user-manual/service-guides/lightning/bluewallet.rst b/site/source/guides/service-guides/lightning/bluewallet.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/bluewallet.rst rename to site/source/guides/service-guides/lightning/bluewallet.rst diff --git a/site/source/user-manual/service-guides/lightning/connecting-cln.rst b/site/source/guides/service-guides/lightning/connecting-cln.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/connecting-cln.rst rename to site/source/guides/service-guides/lightning/connecting-cln.rst diff --git a/site/source/user-manual/service-guides/lightning/connecting-lnbits.rst b/site/source/guides/service-guides/lightning/connecting-lnbits.rst similarity index 96% rename from site/source/user-manual/service-guides/lightning/connecting-lnbits.rst rename to site/source/guides/service-guides/lightning/connecting-lnbits.rst index 21e61e3..f149fde 100644 --- a/site/source/user-manual/service-guides/lightning/connecting-lnbits.rst +++ b/site/source/guides/service-guides/lightning/connecting-lnbits.rst @@ -21,7 +21,7 @@ If you are looking to connect the `Alby `. This also requires having :ref:`native tor setup`. +.. 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`. This also requires having :ref:`native tor setup`. #. 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`. diff --git a/site/source/user-manual/service-guides/lightning/connecting-lnd.rst b/site/source/guides/service-guides/lightning/connecting-lnd.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/connecting-lnd.rst rename to site/source/guides/service-guides/lightning/connecting-lnd.rst diff --git a/site/source/user-manual/service-guides/lightning/connecting-lndc.rst b/site/source/guides/service-guides/lightning/connecting-lndc.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/connecting-lndc.rst rename to site/source/guides/service-guides/lightning/connecting-lndc.rst diff --git a/site/source/user-manual/service-guides/lightning/index.rst b/site/source/guides/service-guides/lightning/index.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/index.rst rename to site/source/guides/service-guides/lightning/index.rst diff --git a/site/source/user-manual/service-guides/lightning/lightning-first-channel.rst b/site/source/guides/service-guides/lightning/lightning-first-channel.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/lightning-first-channel.rst rename to site/source/guides/service-guides/lightning/lightning-first-channel.rst diff --git a/site/source/user-manual/service-guides/lightning/ride-the-lightning.rst b/site/source/guides/service-guides/lightning/ride-the-lightning.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/ride-the-lightning.rst rename to site/source/guides/service-guides/lightning/ride-the-lightning.rst diff --git a/site/source/user-manual/service-guides/lightning/spark.rst b/site/source/guides/service-guides/lightning/spark.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/spark.rst rename to site/source/guides/service-guides/lightning/spark.rst diff --git a/site/source/user-manual/service-guides/lightning/zap.rst b/site/source/guides/service-guides/lightning/zap.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/zap.rst rename to site/source/guides/service-guides/lightning/zap.rst diff --git a/site/source/user-manual/service-guides/lightning/zeus-cln-direct.rst b/site/source/guides/service-guides/lightning/zeus-cln-direct.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/zeus-cln-direct.rst rename to site/source/guides/service-guides/lightning/zeus-cln-direct.rst diff --git a/site/source/user-manual/service-guides/lightning/zeus-lnbits.rst b/site/source/guides/service-guides/lightning/zeus-lnbits.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/zeus-lnbits.rst rename to site/source/guides/service-guides/lightning/zeus-lnbits.rst diff --git a/site/source/user-manual/service-guides/lightning/zeus-lnc.rst b/site/source/guides/service-guides/lightning/zeus-lnc.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/zeus-lnc.rst rename to site/source/guides/service-guides/lightning/zeus-lnc.rst diff --git a/site/source/user-manual/service-guides/lightning/zeus-lnd-direct.rst b/site/source/guides/service-guides/lightning/zeus-lnd-direct.rst similarity index 100% rename from site/source/user-manual/service-guides/lightning/zeus-lnd-direct.rst rename to site/source/guides/service-guides/lightning/zeus-lnd-direct.rst diff --git a/site/source/user-manual/service-guides/matrix.rst b/site/source/guides/service-guides/matrix.rst similarity index 100% rename from site/source/user-manual/service-guides/matrix.rst rename to site/source/guides/service-guides/matrix.rst diff --git a/site/source/user-manual/service-guides/nextcloud/index.rst b/site/source/guides/service-guides/nextcloud/index.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/index.rst rename to site/source/guides/service-guides/nextcloud/index.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/index.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/index.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/index.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/index.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/joplin.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/joplin.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/joplin.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/joplin.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-files.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-files.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-files.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-files.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-maps.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-maps.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-maps.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-maps.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-memories.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-memories.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-memories.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-memories.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-music.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-music.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-music.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-music.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-news.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-news.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-news.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-news.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-notes.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-notes.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-notes.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-notes.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-photos.rst b/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-photos.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-photos.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-photos.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/index.rst b/site/source/guides/service-guides/nextcloud/nextcloud-setup/index.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-setup/index.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-setup/index.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst b/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst b/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst b/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst similarity index 97% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst index dfd53c4..f7a7a60 100644 --- a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst +++ b/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst @@ -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`. +You will first need to :ref:`add your Root CA to your system`. 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` and then the :ref:`Thunderbird-specific instructions`. + - First, follow the :ref:`instructions for adding your Root CA to your system` and then the :ref:`Thunderbird-specific instructions`. 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. diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst b/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst diff --git a/site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst b/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst similarity index 100% rename from site/source/user-manual/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst rename to site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst diff --git a/site/source/user-manual/service-guides/specter/index.rst b/site/source/guides/service-guides/specter/index.rst similarity index 100% rename from site/source/user-manual/service-guides/specter/index.rst rename to site/source/guides/service-guides/specter/index.rst diff --git a/site/source/user-manual/service-guides/specter/specter-service.rst b/site/source/guides/service-guides/specter/specter-service.rst similarity index 100% rename from site/source/user-manual/service-guides/specter/specter-service.rst rename to site/source/guides/service-guides/specter/specter-service.rst diff --git a/site/source/user-manual/service-guides/vaultwarden/bitwarden-client-setup.rst b/site/source/guides/service-guides/vaultwarden/bitwarden-client-setup.rst similarity index 98% rename from site/source/user-manual/service-guides/vaultwarden/bitwarden-client-setup.rst rename to site/source/guides/service-guides/vaultwarden/bitwarden-client-setup.rst index 7ce3f6d..856e9d7 100644 --- a/site/source/user-manual/service-guides/vaultwarden/bitwarden-client-setup.rst +++ b/site/source/guides/service-guides/vaultwarden/bitwarden-client-setup.rst @@ -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 ` and :ref:`configure Firefox to use Tor `. If using Brave you will just need to :ref:`setup Tor on your device `. 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 ` and :ref:`configure Firefox to use Tor `. If using Brave you will just need to :ref:`setup Tor on your device `. 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. diff --git a/site/source/user-manual/service-guides/vaultwarden/bitwarden-walkthrough.rst b/site/source/guides/service-guides/vaultwarden/bitwarden-walkthrough.rst similarity index 100% rename from site/source/user-manual/service-guides/vaultwarden/bitwarden-walkthrough.rst rename to site/source/guides/service-guides/vaultwarden/bitwarden-walkthrough.rst diff --git a/site/source/user-manual/service-guides/vaultwarden/index.rst b/site/source/guides/service-guides/vaultwarden/index.rst similarity index 100% rename from site/source/user-manual/service-guides/vaultwarden/index.rst rename to site/source/guides/service-guides/vaultwarden/index.rst diff --git a/site/source/user-manual/service-guides/vaultwarden/vaultwarden-organizations.rst b/site/source/guides/service-guides/vaultwarden/vaultwarden-organizations.rst similarity index 100% rename from site/source/user-manual/service-guides/vaultwarden/vaultwarden-organizations.rst rename to site/source/guides/service-guides/vaultwarden/vaultwarden-organizations.rst diff --git a/site/source/user-manual/upgrade-hardware/drive-upgrade.rst b/site/source/guides/upgrade-hardware/drive-upgrade.rst similarity index 100% rename from site/source/user-manual/upgrade-hardware/drive-upgrade.rst rename to site/source/guides/upgrade-hardware/drive-upgrade.rst diff --git a/site/source/user-manual/upgrade-hardware/index.rst b/site/source/guides/upgrade-hardware/index.rst similarity index 99% rename from site/source/user-manual/upgrade-hardware/index.rst rename to site/source/guides/upgrade-hardware/index.rst index 924051f..561d5bf 100644 --- a/site/source/user-manual/upgrade-hardware/index.rst +++ b/site/source/guides/upgrade-hardware/index.rst @@ -62,7 +62,6 @@ Guides for migrating or upgrading your server's hardware. .. toctree:: :maxdepth: 2 - :hidden: LND migration SSD upgrade diff --git a/site/source/user-manual/upgrade-hardware/lnd-migration.rst b/site/source/guides/upgrade-hardware/lnd-migration.rst similarity index 100% rename from site/source/user-manual/upgrade-hardware/lnd-migration.rst rename to site/source/guides/upgrade-hardware/lnd-migration.rst diff --git a/site/source/user-manual/upgrade-hardware/naspi-ssd-upgrade.rst b/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst similarity index 100% rename from site/source/user-manual/upgrade-hardware/naspi-ssd-upgrade.rst rename to site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst diff --git a/site/source/user-manual/upgrade-hardware/naspi-upgrade.rst b/site/source/guides/upgrade-hardware/naspi-upgrade.rst similarity index 100% rename from site/source/user-manual/upgrade-hardware/naspi-upgrade.rst rename to site/source/guides/upgrade-hardware/naspi-upgrade.rst diff --git a/site/source/user-manual/upgrade-hardware/upgrade-pro.rst b/site/source/guides/upgrade-hardware/upgrade-pro.rst similarity index 100% rename from site/source/user-manual/upgrade-hardware/upgrade-pro.rst rename to site/source/guides/upgrade-hardware/upgrade-pro.rst diff --git a/site/source/index.rst b/site/source/index.rst index 77bf78f..8c02f4e 100644 --- a/site/source/index.rst +++ b/site/source/index.rst @@ -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 diff --git a/site/source/learn/index.rst b/site/source/learn/index.rst deleted file mode 100644 index 2c43482..0000000 --- a/site/source/learn/index.rst +++ /dev/null @@ -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 - -
- -
- -.. 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 - -
- - -.. This is for the side navigation display -.. toctree:: - :maxdepth: 2 - :hidden: - - concepts/index - ../support/faq/index - \ No newline at end of file diff --git a/site/source/support/common-issues.rst b/site/source/support/common-issues.rst index eafe2ad..1cc167c 100644 --- a/site/source/support/common-issues.rst +++ b/site/source/support/common-issues.rst @@ -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`. If you received your device from us and it will not power up at all, please `Contact us `_ 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` 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 *.local* (LAN) address ------------------------------------------------------------------------------ - Make sure you have successfully followed the :ref:`LAN Setup` 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 `. 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 `. 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 ` to work with .onion URLs. + #. If you are not yet running a Tor daemon on your device, follow :ref:`these instructions `. 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 ` 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` and :ref:`FAQ` 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 `_ 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 + + + + * "bep" - Starting up + + .. raw:: HTML + + + + * "chime" - Server is ready + + .. raw:: HTML + + + + * "flatline" - Server initialization failed / no network connection + + .. raw:: HTML + + + + * 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. diff --git a/site/source/learn/concepts/bitcoin-lightning.rst b/site/source/support/concepts/bitcoin-lightning.rst similarity index 100% rename from site/source/learn/concepts/bitcoin-lightning.rst rename to site/source/support/concepts/bitcoin-lightning.rst diff --git a/site/source/learn/concepts/index.rst b/site/source/support/concepts/index.rst similarity index 100% rename from site/source/learn/concepts/index.rst rename to site/source/support/concepts/index.rst diff --git a/site/source/learn/concepts/networks.rst b/site/source/support/concepts/networks.rst similarity index 99% rename from site/source/learn/concepts/networks.rst rename to site/source/support/concepts/networks.rst index 7fd49bf..589028f 100644 --- a/site/source/learn/concepts/networks.rst +++ b/site/source/support/concepts/networks.rst @@ -90,4 +90,4 @@ A Tor Hidden Service is essentially just software or a website that is only broa For example, you can visit http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion to view the Start9 homepage on Tor. -In order to reach a Tor Hidden Service, you must use a browser that can handle ``.onion`` domains, such as `The Tor Browser `_ or by configuring :ref:`Firefox `. +In order to reach a Tor Hidden Service, you must use a browser that can handle ``.onion`` domains, such as `The Tor Browser `_ or by configuring :ref:`Firefox `. diff --git a/site/source/learn/concepts/open-source.rst b/site/source/support/concepts/open-source.rst similarity index 100% rename from site/source/learn/concepts/open-source.rst rename to site/source/support/concepts/open-source.rst diff --git a/site/source/learn/concepts/self-hosting.rst b/site/source/support/concepts/self-hosting.rst similarity index 100% rename from site/source/learn/concepts/self-hosting.rst rename to site/source/support/concepts/self-hosting.rst diff --git a/site/source/learn/concepts/start9-startos.rst b/site/source/support/concepts/start9-startos.rst similarity index 100% rename from site/source/learn/concepts/start9-startos.rst rename to site/source/support/concepts/start9-startos.rst diff --git a/site/source/support/faq/faq-services.rst b/site/source/support/faq/faq-services.rst index 44d9055..d72791c 100644 --- a/site/source/support/faq/faq-services.rst +++ b/site/source/support/faq/faq-services.rst @@ -53,7 +53,7 @@ You can only follow someone who has an account on a Mastodon server that support What does it mean when Vaultwarden says "This browser requires HTTPS to use the web vault" upon creating an account or loging in to my Vaultwarden onion? --------------------------------------------------------------------------------------------------------------------------------------------------------- -You will need to tell your browser to treat .onion URLs as a "secure context". You will need to follow this guide to configure :ref:`Tor on Firefox`. +You will need to tell your browser to treat .onion URLs as a "secure context". You will need to follow this guide to configure :ref:`Tor on Firefox`. Can the browser extension be used with Bitwarden hosted on StartOS? ------------------------------------------------------------------- diff --git a/site/source/support/index.rst b/site/source/support/index.rst index b96cf10..c26bf9e 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -3,8 +3,7 @@ ======= Support ======= - -View frequently asked questions, troubleshoot common issues, or contact support. +View frequently asked questions, troubleshoot common issues, or contact support. If you can't find what you need, please `reach out `_. We're here to help your server work for you! .. raw:: html @@ -30,15 +29,6 @@ View frequently asked questions, troubleshoot common issues, or contact support. Answers to Frequently Asked Questions from StartOS users -.. topic-box:: - :title: Contact - :link: https://start9.com/contact - :icon: scylla-icon scylla-icon--support - :class: large-5 - :anchor: Get help - - Get help from Start9 and the community directly - .. topic-box:: :title: External Support :link: external-support @@ -48,15 +38,25 @@ View frequently asked questions, troubleshoot common issues, or contact support. Get help for third party apps that connect to your StartOS services +.. topic-box:: + :title: Contact Us + :link: https://start9.com/contact + :icon: scylla-icon scylla-icon--contact-us + :class: large-5 + :anchor: Reach Out + + Join us in our community channels or get support + .. raw:: html
.. This is for the side navigation display .. toctree:: - :maxdepth: 1 + :maxdepth: 3 :hidden: common-issues faq/index + concepts/index external-support diff --git a/site/source/user-manual/connecting/connecting-lan/index.rst b/site/source/user-manual/connecting/connecting-lan/index.rst deleted file mode 100644 index 6e48e3f..0000000 --- a/site/source/user-manual/connecting/connecting-lan/index.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _connecting-lan: - -=================== -Connecting Over LAN -=================== -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! - -.. note:: StartOS creates its own Certificate Authority (CA) to establish trust with client devices. - -Download Root CA ----------------- -First, download your Start9 server's Root CA. There are two way to accomplish this: - - - Download it from the info page you saved at the completion of :ref:`Initial Setup`, OR - - - Navigate to *System > LAN*, then click "Download Certificate". - - .. figure:: /_static/images/ssl/lan_setup.png - :width: 60% - :alt: LAN setup menu item - -Trust Root CA -------------- -Instruct your **client device** to trust your Start9 server's Root CA. - - .. toctree:: - :maxdepth: 2 - - lan-os/index - -**RECOMMENDED**: :ref:`Configure Firefox` to use your system's certificate store. - - .. note:: Brave, Chrome and Safari will work without additional configuration. - -**OPTIONAL**: :ref:`Configure Thunderbird` to use your system's certificate store (for Nextcloud integration). - -Access your Start9 server's LAN Address ---------------------------------------- -With the Root CA downloaded and trusted by both your operating system and your browser, you can visit your Start9 server's LAN Address (.local URL) over secure ``https``. Any service that offers a LAN URL will also be securely accessible! - -.. toctree:: - :maxdepth: 2 - :hidden: - - lan-ff - lan-thunderbird diff --git a/site/source/user-manual/connecting/connecting-lan/lan-ff.rst b/site/source/user-manual/connecting/connecting-lan/lan-ff.rst deleted file mode 100644 index 3c8bde7..0000000 --- a/site/source/user-manual/connecting/connecting-lan/lan-ff.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. _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 `_ on the topic. - -.. caution:: You will first need to complete :ref:`device setup` for your device before continuing. - -.. tabs:: - - .. group-tab:: Linux/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. - - diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/index.rst b/site/source/user-manual/connecting/connecting-lan/lan-os/index.rst deleted file mode 100644 index b004882..0000000 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _lan-os: - -============= -Trust CA - OS -============= - -Instruct your **operating system** to trust your Start9 server's Root CA. - -.. toctree:: - :maxdepth: 2 - - Linux - Mac - Windows - Android - iOS diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-android.rst b/site/source/user-manual/connecting/connecting-lan/lan-os/lan-android.rst deleted file mode 100644 index 9cd0037..0000000 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-android.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. _lan-android: - -================================== -Trusting Your Start9 CA on Android -================================== - -.. note:: This will work on most Android phones running Android v13+, as well as phones running CalyxOS, GrapheneOS or LineageOS (v19+). - -.. 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: 30% - :alt: Install certificate - - .. group-tab:: Android v12 - - .. tip:: Some phones running Android v12 will work, others won't. It depends on the vendor. Most Androids running v12 that we have tested do work with the exception of the Samsung Galaxy S10 which does not. - - Tap **Settings > Security > Advanced > Encryption and Credentials > Install from Storage** and select your unique ``adjective-noun.local.crt`` certificate. - - .. figure:: /_static/images/ssl/android/droidLAN0.png - :width: 30% - :alt: Install certificate diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-linux.rst b/site/source/user-manual/connecting/connecting-lan/lan-os/lan-linux.rst deleted file mode 100644 index 993b5a0..0000000 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-linux.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _lan-linux: - -.. _lan-linux-system: - -================================ -Trusting Your Start9 CA on Linux -================================ - -Here we will insert your Start9 server's CA certificate into Linux's trust store to ensure that applications will trust your Start9 server's services. - -.. tabs:: - - .. group-tab:: Debian/Ubuntu - - These instructions should work for Debian, Ubuntu, or any Debian or Ubuntu-based Linux, such as Linux Mint, PopOS, etc. - - Perform the following commands in the Terminal: - - .. code-block:: bash - - sudo apt update - sudo apt install -y ca-certificates p11-kit - - For each Mozilla-based application (Firefox, Firefox ESR, LibreWolf, Thunderbird, etc) you plan on using, in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store, do the following: - - #. 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 - - Finally, we will change directory to the folder where you downloaded your Start9 server's Root CA (usually `~/Downloads`), and run the following commands (after carefully replacing `adjective-noun` with your server's unique hostname, below) to add your Start9 server's CA certificate to the OS trust store: - - .. 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. - - Now restart Firefox (or other Mozilla application) and login to your server using ``https://``. No SSL warning should appear. If you still encounter issues, `contact support `_. - - .. 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 ".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 ".crt" /etc/pki/ca-trust/source/anchors/ - sudo update-ca-trust \ No newline at end of file diff --git a/site/source/user-manual/connecting/connecting-tor/index.rst b/site/source/user-manual/connecting/connecting-tor/index.rst deleted file mode 100644 index c655bbc..0000000 --- a/site/source/user-manual/connecting/connecting-tor/index.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _connecting-tor: - -=================== -Connecting Over Tor -=================== - -You can connect to your Start9 server from anywhere in the world, privately and anonymously, by using its unique Tor Address (``.onion`` URL). - -.. note:: Tor connection can sometimes be unreliable and have higher latency than normal internet connections. - -Using Firefox -------------- - -.. tip:: This is the recommended way to connect to your Start9 server over Tor, but it requires some additional steps. - -#. Run Tor (**not Tor Browser**) in the background on your connecting device. - - .. toctree:: - :maxdepth: 2 - - tor-os/index - -#. Configure Firefox to handle *``.onion``* URLs. - - .. toctree:: - :maxdepth: 2 - - tor-firefox/index - - -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 `_ - -* iOS - - * iOS lacks a well-functioning Tor Browser. Use `Firefox `_ diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/index.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/index.rst deleted file mode 100644 index 844973c..0000000 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _tor-firefox: - -============= -Tor - Firefox -============= - -.. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer`. - -Once you have completed native :ref:`Tor Setup`, you can configure Firefox to use the Tor Network. This will allow you to visit both ``.onion`` and "normal" (.com, .net, etc) websites from within the same browser. - -.. toctree:: - :maxdepth: 2 - - Linux - Mac - Windows - Android/Graphene - iOS diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst deleted file mode 100644 index ad3f55c..0000000 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _torff-ios: - -================================== -Configuring Firefox for Tor on iOS -================================== - -.. caution:: - This guide assumes you have completed :ref:`setting up Tor for iOS`. Please visit this section before proceeding as it is required for any browser in iOS to work with Tor. - -Once Orbot is setup on your system as illustrated at the link above, you don't need to do anything special to have any browser proxied via tor. All browsers in iOS are Safari under the hood, and the way we've configured Orbot makes it so any browser will work for any given onion url, and won't use Tor for regular clearnet requests. - - diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst deleted file mode 100644 index ed0a6b0..0000000 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _torff-linux: - -==================================== -Configuring Firefox for Tor on Linux -==================================== - -.. caution:: - This guide assumes you have completed :ref:`setting up Tor`. 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 `, and use client integrations such as :ref:`Vaultwarden` apps and extensions. You can test this by going to Start9's ``.onion`` homepage, `here `_. diff --git a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst b/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst deleted file mode 100644 index 6a7d15f..0000000 --- a/site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _torff-mac: - -================================== -Configuring Firefox for Tor on Mac -================================== - -.. caution:: - This guide assumes you have completed :ref:`setting up Tor`. 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 `_. diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/index.rst b/site/source/user-manual/connecting/connecting-tor/tor-os/index.rst deleted file mode 100644 index a6b7ae9..0000000 --- a/site/source/user-manual/connecting/connecting-tor/tor-os/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _tor-os: - -======== -Tor - OS -======== - -Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Start9 server with remotely. - -.. toctree:: - :maxdepth: 2 - - Linux - Mac - Windows - Android - iOS diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst b/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst deleted file mode 100644 index 0405aa5..0000000 --- a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _tor-ios: - -================== -Running Tor on iOS -================== - -*Orbot has been released for iOS so it is now possible to run Tor natively on iOS.* - -1. Download and install `Orbot from the Apple appstore `_. -2. Open Orbot -3. Select Settings -4. Activate the "Disable Orbot for non-onion traffic" setting: - - .. figure:: /_static/images/tor/ios-orbot-settings-oniononlymode.png - :width: 50% - :alt: iOS Orbot -> Settings -> Onion-Only Mode - -5. 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: 50% - :alt: iOS Orbot Connecting to Tor - -6. Apps will now work transparently when requesting onion urls. diff --git a/site/source/user-manual/device-guides/dg-android.rst b/site/source/user-manual/device-guides/dg-android.rst deleted file mode 100644 index da59675..0000000 --- a/site/source/user-manual/device-guides/dg-android.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _dg-android: - -======= -Android -======= -To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. - -* :ref:`lan-android` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN. -* :ref:`tor-android` - Run Tor natively (in the background) on your Android device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server. -* :ref:`torff-android` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers. diff --git a/site/source/user-manual/device-guides/dg-ios.rst b/site/source/user-manual/device-guides/dg-ios.rst deleted file mode 100644 index 488b57b..0000000 --- a/site/source/user-manual/device-guides/dg-ios.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _dg-ios: - -=== -iOS -=== -To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. - -* :ref:`lan-ios` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN. -* :ref:`tor-ios` - Run Tor natively (in the background) on your iOS device. This will allow you to use applications on your device via the Tor Network so they can communicate with your Start9 server. diff --git a/site/source/user-manual/device-guides/dg-linux.rst b/site/source/user-manual/device-guides/dg-linux.rst deleted file mode 100644 index f49ec52..0000000 --- a/site/source/user-manual/device-guides/dg-linux.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _dg-linux: - -===== -Linux -===== -To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. - -* :ref:`lan-linux` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN. -* :ref:`tor-linux` - Run Tor natively (in the background) on your Linux machine. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server. -* :ref:`torff-linux` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers. -* :ref:`backup-linux` - Configure a Network Folder on your Linux machine (or an attached external drive) for StartOS backups. diff --git a/site/source/user-manual/device-guides/dg-windows.rst b/site/source/user-manual/device-guides/dg-windows.rst deleted file mode 100644 index 196b66c..0000000 --- a/site/source/user-manual/device-guides/dg-windows.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _dg-windows: - -======= -Windows -======= -To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides. - -* :ref:`lan-windows` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN. -* :ref:`tor-windows` - Run Tor natively (in the background) on your Windows computer. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server. -* :ref:`torff-windows` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers. -* :ref:`backup-windows` - Configure a Network Folder on your Windows computer (or an attached external drive) for StartOS backups. diff --git a/site/source/user-manual/device-guides/index.rst b/site/source/user-manual/device-guides/index.rst deleted file mode 100644 index a2143d7..0000000 --- a/site/source/user-manual/device-guides/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _device-guides: - -============= -Device Guides -============= -Guides for integrating your client devices with your Start9 server. - -.. toctree:: - :maxdepth: 3 - - dg-linux - dg-mac - dg-windows - dg-android - dg-ios diff --git a/site/source/user-manual/getting-started/index.rst b/site/source/user-manual/getting-started/index.rst new file mode 100644 index 0000000..bb38960 --- /dev/null +++ b/site/source/user-manual/getting-started/index.rst @@ -0,0 +1,37 @@ +.. _getting-started: + +=============== +Getting Started +=============== +Welcome to Sovereign Computing! Follow the 2 guides below to get up and running with your personal server. + +.. raw:: html + +
+ +
+ +.. 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 diff --git a/site/source/user-manual/initial-setup.rst b/site/source/user-manual/getting-started/initial-setup.rst similarity index 65% rename from site/source/user-manual/initial-setup.rst rename to site/source/user-manual/getting-started/initial-setup.rst index 2b64987..e546a93 100644 --- a/site/source/user-manual/initial-setup.rst +++ b/site/source/user-manual/getting-started/initial-setup.rst @@ -43,7 +43,7 @@ Power On #. Select "Start Fresh." .. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg - :width: 60% + :width: 50% :alt: Fresh Setup .. note:: The "Recover" button is used for :ref:`hardware upgrades `, :ref:`restoring from backup `, data migration, or disaster recovery. @@ -51,7 +51,7 @@ Power On #. Select your storage drive .. figure:: /_static/images/setup/screen4-select_storage.jpg - :width: 60% + :width: 50% :alt: Select Drive #. Create a master password for your server and click "Finish." @@ -59,13 +59,13 @@ Power On .. 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: 60% + :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: 60% + :width: 50% :alt: SSD Initialization #. You are now hosting your own private server! @@ -73,13 +73,13 @@ Power On .. 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: 60% + :width: 50% :alt: Setup Complete -#. You may now log in. Continue to the section on :ref:`connecting` to learn more about using your server over Tor and LAN. +#. Next, you will need to :ref:`Trust Your Root 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: 60% + :width: 50% :alt: Setup Complete .. _setup-troubleshooting: @@ -88,10 +88,7 @@ Troubleshooting --------------- If you are experiencing issues with setup, try the following: -#. Confirm that the server is plugged into both power and Ethernet - - - An ethernet network with DHCP server must be available at setup. Most routers provide this. - +#. 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: @@ -106,58 +103,3 @@ If you are experiencing issues with setup, try the following: - 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 `_ if you need a hand. - -Server Models With Speakers ---------------------------- - -.. _sounds-bepchime: - -Server Lite, Server Pure, and Server One (2022 and older) have an internal speaker and may provide the following audio feedback: - - .. raw:: HTML - - - - * "bep" - Starting up - - .. raw:: HTML - - - - * "chime" - Server is ready - - .. raw:: HTML - - - - * "flatline" - Server initialization failed / no network connection - - .. raw:: HTML - - - - * 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. diff --git a/site/source/user-manual/getting-started/trust-ca.rst b/site/source/user-manual/getting-started/trust-ca.rst new file mode 100644 index 0000000..35fe962 --- /dev/null +++ b/site/source/user-manual/getting-started/trust-ca.rst @@ -0,0 +1,59 @@ +.. _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 + +.. raw:: html + +
+ +
+ +.. 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 diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 4796ece..340cd06 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -3,26 +3,35 @@ =========== User Manual =========== - Welcome to the StartOS user manual. Here you will discover all that your server can do! +.. raw:: html + +
+ +
+ +.. 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:: - :includehidden: + :hidden: :maxdepth: 2 - initial-setup - connecting/index - dashboard-overview - updating - backups/index - flashing/index - reset-password - customize - managing-services - service-guides/index - sessions - wifi - ssh - alt-registries - device-guides/index - upgrade-hardware/index \ No newline at end of file + getting-started/index + overview/index diff --git a/site/source/user-manual/alt-registries.rst b/site/source/user-manual/overview/alt-registries.rst similarity index 96% rename from site/source/user-manual/alt-registries.rst rename to site/source/user-manual/overview/alt-registries.rst index 771534c..45e7b7e 100644 --- a/site/source/user-manual/alt-registries.rst +++ b/site/source/user-manual/overview/alt-registries.rst @@ -1,8 +1,8 @@ .. _alt-registries: -====================== -Alternative Registries -====================== +=========================== +Managing Service Registries +=========================== It is critical to Start9's mission that Start9 is **not** a central point of failure. Software distribution is critical infrastructure and therefore the Start9 Marketplace supports adding and accessing of custom registries for maximum resiliency and decentralization. The most basic method Start9 has made available is the ability to use and distribute packages in their ``.s9pk`` form, which can be simply hosted as a file anywhere you'd like, even on your Start9 server (see below)! Start9 has also built open source tools for the Marketplace UI, to keep the community in maximum control with minimal inconvenience. diff --git a/site/source/user-manual/backups/backup-advanced.rst b/site/source/user-manual/overview/backup-restore/backup-advanced.rst similarity index 100% rename from site/source/user-manual/backups/backup-advanced.rst rename to site/source/user-manual/overview/backup-restore/backup-advanced.rst diff --git a/site/source/user-manual/backups/backup-create.rst b/site/source/user-manual/overview/backup-restore/backup-create.rst similarity index 70% rename from site/source/user-manual/backups/backup-create.rst rename to site/source/user-manual/overview/backup-restore/backup-create.rst index 7bd3a14..b1745ab 100644 --- a/site/source/user-manual/backups/backup-create.rst +++ b/site/source/user-manual/overview/backup-restore/backup-create.rst @@ -3,35 +3,34 @@ ====== Backup ====== +Backing up your server is easy and secure. Backups are encrypted with your master password. .. contents:: :depth: 2 :local: -Backing up your server is easy and secure. Backups are encrypted with your master password. - -.. warning:: Create frequent backups to avoid loss of data! +.. tip:: Create frequent backups to keep your data safe! Setup Device ------------ +Select your platform for detailed instructions on how to create a Network Folder for creating backups. This can include a drive in, or attached to, a device on your network. Otherwise, you may backup directly to a :ref:`physical drive`, attached to your server. -Select your platform for detailed instructions on how to create a Network Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main server's SSD. + * :ref:`Linux Network Folder ` -.. toctree:: - :maxdepth: 1 + * :ref:`Mac Network Folder ` - Linux Network Folder - Mac Network Folder - Windows Network Folder - Synology Network Folder - TrueNAS Network Folder - Physical Drive + * :ref:`Windows Network Folder ` + + * :ref:`Synology Network Folder ` + + * :ref:`TrueNAS Network Folder ` + + * :ref:`Physical Drive ` .. _backup-create: Create Backup ------------- - #. Go to *System > Create Backup* .. figure:: /_static/images/config/backup.png diff --git a/site/source/user-manual/backups/backup-setup/backup-physical.rst b/site/source/user-manual/overview/backup-restore/backup-physical.rst similarity index 70% rename from site/source/user-manual/backups/backup-setup/backup-physical.rst rename to site/source/user-manual/overview/backup-restore/backup-physical.rst index 54ff7a8..de70ff6 100644 --- a/site/source/user-manual/backups/backup-setup/backup-physical.rst +++ b/site/source/user-manual/overview/backup-restore/backup-physical.rst @@ -3,15 +3,14 @@ ======================== Backup to Physical Drive ======================== - -.. warning:: Create frequent backups to avoid loss of data! +.. tip:: Create frequent backups to avoid loss of data! .. youtube:: KJRO9wGOOVw :width: 100% -The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder` via your OS. However, you may use a powered external drive, or external drive via a powered USB 3.0 hub, connected directly to your Start9 server if you prefer. +The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder` via your OS. However, you may use an external drive plugged directly into your server. -.. warning:: If you still choose to plug into your Start9 server, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One (NASPi Geekworm case with built-in power management) and Server Pro users can safely ignore this warning. +.. warning:: If you are using a low-powered device (like a RasPi), this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One and Server Pure users can safely ignore this warning. #. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``. diff --git a/site/source/user-manual/backups/backup-restore.rst b/site/source/user-manual/overview/backup-restore/backup-restore.rst similarity index 100% rename from site/source/user-manual/backups/backup-restore.rst rename to site/source/user-manual/overview/backup-restore/backup-restore.rst diff --git a/site/source/user-manual/backups/backup-setup/backup-synology.rst b/site/source/user-manual/overview/backup-restore/backup-synology.rst similarity index 100% rename from site/source/user-manual/backups/backup-setup/backup-synology.rst rename to site/source/user-manual/overview/backup-restore/backup-synology.rst diff --git a/site/source/user-manual/backups/backup-setup/backup-truenas.rst b/site/source/user-manual/overview/backup-restore/backup-truenas.rst similarity index 100% rename from site/source/user-manual/backups/backup-setup/backup-truenas.rst rename to site/source/user-manual/overview/backup-restore/backup-truenas.rst diff --git a/site/source/user-manual/backups/index.rst b/site/source/user-manual/overview/backup-restore/index.rst similarity index 95% rename from site/source/user-manual/backups/index.rst rename to site/source/user-manual/overview/backup-restore/index.rst index d8b75a1..4be8191 100644 --- a/site/source/user-manual/backups/index.rst +++ b/site/source/user-manual/overview/backup-restore/index.rst @@ -48,4 +48,7 @@ In addition to the safe-keeping of a good master password, maintaining good back backup-create backup-restore + backup-physical + backup-synology + backup-truenas backup-advanced diff --git a/site/source/user-manual/overview/change-password.rst b/site/source/user-manual/overview/change-password.rst new file mode 100644 index 0000000..146515e --- /dev/null +++ b/site/source/user-manual/overview/change-password.rst @@ -0,0 +1,33 @@ +.. _change-password: + +=============== +Password Change +=============== + +This guide is for changing your password from the web-UI. If you forgot your password and want to reset it, see the :ref:`reset password guide`. + +#. Login to the web-UI and navigate to System > Change Master Password + + .. figure:: /_static/images/config/password_change_ui-1.png + :width: 60% + +#. A warning will be displayed. Select `CONTINUE`. + + .. figure:: /_static/images/config/password_change_ui-2.png + :width: 60% + +#. Fill out the Change Master Password form by entering + + a. Your current password + b. Your desired new password + c. Retype your new password + d. Click `Save` + + .. figure:: /_static/images/config/password_change_ui-3.png + :width: 60% + +#. You will see a notice pop up near the bottom of the screen informing you that you've successfully changed your password: + + + .. figure:: /_static/images/config/password_change_ui-4.png + :width: 60% diff --git a/site/source/user-manual/overview/connecting/connecting-ff.rst b/site/source/user-manual/overview/connecting/connecting-ff.rst new file mode 100644 index 0000000..92686ed --- /dev/null +++ b/site/source/user-manual/overview/connecting/connecting-ff.rst @@ -0,0 +1,11 @@ +.. _connecting-ff: + +===================== +Firefox Configuration +===================== +Select your OS below to configure Firefox for encrypted sessions and Tor compatability. See our :ref:`Device Guides` section for all your client's setup guides. + + :ref:`Linux` + :ref:`Mac` + :ref:`Windows` + :ref:`Android` diff --git a/site/source/user-manual/overview/connecting/connecting-lan.rst b/site/source/user-manual/overview/connecting/connecting-lan.rst new file mode 100644 index 0000000..60f273c --- /dev/null +++ b/site/source/user-manual/overview/connecting/connecting-lan.rst @@ -0,0 +1,60 @@ +.. _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` section for all your client's setup guides. + +.. raw:: html + +
+ +
+ +.. 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 + \ No newline at end of file diff --git a/site/source/user-manual/overview/connecting/connecting-tor.rst b/site/source/user-manual/overview/connecting/connecting-tor.rst new file mode 100644 index 0000000..2c7a5a4 --- /dev/null +++ b/site/source/user-manual/overview/connecting/connecting-tor.rst @@ -0,0 +1,32 @@ +.. _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` section for all your client's setup guides. + + :ref:`Linux` + + :ref:`Mac` + + :ref:`Windows` + + :ref:`Android` + + :ref:`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 `_ + +* iOS + + * iOS lacks a well-functioning Tor Browser. Use :ref:`Firefox`. diff --git a/site/source/user-manual/connecting/index.rst b/site/source/user-manual/overview/connecting/index.rst similarity index 85% rename from site/source/user-manual/connecting/index.rst rename to site/source/user-manual/overview/connecting/index.rst index d04dde0..812cc11 100644 --- a/site/source/user-manual/connecting/index.rst +++ b/site/source/user-manual/overview/connecting/index.rst @@ -1,8 +1,8 @@ .. _connecting: -========== -Connecting -========== +=================== +Network Connections +=================== .. raw:: html @@ -36,5 +36,6 @@ Connecting :maxdepth: 2 :hidden: - Lan - Tor + connecting-lan + connecting-tor + connecting-ff diff --git a/site/source/user-manual/customize.rst b/site/source/user-manual/overview/customize.rst similarity index 100% rename from site/source/user-manual/customize.rst rename to site/source/user-manual/overview/customize.rst diff --git a/site/source/user-manual/dashboard-overview.rst b/site/source/user-manual/overview/dashboard-overview.rst similarity index 98% rename from site/source/user-manual/dashboard-overview.rst rename to site/source/user-manual/overview/dashboard-overview.rst index 1eb0ad6..398f5bb 100644 --- a/site/source/user-manual/dashboard-overview.rst +++ b/site/source/user-manual/overview/dashboard-overview.rst @@ -1,8 +1,8 @@ .. _dashboard-overview: -================== -Dashboard Overview -================== +========= +Dashboard +========= .. contents:: :depth: 2 diff --git a/site/source/user-manual/overview/index.rst b/site/source/user-manual/overview/index.rst new file mode 100644 index 0000000..a754da2 --- /dev/null +++ b/site/source/user-manual/overview/index.rst @@ -0,0 +1,22 @@ +.. _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 diff --git a/site/source/user-manual/managing-services.rst b/site/source/user-manual/overview/managing-services.rst similarity index 100% rename from site/source/user-manual/managing-services.rst rename to site/source/user-manual/overview/managing-services.rst diff --git a/site/source/user-manual/sessions.rst b/site/source/user-manual/overview/sessions.rst similarity index 100% rename from site/source/user-manual/sessions.rst rename to site/source/user-manual/overview/sessions.rst diff --git a/site/source/user-manual/ssh.rst b/site/source/user-manual/overview/ssh.rst similarity index 100% rename from site/source/user-manual/ssh.rst rename to site/source/user-manual/overview/ssh.rst diff --git a/site/source/user-manual/updating.rst b/site/source/user-manual/overview/updating.rst similarity index 100% rename from site/source/user-manual/updating.rst rename to site/source/user-manual/overview/updating.rst diff --git a/site/source/user-manual/wifi.rst b/site/source/user-manual/overview/wifi.rst similarity index 100% rename from site/source/user-manual/wifi.rst rename to site/source/user-manual/overview/wifi.rst diff --git a/sphinx-scylladb-theme b/sphinx-scylladb-theme index b61ec30..1ed99d9 160000 --- a/sphinx-scylladb-theme +++ b/sphinx-scylladb-theme @@ -1 +1 @@ -Subproject commit b61ec309bce6a30739b4ba561e26a7d9c141b4ec +Subproject commit 1ed99d91de73c8bd12d4b227738df70a5c279097