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
2023-05-23 12:58:32 -07:00
committed by GitHub
parent 404182cffa
commit 60f83aa683
130 changed files with 879 additions and 1030 deletions

View File

@@ -8,14 +8,14 @@ Backup
:depth: 2
:local:
Backing up your Embassy is easy and secure. Backups are encrypted with your master password.
Backing up your server is easy and secure. Backups are encrypted with your master password.
.. warning:: Create frequent backups to avoid loss of data!
Setup Device
------------
Select your platform for detailed instructions on how to create a Network Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main Embassy SSD.
Select your platform for detailed instructions on how to create a Network Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main server's SSD.
.. toctree::
:maxdepth: 1
@@ -25,7 +25,7 @@ Select your platform for detailed instructions on how to create a Network Folder
Windows Network Folder <backup-setup/backup-windows>
Synology Network Folder <backup-setup/backup-synology>
TrueNAS Network Folder <backup-setup/backup-truenas>
Physical Drive via Embassy <backup-setup/backup-physical>
Physical Drive <backup-setup/backup-physical>
.. _backup-create:
@@ -34,20 +34,20 @@ Create Backup
#. Go to *System > Create Backup*
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
#. You will see your previously created Network Folder backup location (or Physical Drive) available. Click it, then click "Create Backup".
.. figure:: /_static/images/config/embassy_backup2.png
.. figure:: /_static/images/config/backup2.png
:width: 60%
#. You can continue to use your Embassy while the backup is in progress.
#. You can continue to use your server while the backup is in progress.
.. figure:: /_static/images/config/embassy_backup3.png
.. figure:: /_static/images/config/backup3.png
:width: 60%
#. When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the System tab.
.. figure:: /_static/images/config/embassy_backup4.png
.. figure:: /_static/images/config/backup4.png
:width: 60%

View File

@@ -4,14 +4,14 @@
Restore
=======
There are 3 different ways that you may choose to restore Embassy data, as well as a 4th option to migrate data between hardware.
There are 3 different ways that you may choose to recover server data, as well as a 4th option to migrate/transfer data between hardware.
#. "Restore" *selected service data* to your currently running Embassy. This is specifically for service data.
#. "Attach" a drive with existing Embassy data on it during setup. Use this when re-flashing your SD card, for example.
#. "Recover" (as in, disaster recovery) all Embassy data in the event that your backup is the **only** thing you have left.
#. "Transfer" all data from an existing Embassy. This is a total migration for use when upgrading hardware only.
#. "Restore [individual services] from Backup" to your currently running server. This is specifically for service data.
#. "Use Existing Drive" a drive with existing server data on it during setup. Use this when re-flashing your SD card, for example.
#. "Restore [entire server] from Backup" (as in, disaster recovery) all server data in the event that your backup is the **only** thing you have left.
#. "Transfer" data from an existing server. This is a total migration for use when upgrading hardware only.
.. warning:: If you are restoring data from a drive that you are attaching *directly to your Embassy,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Embassy One (NASPi Geekworm case with built-in power management) and Embassy Pro users can safely ignore this warning.
.. warning:: If you are restoring data from a drive that you are attaching *directly to your server,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Server One (NASPi Geekworm case with built-in power management) and Server Pro users can safely ignore this warning.
Select the appropriate tab below to restore your data:
@@ -39,7 +39,7 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/config/restore3.png
:width: 60%
It is not possible to recover services already installed on the Embassy. If you wish to recover a service that is already installed, please uninstall it first to permit recovery.
It is not possible to recover services that are already installed. If you wish to recover a service that is already installed, please uninstall it first to permit recovery.
.. group-tab:: Attach
@@ -53,7 +53,7 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/setup/screen3-use_existing.png
:width: 60%
#. Select your Embassy data drive.
#. Select your server's data drive.
.. figure:: /_static/images/setup/screen4-use_existing_drive_selection.png
:width: 60%
@@ -63,7 +63,7 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60%
#. Your Embassy will initialize again (all previous data will be recovered).
#. Your server will initialize again (all previous data will be recovered).
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
@@ -90,7 +90,7 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/restore/recover2.png
:width: 60%
#. Enter the encryption password for the drive (this is your Embassy's master password).
#. Enter the encryption password for the drive (this is your server's master password).
.. figure:: /_static/images/restore/recover3.png
:width: 60%
@@ -105,7 +105,7 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/restore/recover5.png
:width: 60%
#. Your Embassy will now prepare and then copy the data to the new drive. The time required can vary greatly depending on how much data you are migrating and from where that data is coming. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
#. Your server will now prepare and then copy the data to the new drive. The time required can vary greatly depending on how much data you are migrating and from where that data is coming. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
.. figure:: /_static/images/restore/recover6.png
:width: 60%
@@ -122,19 +122,19 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/transfer/transfer0.png
:width: 60%
#. Plug in the drive (make sure it is powered on) of the Embassy you are migrating **from** and select it (in this example, /dev/sda). You may need to try a different USB port and hit "Refresh" if you don't see it immediately. You will see a warning about using the old drive again; read and understand it.
#. Plug in the drive (make sure it is powered on) of the server you are migrating **from** and select it (in this example, /dev/sda). You may need to try a different USB port and hit "Refresh" if you don't see it immediately. You will see a warning about using the old drive again; read and understand it.
.. figure:: /_static/images/transfer/transfer1.png
:width: 60%
#. Select the drive on your new Embassy (that you are migrating **onto**).
#. Select the drive on your new server (that you are migrating **onto**).
.. figure:: /_static/images/transfer/transfer2.png
:width: 60%
.. warning:: This will **PERMANENETLY ERASE** any existing data on that drive. If you re-using an old drive, ensure that you have first removed all your data!!
#. Set your new Embassy master password. *Make it good. Write it down.* Click finish.
#. Set your new master password. *Make it good. Write it down.* Click finish.
.. figure:: /_static/images/transfer/transfer3.png
:width: 60%
@@ -142,7 +142,7 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/transfer/transfer4.png
:width: 60%
#. Your Embassy will now initialize and migrate the old data to the new drive. The time required can vary greatly depending on how much data you are migrating. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
#. Your server will now initialize and migrate the old data to the new drive. The time required can vary greatly depending on how much data you are migrating. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
.. figure:: /_static/images/transfer/transfer5.png
:width: 60%

