From fe79d71e7c99f0411d4de9d8bb1df8253a373aa4 Mon Sep 17 00:00:00 2001 From: Matt Hill Date: Mon, 6 Nov 2023 12:34:37 -0700 Subject: [PATCH] restructure docs --- site/source/conf.py | 2 +- site/source/developer-docs/advanced/index.rst | 42 ----- .../{advanced => }/dev-tools/embassy-cli.rst | 0 .../{advanced => }/dev-tools/embassy-sdk.rst | 0 .../{advanced => }/dev-tools/embassyd.rst | 0 .../{advanced => }/dev-tools/index.rst | 0 .../dev-tools/service-container.rst | 2 +- site/source/developer-docs/index.rst | 63 +------ site/source/developer-docs/packaging.rst | 2 +- .../specification/compat/index.rst | 21 --- .../specification/compat/rules.rst | 111 ------------ .../specification/dependencies.rst | 2 - .../developer-docs/specification/index.rst | 93 +--------- .../developer-docs/specification/manifest.rst | 2 +- .../device-guides/android/ca-android.rst | 0 .../device-guides/android/ff-android.rst | 0 site/source/device-guides/android/index.rst | 15 ++ .../device-guides/android/tor-android.rst | 2 +- .../{guides => }/device-guides/index.rst | 2 +- .../{guides => }/device-guides/ios/ca-ios.rst | 2 - site/source/device-guides/ios/index.rst | 14 ++ .../device-guides/ios/tor-ios.rst | 0 .../device-guides/linux/backup-linux.rst | 0 .../device-guides/linux/ca-linux.rst | 0 .../device-guides/linux/ff-linux.rst | 0 site/source/device-guides/linux/index.rst | 23 +++ .../device-guides/linux/tor-linux.rst | 0 .../device-guides/mac/backup-mac.rst | 0 .../{guides => }/device-guides/mac/ca-mac.rst | 0 .../{guides => }/device-guides/mac/ff-mac.rst | 0 site/source/device-guides/mac/index.rst | 24 +++ .../device-guides/mac/screenshare-mac.rst | 0 .../device-guides/mac/tor-mac.rst | 0 .../synology/backup-synology.rst | 0 site/source/device-guides/synology/index.rst | 13 ++ .../device-guides/truenas/backup-truenas.rst | 0 site/source/device-guides/truenas/index.rst | 13 ++ .../device-guides/windows/backup-windows.rst | 0 .../device-guides/windows/ca-windows.rst | 0 .../device-guides/windows/ff-windows.rst | 0 site/source/device-guides/windows/index.rst | 23 +++ .../device-guides/windows/tor-windows.rst | 0 site/source/diy/diy-pi.rst | 8 +- site/source/diy/diy-x86.rst | 10 +- site/source/diy/index.rst | 25 --- .../firmware-pure.rst} | 8 +- site/source/flashing-guides/index.rst | 17 ++ .../os-pi.rst} | 8 +- .../os-x86.rst} | 8 +- site/source/getting-started/index.rst | 67 ------- .../guides/device-guides/android/index.rst | 47 ----- .../source/guides/device-guides/ios/index.rst | 37 ---- .../guides/device-guides/linux/index.rst | 67 ------- .../source/guides/device-guides/mac/index.rst | 75 -------- .../guides/device-guides/synology/index.rst | 29 --- .../guides/device-guides/truenas/index.rst | 29 --- .../guides/device-guides/windows/index.rst | 67 ------- site/source/guides/flashing/index.rst | 50 ------ site/source/guides/index.rst | 16 -- site/source/guides/misc-guides/lan-ff.rst | 112 ------------ site/source/guides/upgrade-hardware/index.rst | 68 -------- .../upgrade-hardware/naspi-ssd-upgrade.rst | 134 -------------- .../guides/upgrade-hardware/naspi-upgrade.rst | 10 -- .../guides/upgrade-hardware/upgrade-pure.rst | 165 ------------------ site/source/index.rst | 55 ++++-- .../{guides => }/misc-guides/backup-mount.rst | 0 .../{guides => }/misc-guides/data-mount.rst | 0 .../source/{guides => }/misc-guides/index.rst | 9 +- .../lnd-migration.rst | 0 .../reset-password.rst | 2 +- site/source/{guides => }/misc-guides/smtp.rst | 12 +- .../thunderbird.rst} | 16 +- .../upgrade-hardware/drive-upgrade.rst | 0 .../misc-guides/upgrade-hardware/index.rst | 11 ++ .../upgrade-hardware/upgrade-pure.rst | 92 ++++++++++ site/source/quick-start.rst | 13 ++ .../service-guides/bitcoin/bitcoin-cli.rst | 0 .../bitcoin/bitcoin-integrations.rst | 0 .../bitcoin/blockchain-copy.rst | 0 .../service-guides/bitcoin/index.rst | 2 +- .../{guides => }/service-guides/index.rst | 0 .../service-guides/jellyfin/index.rst | 0 .../jellyfin/jellyfin-clients.rst | 0 .../service-guides/lightning/alby-cln.rst | 2 +- .../service-guides/lightning/alby-lnbits.rst | 4 +- .../service-guides/lightning/alby-lnc.rst | 0 .../service-guides/lightning/alby-lnd.rst | 4 +- .../service-guides/lightning/bluewallet.rst | 0 .../lightning/connecting-cln.rst | 0 .../lightning/connecting-lnbits.rst | 2 +- .../lightning/connecting-lnd.rst | 0 .../lightning/connecting-lndc.rst | 0 .../lightning/fully-noded-cln.rst | 0 .../lightning/fully-noded-lnd.rst | 0 .../service-guides/lightning/index.rst | 0 .../lightning/lightning-first-channel.rst | 0 .../lightning/ride-the-lightning.rst | 0 .../service-guides/lightning/spark.rst | 0 .../service-guides/lightning/zap.rst | 0 .../lightning/zeus-cln-direct.rst | 0 .../service-guides/lightning/zeus-lnbits.rst | 0 .../service-guides/lightning/zeus-lnc.rst | 0 .../lightning/zeus-lnd-direct.rst | 0 .../{guides => }/service-guides/matrix.rst | 2 +- .../service-guides/nextcloud/index.rst | 0 .../nextcloud/nextcloud-apps/index.rst | 0 .../nextcloud/nextcloud-apps/joplin.rst | 0 .../nextcloud/nextcloud-apps/nc-bookmarks.rst | 0 .../nextcloud/nextcloud-apps/nc-calendar.rst | 0 .../nextcloud/nextcloud-apps/nc-contacts.rst | 0 .../nextcloud/nextcloud-apps/nc-cookbook.rst | 0 .../nextcloud/nextcloud-apps/nc-files.rst | 0 .../nextcloud/nextcloud-apps/nc-maps.rst | 0 .../nextcloud/nextcloud-apps/nc-memories.rst | 0 .../nextcloud/nextcloud-apps/nc-music.rst | 0 .../nextcloud/nextcloud-apps/nc-news.rst | 0 .../nextcloud/nextcloud-apps/nc-notes.rst | 0 .../nextcloud/nextcloud-apps/nc-photos.rst | 0 .../nextcloud/nextcloud-apps/thunderbird.rst | 2 +- .../nextcloud/nextcloud-setup/index.rst | 0 .../nextcloud-setup/nextcloud-android.rst | 0 .../nextcloud-setup/nextcloud-ios.rst | 0 .../nextcloud-setup/nextcloud-linux.rst | 0 .../nextcloud-setup/nextcloud-mac.rst | 0 .../nextcloud-setup/nextcloud-windows.rst | 0 .../service-guides/specter/index.rst | 0 .../specter/specter-service.rst | 0 .../vaultwarden/bitwarden-client-setup.rst | 2 +- .../vaultwarden/bitwarden-walkthrough.rst | 0 .../service-guides/vaultwarden/index.rst | 0 .../vaultwarden/vaultwarden-organizations.rst | 0 site/source/support/common-issues.rst | 8 +- .../support/concepts/bitcoin-lightning.rst | 45 ----- site/source/support/concepts/index.rst | 18 -- site/source/support/concepts/networks.rst | 93 ---------- site/source/support/concepts/open-source.rst | 34 ---- site/source/support/concepts/self-hosting.rst | 30 ---- .../support/concepts/start9-startos.rst | 127 -------------- site/source/support/index.rst | 59 +------ site/source/user-manual/alt-registries.rst | 2 +- site/source/user-manual/backups/index.rst | 29 --- site/source/user-manual/change-password.rst | 4 +- .../configuring-ff.rst | 10 +- .../connecting-lan.rst | 0 .../connecting-tor.rst | 28 +-- site/source/user-manual/index.rst | 7 +- .../initial-setup.rst | 0 site/source/user-manual/managing-services.rst | 6 +- site/source/user-manual/sessions.rst | 2 +- .../trust-ca.rst | 10 +- 150 files changed, 404 insertions(+), 1866 deletions(-) delete mode 100644 site/source/developer-docs/advanced/index.rst rename site/source/developer-docs/{advanced => }/dev-tools/embassy-cli.rst (100%) rename site/source/developer-docs/{advanced => }/dev-tools/embassy-sdk.rst (100%) rename site/source/developer-docs/{advanced => }/dev-tools/embassyd.rst (100%) rename site/source/developer-docs/{advanced => }/dev-tools/index.rst (100%) rename site/source/developer-docs/{advanced => }/dev-tools/service-container.rst (73%) delete mode 100644 site/source/developer-docs/specification/compat/index.rst delete mode 100644 site/source/developer-docs/specification/compat/rules.rst rename site/source/{guides => }/device-guides/android/ca-android.rst (100%) rename site/source/{guides => }/device-guides/android/ff-android.rst (100%) create mode 100644 site/source/device-guides/android/index.rst rename site/source/{guides => }/device-guides/android/tor-android.rst (91%) rename site/source/{guides => }/device-guides/index.rst (98%) rename site/source/{guides => }/device-guides/ios/ca-ios.rst (93%) create mode 100644 site/source/device-guides/ios/index.rst rename site/source/{guides => }/device-guides/ios/tor-ios.rst (100%) rename site/source/{guides => }/device-guides/linux/backup-linux.rst (100%) rename site/source/{guides => }/device-guides/linux/ca-linux.rst (100%) rename site/source/{guides => }/device-guides/linux/ff-linux.rst (100%) create mode 100644 site/source/device-guides/linux/index.rst rename site/source/{guides => }/device-guides/linux/tor-linux.rst (100%) rename site/source/{guides => }/device-guides/mac/backup-mac.rst (100%) rename site/source/{guides => }/device-guides/mac/ca-mac.rst (100%) rename site/source/{guides => }/device-guides/mac/ff-mac.rst (100%) create mode 100644 site/source/device-guides/mac/index.rst rename site/source/{guides => }/device-guides/mac/screenshare-mac.rst (100%) rename site/source/{guides => }/device-guides/mac/tor-mac.rst (100%) rename site/source/{guides => }/device-guides/synology/backup-synology.rst (100%) create mode 100644 site/source/device-guides/synology/index.rst rename site/source/{guides => }/device-guides/truenas/backup-truenas.rst (100%) create mode 100644 site/source/device-guides/truenas/index.rst rename site/source/{guides => }/device-guides/windows/backup-windows.rst (100%) rename site/source/{guides => }/device-guides/windows/ca-windows.rst (100%) rename site/source/{guides => }/device-guides/windows/ff-windows.rst (100%) create mode 100644 site/source/device-guides/windows/index.rst rename site/source/{guides => }/device-guides/windows/tor-windows.rst (100%) rename site/source/{guides/flashing/flashing-firmware.rst => flashing-guides/firmware-pure.rst} (96%) create mode 100644 site/source/flashing-guides/index.rst rename site/source/{guides/flashing/flashing-pi.rst => flashing-guides/os-pi.rst} (97%) rename site/source/{guides/flashing/flashing-x86.rst => flashing-guides/os-x86.rst} (98%) delete mode 100644 site/source/getting-started/index.rst delete mode 100644 site/source/guides/device-guides/android/index.rst delete mode 100644 site/source/guides/device-guides/ios/index.rst delete mode 100644 site/source/guides/device-guides/linux/index.rst delete mode 100644 site/source/guides/device-guides/mac/index.rst delete mode 100644 site/source/guides/device-guides/synology/index.rst delete mode 100644 site/source/guides/device-guides/truenas/index.rst delete mode 100644 site/source/guides/device-guides/windows/index.rst delete mode 100644 site/source/guides/flashing/index.rst delete mode 100644 site/source/guides/index.rst delete mode 100644 site/source/guides/misc-guides/lan-ff.rst delete mode 100644 site/source/guides/upgrade-hardware/index.rst delete mode 100644 site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst delete mode 100644 site/source/guides/upgrade-hardware/naspi-upgrade.rst delete mode 100644 site/source/guides/upgrade-hardware/upgrade-pure.rst rename site/source/{guides => }/misc-guides/backup-mount.rst (100%) rename site/source/{guides => }/misc-guides/data-mount.rst (100%) rename site/source/{guides => }/misc-guides/index.rst (64%) rename site/source/{guides/upgrade-hardware => misc-guides}/lnd-migration.rst (100%) rename site/source/{guides => misc-guides}/reset-password.rst (92%) rename site/source/{guides => }/misc-guides/smtp.rst (76%) rename site/source/{guides/misc-guides/lan-thunderbird.rst => misc-guides/thunderbird.rst} (89%) rename site/source/{guides => misc-guides}/upgrade-hardware/drive-upgrade.rst (100%) create mode 100644 site/source/misc-guides/upgrade-hardware/index.rst create mode 100644 site/source/misc-guides/upgrade-hardware/upgrade-pure.rst create mode 100644 site/source/quick-start.rst rename site/source/{guides => }/service-guides/bitcoin/bitcoin-cli.rst (100%) rename site/source/{guides => }/service-guides/bitcoin/bitcoin-integrations.rst (100%) rename site/source/{guides => }/service-guides/bitcoin/blockchain-copy.rst (100%) rename site/source/{guides => }/service-guides/bitcoin/index.rst (77%) rename site/source/{guides => }/service-guides/index.rst (100%) rename site/source/{guides => }/service-guides/jellyfin/index.rst (100%) rename site/source/{guides => }/service-guides/jellyfin/jellyfin-clients.rst (100%) rename site/source/{guides => }/service-guides/lightning/alby-cln.rst (98%) rename site/source/{guides => }/service-guides/lightning/alby-lnbits.rst (97%) rename site/source/{guides => }/service-guides/lightning/alby-lnc.rst (100%) rename site/source/{guides => }/service-guides/lightning/alby-lnd.rst (88%) rename site/source/{guides => }/service-guides/lightning/bluewallet.rst (100%) rename site/source/{guides => }/service-guides/lightning/connecting-cln.rst (100%) rename site/source/{guides => }/service-guides/lightning/connecting-lnbits.rst (96%) rename site/source/{guides => }/service-guides/lightning/connecting-lnd.rst (100%) rename site/source/{guides => }/service-guides/lightning/connecting-lndc.rst (100%) rename site/source/{guides => }/service-guides/lightning/fully-noded-cln.rst (100%) rename site/source/{guides => }/service-guides/lightning/fully-noded-lnd.rst (100%) rename site/source/{guides => }/service-guides/lightning/index.rst (100%) rename site/source/{guides => }/service-guides/lightning/lightning-first-channel.rst (100%) rename site/source/{guides => }/service-guides/lightning/ride-the-lightning.rst (100%) rename site/source/{guides => }/service-guides/lightning/spark.rst (100%) rename site/source/{guides => }/service-guides/lightning/zap.rst (100%) rename site/source/{guides => }/service-guides/lightning/zeus-cln-direct.rst (100%) rename site/source/{guides => }/service-guides/lightning/zeus-lnbits.rst (100%) rename site/source/{guides => }/service-guides/lightning/zeus-lnc.rst (100%) rename site/source/{guides => }/service-guides/lightning/zeus-lnd-direct.rst (100%) rename site/source/{guides => }/service-guides/matrix.rst (94%) rename site/source/{guides => }/service-guides/nextcloud/index.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/index.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/joplin.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-files.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-maps.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-memories.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-music.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-news.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-notes.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/nc-photos.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-apps/thunderbird.rst (98%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-setup/index.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst (100%) rename site/source/{guides => }/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst (100%) rename site/source/{guides => }/service-guides/specter/index.rst (100%) rename site/source/{guides => }/service-guides/specter/specter-service.rst (100%) rename site/source/{guides => }/service-guides/vaultwarden/bitwarden-client-setup.rst (98%) rename site/source/{guides => }/service-guides/vaultwarden/bitwarden-walkthrough.rst (100%) rename site/source/{guides => }/service-guides/vaultwarden/index.rst (100%) rename site/source/{guides => }/service-guides/vaultwarden/vaultwarden-organizations.rst (100%) delete mode 100644 site/source/support/concepts/bitcoin-lightning.rst delete mode 100644 site/source/support/concepts/index.rst delete mode 100644 site/source/support/concepts/networks.rst delete mode 100644 site/source/support/concepts/open-source.rst delete mode 100644 site/source/support/concepts/self-hosting.rst delete mode 100644 site/source/support/concepts/start9-startos.rst rename site/source/{getting-started => user-manual}/configuring-ff.rst (82%) rename site/source/{getting-started => user-manual}/connecting-lan.rst (100%) rename site/source/{getting-started => user-manual}/connecting-tor.rst (67%) rename site/source/{getting-started => user-manual}/initial-setup.rst (100%) rename site/source/{getting-started => user-manual}/trust-ca.rst (89%) diff --git a/site/source/conf.py b/site/source/conf.py index 6bc5b82..edf3c7a 100644 --- a/site/source/conf.py +++ b/site/source/conf.py @@ -103,7 +103,7 @@ html_theme_options = { "hide_version_dropdown": [], "github_issues_repository": "Start9Labs/documentation", "github_repository": "Start9Labs/documentation", - "navigation_depth": 3, + "navigation_depth": 2, "site_description": "Start9 documentation for sovereign computing with StartOS", } diff --git a/site/source/developer-docs/advanced/index.rst b/site/source/developer-docs/advanced/index.rst deleted file mode 100644 index f78d192..0000000 --- a/site/source/developer-docs/advanced/index.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _advanced-packaging: - -======== -Advanced -======== - -This section included advanced commands for working with packages in StartOS. - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Developer Tools - :link: dev-tools - :icon: scylla-icon scylla-icon--developers-blog - :class: large-4 - :anchor: View - - StartOS developer CLI tools - -.. topic-box:: - :title: Service Containers - :link: dev-tools/service-container - :icon: scylla-icon scylla-icon--overview - :class: large-4 - :anchor: View - - How to interact with containers on the StartOS - -.. raw:: html - -
- -.. This is for the side navigation display -.. toctree:: - :maxdepth: 2 - :hidden: - - dev-tools/index \ No newline at end of file diff --git a/site/source/developer-docs/advanced/dev-tools/embassy-cli.rst b/site/source/developer-docs/dev-tools/embassy-cli.rst similarity index 100% rename from site/source/developer-docs/advanced/dev-tools/embassy-cli.rst rename to site/source/developer-docs/dev-tools/embassy-cli.rst diff --git a/site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst b/site/source/developer-docs/dev-tools/embassy-sdk.rst similarity index 100% rename from site/source/developer-docs/advanced/dev-tools/embassy-sdk.rst rename to site/source/developer-docs/dev-tools/embassy-sdk.rst diff --git a/site/source/developer-docs/advanced/dev-tools/embassyd.rst b/site/source/developer-docs/dev-tools/embassyd.rst similarity index 100% rename from site/source/developer-docs/advanced/dev-tools/embassyd.rst rename to site/source/developer-docs/dev-tools/embassyd.rst diff --git a/site/source/developer-docs/advanced/dev-tools/index.rst b/site/source/developer-docs/dev-tools/index.rst similarity index 100% rename from site/source/developer-docs/advanced/dev-tools/index.rst rename to site/source/developer-docs/dev-tools/index.rst diff --git a/site/source/developer-docs/advanced/dev-tools/service-container.rst b/site/source/developer-docs/dev-tools/service-container.rst similarity index 73% rename from site/source/developer-docs/advanced/dev-tools/service-container.rst rename to site/source/developer-docs/dev-tools/service-container.rst index 3bba8d9..6629b97 100644 --- a/site/source/developer-docs/advanced/dev-tools/service-container.rst +++ b/site/source/developer-docs/dev-tools/service-container.rst @@ -4,7 +4,7 @@ Service Containers ================== -For simplicity, StartOS is designed to be completely operated via the :ref:`WebUI `, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands. +For simplicity, StartOS is designed to be completely operated through its GUI, however, your device belongs to you and if you want to "lift the hood" and access the internals of the software, you may do so. This guide will show you how to enter a Service's Docker container in order to directly interface with it and issue commands. .. warning:: The following guide is for those that have advanced command line skills, or those who are being guided by a Start9 support technician. Nothing you do inside a container is supported unless under the direction of Start9. Here be dragons!! diff --git a/site/source/developer-docs/index.rst b/site/source/developer-docs/index.rst index 1022de0..68d55e4 100644 --- a/site/source/developer-docs/index.rst +++ b/site/source/developer-docs/index.rst @@ -4,70 +4,13 @@ Developer Docs ============== - Welcome to the Service Packaging documentation for StartOS. If you are here, you have heard the call to help empower users with sovereign computing! +Welcome to the Service Packaging documentation for StartOS. If you are here, you have heard the call to help empower users with sovereign computing! -.. raw:: html - -
- -
- -.. topic-box:: - :title: Listing a Service - :link: submission - :icon: scylla-icon scylla-icon--contact-us - :class: large-4 - :anchor: Submit - - The process for submitting a service to the Community Registry - -.. topic-box:: - :title: Service Packaging - :link: packaging - :icon: scylla-icon scylla-icon--resource-center - :class: large-4 - :anchor: Build - - A concise guide to Service Packaging - -.. topic-box:: - :title: Full Specification - :link: specification - :icon: scylla-icon scylla-icon--glossary - :class: large-4 - :anchor: Read - - Detailed service packaging specification and advanced features - -.. topic-box:: - :title: Advanced Guides - :link: advanced - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: Tinker - - Guides for implementing advanced service configurations - -.. topic-box:: - :title: Documentation - :link: documentation - :icon: scylla-icon scylla-icon--docs - :class: large-4 - :anchor: Edit - - Contribute to our documentation. - -.. raw:: html - -
- -.. This is for the side navigation display .. toctree:: :maxdepth: 1 - :hidden: submission packaging specification/index - advanced/index - documentation \ No newline at end of file + documentation + dev-tools/index \ No newline at end of file diff --git a/site/source/developer-docs/packaging.rst b/site/source/developer-docs/packaging.rst index 3fd9838..caa804c 100644 --- a/site/source/developer-docs/packaging.rst +++ b/site/source/developer-docs/packaging.rst @@ -8,7 +8,7 @@ Service Packaging :depth: 2 :local: -Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on :ref:`StartOS` "services." This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on StartOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package. +Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on StartOS services. This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on StartOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package. Check out the :ref:`glossary ` to get acquainted with unfamiliar terms. The bottom of this guide also includes :ref:`support ` links, including a master checklist. diff --git a/site/source/developer-docs/specification/compat/index.rst b/site/source/developer-docs/specification/compat/index.rst deleted file mode 100644 index 2680e17..0000000 --- a/site/source/developer-docs/specification/compat/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _compat: - -============ -Compat Image -============ - -With the release of StartOS v0.3.0, system utility Docker images are preloaded for service packager convenience. - -The ``Compat`` image is a backwards compatible Docker image that hosts StartOS features used in the v0.2.x series. It was created as a convenience for service packagers to help migrate their service configurations from 0.2.x to 0.3.0. - -It exposes functionality to make use of: - -- ``ConfigRules`` language -- Duplicity backups - - -.. This is for the side navigation display -.. toctree:: - :hidden: - - rules \ No newline at end of file diff --git a/site/source/developer-docs/specification/compat/rules.rst b/site/source/developer-docs/specification/compat/rules.rst deleted file mode 100644 index 09413c8..0000000 --- a/site/source/developer-docs/specification/compat/rules.rst +++ /dev/null @@ -1,111 +0,0 @@ - -.. _config_rules: - -============ -Config Rules -============ - -This file defines the configuration rules, or the rule-set that defines dependencies between config variables. In practice, config rules are for auto-configuring self dependencies. Self dependencies are internal dependencies of a service, such as if the setting of one config variable informs the option of another setting. These "dependencies" are configured as rules. - -A rule is a boolean expression that we demand to be true. It is not true if the expression fails the rule parser. Set of predicates. xt - -They follow the `Backus–Naur `_ meta-syntax for writing rules. - -Rules are composed of two main concepts: - -* Variables - accessor into a configuration -* Terms - either a variable or type literal (ie. a boolean term is a boolean variable, a boolean expression, or a comparison operation between numbers or strings) - -Variables can be booleans, numbers, or strings, and have a different syntax depending on the type. These type annotations check your config rules against your config spec and throw an error if invalid. - -- ``?`` - Casts to boolean value. If the value is not a boolean, this notes whether or not the value is null. -- ``#`` - Treat the value as a number. If it is not a number, the value will be parsed as NaN. String numbers are not currently supported. -- ``'`` - Cast the value into a string. Applies to any value except for an object or a list. -- ``!`` - Equals not. - -.. note:: - Config rules are processed in order. - -If application does not satisfy a rule, a set of suggestions should be provided. These suggestions are in the form of the operation to preform: - - - ``Set`` - set the value - - - ``Push`` - add to the value (such as to a list) - - - ``Delete`` - delete the value - -.. code:: typescript - - enum SuggestionVariant = Set | Delete | Push - - interface Set { - var: String, // fully qualified path without typecast - // one of the following three variants are required - to: Option // a string expression, use when tying another config value - to-value: Option - to-entropy: Option<{ - charset: String (eg. 'a-z,A-Z,0-9') - len: Number - }> - } - - interface Delete { - src: String, // path to key - removes if in a list - } - - interface Push { - to: String, - value: String, // string literal of value to be set - } - -SET Examples ------------- - -.. code:: yaml - - - SET: - # the key in config you want to set - var: 'users.[first(item => ''item.name = "c-lightning")].password' - # the value in config that you will set - to-entropy: - charset: "a-z,A-Z,0-9" - len: 22 - - - SET: - var: 'users.[first(item => ''item.name = "c-lightning")].fetch-blocks' - to-value: true - - -PUSH Examples -------------- - -.. code:: yaml - - - PUSH: - to: "users" - value: - name: c-lightning - allowed-calls: [] - - - PUSH: - to: 'users.[first(item => ''item.name = "c-lightning")].allowed-calls' - value: "getnetworkinfo" - -Full example from `c-lightning manifest `_: - -.. code:: yaml - - config: - - rule: '''users.*.name = "c-lightning"' - description: 'Must have an RPC user named "c-lightning"' - suggestions: - - PUSH: - to: "users" - value: - name: c-lightning - allowed-calls: [] - - SET: - var: 'users.[first(item => ''item.name = "c-lightning")].password' - to-entropy: - charset: "a-z,A-Z,0-9" - len: 22 diff --git a/site/source/developer-docs/specification/dependencies.rst b/site/source/developer-docs/specification/dependencies.rst index 9f5eede..5c79362 100644 --- a/site/source/developer-docs/specification/dependencies.rst +++ b/site/source/developer-docs/specification/dependencies.rst @@ -15,8 +15,6 @@ This may sound cool or neat, but it is more than that: *it's novel*. This has ne The key to making the system work is a new, domain-specific-language (DSL) and set of standards that are used by developers to define the rules and requirements of their services. Run in the context of StartOS, these rules and requirements appear as simple UI elements, such as inputs, toggles, and drop downs, and they are enforced by validations and clear user instructions. Using this system, what previously required serious time and expertise, can now be done by anyone in a matter of seconds. -This DSL is utilized in the :ref:`config rules ` and :ref:`dependencies ` key in the service manifest. - Context ------- diff --git a/site/source/developer-docs/specification/index.rst b/site/source/developer-docs/specification/index.rst index 5c104f9..f460351 100644 --- a/site/source/developer-docs/specification/index.rst +++ b/site/source/developer-docs/specification/index.rst @@ -6,98 +6,8 @@ Specification The following guides provide an in depth overview of the full capabilities available for packaging a service. -.. raw:: html - -
- -
- -.. topic-box:: - :title: Docker - :link: docker - :class: large-4 - :anchor: View - - Learn how to setup the main Docker image for your service. - -.. topic-box:: - :title: Manifest - :link: manifest - :class: large-4 - :anchor: Begin - - Understand the function of a Manifest file and its type. - -.. topic-box:: - :title: Config Spec - :link: config-spec - :class: large-4 - :anchor: Begin - - Learn the purpose and utility of a config specification. - -.. topic-box:: - :title: JS Procedures - :link: js-procedure - :class: large-4 - :anchor: Begin - - Learn how to use this operation configuration library. - -.. topic-box:: - :title: Properties - :link: properties - :class: large-4 - :anchor: View - - Understand the purpose and requirements of service properties. - -.. topic-box:: - :title: Dependencies - :link: dependencies - :class: large-4 - :anchor: View - - Learn how to configure dependency options. - -.. topic-box:: - :title: Backups - :link: advanced - :class: large-4 - :anchor: View - - Learn how to configure backup options. - -.. topic-box:: - :title: Instructions - :link: instructions - :class: large-4 - :anchor: View - - Understand how an instructions file is relevant to a service. - -.. topic-box:: - :title: Package - :link: package - :class: large-4 - :anchor: View - - Learn how to package service components into a single file format. - -.. topic-box:: - :title: Wrapper - :link: wrapper - :class: large-4 - :anchor: View - - Understand the purpose of a wrapper repository. - -.. raw:: html - -
- .. toctree:: - :hidden: + :maxdepth: 2 docker manifest @@ -110,5 +20,4 @@ The following guides provide an in depth overview of the full capabilities avail wrapper makefile js-procedure - compat/index checklist diff --git a/site/source/developer-docs/specification/manifest.rst b/site/source/developer-docs/specification/manifest.rst index 1b16ad6..f1d6852 100644 --- a/site/source/developer-docs/specification/manifest.rst +++ b/site/source/developer-docs/specification/manifest.rst @@ -19,7 +19,7 @@ Each time a service is updated, the Manifest should be updated to include the ne There is nothing you need to do as a developer to set up Tor for running a service. This is *completely* handled by StartOS - a Tor address will be automatically generated when the service is installed. Just define an interface with a tor config in the Manifest file. You do, however, need to ensure the service is in fact capable of running over Tor. -The Manifest is also responsible for outlining service :ref:`dependencies `. By defining rules using the :ref:`StartOS DSL specification `, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. StartOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest! +The Manifest is also responsible for outlining service :ref:`dependencies `. By defining rules using the :ref:`StartOS DSL specification `, users can easily and selectively install, uninstall, and update any service without getting stuck in dependency hell. StartOS presents this information in a polished install/uninstall/update wizard, so there's no need for editing configuration files or jumping into the command line. For you as a developer, this simply means populating this key in the manifest! Formatting ---------- diff --git a/site/source/guides/device-guides/android/ca-android.rst b/site/source/device-guides/android/ca-android.rst similarity index 100% rename from site/source/guides/device-guides/android/ca-android.rst rename to site/source/device-guides/android/ca-android.rst diff --git a/site/source/guides/device-guides/android/ff-android.rst b/site/source/device-guides/android/ff-android.rst similarity index 100% rename from site/source/guides/device-guides/android/ff-android.rst rename to site/source/device-guides/android/ff-android.rst diff --git a/site/source/device-guides/android/index.rst b/site/source/device-guides/android/index.rst new file mode 100644 index 0000000..c0f5aa3 --- /dev/null +++ b/site/source/device-guides/android/index.rst @@ -0,0 +1,15 @@ +.. _android: + +======= +Android +======= + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + ca-android + tor-android + ff-android diff --git a/site/source/guides/device-guides/android/tor-android.rst b/site/source/device-guides/android/tor-android.rst similarity index 91% rename from site/source/guides/device-guides/android/tor-android.rst rename to site/source/device-guides/android/tor-android.rst index f485940..58784f6 100644 --- a/site/source/guides/device-guides/android/tor-android.rst +++ b/site/source/device-guides/android/tor-android.rst @@ -3,7 +3,7 @@ ====================== 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. +Some apps, such as the official 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 ------------- diff --git a/site/source/guides/device-guides/index.rst b/site/source/device-guides/index.rst similarity index 98% rename from site/source/guides/device-guides/index.rst rename to site/source/device-guides/index.rst index dfb4f54..08bdc14 100644 --- a/site/source/guides/device-guides/index.rst +++ b/site/source/device-guides/index.rst @@ -75,7 +75,7 @@ Guides for integrating your client devices with your StartOS server. Guides for Truenas .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :hidden: linux/index diff --git a/site/source/guides/device-guides/ios/ca-ios.rst b/site/source/device-guides/ios/ca-ios.rst similarity index 93% rename from site/source/guides/device-guides/ios/ca-ios.rst rename to site/source/device-guides/ios/ca-ios.rst index 767d303..1c9e0c1 100644 --- a/site/source/guides/device-guides/ios/ca-ios.rst +++ b/site/source/device-guides/ios/ca-ios.rst @@ -5,8 +5,6 @@ Trusting Your Server's Root CA on iOS ===================================== Complete this guide to trust your server's Root Certificate Authority (Root CA) on iOS. -.. note:: This guide only applies to iOS v15+. For v14, see the `v14 guide `_. - #. Ensure you have already `downloaded your server's Root CA `_ #. Open your iCloud Downloads folder and click on the certificate. It will display a dialog box that says "Profile Downloaded." Click `Close`. diff --git a/site/source/device-guides/ios/index.rst b/site/source/device-guides/ios/index.rst new file mode 100644 index 0000000..daf6fd1 --- /dev/null +++ b/site/source/device-guides/ios/index.rst @@ -0,0 +1,14 @@ +.. _ios: + +=== +iOS +=== + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + ca-ios + tor-ios diff --git a/site/source/guides/device-guides/ios/tor-ios.rst b/site/source/device-guides/ios/tor-ios.rst similarity index 100% rename from site/source/guides/device-guides/ios/tor-ios.rst rename to site/source/device-guides/ios/tor-ios.rst diff --git a/site/source/guides/device-guides/linux/backup-linux.rst b/site/source/device-guides/linux/backup-linux.rst similarity index 100% rename from site/source/guides/device-guides/linux/backup-linux.rst rename to site/source/device-guides/linux/backup-linux.rst diff --git a/site/source/guides/device-guides/linux/ca-linux.rst b/site/source/device-guides/linux/ca-linux.rst similarity index 100% rename from site/source/guides/device-guides/linux/ca-linux.rst rename to site/source/device-guides/linux/ca-linux.rst diff --git a/site/source/guides/device-guides/linux/ff-linux.rst b/site/source/device-guides/linux/ff-linux.rst similarity index 100% rename from site/source/guides/device-guides/linux/ff-linux.rst rename to site/source/device-guides/linux/ff-linux.rst diff --git a/site/source/device-guides/linux/index.rst b/site/source/device-guides/linux/index.rst new file mode 100644 index 0000000..5bfa4c4 --- /dev/null +++ b/site/source/device-guides/linux/index.rst @@ -0,0 +1,23 @@ +.. _linux: + +===== +Linux +===== + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + ca-linux + tor-linux + ff-linux + +Other Useful Guides +------------------- + +.. toctree:: + :maxdepth: 1 + + backup-linux diff --git a/site/source/guides/device-guides/linux/tor-linux.rst b/site/source/device-guides/linux/tor-linux.rst similarity index 100% rename from site/source/guides/device-guides/linux/tor-linux.rst rename to site/source/device-guides/linux/tor-linux.rst diff --git a/site/source/guides/device-guides/mac/backup-mac.rst b/site/source/device-guides/mac/backup-mac.rst similarity index 100% rename from site/source/guides/device-guides/mac/backup-mac.rst rename to site/source/device-guides/mac/backup-mac.rst diff --git a/site/source/guides/device-guides/mac/ca-mac.rst b/site/source/device-guides/mac/ca-mac.rst similarity index 100% rename from site/source/guides/device-guides/mac/ca-mac.rst rename to site/source/device-guides/mac/ca-mac.rst diff --git a/site/source/guides/device-guides/mac/ff-mac.rst b/site/source/device-guides/mac/ff-mac.rst similarity index 100% rename from site/source/guides/device-guides/mac/ff-mac.rst rename to site/source/device-guides/mac/ff-mac.rst diff --git a/site/source/device-guides/mac/index.rst b/site/source/device-guides/mac/index.rst new file mode 100644 index 0000000..12990f9 --- /dev/null +++ b/site/source/device-guides/mac/index.rst @@ -0,0 +1,24 @@ +.. _dg-mac: + +=== +Mac +=== + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + ca-mac + tor-mac + ff-mac + +Other Useful Guides +------------------- + +.. toctree:: + :maxdepth: 1 + + backup-mac + screenshare-mac diff --git a/site/source/guides/device-guides/mac/screenshare-mac.rst b/site/source/device-guides/mac/screenshare-mac.rst similarity index 100% rename from site/source/guides/device-guides/mac/screenshare-mac.rst rename to site/source/device-guides/mac/screenshare-mac.rst diff --git a/site/source/guides/device-guides/mac/tor-mac.rst b/site/source/device-guides/mac/tor-mac.rst similarity index 100% rename from site/source/guides/device-guides/mac/tor-mac.rst rename to site/source/device-guides/mac/tor-mac.rst diff --git a/site/source/guides/device-guides/synology/backup-synology.rst b/site/source/device-guides/synology/backup-synology.rst similarity index 100% rename from site/source/guides/device-guides/synology/backup-synology.rst rename to site/source/device-guides/synology/backup-synology.rst diff --git a/site/source/device-guides/synology/index.rst b/site/source/device-guides/synology/index.rst new file mode 100644 index 0000000..59deed2 --- /dev/null +++ b/site/source/device-guides/synology/index.rst @@ -0,0 +1,13 @@ +.. _dg-synology: + +======== +Synology +======== + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + backup-synology diff --git a/site/source/guides/device-guides/truenas/backup-truenas.rst b/site/source/device-guides/truenas/backup-truenas.rst similarity index 100% rename from site/source/guides/device-guides/truenas/backup-truenas.rst rename to site/source/device-guides/truenas/backup-truenas.rst diff --git a/site/source/device-guides/truenas/index.rst b/site/source/device-guides/truenas/index.rst new file mode 100644 index 0000000..49dceb6 --- /dev/null +++ b/site/source/device-guides/truenas/index.rst @@ -0,0 +1,13 @@ +.. _dg-truenas: + +======= +TrueNas +======= + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + backup-truenas diff --git a/site/source/guides/device-guides/windows/backup-windows.rst b/site/source/device-guides/windows/backup-windows.rst similarity index 100% rename from site/source/guides/device-guides/windows/backup-windows.rst rename to site/source/device-guides/windows/backup-windows.rst diff --git a/site/source/guides/device-guides/windows/ca-windows.rst b/site/source/device-guides/windows/ca-windows.rst similarity index 100% rename from site/source/guides/device-guides/windows/ca-windows.rst rename to site/source/device-guides/windows/ca-windows.rst diff --git a/site/source/guides/device-guides/windows/ff-windows.rst b/site/source/device-guides/windows/ff-windows.rst similarity index 100% rename from site/source/guides/device-guides/windows/ff-windows.rst rename to site/source/device-guides/windows/ff-windows.rst diff --git a/site/source/device-guides/windows/index.rst b/site/source/device-guides/windows/index.rst new file mode 100644 index 0000000..e55b778 --- /dev/null +++ b/site/source/device-guides/windows/index.rst @@ -0,0 +1,23 @@ +.. _windows: + +======= +Windows +======= + +Recommended Guides +------------------ + +.. toctree:: + :maxdepth: 1 + + ca-windows + tor-windows + ff-windows + +Other Useful Guides +------------------- + +.. toctree:: + :maxdepth: 1 + + backup-windows diff --git a/site/source/guides/device-guides/windows/tor-windows.rst b/site/source/device-guides/windows/tor-windows.rst similarity index 100% rename from site/source/guides/device-guides/windows/tor-windows.rst rename to site/source/device-guides/windows/tor-windows.rst diff --git a/site/source/diy/diy-pi.rst b/site/source/diy/diy-pi.rst index b10aa29..6290847 100644 --- a/site/source/diy/diy-pi.rst +++ b/site/source/diy/diy-pi.rst @@ -1,8 +1,8 @@ .. _diy-pi: -============================= -DIY Guidelines (Raspberry Pi) -============================= +================== +DIY (Raspberry Pi) +================== .. contents:: :depth: 2 @@ -27,7 +27,7 @@ Flash and Install StartOS ------------------------- .. topic-box:: :title: Flashing (Raspberry Pi) - :link: /latest/guides/flashing/flashing-pi + :link: ../flashing-guides/os-pi :icon: scylla-icon scylla-icon--apps :class: large-4 :anchor: View Guide diff --git a/site/source/diy/diy-x86.rst b/site/source/diy/diy-x86.rst index f22d007..5bd6403 100644 --- a/site/source/diy/diy-x86.rst +++ b/site/source/diy/diy-x86.rst @@ -1,8 +1,8 @@ .. _diy-x86: -======================= -DIY Guidelines (x86_64) -======================= +======= +DIY x86 +======= .. contents:: :depth: 2 @@ -40,8 +40,8 @@ If you intend to run Bitcoin or store any meaningful amount of data, we recommen Flash and Install StartOS ------------------------- .. topic-box:: - :title: Flashing (x86_64) - :link: /latest/guides/flashing/flashing-x86 + :title: Flashing (x86) + :link: ../flashing-guides/os-x86 :icon: scylla-icon scylla-icon--overview :class: large-4 :anchor: View Guide diff --git a/site/source/diy/index.rst b/site/source/diy/index.rst index 6a09bd7..4614dfe 100644 --- a/site/source/diy/index.rst +++ b/site/source/diy/index.rst @@ -15,32 +15,7 @@ There are several reasons you might prefer to build your own server instead of p #. You do not want to share your shipping address. #. You like building things. -.. raw:: html - -
- -
- -.. topic-box:: - :title: DIY (Raspberry Pi) - :link: diy-pi - :icon: scylla-icon scylla-icon--apps - :class: large-4 - :anchor: View Guidelines - - Build a Start9 server using a Raspberry Pi - -.. topic-box:: - :title: DIY (x86_64) - :link: diy-x86 - :icon: scylla-icon scylla-icon--overview - :class: large-4 - :anchor: View Guidelines - - Build a Start9 server using an x86_64 machine - .. toctree:: - :hidden: :maxdepth: 1 diy-pi diff --git a/site/source/guides/flashing/flashing-firmware.rst b/site/source/flashing-guides/firmware-pure.rst similarity index 96% rename from site/source/guides/flashing/flashing-firmware.rst rename to site/source/flashing-guides/firmware-pure.rst index f925eed..f3e3dd3 100644 --- a/site/source/guides/flashing/flashing-firmware.rst +++ b/site/source/flashing-guides/firmware-pure.rst @@ -1,8 +1,8 @@ -.. _flashing-firmware: +.. _flashing-firmware-pure: -=================== -Flashing (Firmware) -=================== +====================== +Firmware (Server Pure) +====================== This page is for Server Pure / Purism Librem Mini users ONLY. This firmware is custom for these devices. The source code can be viewed on Purism's `firmware git repo `_. You will need a USB flash drive, formatted FAT32, to flash the firmware to your server. diff --git a/site/source/flashing-guides/index.rst b/site/source/flashing-guides/index.rst new file mode 100644 index 0000000..fa1e2ea --- /dev/null +++ b/site/source/flashing-guides/index.rst @@ -0,0 +1,17 @@ +.. _flashing: + +=============== +Flashing Guides +=============== + +Here you will find our flashing guides for the Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get StartOS-specific firmware. + + +.. toctree:: + :maxdepth: 1 + + os-pi + os-x86 + firmware-pure + +Appreciate what we're doing? Please consider a `donation to Start9 `_. diff --git a/site/source/guides/flashing/flashing-pi.rst b/site/source/flashing-guides/os-pi.rst similarity index 97% rename from site/source/guides/flashing/flashing-pi.rst rename to site/source/flashing-guides/os-pi.rst index 6c9f9c1..dd6e8c6 100644 --- a/site/source/guides/flashing/flashing-pi.rst +++ b/site/source/flashing-guides/os-pi.rst @@ -1,8 +1,8 @@ -.. _flashing-pi: +.. _flashing-os-pi: -======================= -Flashing (Raspberry Pi) -======================= +====================== +StartOS (Raspberry Pi) +====================== This guide is for flashing StartOS to a micro SD card in order to install it on a Raspberry Pi with an external SSD. Please `contact support `_ if you need to re-install your OS on a Server Lite (SD card storage). .. warning:: If you are running in a "Lite" configuration (everything on an SD card), then flashing that SD card in the manner proscribed below WILL ERASE ALL YOUR DATA! If you need to reflash and you are NOT using an external SSD (ie. you have a Server Lite), please contact support for assistance instead. diff --git a/site/source/guides/flashing/flashing-x86.rst b/site/source/flashing-guides/os-x86.rst similarity index 98% rename from site/source/guides/flashing/flashing-x86.rst rename to site/source/flashing-guides/os-x86.rst index 3cc8e93..eca117f 100644 --- a/site/source/guides/flashing/flashing-x86.rst +++ b/site/source/flashing-guides/os-x86.rst @@ -1,8 +1,8 @@ -.. _flashing-x86: +.. _flashing-os-x86: -================= -Flashing (x86_64) -================= +============= +StartOS (x86) +============= This guide is for flashing StartOS to a USB drive in order to install it to an x86_64 architecture device. This will include most desktops, laptops, mini PCs, and servers. For an up-to-date list of known-good hardware, please check out this `forum post `_. .. note:: You will need a USB drive of at least 8GB in size diff --git a/site/source/getting-started/index.rst b/site/source/getting-started/index.rst deleted file mode 100644 index 3118ab5..0000000 --- a/site/source/getting-started/index.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _getting-started: - -=============== -Getting Started -=============== -The guides below are considered mandatory for a safe and smooth experience with StartOS - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Initial Setup - :link: initial-setup - :icon: scylla-icon scylla-icon--home - :class: large-4 - :anchor: View - - Step by step instructions for setting up your server - -.. topic-box:: - :title: Trusting your Root CA - :link: trust-ca - :icon: scylla-icon scylla-icon--testing - :class: large-4 - :anchor: View - - Use encryption for a secure connection to your server - -.. topic-box:: - :title: Configuring Firefox - :link: configuring-ff - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: View - - Configure Firefox for optimal Local and Tor connectivity - -.. topic-box:: - :title: Connecting Locally - :link: connecting-lan - :icon: scylla-icon scylla-icon--networking - :class: large-4 - :anchor: View - - Connect to your server while on the same LAN - -.. topic-box:: - :title: Connecting Remotely - :link: connecting-tor - :icon: scylla-icon scylla-icon--networking - :class: large-4 - :anchor: View - - Connect to your server remotely using Tor - -.. toctree:: - :hidden: - :maxdepth: 2 - - initial-setup - trust-ca - configuring-ff - connecting-lan - connecting-tor diff --git a/site/source/guides/device-guides/android/index.rst b/site/source/guides/device-guides/android/index.rst deleted file mode 100644 index 6338b10..0000000 --- a/site/source/guides/device-guides/android/index.rst +++ /dev/null @@ -1,47 +0,0 @@ -.. _android: - -======= -Android -======= -It is recommended you complete all of the guides below. - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Trust Root CA - :link: ca-android - :icon: scylla-icon scylla-icon--partners - :class: large-4 - :anchor: View - - Trust your server's Root Certificate Authority for fast, secure connections - -.. topic-box:: - :title: Connect to Tor Network - :icon: scylla-icon scylla-icon--networking - :link: tor-android - :class: large-4 - :anchor: View - - Run Tor natively for remote connectivity - -.. topic-box:: - :title: Configure Firefox - :link: ff-android - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: View - - Configure Firefox for an optimal browser experience - -.. toctree:: - :maxdepth: 4 - :hidden: - - ca-android - tor-android - ff-android diff --git a/site/source/guides/device-guides/ios/index.rst b/site/source/guides/device-guides/ios/index.rst deleted file mode 100644 index 667d744..0000000 --- a/site/source/guides/device-guides/ios/index.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. _ios: - -=== -iOS -=== -It is recommended you complete all of the guides below. - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Trust Root CA - :link: ca-ios - :icon: scylla-icon scylla-icon--partners - :class: large-4 - :anchor: View - - Trust your server's Root Certificate Authority for fast, secure connections - -.. topic-box:: - :title: Connect to Tor Network - :icon: scylla-icon scylla-icon--networking - :link: tor-ios - :class: large-4 - :anchor: View - - Run Tor natively for remote connectivity - -.. toctree:: - :maxdepth: 4 - :hidden: - - ca-ios - tor-ios diff --git a/site/source/guides/device-guides/linux/index.rst b/site/source/guides/device-guides/linux/index.rst deleted file mode 100644 index 3f62788..0000000 --- a/site/source/guides/device-guides/linux/index.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _linux: - -===== -Linux -===== -Recommended Guides ------------------- - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Trust Root CA - :link: ca-linux - :icon: scylla-icon scylla-icon--partners - :class: large-4 - :anchor: View - - Trust your server's Root Certificate Authority for fast, secure connections - -.. topic-box:: - :title: Connect to Tor Network - :icon: scylla-icon scylla-icon--networking - :link: tor-linux - :class: large-4 - :anchor: View - - Run Tor natively for remote connectivity - -.. topic-box:: - :title: Configure Firefox - :link: ff-linux - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: View - - Configure Firefox for an optimal browser experience - -Other Useful Guides -------------------- - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Backup Config - :link: backup-linux - :icon: scylla-icon scylla-icon--cloud - :class: large-4 - :anchor: View - - Configure a Network Folder for storing StartOS backups - -.. toctree:: - :maxdepth: 4 - :hidden: - - ca-linux - tor-linux - ff-linux - backup-linux diff --git a/site/source/guides/device-guides/mac/index.rst b/site/source/guides/device-guides/mac/index.rst deleted file mode 100644 index 6491846..0000000 --- a/site/source/guides/device-guides/mac/index.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. _dg-mac: - -=== -Mac -=== -Recommended Guides ------------------- -.. raw:: html - -
- -
- -.. topic-box:: - :title: Trust Root CA - :link: ca-mac - :icon: scylla-icon scylla-icon--partners - :class: large-4 - :anchor: View - - Trust your server's Root Certificate Authority for fast, secure connections - -.. topic-box:: - :title: Connect to Tor Network - :icon: scylla-icon scylla-icon--networking - :link: tor-mac - :class: large-4 - :anchor: View - - Run Tor natively for remote connectivity - -.. topic-box:: - :title: Configure Firefox - :link: ff-mac - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: View - - Configure Firefox for an optimal browser experience - -Other Useful Guides -------------------- -.. raw:: html - -
- -
- -.. topic-box:: - :title: Backup Config - :link: backup-mac - :icon: scylla-icon scylla-icon--cloud - :class: large-4 - :anchor: View - - Configure a Network Folder for storing StartOS backups - -.. 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: - - ca-mac - tor-mac - ff-mac - backup-mac - screenshare-mac diff --git a/site/source/guides/device-guides/synology/index.rst b/site/source/guides/device-guides/synology/index.rst deleted file mode 100644 index b82631d..0000000 --- a/site/source/guides/device-guides/synology/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _dg-synology: - -======== -Synology -======== - -Recommended Guides ------------------- - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Backup Config - :link: backup-synology - :icon: scylla-icon scylla-icon--cloud - :class: large-4 - :anchor: View - - Configure a Network Folder for storing StartOS backups - -.. toctree:: - :maxdepth: 2 - :hidden: - - backup-synology diff --git a/site/source/guides/device-guides/truenas/index.rst b/site/source/guides/device-guides/truenas/index.rst deleted file mode 100644 index 9bd7a95..0000000 --- a/site/source/guides/device-guides/truenas/index.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _dg-truenas: - -======= -TrueNas -======= - -Recommended Guides ------------------- - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Backup Config - :link: backup-truenas - :icon: scylla-icon scylla-icon--cloud - :class: large-4 - :anchor: View - - Configure a Network Folder for storing StartOS backups - -.. toctree:: - :maxdepth: 2 - :hidden: - - backup-truenas diff --git a/site/source/guides/device-guides/windows/index.rst b/site/source/guides/device-guides/windows/index.rst deleted file mode 100644 index 8335511..0000000 --- a/site/source/guides/device-guides/windows/index.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _windows: - -======= -Windows -======= -Recommended Guides ------------------- - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Trust Root CA - :link: ca-windows - :icon: scylla-icon scylla-icon--partners - :class: large-4 - :anchor: View - - Trust your server's Root Certificate Authority for fast, secure connections - -.. topic-box:: - :title: Connect to Tor Network - :icon: scylla-icon scylla-icon--networking - :link: tor-windows - :class: large-4 - :anchor: View - - Run Tor natively for remote connectivity - -.. topic-box:: - :title: Configure Firefox - :link: ff-windows - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: View - - Configure Firefox for an optimal browser experience - -Other Useful Guides -------------------- - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Backup Config - :link: backup-windows - :icon: scylla-icon scylla-icon--cloud - :class: large-4 - :anchor: View - - Configure a Network Folder for storing StartOS backups - -.. toctree:: - :maxdepth: 4 - :hidden: - - ca-windows - tor-windows - ff-windows - backup-windows diff --git a/site/source/guides/flashing/index.rst b/site/source/guides/flashing/index.rst deleted file mode 100644 index d161e2a..0000000 --- a/site/source/guides/flashing/index.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. _flashing: - -======== -Flashing -======== - -Here you will find our flashing guides for the Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get StartOS-specific firmware. - -.. raw:: html - -
- -
- -.. topic-box:: - :title: Flashing (Raspberry Pi) - :link: flashing-pi - :icon: scylla-icon scylla-icon--apps - :class: large-4 - :anchor: View Guide - - Flash StartOS for use on a Raspberry Pi - -.. topic-box:: - :title: Flashing (x86_64) - :link: flashing-x86 - :icon: scylla-icon scylla-icon--overview - :class: large-4 - :anchor: View Guide - - Flash StartOS for use on an x86_64 machine - -.. topic-box:: - :title: Flashing (Firmware) - :link: flashing-firmware - :icon: scylla-icon scylla-icon--integrations - :class: large-4 - :anchor: Librem Mini Firmware - - Flash the custom firmware for StartOS on an existing Librem Mini - -.. toctree:: - :hidden: - :maxdepth: 2 - - flashing-pi - flashing-x86 - flashing-firmware - -Appreciate what we're doing? Please consider a `donation to Start9 `_. diff --git a/site/source/guides/index.rst b/site/source/guides/index.rst deleted file mode 100644 index b5a42e0..0000000 --- a/site/source/guides/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _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/lan-ff.rst b/site/source/guides/misc-guides/lan-ff.rst deleted file mode 100644 index df04188..0000000 --- a/site/source/guides/misc-guides/lan-ff.rst +++ /dev/null @@ -1,112 +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 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/guides/upgrade-hardware/index.rst b/site/source/guides/upgrade-hardware/index.rst deleted file mode 100644 index 4527b82..0000000 --- a/site/source/guides/upgrade-hardware/index.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. _upgrade-hardware: - -=============== -Hardware Guides -=============== -.. raw:: html - -
- -
- -.. topic-box:: - :title: Migrate an LND Node to StartOS - :link: lnd-migration - :icon: scylla-icon scylla-icon--home - :class: large-4 - :anchor: View - - Migrating an LND from another server to StartOS without closing channels - -.. topic-box:: - :title: Changing Your SSD - :link: drive-upgrade - :icon: scylla-icon scylla-icon--benchmarks - :class: large-4 - :anchor: View - - Replace or upgrade your SSD - -.. topic-box:: - :title: Upgrade SSD ('22 Server One) - :link: naspi-ssd-upgrade - :icon: scylla-icon scylla-icon--benchmarks - :class: large-4 - :anchor: View - - This is for replacing or upgrading your 2022 Server One SSD - -.. topic-box:: - :title: 2022 One to Pure Migration - :link: upgrade-pure - :icon: scylla-icon scylla-icon--enterprise - :class: large-4 - :anchor: View - - This is for migrating from a Server One (Raspberry Pi) to Server Pure - -.. topic-box:: - :title: Upgrade to all-in-one NASPi case - :link: naspi-upgrade - :icon: scylla-icon scylla-icon--home - :class: large-4 - :anchor: View - - This is for upgrading a Pi to an all-in-one NASPi case - -.. raw:: html - -
- -.. toctree:: - :maxdepth: 2 - - lnd-migration - drive-upgrade - upgrade-pure - naspi-upgrade - naspi-ssd-upgrade diff --git a/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst b/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst deleted file mode 100644 index 48723a0..0000000 --- a/site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst +++ /dev/null @@ -1,134 +0,0 @@ -.. _naspi-ssd-upgrade: - -====================== -Upgrade Your NASPI SSD -====================== -This guide will go over how to switch out an old drive on your server to a different drive and transfer the data from the old one to the new one. - -This will preserve the entire state of your server, including all Tor and LAN addresses as well as channels you have open on the lightning network! - -This is not the same as running a back up and restoring them onto a new server. - -#. Start by shutting down your server: - - .. figure:: /_static/images/walkthrough/shutdown.png - :width: 50% - -#. Remove the power and Ethernet cables: - - .. figure:: /_static/images/hardware-pics/back-no-cables.jpg - :width: 50% - -#. Unscrew the two screws here and remove the USB adaptor: - - .. figure:: /_static/images/hardware-pics/back-screws-usb-loop.jpg - :width: 50% - -#. Remove the micro SD card from the front: - - .. figure:: /_static/images/hardware-pics/front-sd-card.jpg - :width: 50% - -#. Remove the bottom four screws: - - .. figure:: /_static/images/hardware-pics/bottom-screws.jpg - :width: 50% - -#. Carefully slide the contents of the case out and disassemble the server by disconnecting the power wire and removing the 5 screws (and 4 brass spacers beneath the fan bracket) highlighted below: - - .. figure:: /_static/images/hardware-pics/disassembly-0.png - :width: 50% - -#. This top section should lift off now and you'll be left with the SSD still attached. Remove the two screws shown below: - - .. figure:: /_static/images/hardware-pics/disassembly-1.png - :width: 50% - -#. Now slide the **old** SSD off the connector: - - .. figure:: /_static/images/hardware-pics/old-drive-exposed.jpg - :width: 50% - -#. Now take the **new** SSD, and connect it where the old one was: - - .. figure:: /_static/images/hardware-pics/new-ssd-attach-0.png - :width: 50% - -#. Secure the SSD with the two silver screws: - - .. figure:: /_static/images/hardware-pics/disassembly-1.png - :width: 50% - -#. Reattach the 4 brass spacers holding the Pi to the SSD board, followed by the 5 black screws to secure the fan bracket and power management board. Then reconnect the power wire: - - .. figure:: /_static/images/hardware-pics/disassembly-0.png - :width: 50% - -#. Now reinsert the server back into the case and reattach the bottom four black screws: - - .. figure:: /_static/images/hardware-pics/bottom-screws.jpg - :width: 50% - -#. Reconnect the USB adaptor and back two black screws: - - .. figure:: /_static/images/hardware-pics/back-screws-usb-loop.jpg - :width: 50% - -#. Flash the micro SD card with a fresh install of StartOS - you can follow the flashing guide :ref:`here ` - -#. Once flashed, reinsert the micro SD card into the server: - - .. figure:: /_static/images/hardware-pics/front-sd-card.jpg - :width: 50% - -#. Reconnect the Ethernet cable, make sure the USB adaptor is connect and then finally connect the power cable: - - .. figure:: /_static/images/hardware-pics/plugged-in-back.jpg - :width: 50% - - .. figure:: /_static/images/hardware-pics/plugged-in-front.jpg - :width: 50% - -#. Head to http://start.local on any device on the same LAN - -#. Select "Recover" - - .. figure:: /_static/images/setup/screen0-recover.jpg - :width: 60% - -#. Select "Transfer" - - .. figure:: /_static/images/setup/transfer.png - :width: 60% - -#. Now connect the **old ssd** to your server: - - .. figure:: /_static/images/hardware-pics/attach-ssd.jpg - :width: 60% - -#. Select the **old drive** - the one that is externally connect to your server (you may need to hit *REFRESH*): - - .. figure:: /_static/images/setup/transfer-from.png - :width: 60% - -#. Select the drive **inside the server** that you are migrating **to** - this is your **NEW** drive - and any data on this drive will be erased: - - .. figure:: /_static/images/setup/transfer-to.png - :width: 60% - -#. You will be asked to create a password. It can be the same as it was previously: - - .. figure:: /_static/images/setup/screen5-set_password.png - :width: 60% - -#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours: - - .. figure:: /_static/images/setup/screen6-storage_initialize.jpg - :width: 60% - -#. You are now ready to proceed and use your server with its new drive! It will have the same addresses and root certificate as it did before migrating. - - .. figure:: /_static/images/setup/screen7-startfresh_complete.jpg - :width: 60% - - .. warning:: Do not unders any circumstances use the old SSD to setup another server unless you wipe it first or wipe it during the initial setup proecess! If you have lightning channels you could lose all your funds! diff --git a/site/source/guides/upgrade-hardware/naspi-upgrade.rst b/site/source/guides/upgrade-hardware/naspi-upgrade.rst deleted file mode 100644 index 85f23dc..0000000 --- a/site/source/guides/upgrade-hardware/naspi-upgrade.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _naspi-upgrade: - -====================================== -Upgrading from an External Drive Setup -====================================== - -If you already have a server with an external drive, you can follow along from the `written guide appendix `_ and/or check out the video below: - - .. youtube:: 355BENA42s8 - :width: 100% \ No newline at end of file diff --git a/site/source/guides/upgrade-hardware/upgrade-pure.rst b/site/source/guides/upgrade-hardware/upgrade-pure.rst deleted file mode 100644 index ef79cf2..0000000 --- a/site/source/guides/upgrade-hardware/upgrade-pure.rst +++ /dev/null @@ -1,165 +0,0 @@ -.. _upgrade-pure: - -============================================= -Migrating From 2022 Server One to Server Pure -============================================= -This guide is for Server One users upgrading from a NASPi (pictured below). If you're using an external drive, such as a Samsung T5/T7 please go :ref:`here `. - - .. figure:: /_static/images/hardware-pics/server-one.png - :width: 30% - -You will need a high quality `USB-A to USB-A cable `_, or a `USB-A to USB-C cable `_. - -#. Shutdown your Server One. - - .. figure:: /_static/images/walkthrough/shutdown.png - :width: 60% - -#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power. - - .. raw:: HTML - - - - * Shutdown sound - -#. Now disconnect the USB adapter found here: - - .. figure:: /_static/images/hardware-pics/naspi-jameson-loop2.png - :width: 60% - -#. Connect the USB cable to the lowest blue USB port like this: - - .. figure:: /_static/images/hardware-pics/usb-into-naspi-edited.jpg - :width: 60% - -#. Now connect the Ethernet cable and then the power to your Server Pro - - .. figure:: /_static/images/hardware-pics/pro-all.jpg - :width: 60% - -#. Head to http://start.local on any device on the same LAN - -#. Select "Recover" - - .. figure:: /_static/images/setup/screen0-recover.jpg - :width: 60% - -#. Select "Transfer" - - .. figure:: /_static/images/setup/transfer.png - :width: 60% - -#. Now connect the other end of the USB cable to either an Server Pure USB-3 port or the USB-C port: - - .. figure:: /_static/images/hardware-pics/pro-all-highlighted.jpg - :width: 60% - -#. Connect the power to the NASPi - you will hear this sound and can ignore it: - - .. raw:: HTML - - - - * Beethoven's 5th - -#. Select the drive inside the NASPi (you may need to hit refresh): - - .. figure:: /_static/images/setup/transfer-from.png - :width: 60% - -#. Select the drive inside the Server Pure that you are migrating *to* (this will erase any data on this drive): - - .. figure:: /_static/images/setup/transfer-to.png - :width: 60% - -#. You will be asked to create a password. It can be the same as it was previously: - - .. figure:: /_static/images/setup/screen5-set_password.png - :width: 60% - -#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours: - - .. figure:: /_static/images/setup/screen6-storage_initialize.jpg - :width: 60% - -#. You are now ready to proceed and use your Server Pro - it will have the same addresses and root certificate as it did before migrating. - - .. figure:: /_static/images/setup/screen7-startfresh_complete.jpg - :width: 60% - - .. warning:: Do not unders any circumstances reassemble your Server One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds! - -.. _external-drives: - -External Drives -=============== -For transferring from an USB-attached drive. - -#. Shutdown your Server One - - .. figure:: /_static/images/walkthrough/shutdown.png - :width: 60% - -#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power. - - .. raw:: HTML - - - - * Shutdown sound - -#. Now connect the Ethernet cable and then the power to your Server Pro - - .. figure:: /_static/images/hardware-pics/pro-all.jpg - :width: 60% - -#. Head to http://start.local on any device on the same LAN - -#. Select "Recover" - - .. figure:: /_static/images/setup/screen0-recover.jpg - :width: 60% - -#. Select "Transfer" - - .. figure:: /_static/images/setup/transfer.png - :width: 60% - -#. Now connect your Samsung T5/T7/alternative drive to any USB-3 or USB-C port on your Server Pure - -#. Select this drive (you may need to hit refresh): - - .. figure:: /_static/images/setup/transfer-from.png - :width: 60% - -#. Select the drive inside the Server Pure that you are migrating *to* (this will erase any data on this drive): - - .. figure:: /_static/images/setup/transfer-to.png - :width: 60% - -#. You will be asked to create a password. It can be the same as it was previously: - - .. figure:: /_static/images/setup/screen5-set_password.png - :width: 60% - -#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours: - - .. figure:: /_static/images/setup/screen6-storage_initialize.jpg - :width: 60% - -#. You are now ready to proceed and use your Server Pure - it will have the same addresses and root certificate as it did before migrating. - - .. figure:: /_static/images/setup/screen7-startfresh_complete.jpg - :width: 60% - - .. warning:: Do not unders any circumstances reassemble your Server One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds! \ No newline at end of file diff --git a/site/source/index.rst b/site/source/index.rst index d0e48ea..807a7aa 100644 --- a/site/source/index.rst +++ b/site/source/index.rst @@ -20,8 +20,8 @@
.. topic-box:: - :title: Getting Started - :link: getting-started + :title: Quick Start + :link: quick-start :icon: scylla-icon scylla-icon--getting-started :class: large-4 :anchor: View @@ -38,22 +38,40 @@ Understand and use your server .. topic-box:: - :title: Guides - :link: guides + :title: Service Guides + :link: service-guides :icon: scylla-icon scylla-icon--circe :class: large-4 :anchor: View - Integrate your devices and tools + Guides for officially supported services .. topic-box:: - :title: Support - :link: support - :icon: scylla-icon scylla-icon--support + :title: Device Guides + :link: device-guides + :icon: scylla-icon scylla-icon--circe :class: large-4 :anchor: View - Find answers to your questions + Guides for specific client devices + +.. topic-box:: + :title: Flashing Guides + :link: flashing-guides + :icon: scylla-icon scylla-icon--circe + :class: large-4 + :anchor: View + + Guides for flashing firmware and StartOS + +.. topic-box:: + :title: Misc Guides + :link: misc-guides + :icon: scylla-icon scylla-icon--circe + :class: large-4 + :anchor: View + + Miscellaneous guides you might find useful .. topic-box:: :title: DIY @@ -74,22 +92,25 @@ Package a service for the Marketplace .. topic-box:: - :title: Contact Us - :link: https://start9.com/contact - :icon: scylla-icon scylla-icon--contact-us + :title: Get Help + :link: support + :icon: scylla-icon scylla-icon--support :class: large-4 :anchor: View - Join us in our community channels or get support + View common issues or contact support .. This is for the side navigation display .. toctree:: - :maxdepth: 5 :hidden: + :maxdepth: 1 - getting-started/index + quick-start user-manual/index - guides/index - support/index + service-guides/index + device-guides/index + flashing-guides/index + misc-guides/index diy/index developer-docs/index + support/index diff --git a/site/source/guides/misc-guides/backup-mount.rst b/site/source/misc-guides/backup-mount.rst similarity index 100% rename from site/source/guides/misc-guides/backup-mount.rst rename to site/source/misc-guides/backup-mount.rst diff --git a/site/source/guides/misc-guides/data-mount.rst b/site/source/misc-guides/data-mount.rst similarity index 100% rename from site/source/guides/misc-guides/data-mount.rst rename to site/source/misc-guides/data-mount.rst diff --git a/site/source/guides/misc-guides/index.rst b/site/source/misc-guides/index.rst similarity index 64% rename from site/source/guides/misc-guides/index.rst rename to site/source/misc-guides/index.rst index 80a16ef..657306d 100644 --- a/site/source/guides/misc-guides/index.rst +++ b/site/source/misc-guides/index.rst @@ -6,10 +6,13 @@ Misc Guides Guides that do not fit into the categories of "devices" or "services." .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - lan-ff - lan-thunderbird + ca-ff + lnd-migration + upgrade-hardware/index + thunderbird smtp backup-mount data-mount + reset-password diff --git a/site/source/guides/upgrade-hardware/lnd-migration.rst b/site/source/misc-guides/lnd-migration.rst similarity index 100% rename from site/source/guides/upgrade-hardware/lnd-migration.rst rename to site/source/misc-guides/lnd-migration.rst diff --git a/site/source/guides/reset-password.rst b/site/source/misc-guides/reset-password.rst similarity index 92% rename from site/source/guides/reset-password.rst rename to site/source/misc-guides/reset-password.rst index 15f6647..13a7d93 100644 --- a/site/source/guides/reset-password.rst +++ b/site/source/misc-guides/reset-password.rst @@ -3,7 +3,7 @@ ============== 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`. +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 main StartOS UI by following the :ref:`change password guide`. .. contents:: :depth: 2 diff --git a/site/source/guides/misc-guides/smtp.rst b/site/source/misc-guides/smtp.rst similarity index 76% rename from site/source/guides/misc-guides/smtp.rst rename to site/source/misc-guides/smtp.rst index d8d3039..b649f99 100644 --- a/site/source/guides/misc-guides/smtp.rst +++ b/site/source/misc-guides/smtp.rst @@ -1,11 +1,9 @@ .. _smtp: -===================== -SMTP Setup (External) -===================== -There are several services that are able to take advantage of a Simple Mail Transfer Protocol (SMTP) server in order to send emails. The most common third party SMTP services are GMail and Amazon SES. Some example services that you may wish to use this functionality with are BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden. - -In order to get SMTP credentials for use in a StartOS service, you can follow one of these vendor specific guides. +======================== +Getting SMTP Credentials +======================== +There are several StartOS services that are capable of sending emails, such as BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden, using third party email (SMTP) servers. The guides below are for using Gmail or Amazon SES for SMTP, but you may also use another third party provider of your choice. .. tabs:: .. group-tab:: Gmail @@ -56,4 +54,4 @@ In order to get SMTP credentials for use in a StartOS service, you can follow on .. group-tab:: Amazon SES - For Amazon SES Configurarions please refer to `Amazon SMTP Credentials Setup Guide On Amazon Docs `_ + To use Amazon SES please refer to the `Amazon SES docs `_ diff --git a/site/source/guides/misc-guides/lan-thunderbird.rst b/site/source/misc-guides/thunderbird.rst similarity index 89% rename from site/source/guides/misc-guides/lan-thunderbird.rst rename to site/source/misc-guides/thunderbird.rst index 7194e32..f062a0f 100644 --- a/site/source/guides/misc-guides/lan-thunderbird.rst +++ b/site/source/misc-guides/thunderbird.rst @@ -1,12 +1,12 @@ -.. _lan-thunderbird: +.. _thunderbird: -========================= -Thunderbird Configuration -========================= +================= +Using Thunderbird +================= .. caution:: You will first need to complete :ref:`device-guides` for your client before continuing. Take special note of the Thunderbird-specific instructions there. -Trusting Your Start9 CA in Thunderbird -====================================== +Trusting Your Root CA in Thunderbird +==================================== #. Open Thunderbird and do the following: @@ -28,8 +28,8 @@ Trusting Your Start9 CA in Thunderbird :width: 60% :alt: Thunderbird enterprise_roots settings -Configure Tor in Thunderbird -============================ +Configuring Tor +=============== .. note:: This is not required if you have enabled a system-wide proxy configuration. diff --git a/site/source/guides/upgrade-hardware/drive-upgrade.rst b/site/source/misc-guides/upgrade-hardware/drive-upgrade.rst similarity index 100% rename from site/source/guides/upgrade-hardware/drive-upgrade.rst rename to site/source/misc-guides/upgrade-hardware/drive-upgrade.rst diff --git a/site/source/misc-guides/upgrade-hardware/index.rst b/site/source/misc-guides/upgrade-hardware/index.rst new file mode 100644 index 0000000..b1d538c --- /dev/null +++ b/site/source/misc-guides/upgrade-hardware/index.rst @@ -0,0 +1,11 @@ +.. _upgrade-hardware: + +================== +Upgrading Hardware +================== + +.. toctree:: + :maxdepth: 1 + + drive-upgrade + upgrade-pure diff --git a/site/source/misc-guides/upgrade-hardware/upgrade-pure.rst b/site/source/misc-guides/upgrade-hardware/upgrade-pure.rst new file mode 100644 index 0000000..95acfc5 --- /dev/null +++ b/site/source/misc-guides/upgrade-hardware/upgrade-pure.rst @@ -0,0 +1,92 @@ +.. _upgrade-pi: + +========================= +Upgrade From Raspberry Pi +========================= +Follow this guide to upgrade from a Raspberry Pi StartOS server to a Server One, Server Pure, or similar device. + +.. _external-drives: + +External Drive +============== +If your current Raspberry Pi setup uses an external drive over USB. + +#. Shutdown your Raspberry Pi server and disconnect from power. If you have a speaker, wait for shutdown noises. + + .. figure:: /_static/images/walkthrough/shutdown.png + :width: 60% + + .. raw:: HTML + + + + * Shutdown sound + +#. Connect your new server to power and ethernet. + + .. figure:: /_static/images/hardware-pics/pro-all.jpg + :width: 60% + +#. Visit http://start.local on any device on the same LAN. + +#. Select "Recover". + + .. figure:: /_static/images/setup/screen0-recover.jpg + :width: 60% + +#. Select "Transfer". + + .. figure:: /_static/images/setup/transfer.png + :width: 60% + +#. Connect your previous external drive to any USB-3 or USB-C port on your new server. + +#. Select this drive (you may need to hit refresh): + + .. figure:: /_static/images/setup/transfer-from.png + :width: 60% + +#. Select the destination drive that you are migrating *to* (this will erase any data on this drive): + + .. figure:: /_static/images/setup/transfer-to.png + :width: 60% + +#. You will be asked to create a password. It can be the same as it was previously. + + .. figure:: /_static/images/setup/screen5-set_password.png + :width: 60% + +#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours. + + .. figure:: /_static/images/setup/screen6-storage_initialize.jpg + :width: 60% + +#. You are now ready to proceed and use your new server - it will have the same addresses and Root CA as it did before. + + .. figure:: /_static/images/setup/screen7-startfresh_complete.jpg + :width: 60% + + .. warning:: DO NOT reconnect your old server without first wiping the SD card and SSD! This can cause serious problems! If you have lightning channels you could lose your money! + +NASPI (Embassy One) +=================== + + .. figure:: /_static/images/hardware-pics/server-one.png + :width: 30% + +#. Get a high quality `USB-A to USB-A cable `_, or a `USB-A to USB-C cable `_. + +#. Disconnect the USB adapter. + + .. figure:: /_static/images/hardware-pics/naspi-jameson-loop2.png + :width: 60% + +#. Connect one side of the USB-A cable to the lowest blue USB port on the NASPI, and the other side to your new server. + + .. figure:: /_static/images/hardware-pics/usb-into-naspi-edited.jpg + :width: 60% + +#. Follow the instructions above. diff --git a/site/source/quick-start.rst b/site/source/quick-start.rst new file mode 100644 index 0000000..ebb6d3e --- /dev/null +++ b/site/source/quick-start.rst @@ -0,0 +1,13 @@ +.. _quick-start: + +=========== +Quick Start +=========== + +Complete the step below to get up and running with your server in the recommended way: + +1. :ref:`initial-setup` (5 minutes) +2. :ref:`trust-ca` (5 minutes) +3. :ref:`configuring-ff` (3 minutes) +4. :ref:`connecting-lan` (1-4 minutes) +5. :ref:`connecting-tor` (4-8 minutes) \ No newline at end of file diff --git a/site/source/guides/service-guides/bitcoin/bitcoin-cli.rst b/site/source/service-guides/bitcoin/bitcoin-cli.rst similarity index 100% rename from site/source/guides/service-guides/bitcoin/bitcoin-cli.rst rename to site/source/service-guides/bitcoin/bitcoin-cli.rst diff --git a/site/source/guides/service-guides/bitcoin/bitcoin-integrations.rst b/site/source/service-guides/bitcoin/bitcoin-integrations.rst similarity index 100% rename from site/source/guides/service-guides/bitcoin/bitcoin-integrations.rst rename to site/source/service-guides/bitcoin/bitcoin-integrations.rst diff --git a/site/source/guides/service-guides/bitcoin/blockchain-copy.rst b/site/source/service-guides/bitcoin/blockchain-copy.rst similarity index 100% rename from site/source/guides/service-guides/bitcoin/blockchain-copy.rst rename to site/source/service-guides/bitcoin/blockchain-copy.rst diff --git a/site/source/guides/service-guides/bitcoin/index.rst b/site/source/service-guides/bitcoin/index.rst similarity index 77% rename from site/source/guides/service-guides/bitcoin/index.rst rename to site/source/service-guides/bitcoin/index.rst index 86f6b2d..b9b7cf5 100644 --- a/site/source/guides/service-guides/bitcoin/index.rst +++ b/site/source/service-guides/bitcoin/index.rst @@ -4,7 +4,7 @@ Bitcoin ======= -These guides will help you to setup external tools to connect or interact with :ref:`Bitcoin`, such as a wallet. +These guides will help you to setup external tools to connect or interact with Bitcoin, such as a wallet. .. toctree:: :maxdepth: 1 diff --git a/site/source/guides/service-guides/index.rst b/site/source/service-guides/index.rst similarity index 100% rename from site/source/guides/service-guides/index.rst rename to site/source/service-guides/index.rst diff --git a/site/source/guides/service-guides/jellyfin/index.rst b/site/source/service-guides/jellyfin/index.rst similarity index 100% rename from site/source/guides/service-guides/jellyfin/index.rst rename to site/source/service-guides/jellyfin/index.rst diff --git a/site/source/guides/service-guides/jellyfin/jellyfin-clients.rst b/site/source/service-guides/jellyfin/jellyfin-clients.rst similarity index 100% rename from site/source/guides/service-guides/jellyfin/jellyfin-clients.rst rename to site/source/service-guides/jellyfin/jellyfin-clients.rst diff --git a/site/source/guides/service-guides/lightning/alby-cln.rst b/site/source/service-guides/lightning/alby-cln.rst similarity index 98% rename from site/source/guides/service-guides/lightning/alby-cln.rst rename to site/source/service-guides/lightning/alby-cln.rst index 667f3f4..55dc2d5 100644 --- a/site/source/guides/service-guides/lightning/alby-cln.rst +++ b/site/source/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/guides/service-guides/lightning/alby-lnbits.rst b/site/source/service-guides/lightning/alby-lnbits.rst similarity index 97% rename from site/source/guides/service-guides/lightning/alby-lnbits.rst rename to site/source/service-guides/lightning/alby-lnbits.rst index 2e253ef..5acd724 100644 --- a/site/source/guides/service-guides/lightning/alby-lnbits.rst +++ b/site/source/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/guides/service-guides/lightning/alby-lnc.rst b/site/source/service-guides/lightning/alby-lnc.rst similarity index 100% rename from site/source/guides/service-guides/lightning/alby-lnc.rst rename to site/source/service-guides/lightning/alby-lnc.rst diff --git a/site/source/guides/service-guides/lightning/alby-lnd.rst b/site/source/service-guides/lightning/alby-lnd.rst similarity index 88% rename from site/source/guides/service-guides/lightning/alby-lnd.rst rename to site/source/service-guides/lightning/alby-lnd.rst index 595f879..44519e3 100644 --- a/site/source/guides/service-guides/lightning/alby-lnd.rst +++ b/site/source/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/guides/service-guides/lightning/bluewallet.rst b/site/source/service-guides/lightning/bluewallet.rst similarity index 100% rename from site/source/guides/service-guides/lightning/bluewallet.rst rename to site/source/service-guides/lightning/bluewallet.rst diff --git a/site/source/guides/service-guides/lightning/connecting-cln.rst b/site/source/service-guides/lightning/connecting-cln.rst similarity index 100% rename from site/source/guides/service-guides/lightning/connecting-cln.rst rename to site/source/service-guides/lightning/connecting-cln.rst diff --git a/site/source/guides/service-guides/lightning/connecting-lnbits.rst b/site/source/service-guides/lightning/connecting-lnbits.rst similarity index 96% rename from site/source/guides/service-guides/lightning/connecting-lnbits.rst rename to site/source/service-guides/lightning/connecting-lnbits.rst index 4eff361..76574b8 100644 --- a/site/source/guides/service-guides/lightning/connecting-lnbits.rst +++ b/site/source/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/guides/service-guides/lightning/connecting-lnd.rst b/site/source/service-guides/lightning/connecting-lnd.rst similarity index 100% rename from site/source/guides/service-guides/lightning/connecting-lnd.rst rename to site/source/service-guides/lightning/connecting-lnd.rst diff --git a/site/source/guides/service-guides/lightning/connecting-lndc.rst b/site/source/service-guides/lightning/connecting-lndc.rst similarity index 100% rename from site/source/guides/service-guides/lightning/connecting-lndc.rst rename to site/source/service-guides/lightning/connecting-lndc.rst diff --git a/site/source/guides/service-guides/lightning/fully-noded-cln.rst b/site/source/service-guides/lightning/fully-noded-cln.rst similarity index 100% rename from site/source/guides/service-guides/lightning/fully-noded-cln.rst rename to site/source/service-guides/lightning/fully-noded-cln.rst diff --git a/site/source/guides/service-guides/lightning/fully-noded-lnd.rst b/site/source/service-guides/lightning/fully-noded-lnd.rst similarity index 100% rename from site/source/guides/service-guides/lightning/fully-noded-lnd.rst rename to site/source/service-guides/lightning/fully-noded-lnd.rst diff --git a/site/source/guides/service-guides/lightning/index.rst b/site/source/service-guides/lightning/index.rst similarity index 100% rename from site/source/guides/service-guides/lightning/index.rst rename to site/source/service-guides/lightning/index.rst diff --git a/site/source/guides/service-guides/lightning/lightning-first-channel.rst b/site/source/service-guides/lightning/lightning-first-channel.rst similarity index 100% rename from site/source/guides/service-guides/lightning/lightning-first-channel.rst rename to site/source/service-guides/lightning/lightning-first-channel.rst diff --git a/site/source/guides/service-guides/lightning/ride-the-lightning.rst b/site/source/service-guides/lightning/ride-the-lightning.rst similarity index 100% rename from site/source/guides/service-guides/lightning/ride-the-lightning.rst rename to site/source/service-guides/lightning/ride-the-lightning.rst diff --git a/site/source/guides/service-guides/lightning/spark.rst b/site/source/service-guides/lightning/spark.rst similarity index 100% rename from site/source/guides/service-guides/lightning/spark.rst rename to site/source/service-guides/lightning/spark.rst diff --git a/site/source/guides/service-guides/lightning/zap.rst b/site/source/service-guides/lightning/zap.rst similarity index 100% rename from site/source/guides/service-guides/lightning/zap.rst rename to site/source/service-guides/lightning/zap.rst diff --git a/site/source/guides/service-guides/lightning/zeus-cln-direct.rst b/site/source/service-guides/lightning/zeus-cln-direct.rst similarity index 100% rename from site/source/guides/service-guides/lightning/zeus-cln-direct.rst rename to site/source/service-guides/lightning/zeus-cln-direct.rst diff --git a/site/source/guides/service-guides/lightning/zeus-lnbits.rst b/site/source/service-guides/lightning/zeus-lnbits.rst similarity index 100% rename from site/source/guides/service-guides/lightning/zeus-lnbits.rst rename to site/source/service-guides/lightning/zeus-lnbits.rst diff --git a/site/source/guides/service-guides/lightning/zeus-lnc.rst b/site/source/service-guides/lightning/zeus-lnc.rst similarity index 100% rename from site/source/guides/service-guides/lightning/zeus-lnc.rst rename to site/source/service-guides/lightning/zeus-lnc.rst diff --git a/site/source/guides/service-guides/lightning/zeus-lnd-direct.rst b/site/source/service-guides/lightning/zeus-lnd-direct.rst similarity index 100% rename from site/source/guides/service-guides/lightning/zeus-lnd-direct.rst rename to site/source/service-guides/lightning/zeus-lnd-direct.rst diff --git a/site/source/guides/service-guides/matrix.rst b/site/source/service-guides/matrix.rst similarity index 94% rename from site/source/guides/service-guides/matrix.rst rename to site/source/service-guides/matrix.rst index 212478b..78b0073 100644 --- a/site/source/guides/service-guides/matrix.rst +++ b/site/source/service-guides/matrix.rst @@ -9,7 +9,7 @@ Synapse With registrations disabled, the only way to create an account on your Server is through the Admin Portal. The Admin Portal is the preferred method for creating an account. -#. In your Start9 web-UI, under `Services > Synapse`, click "Launch UI" +#. In your Start9 UI, under `Services > Synapse`, click "Launch UI" #. Log in with your Admin Username and Password (located in Properties). For "Homeserver URL", do `not` enter your Homeserver address. Instead, enter your Admin Portal URL. .. note:: This is the URL currently showing in your browser URL bar, excluding the path. e.g. https://exampleaddress.local or http://exampleaddress.onion. diff --git a/site/source/guides/service-guides/nextcloud/index.rst b/site/source/service-guides/nextcloud/index.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/index.rst rename to site/source/service-guides/nextcloud/index.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/index.rst b/site/source/service-guides/nextcloud/nextcloud-apps/index.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/index.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/index.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/joplin.rst b/site/source/service-guides/nextcloud/nextcloud-apps/joplin.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/joplin.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/joplin.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-files.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-files.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-files.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-files.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-maps.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-maps.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-maps.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-maps.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-memories.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-memories.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-memories.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-memories.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-music.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-music.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-music.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-music.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-news.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-news.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-news.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-news.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-notes.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-notes.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-notes.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-notes.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-photos.rst b/site/source/service-guides/nextcloud/nextcloud-apps/nc-photos.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/nc-photos.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/nc-photos.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-apps/thunderbird.rst b/site/source/service-guides/nextcloud/nextcloud-apps/thunderbird.rst similarity index 98% rename from site/source/guides/service-guides/nextcloud/nextcloud-apps/thunderbird.rst rename to site/source/service-guides/nextcloud/nextcloud-apps/thunderbird.rst index 5716fca..a218c08 100644 --- a/site/source/guides/service-guides/nextcloud/nextcloud-apps/thunderbird.rst +++ b/site/source/service-guides/nextcloud/nextcloud-apps/thunderbird.rst @@ -13,7 +13,7 @@ Calendar & Contacts Syncing You can set up your devices using their :ref:`integrations`, but if you wish to use a standalone client for your Calendar and Contacts syncing, we recommend Mozilla's `Thunderbird `_. 1. Install the :ref:`Calendar` and :ref:`Contacts` apps in Nextcloud if they are not currently installed. -2. Add your :ref:`RootCA` to your system and then configure :ref:`Thunderbird`. +2. Add your :ref:`RootCA` to your system and then configure :ref:`Thunderbird`. 3. Select Calendar or Contacts from below to complete each unique setup: diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-setup/index.rst b/site/source/service-guides/nextcloud/nextcloud-setup/index.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-setup/index.rst rename to site/source/service-guides/nextcloud/nextcloud-setup/index.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst b/site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst rename to site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-android.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst b/site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst rename to site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-ios.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst b/site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst rename to site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-linux.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst b/site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst rename to site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-mac.rst diff --git a/site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst b/site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst similarity index 100% rename from site/source/guides/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst rename to site/source/service-guides/nextcloud/nextcloud-setup/nextcloud-windows.rst diff --git a/site/source/guides/service-guides/specter/index.rst b/site/source/service-guides/specter/index.rst similarity index 100% rename from site/source/guides/service-guides/specter/index.rst rename to site/source/service-guides/specter/index.rst diff --git a/site/source/guides/service-guides/specter/specter-service.rst b/site/source/service-guides/specter/specter-service.rst similarity index 100% rename from site/source/guides/service-guides/specter/specter-service.rst rename to site/source/service-guides/specter/specter-service.rst diff --git a/site/source/guides/service-guides/vaultwarden/bitwarden-client-setup.rst b/site/source/service-guides/vaultwarden/bitwarden-client-setup.rst similarity index 98% rename from site/source/guides/service-guides/vaultwarden/bitwarden-client-setup.rst rename to site/source/service-guides/vaultwarden/bitwarden-client-setup.rst index d80c28c..9021e41 100644 --- a/site/source/guides/service-guides/vaultwarden/bitwarden-client-setup.rst +++ b/site/source/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/guides/service-guides/vaultwarden/bitwarden-walkthrough.rst b/site/source/service-guides/vaultwarden/bitwarden-walkthrough.rst similarity index 100% rename from site/source/guides/service-guides/vaultwarden/bitwarden-walkthrough.rst rename to site/source/service-guides/vaultwarden/bitwarden-walkthrough.rst diff --git a/site/source/guides/service-guides/vaultwarden/index.rst b/site/source/service-guides/vaultwarden/index.rst similarity index 100% rename from site/source/guides/service-guides/vaultwarden/index.rst rename to site/source/service-guides/vaultwarden/index.rst diff --git a/site/source/guides/service-guides/vaultwarden/vaultwarden-organizations.rst b/site/source/service-guides/vaultwarden/vaultwarden-organizations.rst similarity index 100% rename from site/source/guides/service-guides/vaultwarden/vaultwarden-organizations.rst rename to site/source/service-guides/vaultwarden/vaultwarden-organizations.rst diff --git a/site/source/support/common-issues.rst b/site/source/support/common-issues.rst index 4a34d33..fdb2c9d 100644 --- a/site/source/support/common-issues.rst +++ b/site/source/support/common-issues.rst @@ -23,7 +23,7 @@ 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. +* Confirm the the server emitted two sounds when powering on: a bep and a chime. * Confirm your phone is **not** connected to a “Guest” network @@ -38,13 +38,13 @@ Make sure you have successfully followed the :ref:`LAN Setup` in I am unable to reach my server via its xxxxxxxxxxxxxxxxxx.onion (Tor) address -------------------------------------------------------------------------------- -#. **Test** - Try connecting to your server using the preferred :ref:`Tor Browser `. +#. **Test** - Try connecting to your server using the official Tor Browser. #. **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 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. @@ -78,7 +78,7 @@ This means your server was unable to sync its clock with the Internet using the 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. +If a Service is crashing or acting up in some way, check the :ref:`Documentation` 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: diff --git a/site/source/support/concepts/bitcoin-lightning.rst b/site/source/support/concepts/bitcoin-lightning.rst deleted file mode 100644 index 9f435d0..0000000 --- a/site/source/support/concepts/bitcoin-lightning.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. _bitcoin-lightning: - -===================== -Bitcoin and Lightning -===================== - -.. contents:: - :depth: 2 - :local: - -.. _bitcoin: - -Bitcoin -------- -Bitcoin is a revolutionary piece of software that allows users to exchange value all over the world, without the permission of a third party. Entire web sites, books, podcasts, and other resources exist on Bitcoin. A fantastic compilation of resources can be found `here `_. - -.. _bitcoin-node: - -Bitcoin Node ------------- -StartOS can optionally run a Bitcoin node. When most people say "Bitcoin node" what they mean is a "validating node", meaning that the node is capable of enforcing the consensus rules of Bitcoin by accepting, validating, and relaying every transaction and block produced by the network. Fully validating nodes are necessary for Bitcoin to exist and function properly. They protect the network from attackers attempting to bypass the consensus rules. When you run a Bitcoin node, you are "being your own bank." - -Here is a video explaining the importance of `running a node `_. - -.. _btc-wallets: - -Bitcoin Wallets ---------------- -The word "wallet" has come to mean a lot of things in Bitcoin world, depending on who you ask and what software you are using. There are (1) software "wallets", (2) hardware "wallets", (3) seed "wallets", and (4) branch "wallets". - -(1) SOFTWARE WALLETS - (such as FullyNoded and Specter) Software applications capable of interfacing with hardware wallets (see below), interfacing with one or more nodes, as well as address creation, transaction creation, transaction broadcasting, and transaction display. Most software wallets are also capable of creating and storing public/private keypairs, granting them properties of both hardware wallets (see below) and seed wallets (see below). When we say "wallet", we are referring to software applications that possess a user interface for interacting with the Bitcoin network. If a wallet is capable of creating, storing and using private keys, it should be referred to as just a wallet with signer ability. - -(2) HARDWARE WALLETS - (such as ColdCard and Trezor) Physical devices that create and store public/private keypairs, exporting the public keys, NEVER exporting the private keys, and using the private keys to sign transactions on demand. Hardware wallets must interface with a software wallet in order to be useful to a user. For this reason, some have proposed renaming hardware wallets to "hardware signers" for clarity. - -(3) SEED WALLETS - Basically just the root of a hierarchical deterministic tree of keypairs. It usually takes the form of a mnemonic phrase of 12 or 24 words. Why people refer to their mnemonic seed as a "wallet" is confusing. Just call it a seed. - -(4) BRANCH WALLETS - This is how Specter uses the word wallet, and it is causing a lot of confusion. Whenever you create a new "wallet" in specter, you are actually creating a new hierarchical deterministic branch of your mnemonic seed - or in the case of multisig, multiple seeds. The branch you create can be based on "purpose" (segwit, non-segwit, single-sig, multi-sig, etc), "coin type" (Bitcoin, Dogecoin, etc), or "account" (for personal accounting). Change any of these parameters, and you have yourself a new wallet, which again is just a different branch of the same mnemonic seed that potentially abides by a different set of rules. Perhaps a better name for this concept is "bank". Instead of "wallets", you should be able to create different "banks" from your seed. - -.. _lightning-network: - -Lightning Network ------------------ -The Lightning Network is a "payment layer" that sits on top of the Bitcoin blockchain, which it uses for final settlement. This allows Bitcoin to scale without affecting the security of the protocol layer. It is easiest to think of Lightning Network as a system that allows anyone to use their Bitcoin to have a running tab (think bar tab) of money they owe each other. For example, 2 friends may have a "channel" (tab) between them that they use for exchanging value. The channel keeps track of who owes what. Those payments can be settled at any time on the Bitcoin blockchain if either or both parties decide to close out. One big incentive to use Lightning is that payments are extremely fast and fees are extremely low. Check out this `introductory video explanation `_. - -`Learn more about Lightning `_. diff --git a/site/source/support/concepts/index.rst b/site/source/support/concepts/index.rst deleted file mode 100644 index 6888c07..0000000 --- a/site/source/support/concepts/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _concepts: - -======== -Concepts -======== - -An overview of the ideas and technologies surrounding Start9 and StartOS. - -`Start9 `_ and our :ref:`products` (powered by :ref:`StartOS`) "stand on the shoulders of giants." Over the past several decades, technologies have been developed by individuals and companies without which these ground-breaking devices could not exist. Below you will find some select ideas and software which will help you understand what StartOS is and how it works. - -.. toctree:: - :maxdepth: 2 - - open-source - networks - self-hosting - start9-startos - bitcoin-lightning diff --git a/site/source/support/concepts/networks.rst b/site/source/support/concepts/networks.rst deleted file mode 100644 index cee2cfe..0000000 --- a/site/source/support/concepts/networks.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. _networks: - -======== -Networks -======== - -.. contents:: - :depth: 2 - :local: - -.. _lan: - -LAN ---- -A Local Area Network (LAN) is a computer network that interconnects computers within a limited area such as a residence, school, laboratory, university campus, or office building. - -Devices on a LAN are private and protected, such that only devices connected to the same Ethernet or WiFi network can see or communicate with them. - -You can reach your StartOS dashboard by visiting ``start.local`` for initial setup, and ``.local`` after setup from any browser while also connected to the LAN. - -.. note:: Any device connected to a LAN can inspect all communications on that LAN. To avoid snooping, LAN communications are encrypted using :ref:`ssl`, which requires :ref:`additional setup `. - -.. _lan-cert: - -LAN Certificate ---------------- -When you visit an SSL website (one with the ``https://`` prefix), the connection is secured using SSL/TLS encryption. The website will present your browser with an SSL certificate showing that the owner of the website has been authenticated by a recognized Certificate Authority (CA). In the case of StartOS, **you** are the CA, and **you** sign your own certificate. No third party required! - -Your certificate is created when you initially setup StartOS, or migrate to a new version of the OS, such as 0.3.0. - -.. _mdns: - -MDNS ----- -Multicast Domain Name System (MDNS) is a protocol that resolves a human-readable hostname to an IP address on a small network, such as the home or office network where you host your Start9 server. - -This is known as a "zeroconf," or zero-configuration service, meaning that you can instantly visit a human-recognizable domain name, such as ``start.local`` from your network. - -This domain is not broadcast outside of your local network, so it is as private and secure as your LAN. - -.. _ssl: - -SSL ---- -Remote connections to your server (when you are on the go) are handled via :ref:`tor`. Visiting websites on the Tor network can be slow and cumbersome. We wanted to provide a better user experience when accessing your server at home. That's why we created an address for StartOS that can be accessed on your Local Area Network (:ref:`LAN`). - -By default, this ``.local`` address is served like a regular website, over HTTP. Browsers make it noticeable when visiting a site over HTTP in the URL bar - it could be red, show an unlocked lock, or warn that the connection is not secure. - -SSL certificates are what enable websites to move from HTTP to HTTPS, which increases security and makes browsers happy (a happy 'green lock' icon, instead of an angry 'red unlocked' one in the URL bar). Using the Transport Layer Security protocol (TLS, aka SSL), HTTPS-enabled websites use certificates to establish authenticated and encrypted links between networked computers. This is the standard technology for keeping an internet connection secure and safeguarding any sensitive data that is being sent between two devices, preventing third parties from reading and modifying any personal information transferred. These certificates also verify ownership of a website. - -Valid SSL certificates are typically issued and obtained from Certificate Authorities. These trusted third parties generate and distribute certificates, signing them with their trusted private key, which allows the clients who use them to verify their authenticity. Websites obtain a certificate from a CA then load it onto their website's hosting service or server, allowing the website to load over HTTPS and have all traffic to and from the website be encrypted and secure. - -We decided to have StartOS act as a Certificate Authority (CA). It signs all of your server's certificates, which means that the private key used to sign each digital certificate is your server's own private key instead of a third party's. - -When you setup SSL for StartOS and a client device, the certificate communicates to the client (a browser) that the server demonstrated ownership of the domain (``.local``) to the certificate authority at the time of certificate issuance (during the setup process). The StartOS dashboard can then be accessed from a home network (LAN) using a secure HTTPS connection! You own this entire stack and no third party can interfere. - -For more information on how to setup your devices to enable this feature visit :ref:`connecting-lan`. - - -.. _tor: - -Tor ---- -The Onion Router, or Tor, is a free and open source software that enables anonymous communication. By routing Internet traffic through a worldwide, volunteer overlay network of nodes, requests are bundled in layers of encryption like the layers of an onion. The request is relayed across nodes, decrypting a layer only to reveal the next relay destination, until the request meets its final destination, without revealing the source IP address. - -If a malicious third party were to intercept a request, they would see a garbled mess of the remaining onion encryption, and would only know that it came from some onion node and was heading to some other onion node. The contents, source, and destination of the message are completely anonymous. - -When you use Tor to communicate with services running on StartOS, all of the traffic is onion-routed and encrypted, and there are no Tor exit nodes involved - it's completely private with no configuration needed. - -Furthermore, every service on StartOS has a different Tor address, including the device itself. This is done for privacy purposes - should one Tor address be exposed, the others will not be compromised. In actuality, Tor addresses are ed25519 keys, which means they also provide all the benefits of cryptographically secure private/public keys. - -Here's an introductory video on `Tor `__. - -.. youtube:: 6czcc1gZ7Ak - :width: 100% - -.. _tor-browser: - -Tor Browser ------------ -The Tor Browser is a version of Firefox specifically made for use with the Tor Network. Tor Browser has Tor built-in, so that you do not need to be running Tor natively in order to use the network. This makes it a great browser for use with your server. - -.. caution:: Tor Browser has some advanced security and privacy settings, which can be useful, but please keep in mind that if you raise them from the standard level, you may be unable to use some websites, such as your StartOS dashboard. - -.. _hidden-service: - -Tor Hidden Service ------------------- -A Tor Hidden Service is essentially just software or a website that is only broadcast on the Tor network. These are identified by a long, random public key, and end with the ``.onion`` suffix. - -For example, you can visit http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion to view the Start9 homepage on Tor. - -In order to reach a Tor Hidden Service, you must use a browser that can handle ``.onion`` domains, such as `The Tor Browser `_ or by configuring :ref:`Firefox `. diff --git a/site/source/support/concepts/open-source.rst b/site/source/support/concepts/open-source.rst deleted file mode 100644 index 6edfb26..0000000 --- a/site/source/support/concepts/open-source.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. _open-source: - -=========== -Open Source -=========== - -.. contents:: - :depth: 2 - :local: - -The Internet was built on free and publicly available code, with the values of collaboration, peer review, communication, and openness built into its very foundation. This decentralized model has since evolved into the open source movement, which leverages these values to discover innovative ways to solve problems across boundaries and industries. - -Open source software centers around the concept of user freedoms: freedom to view, use, modify, and redistribute the code to suit the needs of the user. While this does not necessarily mean free to use, it generally leads to software that is be better, cheaper, and more flexible on account of it being freely accessible, openly modifiable, and easily shared. - -If anyone can inspect, modify, and distribute the code, bugs tend to be more rapidly identified and resolved, while security vulnerabilities are also more quickly audited and exposed. Community driven development efforts enable diverse collaboration which increases project reliability and longevity. - -On the opposite end of the spectrum from open source software is proprietary, or closed source, software. Closed source software is strictly moderated, cannot legally be altered, copied, or distributed, and is paid for to be used as intended without modification. Only the owners of the code have the right to access the code. - -As a company founded on the principles of freedom, openness, and decentralization, every service we support is open source. We are committed to acitively contributing to the future of this vibrant and passionate ecosystem. - -Open Source ideas explained in `Lego `_. - - .. youtube:: a8fHgx9mE5U - :width: 100% - -Dependencies ------------- -A software dependency is a code library or package that is reused in a new piece of software. The benefit of software dependencies is that they allow developers to more quickly deliver software by building on previous work. Software may even require its dependency to be configured in a particular way. - -Traditionally, managing dependencies has been a massive headache and has served as a huge barrier to running a personal server. But no more! The StartOS dependency management system makes the process simple and accesible. - -If a service has one or more dependencies, or a dependency needs to be configured in a particular way, StartOS will inform you and provide an automated solution, giving details of what will be done so you can make an informed decision before taking action. - -Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. This does not necessarily mean you need to have Bitcoin installed on StartOS. You could just as easily configure Lightning to use another Bitcoin node located somewhere else! diff --git a/site/source/support/concepts/self-hosting.rst b/site/source/support/concepts/self-hosting.rst deleted file mode 100644 index 1f2a12d..0000000 --- a/site/source/support/concepts/self-hosting.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _self-hosting: - -======= -Hosting -======= - -.. contents:: - :depth: 2 - :local: - -The Client-Server Model ------------------------ - -The Internet currently works on an idea known as the "client-server model." This basically means that a server, which is just a computer, "serves" (hence the name) software and data from which clients (also computers, often including phones these days), can request access to. This is also known as "hosting." Servers are often referred to as "The Cloud." The Cloud is literally just **someone else's computer.** A model of this can be seen below: - - .. figure:: /_static/images/concepts/client-server.png - :width: 30% - :alt: Client-Server Model - -We can quickly realize the problem with a model like this. The server has **ALL** the power. The client is completely dependent on the server for any data it stores there, or any server-side software it uses. This may mean your pictures (Google Photos, iCloud), your files/documents (Dropbox, Google Drive, OneDrive), your social media (Facebook, Instagram, Twitter), and even your ability to do basic communication (Messenger, Signal, Telegram, WhatsApp). - -"Self-Hosting" --------------- - -Since a server is "just a computer," one might ask why we can't just host our own data and software. Unfortunately, running a server is no trivial task, and typically requires Linux and systems administration skills. That is, until now. StartOS was designed specifically to allow anyone to be able to run their own server-side software and host their own data, with no special tech skills or excessive effort. - -For an overview, please check out the video below: - -.. youtube:: dc741XwqlyU - :width: 100% diff --git a/site/source/support/concepts/start9-startos.rst b/site/source/support/concepts/start9-startos.rst deleted file mode 100644 index 95e76d5..0000000 --- a/site/source/support/concepts/start9-startos.rst +++ /dev/null @@ -1,127 +0,0 @@ -.. _start9-concepts: - -======================= -Start9 Server & StartOS -======================= - -.. contents:: - :depth: 2 - :local: - -.. _server: - -Server Lite ------------ -Server Lite is a plug 'n' play hardware device, based on the `Raspberry Pi `_, assembled in-house by Start9. The current iteration features an SD card, speaker, and passive cooling. The Server Lite comes pre-loaded with :ref:`StartOS`. For more details, check out the `Server Lite tech specs `_. - -Server One ----------- -Server One is a plug 'n' play hardware device, based on the `Intel NUC `_, assembled in-house by Start9. The current iteration features an internal SSD, speaker, active cooling, and power management in a custom AIO (all-in-one) case. The Server One comes pre-loaded with :ref:`StartOS`. For more details, check out the `Server One tech specs `_. - -Server Pure ------------ -Server Pure is a plug 'n' play hardware device, based on the `Librem Mini `_, built by `Purism `_. Pure features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. The Server Pure comes pre-loaded with :ref:`StartOS`. For more details, check out the `Server Pure tech specs `_. - -.. _start-os: - -StartOS -------- -StartOS is a Linux-based operating system built to simplify open source software hosting. It has a range of features that allow anyone to run their own server software without needing all of the traditionally required systems administration skills. Features such as advanced dependency management, sensible default configuration with potential for customization, and a sleek GUI make for a smooth user experience with minimal reliance on the developers for people with all levels of technical expertise. - -Start9 currently supports the Raspberry Pi, and most x86_64 and ARM hardware architectures. Our wonderful community is constantly adding to the list of `known good hardware `_ and we hope to add official support for more platforms soon! Drop in our `community channels `_ to learn more and collaborate!! - -.. _sounds: - -Server Sounds -------------- -On some models (Server Lite, 2022 Server One, and Server Pure), StartOS emits sounds for user feedback and troubleshooting. Below is the current library of potential sounds and their prospective meaning: - - .. raw:: HTML - - - - * "bep" - StartOS is starting up - - .. raw:: HTML - - - - * "chime" - StartOS is ready - - .. raw:: HTML - - - - * "shutdown" - StartOS is shutting down - - .. raw:: HTML - - - - * "Beethoven" - An error has occurred. Check your "Notifications" tab for more info, or `Contact Support `_ - -.. _services-eos: - -Services --------- -The server-side software available on StartOS are referred to as "Services." It's important to distinguish the difference between *services* and *applications*. Applications are generally *client-side*. This means that they are either standalone software, or they reach out to a server in order to operate. Services are *server-side*. These generally run 24/7, waiting for commands from a user via an application. - -.. _sessions: - -Sessions --------- -A session is simply a logged-in connection to the StartOS dashboard. You can view your :ref:`Active Sessions`, and kill one if you suspect it is not legitimate, or no longer use it. - -.. _service-container: - -Service Container ------------------ -Each service is compartmentalized into its own "container." At this time, this normally means a `Docker `_ container, however StartOS is modular and other options will be available soon. There are several reasons for doing this, including security, ease of use, and maintenance. - -.. _service-dependencies: - -Dependencies ------------- -A software dependency is a code library or package that is reused in a new piece of software. The benefit of software dependencies is that they allow developers to more quickly deliver software by building on previous work. Software may even require its dependency to be configured in a particular way. - -Traditionally, managing dependencies has been a massive headache and has served as a huge barrier to running a personal server. But no more! The StartOS dependency management system makes the process transparent and simple. - -If a service has one or more dependencies, or a dependency needs to be configured in a particular way, StartOS will inform you and provide an automated solution, giving details of what will be done so you can make an informed decision before taking action. - -Sometimes, a dependency can be satisfied in multiple ways. For example, Lightning has a dependency on Bitcoin. However, this does not necessarily mean you need to have Bitcoin installed on StartOS. You could just as easily configure Lightning to use another Bitcoin node located somewhere else! - -.. _web-ui: - -Web User Interface (UI) ------------------------ -A User Interface (UI) is the way in which the user interacts with some software. Typically, this is achieved through a graphical interface (GUI). A WebUI is a website that is served specifically for a user to issue commands or view data. A great example of this is StartOS itself, which serves a WebUI for the user to add/remove services, make configurations, etc. This is your main point of contact with StartOS. - -.. _interfaces: - -Service Interfaces ------------------- -In StartOS, each installed service creates its own Tor Hidden Service URL. For some services, such as File Browser, the URL represents a website that can be visited in the browser; for other services, such as Bitcoin, the URL has to be input into a native client wallet such as Fully Noded, Sparrow, or Specter. - -Certain services, such as Bitcoin, actually have multiple interfaces. Bitcoin has an RPC interface, a P2P interface, and could potentially even have a graphical interface, such as a dashboard displaying important node information. Using the same URL for these various interfaces is not only confusing, but it could also potentially pose a security vulnerability. For example, a user may want to share their P2P interface address with someone for peering, but would not want to give out their UI address, which is for private use only. - -As such, StartOS permits services to have multiple interfaces, each receiving its own Tor address and/or LAN address. Users can then view and access all interfaces for a given service inside the "Interfaces" section of the service dashboard. - -.. _health-checks: - -Health Checks -------------- -One of the most critical duties of a sysadmin or devops engineer is to build mechanisms to monitor the health of systems. For example, a simple health check that monitors the availability of an LND node could mean the difference between that node having a poor reputation or a great one. Sometimes, it is not obvious when a service is unhealthy, especially since “health” is a subjective term depending on the subject. For example, is your Bitcoin node “healthy” if it is not fully synced? Is it healthy if the user interface is unreachable but everything else is working properly? - -In StartOS, package developers define what constitutes health and implement health checks according to subjective criteria. These health checks are then displayed to the user in easily digestible messages, complete with icons and colors. Even better, health checks are completely arbitrary and turing complete, meaning they can include anything, including config options and internal or external dependencies! For example, a Lightning wallet package developer could say “this service is only healthy if (1) it is fully synced, (2) Bitcoin is fully synced, (3) LND is fully synced, and (4) if and only if the user has opted for real-time pricing from a third party website, that third party website must be reachable.” Enormous power. diff --git a/site/source/support/index.rst b/site/source/support/index.rst index 2e84ef0..344a170 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -1,61 +1,12 @@ .. _support: -======= -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! +======== +Get Help +======== -.. raw:: html - -
- -
- -.. topic-box:: - :title: Common Issues - :link: common-issues - :icon: scylla-icon scylla-icon--knowledge-base - :class: large-5 - :anchor: View - - Explore common issues and their solutions - -.. topic-box:: - :title: FAQ - :link: https://start9.com/faq - :icon: scylla-icon scylla-icon--monitoring - :class: large-5 - :anchor: View - - Answers to Frequently Asked Questions from StartOS users - -.. topic-box:: - :title: External Support - :link: external-support - :icon: scylla-icon scylla-icon--mail-list - :class: large-5 - :anchor: Get help - - 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: 3 - :hidden: + :maxdepth: 1 common-issues - concepts/index external-support + Contact diff --git a/site/source/user-manual/alt-registries.rst b/site/source/user-manual/alt-registries.rst index 45e7b7e..0cc499d 100644 --- a/site/source/user-manual/alt-registries.rst +++ b/site/source/user-manual/alt-registries.rst @@ -31,6 +31,6 @@ Click "Add custom registry" and enter the URL of your desired Marketplace. You m Hosting a Registry ------------------ -You can run your own basic registry using your Start9 server! On each service's GitHub Releases page, such as `Bitcoin `_ for example, you will find the ``.s9pk`` Asset. You can download this package, upload to a folder on `File Browser `_ or `Nextcloud `_, and then host it over :ref:`Tor` using `Start9 Pages `_! +You can run your own basic registry using your Start9 server! On each service's GitHub Releases page, such as `Bitcoin `_ for example, you will find the ``.s9pk`` Asset. You can download this package, upload to a folder on `File Browser `_ or `Nextcloud `_, and then host it over Tor using `Start9 Pages `_! If you are interested in building and hosting your own full registry that can be accessed in the Start9 Marketplace UI, you can check out the `registry repository `_. \ No newline at end of file diff --git a/site/source/user-manual/backups/index.rst b/site/source/user-manual/backups/index.rst index 7ea3142..55c896f 100644 --- a/site/source/user-manual/backups/index.rst +++ b/site/source/user-manual/backups/index.rst @@ -6,37 +6,8 @@ Backups In addition to the safe-keeping of a good master password, maintaining good backups is the major responsibility required to keep the benefits and freedom that come with self-hosting. -.. raw:: html - -
- -
- -.. topic-box:: - :title: Backup Create - :link: backup-create - :icon: scylla-icon scylla-icon--cloud - :class: large-5 - :anchor: Backup - - Create an encrypted backup of your server data. - -.. topic-box:: - :title: Backup Restore - :link: backup-restore - :icon: scylla-icon scylla-icon--live-test - :class: large-5 - :anchor: Restore - - Restore your server data from a previous backup. - -.. raw:: html - -
- .. toctree:: :maxdepth: 1 - :hidden: backup-create backup-restore diff --git a/site/source/user-manual/change-password.rst b/site/source/user-manual/change-password.rst index 146515e..dfd0031 100644 --- a/site/source/user-manual/change-password.rst +++ b/site/source/user-manual/change-password.rst @@ -4,9 +4,9 @@ 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`. +This guide is for changing your password from the main StartOS 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 +#. Navigate to System > Change Master Password .. figure:: /_static/images/config/password_change_ui-1.png :width: 60% diff --git a/site/source/getting-started/configuring-ff.rst b/site/source/user-manual/configuring-ff.rst similarity index 82% rename from site/source/getting-started/configuring-ff.rst rename to site/source/user-manual/configuring-ff.rst index f78cc27..3a6ece1 100644 --- a/site/source/getting-started/configuring-ff.rst +++ b/site/source/user-manual/configuring-ff.rst @@ -1,4 +1,4 @@ -.. _connecting-ff: +.. _configuring-ff: =================== Configuring Firefox @@ -17,7 +17,7 @@ Select your OS: .. topic-box:: :title: Linux - :link: ../../../../guides/device-guides/linux/ff-linux + :link: ../../../../device-guides/linux/ff-linux :icon: scylla-icon scylla-icon--linux :class: large-4 :anchor: View @@ -26,7 +26,7 @@ Select your OS: .. topic-box:: :title: Mac - :link: ../../../../guides/device-guides/mac/ff-mac + :link: ../../../../device-guides/mac/ff-mac :icon: scylla-icon scylla-icon--apple :class: large-4 :anchor: View @@ -35,7 +35,7 @@ Select your OS: .. topic-box:: :title: Windows - :link: ../../../../guides/device-guides/windows/ff-windows + :link: ../../../../device-guides/windows/ff-windows :icon: scylla-icon scylla-icon--windows :class: large-4 :anchor: View @@ -44,7 +44,7 @@ Select your OS: .. topic-box:: :title: Android - :link: ../../../../guides/device-guides/android/ff-android + :link: ../../../../device-guides/android/ff-android :icon: scylla-icon scylla-icon--android :class: large-4 :anchor: View diff --git a/site/source/getting-started/connecting-lan.rst b/site/source/user-manual/connecting-lan.rst similarity index 100% rename from site/source/getting-started/connecting-lan.rst rename to site/source/user-manual/connecting-lan.rst diff --git a/site/source/getting-started/connecting-tor.rst b/site/source/user-manual/connecting-tor.rst similarity index 67% rename from site/source/getting-started/connecting-tor.rst rename to site/source/user-manual/connecting-tor.rst index fcb209c..d88b50a 100644 --- a/site/source/getting-started/connecting-tor.rst +++ b/site/source/user-manual/connecting-tor.rst @@ -7,8 +7,8 @@ You can connect to your server from anywhere in the world, privately and anonymo .. note:: It is normal for Tor connections to be slow or unreliable at times -Running Tor Natively on Your Phone/Computer (Recommended) ---------------------------------------------------------- +Running Tor on Your Phone/Computer (Recommended) +------------------------------------------------ Select your OS below: @@ -20,7 +20,7 @@ Select your OS below: .. topic-box:: :title: Linux - :link: ../../../../guides/device-guides/linux/tor-linux + :link: ../../../../device-guides/linux/tor-linux :icon: scylla-icon scylla-icon--linux :class: large-4 :anchor: View @@ -29,7 +29,7 @@ Select your OS below: .. topic-box:: :title: Mac - :link: ../../../../guides/device-guides/mac/tor-mac + :link: ../../../../device-guides/mac/tor-mac :icon: scylla-icon scylla-icon--apple :class: large-4 :anchor: View @@ -38,7 +38,7 @@ Select your OS below: .. topic-box:: :title: Windows - :link: ../../../../guides/device-guides/windows/tor-windows + :link: ../../../../device-guides/windows/tor-windows :icon: scylla-icon scylla-icon--windows :class: large-4 :anchor: View @@ -47,7 +47,7 @@ Select your OS below: .. topic-box:: :title: Android - :link: ../../../../guides/device-guides/android/tor-android + :link: ../../../../device-guides/android/tor-android :icon: scylla-icon scylla-icon--android :class: large-4 :anchor: View @@ -56,21 +56,23 @@ Select your OS below: .. topic-box:: :title: iOS - :link: ../../../../guides/device-guides/ios/tor-ios + :link: ../../../../device-guides/ios/tor-ios :icon: scylla-icon scylla-icon--ios :class: large-4 :anchor: View Running Tor on iOS -Using The Tor Browser ---------------------- +Using a Tor Browser +------------------- Using the official Tor Browser allows you to access `.onion` URLs without additional configuration. However, accessing clearnet (`.com`, `.org`, ect) websites will also be routed over Tor, making them slower, and `.local` URLs cannot be accessed at all. -* Linux, Mac, Windows, Android +Linux, Mac, Windows, Android +............................ - * `Tor Browser `_ +`Download Tor Browser `_ -* iOS +iOS +... - * iOS lacks a well-functioning Tor Browser. Instead, we recommend :ref:`using Safari with Orbot`. +iOS lacks a well-functioning Tor Browser. diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 643c30f..5ed7910 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -6,8 +6,13 @@ User Manual .. toctree:: :includehidden: - :maxdepth: 1 + :maxdepth: 2 + initial-setup + trust-ca + configuring-ff + connecting-lan + connecting-tor dashboard-overview change-password managing-services diff --git a/site/source/getting-started/initial-setup.rst b/site/source/user-manual/initial-setup.rst similarity index 100% rename from site/source/getting-started/initial-setup.rst rename to site/source/user-manual/initial-setup.rst diff --git a/site/source/user-manual/managing-services.rst b/site/source/user-manual/managing-services.rst index f59e845..7e3423c 100644 --- a/site/source/user-manual/managing-services.rst +++ b/site/source/user-manual/managing-services.rst @@ -24,9 +24,9 @@ The Service Dashboard provides quick insight into the status and health of your * **Stopped**: Service is installed and configured, but not currently running. * **Starting**: Service is in the process of starting up. * **Running**: Service is running. -* **Launch UI**: If the service offer a User Interface (UI), and the UI is currently available, clicking this button will launch the UI in a new browser tab. Learn more about :ref:`Web UIs`. -* **Health Checks**: This is a critical feature of StartOS. Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, as well as possible actions they may want to take. Learn more about :ref:`Health Checks `. -* **Dependencies**: Some services depend on the presence and proper configuration of other services to function. This section will inform you if all dependencies are satisfied and, if not, what to do about it. Learn more about :ref:`Dependencies `. +* **Launch UI**: If the service offer a User Interface (UI), and the UI is currently available, clicking this button will launch the UI in a new browser tab. +* **Health Checks**: This is a critical feature of StartOS. Health Checks are configured by the service packager in order to quickly convey to the user what is happening with their service, as well as possible actions they may want to take. +* **Dependencies**: Some services depend on the presence and proper configuration of other services to function. This section will inform you if all dependencies are satisfied and, if not, what to do about it. * **Start / Stop**: Self-explanatory, use these buttons to start or stop a service. Installing a Service diff --git a/site/source/user-manual/sessions.rst b/site/source/user-manual/sessions.rst index 26a7d42..683b846 100644 --- a/site/source/user-manual/sessions.rst +++ b/site/source/user-manual/sessions.rst @@ -4,7 +4,7 @@ Session Management ================== -Every time a login is made with StartOS, such as from a web browser on your laptop or mobile device, a :ref:`Session ` is created. +Every time a login is made with StartOS, such as from a web browser on your laptop or mobile device, an authenticated session is created. * To view and manage your active sessions, go to *System > Active Sessions*. diff --git a/site/source/getting-started/trust-ca.rst b/site/source/user-manual/trust-ca.rst similarity index 89% rename from site/source/getting-started/trust-ca.rst rename to site/source/user-manual/trust-ca.rst index 40b2c00..bd8428b 100644 --- a/site/source/getting-started/trust-ca.rst +++ b/site/source/user-manual/trust-ca.rst @@ -66,7 +66,7 @@ Select your operating system: .. topic-box:: :title: Linux - :link: ../../../../guides/device-guides/linux/ca-linux/ + :link: ../../../../device-guides/linux/ca-linux/ :icon: scylla-icon scylla-icon--linux :class: large-4 :anchor: View @@ -75,7 +75,7 @@ Select your operating system: .. topic-box:: :title: Mac - :link: ../../../../guides/device-guides/mac/ca-mac + :link: ../../../../device-guides/mac/ca-mac :icon: scylla-icon scylla-icon--apple :class: large-4 :anchor: View @@ -84,7 +84,7 @@ Select your operating system: .. topic-box:: :title: Windows - :link: ../../../../guides/device-guides/windows/ca-windows + :link: ../../../../device-guides/windows/ca-windows :icon: scylla-icon scylla-icon--windows :class: large-4 :anchor: View @@ -93,7 +93,7 @@ Select your operating system: .. topic-box:: :title: Android - :link: ../../../../guides/device-guides/android/ca-android + :link: ../../../../device-guides/android/ca-android :icon: scylla-icon scylla-icon--android :class: large-4 :anchor: View @@ -102,7 +102,7 @@ Select your operating system: .. topic-box:: :title: iOS - :link: ../../../../guides/device-guides/ios/ca-ios + :link: ../../../../device-guides/ios/ca-ios :icon: scylla-icon scylla-icon--ios :class: large-4 :anchor: View