mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 12:11:57 +00:00
change embassyOS to StartOS & nuance (#357)
* change embassyOS to StartOS & nuance * Update conf.py * Update manifest.rst * say start9 instead of embassy in two links * progress * scrubbed faqs - basic-use, lightning, service-packaging, services, startos * add a few fixes * more * more 'embassy' cleanup * more * the last of embassy (aside from sdk and cli commands, links, etc) * some fixes * update icon, logo, and theme * Update site/source/user-manual/upgrade-hardware/upgrade-pro.rst * Update site/source/developer-docs/packaging.rst * Update site/source/developer-docs/specification/config-spec.rst * Update site/source/learn/concepts/networks.rst * Update site/source/learn/concepts/networks.rst * Update site/source/user-manual/customize.rst * Update site/source/support/faq/faq-basic-use.rst * Update site/source/user-manual/upgrade-hardware/naspi-upgrade.rst * Update site/source/user-manual/upgrade-hardware/upgrade-pro.rst * Update site/source/support/faq/faq-bitcoin.rst * Update site/source/support/faq/faq-bitcoin.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-services.rst * Update site/source/support/faq/faq-general.rst * Update site/source/support/faq/faq-startos.rst * Update site/source/support/faq/faq-troubleshooting.rst * Update site/source/support/faq/faq-startos.rst * Minor fixes * Fix build errors, ready to roll * Add Beethoven * More fixes * More nother fix * More nother fixes agin * Remove sentence * cards instead --------- Co-authored-by: Matt Hill <matthewonthemoon@gmail.com> Co-authored-by: Shadowy Super Coder <musashidisciple@proton.me> Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Co-authored-by: kn0wmad <39687477+kn0wmad@users.noreply.github.com> Co-authored-by: agent <kn0wmad@protonmail.com>
This commit is contained in:
BitcoinMechanic
@@ -4,14 +4,14 @@
|
||||
Connecting Over LAN
|
||||
===================
|
||||
|
||||
Whenever you are connected the same Local Area Network (LAN) as your Embassy (i.e. the same WiFi network), it is best to access your Embassy's LAN Address (.local URL). LAN connections are fast and secure and do not even require Internet access!
|
||||
Whenever you are connected the same Local Area Network (LAN) as your Start9 server (i.e. the same WiFi network), it is best to access your Start9 server's LAN Address (.local URL). LAN connections are fast and secure and do not even require Internet access!
|
||||
|
||||
.. note:: Your Embassy creates its own Certificate Authority (CA) to establish trust with client devices.
|
||||
.. note:: StartOS creates its own Certificate Authority (CA) to establish trust with client devices.
|
||||
|
||||
Download Root CA
|
||||
----------------
|
||||
|
||||
First, download your Embassy's Root CA. There are two way to accomplish this:
|
||||
First, download your Start9 server's Root CA. There are two way to accomplish this:
|
||||
|
||||
Option 1
|
||||
........
|
||||
@@ -23,21 +23,21 @@ Option 2
|
||||
|
||||
Navigate to *System > LAN*, then click "Download Certificate".
|
||||
|
||||
.. figure:: /_static/images/ssl/embassy_lan_setup.png
|
||||
.. figure:: /_static/images/ssl/lan_setup.png
|
||||
:width: 60%
|
||||
:alt: LAN setup menu item
|
||||
|
||||
Trust Root CA
|
||||
-------------
|
||||
|
||||
First, instruct your **operating system** to trust your Embassy's Root CA.
|
||||
First, instruct your **operating system** to trust your Start9 server's Root CA.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-os/index
|
||||
|
||||
Then instruct your **browser** to trust your Embassy's Root CA.
|
||||
Then instruct your **browser** to trust your Start9 server's Root CA.
|
||||
|
||||
.. note:: On a Mac - this is only necessary on Firefox. Brave, Chrome and Safari will already work.
|
||||
|
||||
@@ -46,14 +46,14 @@ Then instruct your **browser** to trust your Embassy's Root CA.
|
||||
|
||||
lan-browser/index
|
||||
|
||||
**OPTIONAL**: Setup client integrations for Embassy Services (such as Nextcloud).
|
||||
**OPTIONAL**: Setup client integrations for StartOS Services (such as Nextcloud).
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lan-integrations/index
|
||||
|
||||
Access your Embassy LAN Address
|
||||
-------------------------------
|
||||
Access your Start9 server's LAN Address
|
||||
---------------------------------------
|
||||
|
||||
With the Root CA downloaded and trusted by both your operating system and your browser, you can now visit your Embassy's LAN Address (.local URL) over secure https. Any service that offers a LAN URL will also be securely accessible!
|
||||
With the Root CA downloaded and trusted by both your operating system and your browser, you can now visit your Start9 server's LAN Address (.local URL) over secure https. Any service that offers a LAN URL will also be securely accessible!
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
Trust CA - Browser
|
||||
==================
|
||||
|
||||
Instruct your **browser** to trust your Embassy's Root CA.
|
||||
Instruct your **browser** to trust your Start9 server's Root CA.
|
||||
|
||||
On Mac, you only need to instruct Firefox to trust your Embassy's Root CA. The other three browsers listed below will work already.
|
||||
On Mac, you only need to instruct Firefox to trust your Start9 server's Root CA. The other three browsers listed below will work already.
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-chrome-brave:
|
||||
|
||||
==========================================
|
||||
Trust Embassy CA in Chrome / Brave Browser
|
||||
==========================================
|
||||
=================================================
|
||||
Trusting Your Start9 CA in Chrome / Brave Browser
|
||||
=================================================
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing.
|
||||
|
||||
@@ -36,13 +36,13 @@ Trust Embassy CA in Chrome / Brave Browser
|
||||
:width: 60%
|
||||
:alt: Certificate Authorities
|
||||
|
||||
#. If you see "org-Start9" with a trusted “Embassy Local Root CA” listed under it, your work is already done. Open a new tab and visit your Embassy's address. The browser shouldn't give any warning pages about the certificate anymore. If it still does, quit and restart the browser using `Menu > Exit`.
|
||||
#. If you see "org-Start9" with a trusted “<custom-address> Local Root CA” listed under it, your work is already done. Open a new tab and visit your Start9 server's ``.local`` address. The browser shouldn't give any warning pages about the certificate anymore. If it still does, quit and restart the browser using `Menu > Exit`.
|
||||
|
||||
#. If you do not see "org-Start9" in the list, click "Import" and open the downloaded "Embassy Local Root CA.crt" file on your device.
|
||||
#. If you do not see "org-Start9" in the list, click "Import" and open the downloaded "<custom-address> Local Root CA.crt" file on your device.
|
||||
|
||||
.. figure:: /_static/images/ssl/browser/chrome_authorities.png
|
||||
:width: 60%
|
||||
:alt: Chrome / Brave Import "Embassy Local Root CA.crt"
|
||||
:alt: Chrome / Brave Import "<custom-address>.crt"
|
||||
|
||||
#. Check the box for "Trust this certificate for identifying websites" and click "OK".
|
||||
|
||||
@@ -89,7 +89,7 @@ Trust Embassy CA in Chrome / Brave Browser
|
||||
:width: 40%
|
||||
:alt: Windows Certificates CA Cert Import Step 3
|
||||
|
||||
#. Navigate to the location of and select your previously dowloaded `Embassy Local CA.crt` file, and click `Open`
|
||||
#. Navigate to the location of and select your previously downloaded `<custom-address>.crt` file, and click `Open`
|
||||
|
||||
.. figure:: /_static/images/ssl/windows/windows_certificates_caimport_step4.jpg
|
||||
:width: 40%
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-ff:
|
||||
|
||||
==============================
|
||||
Trusting Embassy CA in Firefox
|
||||
==============================
|
||||
==================================
|
||||
Trusting Your Start9 CA in Firefox
|
||||
==================================
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.. _lan-safari:
|
||||
|
||||
=============================
|
||||
Trusting Embassy CA In Safari
|
||||
=============================
|
||||
=================================
|
||||
Trusting Your Start9 CA In Safari
|
||||
=================================
|
||||
|
||||
Once you have completed the :ref:`lan-os` steps on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now securely navigate to the LAN address for your Embassy!
|
||||
Once you have completed the :ref:`lan-os` steps on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now securely navigate to the LAN address for your Start9 server!
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Trust CA - Integrations
|
||||
=======================
|
||||
|
||||
Instruct your end-user **application** to trust your Embassy's Root CA.
|
||||
Instruct your end-user **application** to trust your Start9 server's Root CA.
|
||||
|
||||
Certain services (such as NextCloud) offer file sync, calendar/contacts sync, or other connectivity you may want to use via a desktop or mobile application. Select from the list below for supported applications.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-thunderbird:
|
||||
|
||||
==================================
|
||||
Trusting Embassy CA in Thunderbird
|
||||
==================================
|
||||
======================================
|
||||
Trusting Your Start9 CA in Thunderbird
|
||||
======================================
|
||||
|
||||
.. caution:: You will first need to complete :ref:`lan-os` for your device before continuing. Take special note of the Thunderbird-specific instructions there.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Trust CA - OS
|
||||
=============
|
||||
|
||||
Instruct your **operating system** to trust your Embassy's Root CA.
|
||||
Instruct your **operating system** to trust your Start9 server's Root CA.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-android:
|
||||
|
||||
==============================
|
||||
Trusting Embassy CA on Android
|
||||
==============================
|
||||
==================================
|
||||
Trusting Your Start9 CA on Android
|
||||
==================================
|
||||
|
||||
.. note:: This will work on most Android phones running Android v13+, as well as phones running CalyxOS, GrapheneOS or LineageOS (v19+).
|
||||
|
||||
@@ -10,7 +10,7 @@ Trusting Embassy CA on Android
|
||||
|
||||
.. group-tab:: Android v13+
|
||||
|
||||
Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your "Embassy Local Root CA" certificate.
|
||||
Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your "<custom-address> Local Root CA" certificate.
|
||||
|
||||
.. figure:: /_static/images/ssl/android/droidLAN2.png
|
||||
:width: 30%
|
||||
@@ -20,7 +20,7 @@ Trusting Embassy CA on Android
|
||||
|
||||
.. tip:: Some phones running Android v12 will work, others won't. It depends on the vendor. Most Androids running v12 that we have tested do work with the exception of the Samsung Galaxy S10 which does not.
|
||||
|
||||
Tap **Settings > Security > Advanced > Encryption and Credentials > Install from Storage** and select your "Embassy Local Root CA" certificate.
|
||||
Tap **Settings > Security > Advanced > Encryption and Credentials > Install from Storage** and select your "<custom-address> Local Root CA" certificate.
|
||||
|
||||
.. figure:: /_static/images/ssl/android/droidLAN0.png
|
||||
:width: 30%
|
||||
|
||||
@@ -68,7 +68,7 @@ This applies to iOS v15 and v16. For older versions, see the `v14 guide </0.3.1
|
||||
:width: 20%
|
||||
:alt: Certificate trust settings
|
||||
|
||||
#. Under "Enable full trust for root certificates", enable your "adjective-noun Local Root CA".
|
||||
#. Under "Enable full trust for root certificates", enable your "<custom-address> Local Root CA".
|
||||
|
||||
.. figure:: /_static/images/ssl/ios/trust_2.png
|
||||
:width: 20%
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
.. _lan-linux-system:
|
||||
|
||||
============================
|
||||
Trusting Embassy CA on Linux
|
||||
============================
|
||||
================================
|
||||
Trusting Your Start9 CA on Linux
|
||||
================================
|
||||
|
||||
Here we will insert your Embassy's CA certificate into Linux's trust store to ensure that applications will trust your Embassy's services.
|
||||
Here we will insert your Start9 server's CA certificate into Linux's trust store to ensure that applications will trust your Start9 server's services.
|
||||
|
||||
.. tabs::
|
||||
|
||||
@@ -20,7 +20,7 @@ Here we will insert your Embassy's CA certificate into Linux's trust store to en
|
||||
|
||||
sudo apt install -y ca-certificates p11-kit
|
||||
|
||||
.. note:: For each Mozilla-based application you plan on using, in order for them to trust your Embassy's CA certificate directly from your Linux distribution's certificate trust store, execute the following command(s):
|
||||
.. note:: For each Mozilla-based application you plan on using, in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store, execute the following command(s):
|
||||
|
||||
|
||||
If you use Firefox:
|
||||
@@ -53,34 +53,34 @@ Here we will insert your Embassy's CA certificate into Linux's trust store to en
|
||||
|
||||
mv ~/.pki ~/.pki.mozilla-old
|
||||
|
||||
Finally, we will change directory to the folder where you downloaded your Embassy's Root CA (usually `~/Downloads`), and run the following commands to add your Embassy's CA certificate to the OS trust store:
|
||||
Finally, we will change directory to the folder where you downloaded your Start9 server's Root CA (usually `~/Downloads`), and run the following commands to add your Start9 server's CA certificate to the OS trust store:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cd ~/Downloads
|
||||
sudo cp "Embassy Local CA.crt" /usr/local/share/ca-certificates/
|
||||
sudo cp "<custom-address>.crt" /usr/local/share/ca-certificates/
|
||||
sudo update-ca-certificates
|
||||
|
||||
In the output it should say ``1 added`` if it was successful.
|
||||
|
||||
.. group-tab:: Arch/Garuda
|
||||
|
||||
From the folder you have downloaded your Embassy's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo pacman -S ca-certificates
|
||||
sudo cp "Embassy Local CA.crt" /etc/ca-certificates/trust-source/anchors/
|
||||
sudo cp "<custom-address>.crt" /etc/ca-certificates/trust-source/anchors/
|
||||
sudo update-ca-trust
|
||||
|
||||
Despite no output from the last command, you can test your app right away.
|
||||
|
||||
.. group-tab:: CentOS/Fedora
|
||||
|
||||
From the folder you have downloaded your Embassy's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo yum install ca-certificates
|
||||
sudo cp "Embassy Local CA.crt" /etc/pki/ca-trust/source/anchors/
|
||||
sudo cp "<custom-address>.crt" /etc/pki/ca-trust/source/anchors/
|
||||
sudo update-ca-trust
|
||||
@@ -1,10 +1,10 @@
|
||||
.. _lan-mac:
|
||||
|
||||
==========================
|
||||
Trusting Embassy CA on Mac
|
||||
==========================
|
||||
==============================
|
||||
Trusting Your Start9 CA on Mac
|
||||
==============================
|
||||
|
||||
#. In your Embassy, head to *System* -> *Lan* -> click *Download Certificate* and save it to your Mac.
|
||||
#. In your Start9 server's UI, navigate to *System* -> *Lan* -> click *Download Certificate* and save it to your Mac.
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/mac-lan-setup0.png
|
||||
:width: 60%
|
||||
@@ -29,7 +29,7 @@ Trusting Embassy CA on Mac
|
||||
|
||||
.. note:: If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it.
|
||||
|
||||
#. Navigate to the "System" tab on the left, find the certificate, which is usually named as your server's unique "adjective-noun.local", and double click on this certificate. A second window will pop up.
|
||||
#. Navigate to the "System" tab on the left, find the certificate named "<custom-address> Local Root CA", and double click on this certificate. A second window will pop up.
|
||||
|
||||
#. Open the "Trust" dropdown and select "Always Trust" from the dropdown next to "When using this certificate".
|
||||
|
||||
@@ -39,12 +39,12 @@ Trusting Embassy CA on Mac
|
||||
|
||||
#. Close this window and enter your password to apply the settings.
|
||||
|
||||
#. The "Embassy Local Root CA" cert will now read "This certificate is marked as trusted for all users" in Keychain Access.
|
||||
#. The "<custom-address> Local Root CA" cert will now read "This certificate is marked as trusted for all users" in Keychain Access.
|
||||
|
||||
.. figure:: /_static/images/ssl/macos/certificate_trusted.png
|
||||
:width: 60%
|
||||
:alt: Keychain menu trusted certificate
|
||||
|
||||
No additional setup is required for most browsers and you will now be able to safely connect to your Embassy over LAN.
|
||||
No additional setup is required for most browsers and you will now be able to safely connect to your Start9 server over LAN.
|
||||
|
||||
For Firefox, you will need to follow :ref:`these <lan-ff>` instructions.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _lan-windows:
|
||||
|
||||
======================
|
||||
Trusting CA On Windows
|
||||
======================
|
||||
==================================
|
||||
Trusting Your Start9 CA On Windows
|
||||
==================================
|
||||
|
||||
Unfortunately, Windows does not have mDNS alias support built-in, which is necessary in order to visit .local addresses for any service you install on your Start9 server, so we recommend using the Bonjour service. Check out this :ref:`FAQ answer<why-bonjour>` for details.
|
||||
|
||||
@@ -86,6 +86,6 @@ Unfortunately, Windows does not have mDNS alias support built-in, which is neces
|
||||
:width: 90%
|
||||
:alt: Successful cert install
|
||||
|
||||
Your server's unique `adjective-noun Local Root CA` is now imported into Certificate folder
|
||||
Your server's unique `<custom-address> Local Root CA` is now imported into Certificate folder
|
||||
|
||||
#. You can save the settings to the console if desired, or not by pressing `Yes` or `No`. The CA certificate will remain imported to the CA certificate store either way.
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
Connecting Over Tor
|
||||
===================
|
||||
|
||||
You can connect to your Embassy from anywhere in the world, privately and anonymously, by using its unique Tor Address (.onion URL).
|
||||
You can connect to your Start9 server from anywhere in the world, privately and anonymously, by using its unique Tor Address (``.onion`` URL).
|
||||
|
||||
.. note:: Tor connection can sometimes be unreliable and have higher latency than normal internet connections.
|
||||
|
||||
Using Firefox
|
||||
-------------
|
||||
|
||||
.. tip:: This is recommended way to connect to your Embassy over Tor, but it requires some additional steps.
|
||||
.. tip:: This is the recommended way to connect to your Start9 server over Tor, but it requires some additional steps.
|
||||
|
||||
#. Run Tor (**not Tor Browser**) in the background on your connecting device.
|
||||
|
||||
@@ -20,7 +20,7 @@ Using Firefox
|
||||
|
||||
tor-os/index
|
||||
|
||||
#. Configure Firefox to handle *.onion* URLs.
|
||||
#. Configure Firefox to handle *``.onion``* URLs.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@@ -31,7 +31,7 @@ Using Firefox
|
||||
Using TorBrowser
|
||||
-------------------
|
||||
|
||||
.. caution:: Tor Browser will allow you to use your Embassy's .onion URL without any manual configuration, however *all* connections are proxied via Tor, so you will not be able to access your Embassy's .local LAN address with it. `Using Firefox <#using-firefox>`_ is recommended over TorBrowser.
|
||||
.. caution:: Tor Browser will allow you to use your Start9 server's ``.onion`` URL without any manual configuration, however *all* connections are proxied via Tor, so you will not be able to access your Start9 server's ``.local`` LAN address with it. `Using Firefox <#using-firefox>`_ is recommended over TorBrowser.
|
||||
|
||||
* Linux, Mac, Windows, Android
|
||||
|
||||
|
||||
@@ -60,4 +60,4 @@ Once Tor is setup on your system, you can proceed to setup Firefox:
|
||||
|
||||
#. Optional but recommended: search for ``network.http.referer.hideOnionsSource`` and set the value to ``true``.
|
||||
|
||||
#. Restart Firefox, and you're all set! You should now be able to navigate to `.onion` URLs in Firefox. This means you can bookmark Cups Messenger, or other Embassy ``.onion`` addresses, as well as use the :ref:`Bitwarden<vaultwarden-service>` browser extension.
|
||||
#. Restart Firefox, and you're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can bookmark Cups Messenger, or other Start9 services' ``.onion`` addresses, as well as use the :ref:`Bitwarden<vaultwarden-service>` browser extension.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Tor - OS
|
||||
========
|
||||
|
||||
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Embassy with remotely.
|
||||
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Start9 server with remotely.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -26,7 +26,7 @@ Connecting
|
||||
:class: large-5
|
||||
:anchor: Setup
|
||||
|
||||
Leverage Tor to connect to your Embassy privately and anonymously from anywhere in the world.
|
||||
Leverage Tor to connect to your Start9 server privately and anonymously from anywhere in the world.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
Reference in New Issue
Block a user