View File

@@ -17,7 +17,7 @@ Setup Network Folder
.. group-tab:: Ubuntu
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Linux machine, such that you may create encrypted, private backups of all your Start9 server's data.
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Linux machine, such that you may create encrypted, private backups of all your StartOS data.
.. youtube:: LLIMC5P3NdY
:width: 100%
@@ -56,7 +56,7 @@ Setup Network Folder
.. figure:: /_static/images/cifs/cifs-lin2.png
:width: 60%
- You may name the share whatever you like, but **remember this name**, as you will need it later in your Start9 server's web UI. Here, we used ``backup-share``.
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in the StartOS dashboard
- (Optional) Create a description in the "Comment" section
@@ -94,7 +94,7 @@ Setup Network Folder
.. figure:: /_static/images/cifs/cifs-mint1.png
:width: 60%
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in your Start9 server's web UI. In this example, we call it ``backup-share``.
- You may rename the "Share", if you prefer - **remember this name**, you will need it later in the StartOS dashboard. In this example, we call it ``backup-share``
- (Optional) Create a description in the "Comment" section
@@ -160,17 +160,17 @@ Setup Network Folder
sudo ufw allow Samba
Connect Your Start9 Server
--------------------------
Connect StartOS
---------------
#. Go to *System > Create Backup*.
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/embassy_backup0.png
.. figure:: /_static/images/config/backup0.png
:width: 60%
#. Fill in the following fields:
@@ -180,9 +180,9 @@ Connect Your Start9 Server
* Username - This is your Linux username on the remote machine that you used to create the shared directory
* Password - This is the password you set above using ``smbpasswd``
.. figure:: /_static/images/config/embassy_backup1.png
.. figure:: /_static/images/config/backup1.png
:width: 60%
#. Click "Save".
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Start9 server's data to your Linux machine or external drive!!
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your StartOS data to your Linux machine or external drive!!

View File

@@ -8,7 +8,6 @@ Mac Network Folder
:depth: 2
:local:
Setup a Network Folder
----------------------
@@ -109,13 +108,13 @@ Connect Your Server
#. Go to the **System** tab and click **Create Backup**:
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
:alt: system-create-backup
#. Click **Open New**:
.. figure:: /_static/images/config/embassy_backup0.png
.. figure:: /_static/images/config/backup0.png
:width: 60%
:alt: open-new

View File

@@ -9,17 +9,17 @@ Backup to Physical Drive
.. youtube:: KJRO9wGOOVw
:width: 100%
The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder<backup>` via your OS. However, you may use a powered external drive, or external drive via a powered USB 3.0 hub, connected directly to your Embassy if you prefer.
The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder<backup>` via your OS. However, you may use a powered external drive, or external drive via a powered USB 3.0 hub, connected directly to your Start9 server if you prefer.
.. warning:: If you still choose to plug into your Embassy, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Embassy One (NASPi Geekworm case with built-in power management) and Embassy Pro users can safely ignore this warning.
.. warning:: If you still choose to plug into your Start9 server, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One (NASPi Geekworm case with built-in power management) and Server Pro users can safely ignore this warning.
#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``.
#. If your drive is self-powered, you can plug it directly into your Embassy blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Embassy. Then you may power it up.
#. If your drive is self-powered, you can plug it directly into your Start9 server blue USB 3.0 slot. If not, first plug the drive into a powered USB hub, then plug the hub into your Start9 server. Then you may power it up.
#. Go to *System > Create Backup*
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Select your drive.
@@ -30,12 +30,12 @@ The recommended method of backup (including with external drives) is to setup a
.. figure:: /_static/images/config/physical-backup2.png
:width: 60%
#. Enter your embassyOS master password.
#. Enter your StartOS master password.
.. figure:: /_static/images/config/embassy_backup3.png
.. figure:: /_static/images/config/backup3.png
:width: 60%
#. When the backup is complete, you will receive a notification. If successful, you will see the date and time of your most recent backup updated under "Backups" in the System tab.
.. figure:: /_static/images/config/embassy_backup4.png
.. figure:: /_static/images/config/backup4.png
:width: 60%

