Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-04-04 22:39:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

change embassyOS to StartOS & nuance (#357)

Browse Source 
* 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
2023-05-23 12:58:32 -07:00
committed by GitHub
parent 404182cffa
commit 60f83aa683
130 changed files with 879 additions and 1030 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
site/source/user-manual/connecting/connecting-lan/lan-os/index.rst
View File

@@ -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

10
site/source/user-manual/connecting/connecting-lan/lan-os/lan-android.rst
View File

@@ -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%

2
site/source/user-manual/connecting/connecting-lan/lan-os/lan-ios.rst
View File

@@ -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%

22
site/source/user-manual/connecting/connecting-lan/lan-os/lan-linux.rst
View File

@@ -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

14
site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst
View File

@@ -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.

8
site/source/user-manual/connecting/connecting-lan/lan-os/lan-windows.rst
View File

@@ -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.