View File

@@ -23,21 +23,21 @@ Setup Network Folder
#. On the rsync tab, under File Services -> turn on rsync protocol.
#. In the same dropdown, under "Note" will be "PC (Windows Explorer): \". This DeviceAddressName is the "Hostname" within the Embassy New Shared Folder dialog, and note that it is case sensitive and that the \ have been removed.
#. In the same dropdown, under "Note" will be "PC (Windows Explorer): \". This DeviceAddressName is the "Hostname" within the StartOS New Network Folder dialog, and note that it is case sensitive and that the \ characters have been removed.
#. Back in Synonogy UI, click "File Station" and navigate so that you can see the the desired destination folder. Right click the folder, then *Properties > General*. Next to "Location" will be a folder location of the format ///, the / portion (so without the volume label) is the "Path" within the Embassy New Shared Folder dialog.
#. Back in Synonogy UI, click "File Station" and navigate so that you can see the the desired destination folder. Right click the folder, then *Properties > General*. Next to "Location" will be a folder location of the format ///, the / portion (so without the volume label) is the "Path" within the StartOS New Network Folder dialog.
Connect Embassy
Connect StartOS
---------------
#. Go to *System > Create Backup*.
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/embassy_backup0.png
.. figure:: /_static/images/config/backup0.png
:width: 60%
#. Fill in the following fields:
@@ -47,7 +47,7 @@ Connect Embassy
* Username - This is the user on the remote machine that you used to create the shared directory
* Password - This is your user (from above) password
.. figure:: /_static/images/config/embassy_backup1.png
.. figure:: /_static/images/config/backup1.png
:width: 60%
#. Click "Save".

View File

@@ -73,17 +73,17 @@ Setup Network Folder
Off to the right-hand side, *Permissions Type* should be set to "Basic" and *Permissions* should be set to "Full Control".
Click **SAVE**
Connect Embassy
Connect StartOS
---------------
#. Go to *System > Create Backup*.
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/embassy_backup0.png
.. figure:: /_static/images/config/backup0.png
:width: 60%
#. Fill in the following fields:

View File

@@ -8,7 +8,7 @@ Windows Network Folder
:depth: 2
:local:
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Windows machine (or attached drive), such that you may create encrypted, private backups of all your Embassy data.
Check out the video below, and follow along with the steps in this guide to setup a Network Folder on your Windows machine (or attached drive), such that you may create encrypted, private backups of all your StartOS data.
.. youtube:: wqbXRjttJQY
:width: 100%
@@ -48,22 +48,22 @@ Setup Network Folder
.. figure:: /_static/images/cifs/cifs-win5.png
:width: 60%
Connect Embassy
Connect StartOS
---------------
#. Return to your EmbassyUI, and go to *System > Create Backup*
#. Return to your StartOS UI, and go to *System > Create Backup*
.. figure:: /_static/images/config/embassy_backup.png
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Click "Open" to set up a new connection to your Shared Folder
.. figure:: /_static/images/config/embassy_backup0.png
.. figure:: /_static/images/config/backup0.png
:width: 60%
#. Fill out the following fields as shown below:
.. figure:: /_static/images/config/embassy_backup1.png
.. figure:: /_static/images/config/backup1.png
:width: 60%
- For "Hostname" - Enter your Windows computer name (this is shown after a ``\\`` in Windows)
@@ -74,10 +74,10 @@ Connect Embassy
If you use a "PIN" to log in to Windows, keep in mind that your password needs to be the user's full password, NOT the PIN! Office365 accounts also may **not** work, try a regular user in this case.
.. tip::
If you recieve the following error:
If you receive the following error:
**Filesystem I/O Error mount error(115): Operation now in progress**
Click Start > Settings > Network & Internet > Ethernet (or WiFi) and select the "Private" profile to treat your LAN as a trusted network that allows file sharing.
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your Embassy data to your Windows machine or external drive!!
That's it! You can now :ref:`Create<backup-create>` encrypted, private backups of all your server data to your Windows machine or external drive!!

View File

@@ -19,7 +19,7 @@ In addition to the safe-keeping of a good master password, maintaining good back
:class: large-5
:anchor: Backup
Create an encrypted backup of your Embassy data.
Create an encrypted backup of your server data.
.. topic-box::
:title: Restore From Backup
@@ -28,7 +28,7 @@ In addition to the safe-keeping of a good master password, maintaining good back
:class: large-5
:anchor: Restore
Restore your Embassy data from a previous backup.
Restore your server data from a previous backup.
.. raw:: html