Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 20:14:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Big refactor, many minor fixes (#441)

Browse Source 
* Big refactor, many minor fixes

* Link fixes, icon edits

* Index and ToC fixes

* update icons in theme lib and add to device guides index

* WIP - refactor Initial setup, LAN, FF, others

* First draft ready, many fixes and edits

* Ooops - minor edits and changes on initial setup

* Add change password guide (try 2).

* Remove change password menu item from guides

* Fix display bug, think different

---------

Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
Co-authored-by: gStart9 <george@start9labs.com>
This commit is contained in:
kn0wmad
2023-07-28 18:02:43 +00:00
committed by GitHub
parent eceae35a2b
commit 09b61c7e33
149 changed files with 1362 additions and 785 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
site/source/user-manual/backups/backup-setup/backup-linux.rst
View File

@@ -1,188 +0,0 @@
.. _backup-linux:
====================
Linux Network Folder
====================
.. contents::
:depth: 2
:local:
Setup Network Folder
--------------------
.. note:: This guide is for Ubuntu only. For Linux Mint, click on "Mint", or for different distros such as Arch, Debian, Pop-OS, PureOS, etc, click "Other Linux" below.
.. tabs::
.. 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 StartOS data.
.. youtube:: LLIMC5P3NdY
:width: 100%
.. raw:: html
<br/><br/>
#. Install Samba if you have not already:
.. code-block::
sudo apt install samba && sudo systemctl enable smbd
#. Add your user to samba, replacing ``$USER`` with your Linux username.
.. code-block:: bash
sudo smbpasswd -a $USER
First you will be prompted for your linux password, then you will be asked to create a new SMB password for the user with permission to write to your new backup share. Keep it somewhere safe, such as Vaultwarden.
#. Right-click the folder that you want to backup to (or create a new one) and click "Properties"
.. figure:: /_static/images/cifs/cifs-lin0.png
:width: 60%
#. Select the "Local Network Share" tab
.. figure:: /_static/images/cifs/cifs-lin1.png
:width: 60%
#. Click "Share this folder"
.. figure:: /_static/images/cifs/cifs-lin2.png
:width: 60%
- 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
#. In case your installation of Ubuntu is running a firewall by default or due to your own custom configuration, enter this command to allow connections to Samba. If it generates an error, you can safely ignore it:
.. code-block:: bash
sudo ufw allow Samba
.. group-tab:: Mint
#. Install Samba if you have not already:
.. code-block::
sudo apt install samba && sudo systemctl enable smbd
#. Add your user to samba, replacing ``$USER`` with your Linux username.
.. code-block:: bash
sudo usermod -a -G sambashare $USER
sudo smbpasswd -a $USER
First you will be prompted for your linux password, then you will be asked to create a new SMB password for the user with permission to write to your new backup share. Keep it somewhere safe, such as Vaultwarden.
#. Right-click the folder that you want to backup to (or create a new one, eg. ``start9-backup``) and click "Sharing Options"
.. figure:: /_static/images/cifs/cifs-mint0.png
:width: 60%
#. Enter a Share name consisting of 12 or fewer characters and click "Create Share"
.. 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 the StartOS dashboard. In this example, we call it ``backup-share``
- (Optional) Create a description in the "Comment" section
#. In case your installation of Mint is running a firewall by default or due to your own custom configuration, enter this command to allow connections to Samba. If it generates an error, you can safely ignore it:
.. code-block:: bash
sudo ufw allow Samba
.. group-tab:: Other Linux
1. Install Samba if it is not already installed.
* ``sudo pacman -S samba`` For Arch
* ``sudo apt install samba`` For Debian-based distros (Pop-OS, PureOS, etc)
* ``sudo yum install samba`` For CentOS/Redhat
* ``sudo dnf install samba`` For Fedora
2. Create a directory to share or choose an existing one and make note of its location (path). For this example, we will call the share ``backup-share`` and its corresponding shared directory will be located at ``/home/$USER/start9-backup``. Replace ``$USER`` with your Linux username below.
.. code-block:: bash
mkdir -p /home/$USER/start9-backup
.. note:: If you are on Fedora 38+, you need to do an extra step to allow the Samba share in SELinux:
.. code-block:: bash
sudo semanage fcontext --add --type "samba_share_t" "/home/$USER/start9-backup(/.*)?"
sudo restorecon -R /home/$USER/start9-backup
3. Configure Samba by adding the following to the end of the ``/etc/samba/smb.conf`` file:
.. code-block::
[backup-share]
path = "/home/$USER/start9-backup"
create mask = 0600
directory mask = 0700
read only = no
guest ok = no
Where:
- ``[backup-share]`` is the *Share Name* inside brakets, and can be called anything you'd like. We used ``backup-share`` in this example.
- ``path`` should be the path to the directory you created earlier
Copy the remainder of the entry exactly as it is
4. Open a terminal and enter the following command, replacing ``$USER`` with your Linux username:
.. code-block:: bash
sudo smbpasswd -a $USER
This creates a password for the Local Network Share. Keep it somewhere safe, such as Vaultwarden.
5. In case your installation of Linux (Pop-OS users take special note!) is running a firewall by default or due to your own custom configuration, enter this command to allow connections to Samba. If it generates an error, you can safely ignore it:
.. code-block:: bash
sudo ufw allow Samba
Connect StartOS
---------------
#. Go to *System > Create Backup*.
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Click "Open".
.. figure:: /_static/images/config/backup0.png
:width: 60%
#. Fill in the following fields:
* Hostname - This is the hostname of the machine that your shared folder is located on
* Path - This is the "Share Name" (name of the share in your samba config) and **not** the full directory path. In this guide we use ``backup-share``.
* 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/backup1.png
:width: 60%
#. Click "Save".
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!!

163
site/source/user-manual/backups/backup-setup/backup-mac.rst
View File

@@ -1,163 +0,0 @@
.. _backup-mac:
==================
Mac Network Folder
==================
.. contents::
:depth: 2
:local:
Setup a Network Folder
----------------------
Please select what version of MacOS you are using from the two tabs below:
.. tabs::
.. group-tab:: Ventura
#. Identify or create a folder you would like to use to store your Start9 server's backups.
.. tip:: You can select an external drive or folder within an external drive connected to your Mac if you'd like.
#. Go to **System Settings**:
.. figure:: /_static/images/tor/systemSettings.png
:width: 40%
:alt: System settings
#. Click on **General** then **Sharing**:
.. figure:: /_static/images/cifs/ventura-general-sharing.png
:width: 40%
:alt: general-sharing
#. Click the toggle to enable file sharing and then click info icon:
.. figure:: /_static/images/cifs/ventura-enable-file-sharing.png
:width: 40%
:alt: enable-cifs
#. Click on the **"+"** icon and select the folder you would like to make backups to:
.. figure:: /_static/images/cifs/ventura-click-plus.png
:width: 40%
:alt: click-plus
#. Once added, click **Options**:
.. figure:: /_static/images/cifs/ventura-folder-added.png
:width: 40%
:alt: ventura-folder-added
#. Enable SMB sharing for the user you want to use and then click **Done**:
.. figure:: /_static/images/cifs/ventura-smb.png
:width: 40%
:alt: ventura-smb
#. Click **Done** to close this window. You can now move on to connecting your server.
.. tip:: You can find hostname at the bottom of sharing window. You will need this in the next step.
.. tip:: You can find hostname at the bottom of sharing window.
.. group-tab:: Pre-Ventura
#. Identify or create a folder you would like to use to store your Start9 server's backups.
.. tip:: You can select an external drive or folder within an external drive connected to your Mac if you'd like.
#. Go to **System Preferences** and click **Sharing**:
.. figure:: /_static/images/cifs/cifs-mac0.png
:width: 40%
:alt: sharing
#. Click **File Sharing**:
.. figure:: /_static/images/cifs/cifs-mac1.png
:width: 40%
:alt: file-sharing
#. Click the **"+"** icon under **Shared Folders** and add the folder you would like to back up to:
.. figure:: /_static/images/cifs/cifs-mac2.png
:width: 40%
:alt: click-plus
#. After selecting your folder, click **Options**:
.. figure:: /_static/images/cifs/cifs-mac3.png
:width: 40%
:alt: options
#. Enable **Share files and folders using SMB** and turn it on for the user you would like to use to authenticate and then click **Done**:
.. figure:: /_static/images/cifs/cifs-mac4.png
:width: 40%
:alt: SMB
#. Make a note of your computer's **Hostname** which can be found here:
.. figure:: /_static/images/cifs/cifs-mac-hostname.png
:width: 40%
:alt: hostname
#. You will also need the name of the "Shared Folder" you chose or created, as well as your Mac's username and password.
Connect Your Server
-------------------
#. Go to the **System** tab and click **Create Backup**:
.. figure:: /_static/images/config/backup.png
:width: 60%
:alt: system-create-backup
#. Click **Open New**:
.. figure:: /_static/images/config/backup0.png
:width: 60%
:alt: open-new
#. You will now see the following:
.. figure:: /_static/images/cifs/cifs-blank.png
:width: 50%
:alt: cifs-blank
Enter the credentials as follows:
* **Hostname** - This is the name of your computer.
.. tip:: Sometimes it can be unclear what your Mac's hostname is. Check the tip in Step 8 of the section above to find it. On some versions of Mac, you may need to open up Terminal and type `hostname` as below:
.. figure:: /_static/images/cifs/hostname-terminal-mac.png
:width: 35%
:alt: hostname-terminal-mac
* **Path** - This is the *name of the shared folder* you are using and **not** the full directory path.
.. tip:: If you copied the share name from the Mac computer and it contained a space, macOS will have replaced the space with the string "%20". Please re-replace `%20` with a space in this `Path` field.
* **Username** - This is the user on the remote machine that you used to create the shared directory.
* **Password** - This is the password to the above user.
.. figure:: /_static/images/cifs/cifs-mac5.png
:width: 60%
.. note:: If you are on MacOS Catalina (version 10.15.7), and the backup fails, please `see this Apple support thread <https://discussions.apple.com/thread/253970425>`_. If the provided solution still doesn't work, SMB file sharing probably will not work for this old Mac. Consider backing up to a USB thumb drive instead.
.. note:: If you recently updated to MacOS Ventura (version 13.2), and you cannot get the share to connect:
#. Turn off file sharing switch in **General > Sharing**
#. Restart macOS
#. Turn on file sharing switch in **General > Sharing**
#. Click **Connect**.
That's it! You can now :ref:`create encrypted, private backups<backup-create>` of all your Start9 server's data to your Mac.

83
site/source/user-manual/backups/backup-setup/backup-windows.rst
View File

@@ -1,83 +0,0 @@
.. _backup-windows:
======================
Windows Network Folder
======================
.. contents::
: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 StartOS data.
.. youtube:: wqbXRjttJQY
:width: 100%
Setup Network Folder
--------------------
#. Create a folder, or select an existing one. Right-click the folder and select "Properties"
.. figure:: /_static/images/cifs/cifs-win0.png
:width: 60%
#. Click the "Sharing" tab...
.. figure:: /_static/images/cifs/cifs-win1.png
:width: 60%
then click "Share"
.. figure:: /_static/images/cifs/cifs-win2.png
:width: 60%
#. Select a user you want to use for login and click "Share"
.. figure:: /_static/images/cifs/cifs-win3.png
:width: 60%
.. note::
If you get the following dialogue box, you have designated your network "Public." You may wish to change to "Private" if this is your home network. Otherwise you may turn on network sharing for public networks.
.. figure:: /_static/images/cifs/cifs-win4.png
:width: 60%
#. Note the share's name, "SharedFolder" displayed in black text in the example screenshot below, above the long hostname and Windows directory path in grey text, both highlighted in blue. We will take the share's name and enter it in the final step below.
.. figure:: /_static/images/cifs/cifs-win5.png
:width: 60%
Connect StartOS
---------------
#. Return to your StartOS UI, and go to *System > Create Backup*
.. figure:: /_static/images/config/backup.png
:width: 60%
#. Click "Open" to set up a new connection to your Shared Folder
.. figure:: /_static/images/config/backup0.png
:width: 60%
#. Fill out the following fields as shown below:
.. figure:: /_static/images/config/backup1.png
:width: 60%
- For "Hostname" - Enter your Windows computer name (this is shown after a ``\\`` in Windows)
- For "Path" - Enter the full path followed by the share name displayed in the Windows sharing dialog shown in Step 4 above. In our example this would be, literally, ``/Users/win/Desktop/SharedFolder``. When entering the path, make sure replace the backshashes ``\`` shown by Windows with forward slashes ``/``.
- Enter your Windows username and password in the "User" and "Password" fields
.. caution::
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 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 server data to your Windows machine or external drive!!

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

@@ -1,46 +0,0 @@
.. _connecting-lan:
===================
Connecting Over LAN
===================
Whenever you are connected to the same Local Area Network (LAN) as your Start9 server, it is best to access your Start9 server's LAN Address (.local URL). LAN connections are fast and secure and do not even require Internet access!
.. note:: StartOS creates its own Certificate Authority (CA) to establish trust with client devices.
Download Root CA
----------------
First, download your Start9 server's Root CA. There are two way to accomplish this:
- Download it from the info page you saved at the completion of :ref:`Initial Setup<initial-setup>`, OR
- Navigate to *System > LAN*, then click "Download Certificate".
.. figure:: /_static/images/ssl/lan_setup.png
:width: 60%
:alt: LAN setup menu item
Trust Root CA
-------------
Instruct your **client device** to trust your Start9 server's Root CA.
.. toctree::
:maxdepth: 2
lan-os/index
**RECOMMENDED**: :ref:`Configure Firefox<lan-ff>` to use your system's certificate store.
.. note:: Brave, Chrome and Safari will work without additional configuration.
**OPTIONAL**: :ref:`Configure Thunderbird<lan-thunderbird>` to use your system's certificate store (for Nextcloud integration).
Access your Start9 server's LAN Address
---------------------------------------
With the Root CA downloaded and trusted by both your operating system and your browser, you can visit your Start9 server's LAN Address (.local URL) over secure ``https``. Any service that offers a LAN URL will also be securely accessible!
.. toctree::
:maxdepth: 2
:hidden:
lan-ff
lan-thunderbird

52
site/source/user-manual/connecting/connecting-lan/lan-ff.rst
View File

@@ -1,52 +0,0 @@
.. _lan-ff:
==================================
Trusting Your Start9 CA in Firefox
==================================
This guide applies to Firefox, Firefox ESR, and Librewolf. Mozilla apps need to be configured to use the certificate store of your device. To find out why Mozilla does this differently, you can read their `blog post <https://blog.mozilla.org/security/2019/02/14/why-does-mozilla-maintain-our-own-root-certificate-store/>`_ on the topic.
.. caution:: You will first need to complete :ref:`device setup<lan-os>` for your device before continuing.
.. tabs::
.. group-tab:: Linux/Mac/Windows
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about changing advanced configuration preferences.
#. Search for *security.enterprise_roots.enabled* and double click on *false* so that it turns to *true*:
.. figure:: /_static/images/ssl/browser/enterprise_roots_enabled_true.png
:width: 80%
:alt: Firefox security settings
#. Now restart Firefox and you should now see this symbol indicating a secure connection:
.. figure:: /_static/images/ssl/browser/firefox-https-good.png
:width: 80%
:alt: Firefox security settings
.. note:: If you see an exclamation point inside a triangle by the lock, you have made a security exception in the browser. To remove it, click the lock and go to "Connection not secure":
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-1.png
:width: 80%
:alt: Firefox - Remove security exception (Part 1)
Then click "Remove Exception":
.. figure:: /_static/images/ssl/browser/cert-trust-exception-remove-2.png
:width: 80%
:alt: Firefox - Remove security exception (Part 2)
You should now see that the website is trusted as in the final step show above.
.. group-tab:: Android
#. To setup in Firefox Beta or Fennec, tap the kebab menu, then go to *Settings > About Firefox Beta* and tap the Firefox logo five times until it says "Debug menu enabled."
#. Return to *Settings > Secret Settings* and enable "Use third party CA certificates".
.. group-tab:: iOS
No additional configuration for iOS is required.

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

@@ -1,16 +0,0 @@
.. _lan-os:
=============
Trust CA - OS
=============
Instruct your **operating system** to trust your Start9 server's Root CA.
.. toctree::
:maxdepth: 2
Linux <lan-linux>
Mac <lan-mac>
Windows <lan-windows>
Android <lan-android>
iOS <lan-ios>

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

@@ -1,27 +0,0 @@
.. _lan-android:
==================================
Trusting Your Start9 CA on Android
==================================
.. note:: This will work on most Android phones running Android v13+, as well as phones running CalyxOS, GrapheneOS or LineageOS (v19+).
.. tabs::
.. group-tab:: Android v13+
Tap **Settings > Security > More security settings > Encryption & credentials > Install a certificate > CA Certificate > Install Anyway** and select your custom-named ``adjective-noun.local.crt`` certificate.
.. figure:: /_static/images/ssl/android/droidLAN2.png
:width: 30%
:alt: Install certificate
.. group-tab:: Android v12
.. tip:: Some phones running Android v12 will work, others won't. It depends on the vendor. Most Androids running v12 that we have tested do work with the exception of the Samsung Galaxy S10 which does not.
Tap **Settings > Security > Advanced > Encryption and Credentials > Install from Storage** and select your unique ``adjective-noun.local.crt`` certificate.
.. figure:: /_static/images/ssl/android/droidLAN0.png
:width: 30%
:alt: Install certificate

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

@@ -1,87 +0,0 @@
.. _lan-ios:
================================
Trusting Your Server's CA on iOS
================================
This applies to iOS v15 and v16. For older versions, see the `v14 guide </0.3.1.x/user-manual/connecting/connecting-lan/lan-os/lan-ios>`_.
#. Download the certificate to your Downloads folder
.. note::
In order to do this, open Safari and visit your Start9 server's .local URL while connected to WiFi, but make sure it is prefixed with `http://` and not `https://`.
Log in using your password, then click the hamburger (3 lines) menu at the top right, select System > LAN > Download Certificate. It may say `This website is trying to download a configuration profile. Do you want to allow this?` Click `Allow`.
Once this is done, you can skip to step 3, below.
If you downloaded the certificate from a browser such as Firefox, you will need to copy the file from that Downloads folder to your iCloud Downloads folder. Navigate there via `Files > iCloud Drive > Downloads`. Otherwise, the "Profile Download" dialog will not appear when you click on the file in the next step.
#. Open your iCloud Downloads folder and click on the certificate. It will display a dialog box that says "Profile Downloaded." Click `Close`.
.. figure:: /_static/images/ssl/ios/import_cert.png
:width: 20%
:alt: Profiles
#. Head to *Settings > General > VPN & Device Management*
.. figure:: /_static/images/ssl/ios/settings_general_vpn.png
:width: 20%
:alt: Profiles
#. Locate the profile under "DOWNLOADED PROFILE" and tap on it
.. figure:: /_static/images/ssl/ios/install_1.png
:width: 20%
:alt: Profiles
#. Tap *Install*
.. figure:: /_static/images/ssl/ios/install_2.png
:width: 20%
:alt: Profiles
#. Tap *Install* again
.. figure:: /_static/images/ssl/ios/install_3.png
:width: 20%
:alt: Profiles
#. Tap *Install* yet again
.. figure:: /_static/images/ssl/ios/install_4.png
:width: 20%
:alt: Profiles
#. You should see green text with a check-mark saying "Verified" under the Profile Installed dialog.
.. figure:: /_static/images/ssl/ios/install_5.png
:width: 20%
:alt: Profiles
#. Tap *Done* near the top right.
#. Next, navigate to *General > About > Certificate Trust Settings*.
.. figure:: /_static/images/ssl/ios/trust_1.png
:width: 20%
:alt: Certificate trust settings
#. Under "Enable full trust for root certificates", enable your "<custom-address> Local Root CA".
.. figure:: /_static/images/ssl/ios/trust_2.png
:width: 20%
:alt: Enable full trust
#. Tap *Continue*
.. figure:: /_static/images/ssl/ios/trust_3.png
:width: 20%
:alt: Profiles
#. Your certificate should now be installed and trusted:
.. figure:: /_static/images/ssl/ios/trust_4.png
:width: 20%
:alt: Profiles

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

@@ -1,94 +0,0 @@
.. _lan-linux:
.. _lan-linux-system:
================================
Trusting Your Start9 CA on Linux
================================
Here we will insert your Start9 server's CA certificate into Linux's trust store to ensure that applications will trust your Start9 server's services.
.. tabs::
.. group-tab:: Debian/Ubuntu
These instructions should work for Debian, Ubuntu, or any Debian or Ubuntu-based Linux, such as Linux Mint, PopOS, etc.
Perform the following commands in the Terminal:
.. code-block:: bash
sudo apt update
sudo apt install -y ca-certificates p11-kit
For each Mozilla-based application (Firefox, Firefox ESR, LibreWolf, Thunderbird, etc) you plan on using, in order for them to trust your Start9 server's CA certificate directly from your Linux distribution's certificate trust store, do the following:
#. Select the hamgurger menu, then *Settings*, then search for "*security devices*", then select "*Security Devices...*"
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-1.png
:width: 60%
:alt: Mozilla application p11kit trust #1
#. When the Device Manager dialog window opens, select "*Load*"
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-2.png
:width: 60%
:alt: Mozilla application p11kit trust #2
#. Give the Module Name a title such as "*System CA Trust Module*" and for the Module filename, paste in ``/usr/lib/x86_64-linux-gnu/pkcs11/p11-kit-trust.so`` and hit *OK*:
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-3.png
:width: 60%
:alt: Mozilla application p11kit trust #3
#. Verify that the new module shows up on the left hand side and select *OK* at the bottom right:
.. figure:: /_static/images/ssl/linux/cert-trust-linux-firefox-p11kit-4.png
:width: 60%
:alt: Mozilla application p11kit trust #4
Finally, we will change directory to the folder where you downloaded your Start9 server's Root CA (usually `~/Downloads`), and run the following commands (after carefully replacing `adjective-noun` with your server's unique hostname, below) to add your Start9 server's CA certificate to the OS trust store:
.. code-block:: bash
cd ~/Downloads
sudo mkdir -p /usr/share/ca-certificates/start9
sudo cp "adjective-noun.local.crt" /usr/share/ca-certificates/start9/
sudo bash -c "echo 'start9/adjective-noun.local.crt' >> /etc/ca-certificates.conf"
sudo update-ca-certificates
In the output it should say ``1 added`` if it was successful.
Now restart Firefox (or other Mozilla application) and login to your server using ``https://``. No SSL warning should appear. If you still encounter issues, `contact support <https://start9.com/contact>`_.
.. group-tab:: Arch/Garuda
From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
.. code-block:: bash
sudo pacman -S ca-certificates
sudo cp "<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
First, ensure mDNS resolution is turned on so you can reach your server:
Ensure ``MulticastDNS=Yes`` is set in /etc/systemd/resolved.conf and then restart systemd-resolved:
.. code-block:: bash
sudo systemctl restart systemd-resolved
Trust your server's CA certificate:
From the folder you have downloaded your Start9 server's Root CA, run the following commands (if you have changed the certificate's filename, be sure to change it here):
.. code-block:: bash
sudo yum install ca-certificates
sudo cp "<custom-address>.crt" /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust

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

@@ -1,60 +0,0 @@
.. _lan-mac:
================================
Trusting Your Start9 CA on macOS
================================
#. In your Start9 server's UI, navigate to **System** -> **LAN**
.. figure:: /_static/images/ssl/macos/trust-cert-macos-1-system-lan.png
:width: 60%
:alt: Navigate to System > LAN
#. Click **Download Certificate** and your browser will either automatically save the certificate to your Downloads folder or ask you where to save it:
.. figure:: /_static/images/ssl/macos/trust-cert-macos-2-download_cert.png
:width: 60%
:alt: Download Certificate
#. Among the browser's downloads, right click your certificate file and select *Show in Folder*:
.. figure:: /_static/images/ssl/macos/trust-cert-macos-3-show_in_folder.png
:width: 60%
:alt: Show certificate file in Downloads folder
#. Finder will open. Locate your unique `adjective-noun Local CA.crt` file in your *Downloads* folder and double click it to open it in the Keychain Access program. You will be prompted for your macOS username and password, or thumbprint. Then select *Modify Keychain*:
.. figure:: /_static/images/ssl/macos/trust-cert-macos-4-modify_keychain.png
:width: 60%
#. Your server's CA certificate will be displayed among the imported certificates in Keychain Access. Right-click on the imported CA cert and select *Get Info*:
.. figure:: /_static/images/ssl/macos/trust-cert-macos-5-cert-get_info.png
:width: 60%
:alt: Keychain Access - Get Info of CA Certificate
#. The details of your CA certificate will be displayed in a new dialog window. Expand the **Trust** heading, then select "**Always Trust**" on **Secure Sockets Layer (SSL)** and **X.509 Basic Policy**.
.. figure:: /_static/images/ssl/macos/trust-cert-macos-6-ssl_tls-always_trust.png
:width: 60%
:alt: Trust CA Certificate
Click the red (x) button at the top left of the Local Root CA dialog window.
#. You will then be prompted again for your username and password, or thumbprint. Enter those and click **Update Settings**:
.. figure:: /_static/images/ssl/macos/trust-cert-macos-7-password-update_settings.png
:width: 60%
:alt: Authenticate to change the settings
#. You will see your server's CA certificate as trusted now, signified by a blue (+) sign and the CA cert information will now say "This certificate is marked as trusted for all users" in Keychain Access:
.. figure:: /_static/images/ssl/macos/trust-cert-macos-8-cert_trusted.png
:width: 60%
:alt: Keychain submenu
.. tip:: If the keychain console did not show the certificate as trusted, press "Command + spacebar" and type “Keychain Access”, and hit enter to re-open it.
No additional setup is required for most browsers and you will now be able to safely connect to your Start9 server over LAN.
For Firefox, you will need to follow :ref:`these <lan-ff>` instructions.

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

@@ -1,95 +0,0 @@
.. _lan-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.
.. note:: Recently many users who have run through the following instructions have successfully connected to their Start9 server via LAN only to have it stop working a few days or weeks later. We believe this to be due to a recent change in Windows. When this happens the fix is to simply reinstall Bonjour and Bonjour Print Services. A solution is being worked on and Bonjour will not be necessary to connect to your Start9 server for much longer.
#. Install `Bonjour Print Services <https://support.apple.com/kb/DL999>`_ on your Windows machine.
.. tip:: If you are experiencing issues after installing Bonjour, you might have had a previous or failed install. To fix:
#. Check out this video: https://www.youtube.com/watch?v=9ECCB3bqNDQ
#. Uninstall Bonjour and Bonjour Print Services completely via *system settings > remove programs*
#. Reinstall Bonjour Printer Driver package (download at https://support.apple.com/kb/DL999?locale=en_US)
#. Restart Windows
#. Note: Uninstalling Bonjour via the setup package seems to be not enough to solve the issue. Bonjour must be uninstalled via windows system settings.
#. Back in Windows, click the “Start” menu, type “mmc”, and select "Run as administrator" to access the Windows Management Console.
.. figure:: /_static/images/ssl/windows/0_windows_mmc.png
:width: 50%
:alt: Windows MMC
When prompted with the “User Account Control” window, select “Yes” to allow this program to run.
#. When the Management Console opens, navigate to *File > Add/Remove Snap-in*.
.. figure:: /_static/images/ssl/windows/1_windows_console_root.png
:width: 50%
:alt: Windows Console Root
#. Select “Certificates” in the left side menu, then “Add”. This will open another window.
.. figure:: /_static/images/ssl/windows/2_windows_add_certificates.png
:width: 50%
:alt: Add Certificates
#. Select “Computer account” and click “Next". Leave defaulted options on the next screen and click “Finish”.
.. figure:: /_static/images/ssl/windows/3_snap_in_wizard.png
:width: 50%
:alt: Add Snap-in
#. When you return to the “Add or Remove Snap-ins” page, ensure “Certificates (Local Computer)” exists under “Console Root” in the “Selected snap-ins” section, then click “OK”.
.. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.png
:width: 50%
:alt: Snap-in Selected
#. In the left hand menu of the Management Console, navigate to Certificates (Local Computer) > Trusted Root Certification Authorities > Certificates.
.. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.png
:width: 50%
:alt: Certificates in Management Console
#. Right click on the “Certificates” directory, then navigate to *All Tasks > Import*.
.. figure:: /_static/images/ssl/windows/6_windows_import_cert.png
:width: 50%
:alt: Import certificate
#. Click “Next” on the first page of the Certificate Import Wizard, then browse to the location where you saved the downloaded certificate and open it. Then click "Next".
.. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.png
:width: 50%
:alt: Import cert wizard
#. On the “Certificate Store” window, ensure that it says “Trusted Root Certificate Authorities” and click “Next”. Then click "Finish" on the final screen.
.. figure:: /_static/images/ssl/windows/8_windows_import_cert_wizard.png
:width: 50%
:alt: Import cert wizard
#. Select “OK” when the import is successful.
.. figure:: /_static/images/ssl/windows/9_success.png
:width: 20%
:alt: Import success!
#. Verify your server's unique `<adjective-noun> Local Root CA` certificate is in the “Certificates” folder:
.. figure:: /_static/images/ssl/windows/10_successful_cert_install.png
:width: 50%
:alt: Successful cert install
#. You can save the console settings (where we added a snap-in), if desired. The CA certificate will remain imported to the CA certificate store either way, and you will likely use this guide if you need to import a new certificate.
.. figure:: /_static/images/ssl/windows/11_console_settings.png
:width: 20%
:alt: Console settings
You're now ready to browse your service UIs with encryption, either via the browser, or with native client apps. You may wish to :ref:`configure Firefox<lan-ff>` and/or :ref:`Thunderbird<lan-thunderbird>` next.

36
site/source/user-manual/connecting/connecting-lan/lan-thunderbird.rst
View File

@@ -1,36 +0,0 @@
.. _lan-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.
.. tabs::
.. group-tab:: Linux/Mac/Windows
#. Open Thunderbird and do the following:
a. Select the hamburger menu bar near the top right of the tab
b. Select *Settings* from the resulting drop-down menu
.. figure:: /_static/images/ssl/integrations/thunderbird_1.png
:width: 80%
:alt: Thunderbird config editor
c. In the search bar in the top right, type "*config*"
d. Select *Config Editor...*
.. figure:: /_static/images/ssl/integrations/thunderbird_2.png
:width: 80%
:alt: Thunderbird config editor
#. Search for **security.enterprise_roots.enabled**, and click the toggle button so that it turns to **true**:
.. figure:: /_static/images/ssl/integrations/thunderbird_3.png
:width: 80%
:alt: Thunderbird enterprise_roots settings

42
site/source/user-manual/connecting/connecting-tor/index.rst
View File

@@ -1,42 +0,0 @@
.. _connecting-tor:
===================
Connecting Over Tor
===================
You can connect to your Start9 server from anywhere in the world, privately and anonymously, by using its unique Tor Address (``.onion`` URL).
.. note:: Tor connection can sometimes be unreliable and have higher latency than normal internet connections.
Using Firefox
-------------
.. tip:: This is the recommended way to connect to your Start9 server over Tor, but it requires some additional steps.
#. Run Tor (**not Tor Browser**) in the background on your connecting device.
.. toctree::
:maxdepth: 2
tor-os/index
#. Configure Firefox to handle *``.onion``* URLs.
.. toctree::
:maxdepth: 2
tor-firefox/index
Using TorBrowser
-------------------
.. caution:: Tor Browser will allow you to use your Start9 server's ``.onion`` URL without any manual configuration, however *all* connections are proxied via Tor, so you will not be able to access your Start9 server's ``.local`` LAN address with it. `Using Firefox <#using-firefox>`_ is recommended over TorBrowser.
* Linux, Mac, Windows, Android
* `Tor Browser <https://torproject.org/download/>`_
* iOS
* iOS lacks a well-functioning Tor Browser. Use `Firefox <tor-firefox/torff-ios>`_

18
site/source/user-manual/connecting/connecting-tor/tor-firefox/index.rst
View File

@@ -1,18 +0,0 @@
.. _tor-firefox:
=============
Tor - Firefox
=============
.. caution:: This guide assumes you are already :ref:`running Tor on your phone or computer<tor-os>`.
Once you have completed native :ref:`Tor Setup<tor-os>`, you can configure Firefox to use the Tor Network. This will allow you to visit both ``.onion`` and "normal" (.com, .net, etc) websites from within the same browser.
.. toctree::
:maxdepth: 2
Linux <torff-linux>
Mac <torff-mac>
Windows <torff-windows>
Android/Graphene <torff-android>
iOS <torff-ios>

63
site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-android.rst
View File

@@ -1,63 +0,0 @@
.. _torff-android:
======================================
Configuring Firefox for Tor on Android
======================================
.. caution::
This guide assumes you have completed :ref:`setting up Tor for Android<tor-android>`. Please visit this section before proceeding as it is required for Firefox to properly work with Tor.
.. note:: Setups may strongly vary across different Android forks. We have made specific mention of GrapheneOS which has been tested on Pixel 5 and Pixel 6. Configuring Firefox for Tor is not currently possible on CalyxOS or LineageOS v20.
Once Tor is setup on your system, you can proceed to setup Firefox:
#. Download `Firefox Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta>`_ from the Play Store, or `Fennec <https://f-droid.org/en/packages/org.mozilla.fennec_fdroid/>`_ from F-Droid.
.. note:: Regular Firefox offered in the Play Store will not work - be sure to use Firefox Beta.
#. Next, download a `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here <https://start9.com/assets/proxy.pac>`_.
#. Navigate to ``about:config`` in the Firefox URL bar.
.. figure:: /_static/images/tor/about_config.png
:width: 50%
:alt: Firefox about config
#. You are going to have to change a few options in here. First, type ``network.proxy.type`` into the search bar, and set the value to ``2``.
.. figure:: /_static/images/tor/network_proxy_type.png
:width: 50%
:alt: Firefox network proxy type setting screenshot
#. (This step is for GrapheneOS only): Head to *Settings -> Apps -> Firefox Beta -> Permissions -> Photos and videos -> Configure Storage Scopes -> ADD FILE* then navigate to where you placed the proxy.pac file.
.. figure:: /_static/images/tor/storage-scopes-proxy.jpg
:width: 30%
#. (All users): Search for ``network.proxy.autoconfig_url``, and set the value to ``file:///storage/emulated/0/Download/proxy.pac``. This is the default location of a the proxy.pac file downloaded in step 2, although your path may vary.
.. figure:: /_static/images/tor/autoconfig_url.png
:width: 50%
:alt: Firefox autoconfig url setting screenshot
#. Search for ``network.proxy.socks_remote_dns``, and set the value to ``true``.
.. figure:: /_static/images/tor/socks_remote_dns.png
:width: 50%
:alt: Firefox socks remote dns setting screenshot
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_allowlist_mobile.png
:width: 50%
:alt: Firefox whitelist onions screenshot
#. Finally, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
.. figure:: /_static/images/tor/firefox_insecure_websockets_droid.png
:width: 50%
:alt: Firefox allow insecure websockets over https
#. Optional but recommended: search for ``network.http.referer.hideOnionsSource`` and set the value to ``true``.
#. Restart Firefox, and you're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can bookmark your Start9 services' ``.onion`` addresses, as well as use integrations, such as the :ref:`Bitwarden<vaultwarden-service>` browser extension.

12
site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-ios.rst
View File

@@ -1,12 +0,0 @@
.. _torff-ios:
==================================
Configuring Firefox for Tor on iOS
==================================
.. caution::
This guide assumes you have completed :ref:`setting up Tor for iOS<tor-ios>`. Please visit this section before proceeding as it is required for any browser in iOS to work with Tor.
Once Orbot is setup on your system as illustrated at the link above, you don't need to do anything special to have any browser proxied via tor. All browsers in iOS are Safari under the hood, and the way we've configured Orbot makes it so any browser will work for any given onion url, and won't use Tor for regular clearnet requests.

57
site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-linux.rst
View File

@@ -1,57 +0,0 @@
.. _torff-linux:
====================================
Configuring Firefox for Tor on Linux
====================================
.. caution::
This guide assumes you have completed :ref:`setting up Tor<tor-linux>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``:
.. figure:: /_static/images/tor/firefox_allowlist.png
:width: 60%
:alt: Firefox whitelist onions screenshot
#. Next, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
.. figure:: /_static/images/tor/firefox_insecure_websockets.png
:width: 60%
:alt: Firefox allow insecure websockets over https
#. Download a `Proxy Auto Config` file to inform Firefox how to use the Tor daemon running on your computer. You can get Start9's standard file from a terminal, by using:
.. code-block::
sudo wget -P /etc/tor https://start9.com/assets/proxy.pac
#. Now, back in your Firefox web browser, select ``Settings`` from the right-hand hamburger menu:
.. figure:: /_static/images/tor/os_ff_settings.png
:width: 30%
:alt: Firefox options screenshot
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
.. figure:: /_static/images/tor/firefox_search.png
:width: 60%
:alt: Firefox search screenshot
#. This should open a menu that will allow you to configure your proxy settings. Select ``Automatic proxy configuration URL`` and paste in the path to your PAC file from earlier, prefixed with ``file://``. For example:
.. code-block::
file:///etc/tor/proxy.pac
#. Then, check the box labeled ``Proxy DNS when using SOCKS v5``:
.. figure:: /_static/images/tor/firefox_proxy.png
:width: 60%
:alt: Firefox proxy settings screenshot
#. Click ``OK`` and then restart Firefox for the changes to take effect.
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. This means you can access tor service :ref:`WebUIs <web-ui>`, and use client integrations such as :ref:`Vaultwarden<vaultwarden-service>` apps and extensions. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_.

46
site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-mac.rst
View File

@@ -1,46 +0,0 @@
.. _torff-mac:
==================================
Configuring Firefox for Tor on Mac
==================================
.. caution::
This guide assumes you have completed :ref:`setting up Tor<tor-mac>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to ``true``:
.. figure:: /_static/images/tor/firefox_allowlist.png
:width: 60%
:alt: Firefox whitelist onions screenshot
#. Next, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
.. figure:: /_static/images/tor/firefox_insecure_websockets.png
:width: 60%
:alt: Firefox allow insecure websockets over https
#. Now go to the right-hand hamburger menu and select ``Settings``:
.. figure:: /_static/images/tor/os_ff_settings.png
:width: 30%
:alt: Firefox options screenshot
#. Search for the term “proxy” in the search bar in the upper right, then select the button that says ``Settings…``:
.. figure:: /_static/images/tor/firefox_search.png
:width: 60%
:alt: Firefox search screenshot
#. Check the option labeled ``Use System Proxy Settings``
#. Check the box labeled ``Proxy DNS when using SOCKS v5``:
.. figure:: /_static/images/tor/firefox_proxy.png
:width: 60%
:alt: Firefox proxy settings screenshot
#. Click ``OK`` and then restart Firefox for the changes to take effect.
#. You're all set! You should now be able to navigate to ``.onion`` URLs in Firefox. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`_.

58
site/source/user-manual/connecting/connecting-tor/tor-firefox/torff-windows.rst
View File

@@ -1,58 +0,0 @@
.. _torff-windows:
======================================
Configuring Firefox for Tor on Windows
======================================
.. caution:: This guide assumes you have completed :ref:`setting up Tor<tor-windows>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
#. Open Firefox and enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
#. Search for ``dom.securecontext.allowlist_onions`` and set the value to "true":
.. figure:: /_static/images/tor/firefox_allowlist.png
:width: 60%
:alt: Firefox whitelist onions screenshot
#. Next, search for ``network.websocket.allowInsecureFromHTTPS`` and set the value to ``true``:
.. figure:: /_static/images/tor/firefox_insecure_websockets.png
:width: 60%
:alt: Firefox allow insecure websockets over https
#. Download a *Proxy Auto Config* file to inform Firefox how to use the Tor daemon running on your computer. You can get Start9's standard file by following instructions below:
- Click `here <https://start9.com/assets/proxy.pac>`_ to get the file and save the file somewhere you will not delete it. Remember where you save the file. For this example:
.. code-block::
C:\Program Files\Tor Browser\proxy.pac
#. Now, back in your Firefox web browser, select "Settings" from the right-hand hamburger menu:
.. figure:: /_static/images/tor/firefox_options_windows.png
:width: 60%
:alt: Firefox options screenshot
#. Search for the term "proxy" in the search bar in the upper right, then select the button that says "Settings":
.. figure:: /_static/images/tor/firefox_search.png
:width: 60%
:alt: Firefox search screenshot
#. This should open a menu that will allow you to configure your proxy settings. Select "Automatic proxy configuration URL" and paste in the path to your PAC file from earlier, prefixed with ``file://``. For example:
.. code-block::
file://C:/Program Files/Tor Browser/proxy.pac
#. Then, check the box labeled "Proxy DNS when using SOCKS v5":
.. figure:: /_static/images/tor/firefox_proxy_windows.png
:width: 60%
:alt: Firefox proxy settings screenshot
#. Click "OK" and then restart Firefox for the changes to take effect.
#. You're all set! You should now be able to navigate to ".onion" URLs in Firefox. You can test this by going to Start9's ``.onion`` homepage, `here <http://privacy34kn4ez3y3nijweec6w4g54i3g54sdv7r5mr6soma3w4begyd.onion/>`__.

16
site/source/user-manual/connecting/connecting-tor/tor-os/index.rst
View File

@@ -1,16 +0,0 @@
.. _tor-os:
========
Tor - OS
========
Select your Operating System to setup Tor to run in the background (natively) of any device that you might want to use to access your Start9 server with remotely.
.. toctree::
:maxdepth: 2
Linux <tor-linux>
Mac <tor-mac>
Windows <tor-windows>
Android <tor-android>
iOS <tor-ios>

80
site/source/user-manual/connecting/connecting-tor/tor-os/tor-android.rst
View File

@@ -1,80 +0,0 @@
.. _tor-android:
======================
Running Tor on Android
======================
Some apps, such as :ref:`Tor Browser<tor-browser>`, have Tor built in. They do not require additional software or configurations to utilize Tor. Most apps, however, do not have Tor built in. They require an app called Orbot to be installed in order to utilize the Tor Network.
Running Orbot
-------------
Orbot is a system wide proxy for your Android device that enables communications over Tor.
#. Download and install Orbot from the `Play Store <https://play.google.com/store/apps/details?id=org.torproject.android>`_, or from `F-Droid <https://f-droid.org/packages/org.torproject.android>`_ (must open with F-Droid app). Then launch the app.
.. tip:: When using F-Droid, you will want to activate the Guardian Project repository by visiting the ``Settings`` menu (bottom right) -> ``Repositories`` -> ``Guardian Project Official Releases``
.. figure:: /_static/images/tor/orbot0.png
:width: 30%
:alt: Orbot
#. Tap "Start VPN".
.. figure:: /_static/images/tor/orbot1.png
:width: 30%
:alt: Orbot starting
#. Orbot will start up the Tor service. Once complete, you will see:
.. figure:: /_static/images/tor/orbot2.png
:width: 30%
:alt: Orbot running
#. Open the kebab menu in the bottom right hand corner and select `Settings`:
.. figure:: /_static/images/tor/orbot_menu.png
:width: 30%
:alt: Orbot settings
#. Make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked:
.. figure:: /_static/images/tor/orbot_settings.png
:width: 30%
:alt: Orbot menu
#. That's it, you're now running a Tor client on your Android device! Certain apps, such as Firefox, Fennec, and DuckDuckGo will now work after you configure them to use Tor's local proxy. Other apps do not have sophisticated proxy configurations and require that Orbot be running in VPN mode.
Orbot VPN mode
--------------
To utilize Tor, some apps require that Orbot be running in VPN mode. This means that you are sending your application's traffic across the Tor network via Orbot.
#. Disable Private DNS on your device. Navigate to: ``Settings > Network & Internet > Advanced > Private DNS > Off`` and toggle Private DNS to "off".
.. figure:: /_static/images/tor/private_dns_off.png
:width: 30%
:alt: Private DNS off
#. Tap `Select Apps`, and add the apps you want to utilize Tor.
.. figure:: /_static/images/tor/orbot_apps.png
:width: 30%
:alt: Orbot apps
Examples of applications that need this feature for remote access are:
- Bitwarden
- Element (Matrix client)
- Nextcloud
.. figure:: /_static/images/tor/orbot2.png
:width: 30%
:alt: Orbot running
You can also add the following browsers to the Tor-Enabled Apps list to easily access Tor addresses (`.onion` URLs):
- Chrome
- Vanadium
.. caution:: Pushing apps through Orbot's VPN mode will allow you to access .onion URLs, however, all other traffic will also go through Tor. This means connections to some sites may be blocked by site operators' fraud prevention measures, especially e-commerce sites where credit cards are used. Proceed with caution especially for Web Browsers.

24
site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst
View File

@@ -1,24 +0,0 @@
.. _tor-ios:
==================
Running Tor on iOS
==================
*Orbot has been released for iOS so it is now possible to run Tor natively on iOS.*
1. Download and install `Orbot from the Apple appstore <https://apps.apple.com/us/app/orbot/id1609461599>`_.
2. Open Orbot
3. Select Settings
4. Activate the "Disable Orbot for non-onion traffic" setting:
.. figure:: /_static/images/tor/ios-orbot-settings-oniononlymode.png
:width: 50%
:alt: iOS Orbot -> Settings -> Onion-Only Mode
5. Go back to the main screen and click "Start" and you will see Tor connect:
.. figure:: /_static/images/tor/ios-orbot-connecting-full.png
:width: 50%
:alt: iOS Orbot Connecting to Tor
6. Apps will now work transparently when requesting onion urls.

95
site/source/user-manual/connecting/connecting-tor/tor-os/tor-linux.rst
View File

@@ -1,95 +0,0 @@
.. _tor-linux:
====================
Running Tor on Linux
====================
.. tabs::
.. group-tab:: Debian / Ubuntu
For Debian and Debian-based systems, such as Mint, PopOS etc.
.. note:: The following install is for the LTS (Long Term Support) version of Tor from Debian. If you would like the latest stable release, The Tor Project maintain their own Debian repository. The instructions to connect to this can be found `here <https://support.torproject.org/apt/tor-deb-repo/>`_.
Install the Tor proxy service to your system. To do so, open your terminal and run the following command:
.. code-block:: bash
sudo apt update && sudo apt install tor
.. tip:: You can check that Tor is running with:
.. code-block:: bash
systemctl status tor
In the rare event that Tor is having connectivity issues, you can reset your connection with:
.. code-block:: bash
sudo systemctl restart tor
.. group-tab:: Arch / Garuda / Manjaro
Simply install Tor with:
.. code-block:: bash
sudo pacman -S tor
.. tip:: You can check that Tor is running with:
.. code-block:: bash
systemctl status tor
In the rare event that Tor is having connectivity issues, you can reset your connection with:
.. code-block:: bash
sudo systemctl restart tor
.. group-tab:: CentOS / Fedora / RHEL
#. Configure the Tor Package repository. Add the following to ``/etc/yum.repos.d/tor.repo``:
- CentOS / RHEL:
.. code-block:: bash
[Tor]
name=Tor for Enterprise Linux $releasever - $basearch
baseurl=https://rpm.torproject.org/centos/$releasever/$basearch
enabled=1
gpgcheck=1
gpgkey=https://rpm.torproject.org/centos/public_gpg.key
cost=100
- Fedora:
.. tip:: Latest Fedora versions have Tor package available for installation:
.. code-block:: bash
[Tor]
name=Tor for Fedora $releasever - $basearch
baseurl=https://rpm.torproject.org/fedora/$releasever/$basearch
enabled=1
gpgcheck=1
gpgkey=https://rpm.torproject.org/fedora/public_gpg.key
cost=100
#. Install the Tor package:
.. code-block:: bash
sudo dnf install tor
#. Then enable tor service:
.. code-block:: bash
sudo systemctl enable --now tor

179
site/source/user-manual/connecting/connecting-tor/tor-os/tor-mac.rst
View File

@@ -1,179 +0,0 @@
.. _tor-mac:
==================
Running Tor on Mac
==================
Install Homebrew
----------------
#. If you do not have Homebrew installed, follow the installation instructions `here <https://brew.sh/>`_. TLDR: Open the Terminal and paste the following line:
.. code-block:: bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
#. You will be prompted for your system password before installation; proceed with entering your password. You may be asked more than once.
.. figure:: /_static/images/tor/install_homebrew.png
:width: 80%
:alt: Homebrew installation
#. You will be notified which directories Homebrew is going to create, hit :code:`RETURN`:
.. figure:: /_static/images/tor/install_homebrew1.png
:width: 80%
:alt: Homebrew installation
Homebrew creates the directories and downloads any other files it needs e.g. “Command Line Tool for Xcode” and “Homebrew”.
Wait a few minutes while it downloads and installs what it needs.
.. note:: Once installation is complete you will need to add "brew" to your path. There will be instructions on how to do this with the specific commands you need to enter if you scroll up a little in your terminal. Look for "Add homebrew to your path". Enter the commands and then type **brew --version** to ensure that brew is working. If you see something like **"Homebrew 3.6.18"** then it is installed. If you see **"zsh: command not found: brew"** then it either hasn't installed correctly, has not been added to your path yet or you simply need to open a new terminal. (If you do try restarting terminal, make a note of the commands suggested in case you need them again).
.. warning:: Surprisingly, Homebrew uses Google Analytics to collect anonymous usage data. You can deselect the option to share usage data by `opting out <https://docs.brew.sh/Analytics#opting-out>`_.
Install Tor
-----------
.. caution:: If you have the Tor Browser open, close it and quit the application.
.. note:: If you are on a very old version of macOS, such as High Sierra (10.13) or below, first execute this command in a Terminal window:
.. code-block::
echo 'export PATH="/usr/local/bin:$PATH"' >> ~/.bash_profile
Then close the Terminal.
#. Open a new Terminal and install Tor using the following command:
.. code-block:: bash
brew install tor
#. Then run Tor with:
.. code-block:: bash
brew services start tor
This will start Tor and ensure that it is always running, even after a restart. See the `Tor Project docs <https://2019.www.torproject.org/docs/tor-doc-osx.html.en>`_ for more details.
Enable Tor System-wide
----------------------
.. tabs::
.. group-tab:: Ventura
#. Enable proxy autoconfig file (This will download the Start9 standard proxy config file. You can use your own if you prefer):
.. code-block:: bash
sudo curl https://start9.com/assets/proxy.pac --output /Library/WebServer/Documents/proxy.pac
#. Now enable apache service:
.. code-block:: bash
sudo launchctl load -w /System/Library/LaunchDaemons/org.apache.httpd.plist
#. Go to System Settings:
.. figure:: /_static/images/tor/systemSettings.png
:width: 40%
:alt: System Preferences
#. Click on *Network* and then select the interface on which you wish to enable Tor system-wide (both Ethernet and WiFi advised - do one then the other):
.. figure:: /_static/images/tor/ventura-settings.png
:width: 80%
:alt: Select Network
#. Click *Details*:
.. figure:: /_static/images/tor/ventura-network-advanced.png
:width: 80%
:alt: Click Advanced
#. Click "Proxies," then select "Automatic Proxy Configuration," add this URL: ``http://localhost/proxy.pac``, then click "OK":
.. figure:: /_static/images/tor/ventura-proxies-corrected.png
:width: 80%
:alt: Select Proxys
Done! You have now enabled system-wide Tor potential.
We advise going back to step 4 and repeating this for Wifi/Ethernet depending on which interface you haven't done yet.
If you ever need to view the status of the tor service, enter the following into a Terminal:
.. code-block:: bash
cat /usr/local/var/log/tor.log || sudo cat /opt/homebrew/var/log/tor.log
If you'd like to setup Firefox to use Tor you can follow :ref:`this guide<torff-mac>`.
.. group-tab:: Pre-Ventura
#. Enable proxy autoconfig file (This will download the Start9 standard proxy config file. You can use your own if you prefer):
.. code-block:: bash
sudo curl https://start9.com/assets/proxy.pac --output /Library/WebServer/Documents/proxy.pac
#. Now enable apache service:
.. code-block:: bash
sudo launchctl load -w /System/Library/LaunchDaemons/org.apache.httpd.plist
#. Go to System Preferences:
.. figure:: /_static/images/tor/systemprefs.png
:width: 40%
:alt: System Preferences
#. Click on Network:
.. figure:: /_static/images/tor/network.png
:width: 80%
:alt: Select Network
#. In this example, we'll select WiFi on the left panel. If you're using Ethernet, click that instead. Next click "Advanced" (We suggest returning to this step in order to do both Ethernet AND WiFi):
.. figure:: /_static/images/tor/wifi_click_advanced.png
:width: 80%
:alt: Click Advanced
#. Select "Proxies":
.. figure:: /_static/images/tor/proxys.png
:width: 80%
:alt: Select Proxys
#. Select "Automatic Proxy Configuration", add this URL: **http://localhost/proxy.pac** then click "OK"
.. figure:: /_static/images/tor/entertorproxyURL-pre-ventura.png
:width: 80%
:alt: Select Automatic proxy config and enter URL
#. Finally, click "Apply"
.. figure:: /_static/images/tor/applyproxy.png
:width: 80%
:alt: Apply proxy
Done! You have now enabled system-wide Tor potential.
We suggest heading back to step 5 and enabling Tor system-wide on Ethernet/WiFi now - whichever you did not do already.
If you ever need to view the status of the tor service, enter the following into a Terminal:
.. code-block:: bash
cat /usr/local/var/log/tor.log || sudo cat /opt/homebrew/var/log/tor.log
If you'd like to setup Firefox to use Tor you can follow :ref:`this guide<torff-mac>`.

60
site/source/user-manual/connecting/connecting-tor/tor-os/tor-windows.rst
View File

@@ -1,60 +0,0 @@
.. _tor-windows:
======================
Running Tor on Windows
======================
.. youtube:: j_ldDT2zPsg
:width: 100%
#. Unfortunately, `The Tor Project <https://torproject.org>`_ no longer publishes a standalone Tor binary for Windows, so the recommended way to get it is with the Tor Browser Bundle. You can download it `here <https://www.torproject.org/download/>`_.
.. figure:: /_static/images/tor/tor_download_windows.png
:width: 80%
:alt: Tor download
Download Tor for Windows
#. Once it is downloaded, run the installer by right clicking on it and selecting `Run as Administrator`.
#. Once you have selected a language, you should see a menu like this:
.. figure:: /_static/images/tor/tor_windows_install.png
:width: 80%
:alt: Tor install wizard
We will install it to ``C:\Program Files\Tor Browser``. If you choose a different folder, it needs to *not* be anywhere under ``C:\Users\``. Note the path you use here for the step after next.
#. Now you want to set up Tor to run as a service: to run in the background and keep itself running so you don't have to worry about it again. To do so, you need to open your Command Prompt as an administrator.
* In Windows 10, you can simply type ``cmd`` in the Windows search bar, right click on the first result, and select `Run as Administrator`.
#. Once it opens, you can run the following commands, inserting your destination folder (from above) between `binPath="` and the `Browser` subfolder, like this:
.. code-block::
sc create tor start= auto binPath="C:\Program Files\Tor Browser\Browser\TorBrowser\Tor\tor.exe -nt-service"
.. tip:: If you get the error "Access denied," please ensure you are running the command prompt in Administrator mode. You can tell because the prompt will show C:\\Users\\YOUR-USERNAME> if you are NOT in admin mode, and it will show C:\\WINDOWS\\system32 if you ARE in admin mode.
.. code-block::
sc start tor
#. When you run this, it should look something like this:
.. figure:: /_static/images/tor/tor_windows_terminal.png
:width: 80%
:alt: Tor windows terminal
.. note:: If you get the error "The specified service already exists," complete the following steps:
1. Run the command:
.. code-block::
sc delete tor
2. Uninstall the Tor Browser, following `these steps <https://tb-manual.torproject.org/uninstalling/>`_.
3. Begin this guide again from the beginning.
#. That's it! Your Windows computer is now setup to natively use Tor.

10
site/source/user-manual/device-guides/dg-android.rst
View File

@@ -1,10 +0,0 @@
.. _dg-android:
=======
Android
=======
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
* :ref:`lan-android` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-android` - Run Tor natively (in the background) on your Android device. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
* :ref:`torff-android` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.

9
site/source/user-manual/device-guides/dg-ios.rst
View File

@@ -1,9 +0,0 @@
.. _dg-ios:
===
iOS
===
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
* :ref:`lan-ios` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-ios` - Run Tor natively (in the background) on your iOS device. This will allow you to use applications on your device via the Tor Network so they can communicate with your Start9 server.

11
site/source/user-manual/device-guides/dg-linux.rst
View File

@@ -1,11 +0,0 @@
.. _dg-linux:
=====
Linux
=====
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
* :ref:`lan-linux` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-linux` - Run Tor natively (in the background) on your Linux machine. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
* :ref:`torff-linux` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
* :ref:`backup-linux` - Configure a Network Folder on your Linux machine (or an attached external drive) for StartOS backups.

71
site/source/user-manual/device-guides/dg-mac.rst
View File

@@ -1,71 +0,0 @@
.. _dg-mac:
===
Mac
===
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
* :ref:`lan-mac` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-mac` - Run Tor natively (in the background) on your Mac. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
* :ref:`torff-mac` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
* :ref:`backup-mac` - Configure a Network Folder on your Mac (or an attached external drive) for StartOS backups.
Screensharing
-------------
You may run into an issue and want to have a support call where we ask you to share your screen with us. While we understand if you'd rather not do this, it can make troubleshooting issues a lot easier. We will send you a Jitsi link and from there you can share your screen. If it doesn't work, please see the following instructions:
.. tabs::
.. group-tab:: Pre-Ventura:
#. Head to System Preferences:
.. figure:: /_static/images/mac-stuff/system-prefs.png
:width: 20%
#. Click Security & Privacy:
.. figure:: /_static/images/mac-stuff/priv-security.png
:width: 20%
#. Click the lock to make changes and select "Privacy":
.. figure:: /_static/images/mac-stuff/click-lock.png
:width: 20%
#. Click "Screen Recording" and click the + icon:
.. figure:: /_static/images/mac-stuff/screen-rec-plus.png
:width: 20%
#. Find your browser within the applications folder and click "Open":
.. figure:: /_static/images/mac-stuff/add-browser-screen-rec.png
:width: 20%
#. Restart your browser and you should now be able to share your screen by clicking on this button within the Jitsi call:
.. figure:: /_static/images/mac-stuff/jitsi-screenshare.png
:width: 20%
.. group-tab:: Ventura:
#. Head to System Settings and scroll down to "Privacy & Security":
.. figure:: /_static/images/mac-stuff/system-settings-priv-sec.png
:width: 20%
#. Scroll down and click "Screen Recording":
.. figure:: /_static/images/mac-stuff/screen-rec-vent.png
:width: 20%
#. You can then click the + icon and add your browser - you may need to restart your browser after this:
.. figure:: /_static/images/mac-stuff/screen-rec-plus-vent.png
:width: 20%
#. You should now be able to share your screen by clicking on this button within the Jitsi call:
.. figure:: /_static/images/mac-stuff/jitsi-screenshare.png
:width: 20%

11
site/source/user-manual/device-guides/dg-windows.rst
View File

@@ -1,11 +0,0 @@
.. _dg-windows:
=======
Windows
=======
To optimize your device for use with your Start9 server, it is recommended to complete all of the following guides.
* :ref:`lan-windows` - Trust your Start9 server's Root Certificate Authority in order to securely connect over LAN.
* :ref:`tor-windows` - Run Tor natively (in the background) on your Windows computer. This will allow you to use applications on your machine via the Tor Network so they can communicate with your Start9 server.
* :ref:`torff-windows` - Configure Firefox to use the Tor Network so that you can reach ".onion" sites without needing to change browsers.
* :ref:`backup-windows` - Configure a Network Folder on your Windows computer (or an attached external drive) for StartOS backups.

15
site/source/user-manual/device-guides/index.rst
View File

@@ -1,15 +0,0 @@
.. _device-guides:
=============
Device Guides
=============
Guides for integrating your client devices with your Start9 server.
.. toctree::
:maxdepth: 3
dg-linux
dg-mac
dg-windows
dg-android
dg-ios

56
site/source/user-manual/flashing/flashing-firmware.rst
View File

@@ -1,56 +0,0 @@
.. _flashing-firmware:
===================
Flashing (Firmware)
===================
This page is for existing Librem Mini owners ONLY. This will add StartOS-specific tweaks to your system, such that it will operate just as a Start9 Pure bought from the `Start9 Store <https://store.start9.com/products/server-pro>`_.
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_.
#. `Download the firmware from Purism's git repository <https://source.puri.sm/firmware/releases/-/raw/master/librem_mini_v2/custom/pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-26.rom.gz>`_ and extract it. You'll need a USB flash drive, formatted FAT32.
.. warning:: USB drive **must** be formatted for FAT32
#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-26.rom`` file onto your USB drive, then eject the drive and insert it into your (powered down) Librem Mini. USB 3.0 (blue ports) are faster.
.. note:: You'll need a monitor and keyboard plugged into your Librem Mini for this operation
#. Turn on the Librem Mini while pressing the ``ESC`` key on the keyboard repeatedly while you see this screen:
.. figure:: /_static/images/flashing/flash_firmware-pro-step0-pureboot_screen.jpg
:width: 30%
#. The PureBoot Basic Boot Menu screen will appear. Select "Options -->"
.. figure:: /_static/images/flashing/flash_firmware-pro-step1-pureboot_basic_boot_menu-options.jpg
:width: 30%
#. Select "Flash/Update the BIOS"
.. figure:: /_static/images/flashing/flash_firmware-pro-step2-flash_update_the_bios.jpg
:width: 30%
#. Select "Flash the firmware with a new ROM, erase settings"
.. figure:: /_static/images/flashing/flash_firmware-pro-step3-flash_firmware_with_new_rom.jpg
:width: 30%
#. The system will ask if you want to proceed flashing the BIOS with a new ROM, select "Yes"
.. figure:: /_static/images/flashing/flash_firmware-pro-step4-proceed_yes.jpg
:width: 30%
#. Choose the file that we downloaded and copied to the USB stick earlier: ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-26.rom``
.. figure:: /_static/images/flashing/flash_firmware-pro-step5-select_your_file.jpg
:width: 30%
#. Confirm you want to proceed with the flash by selecting "Yes"
.. figure:: /_static/images/flashing/flash_firmware-pro-step6-proceed_yes.jpg
:width: 30%
#. The BIOS will be reflashed with the new firmware. This may take a few minutes. When complete, remove the firmware USB (and insert your StartOS USB if you are ready to install), then select "OK" to complete the process.
.. figure:: /_static/images/flashing/flash_firmware-pro-step7-flashed_successfully.jpg
:width: 30%

73
site/source/user-manual/flashing/flashing-pi.rst
View File

@@ -1,73 +0,0 @@
.. _flashing-pi:
=======================
Flashing (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 <https://start9.com/contact>`_ if you need to re-install your OS on a Server Lite (SD card storage).
.. warning:: DO NOT DO THIS UNLESS YOU HAVE AN EXTERNAL SSD. If you are running in a "Lite" configuration (everything on an SD card), then flashing in the manner proscribed below WILL ERASE ALL YOUR DATA! Contact support for assistance instead.
Getting StartOS
---------------
Visit the `Github release page <https://github.com/Start9Labs/start-os/releases/latest>`_ to find the latest StartOS release.
At the bottom of the page, under "Assets," download the ``startos-..._raspberrypi.img.gz`` file.
.. figure:: /_static/images/flashing/raspi-asset.png
:width: 60%
:alt: Raspberry Pi Asset
Select your OS to continue:
.. tabs::
.. group-tab:: Linux
(Optional, but recommended) Verify the checksum against the one listed on GitHub (SHA256):
.. code-block::
sha256sum startos-0.3.4.2-efc56c0-20230525_raspberrypi.img.gz
.. group-tab:: Mac
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a terminal and entering:
.. code-block::
openssl dgst -sha256 startos-0.3.4.2-efc56c0-20230525_raspberrypi.img.gz
.. group-tab:: Windows
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening Windows PowerShell, changing your directory to where you downloaded the .img.gz file, and running `Get-FileHash`:
.. code-block::
cd Downloads
Get-FileHash startos-0.3.4.2-efc56c0-20230525_raspberrypi.img.gz
Installing StartOS
------------------
Once you have the StartOS ``.img.gz`` file, you will need to flash it onto a microSD card.
#. Download and install `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Linux, Mac, or Windows computer.
#. Insert the microSD card into your computer, either directly or using an adapter.
#. Open balenaEtcher.
.. figure:: /_static/images/diy/balena.png
:width: 60%
:alt: Balena Etcher Dashboard
#. Click "Select Image" and select the ``.img.gz`` file.
#. Click "Select Target" and select your microSD card.
.. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target microSD card. Whatever drive you select will be **COMPLETELY ERASED**!!
#. Click "Flash!". You may be asked to approve the unusually large disk target and/or enter your password. Both are normal.
#. After the flash completes, you may remove the newly flashed micro SD card from any adapter, and insert it into your server's SD card slot.
#. Finally, continue to the :ref:`Initial Setup <initial-setup>`, :ref:`Manual Update <manual-update>`, or :ref:`Reset Password <reset-password>` instructions - depending on your need.

78
site/source/user-manual/flashing/flashing-x86.rst
View File

@@ -1,78 +0,0 @@
.. _flashing-x86:
=================
Flashing (x86_64)
=================
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 <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-startos/>`_.
.. note:: You will need a USB drive of at least 8GB in size
Getting StartOS
---------------
Visit the `Github release page <https://github.com/Start9Labs/start-os/releases/latest>`_ to find the latest StartOS release.
At the bottom of the page, under "Assets," download the ``x86_64.iso`` or ``x86_64-nonfree.iso`` file. The former image contains no proprietary software (built for the Server Pure). As the title implies, the latter, ``nonfree`` image, contains non-free (closed-source) software. This may be required for your hardware, especially for graphics and/or wireless device support.
.. figure:: /_static/images/flashing/x86_64-asset.png
:width: 60%
Select your OS to continue:
.. tabs::
.. group-tab:: Linux
(Optional, but recommended) Verify the checksum against the one listed on GitHub (SHA256):
.. code-block::
sha256sum startos-0.3.4.2-efc56c0-20230525_x86_64.iso
.. group-tab:: Mac
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a terminal and entering:
.. code-block::
openssl dgst -sha256 startos-0.3.4.2-efc56c0-20230525_x86_64.iso
.. group-tab:: Windows
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening Windows PowerShell, changing your directory to where you downloaded the .img.gz file, and running `Get-FileHash`:
.. code-block::
cd Downloads
Get-FileHash startos-0.3.4.2-efc56c0-20230525_x86_64.iso
Installing StartOS
------------------
Once you have the StartOS image, you will need to flash it onto your USB drive.
#. Download `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Linux, Mac, or Windows computer.
#. Insert your USB drive into your computer.
#. Open balenaEtcher.
.. figure:: /_static/images/diy/balena.png
:width: 60%
:alt: Balena Etcher Dashboard
#. Click "Select Image" and select the ``.iso`` file you just downloaded.
#. Click "Select Target" and select your USB drive, checking the size to make sure it's the correct drive.
.. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target flash drive. Whatever target you select will be **COMPLETELY ERASED**!!
#. Click "Flash!". You may be asked to approve the unusually large disk target and/or enter your password. Both are normal.
#. After this completes, you may remove the newly flashed drive from your computer, and insert it into the device you intend to install StartOS onto.
#. Plug the USB drive into the device and power on. Follow the on-screen instructions to Install StartOS (use "Re-Install" to preserve data, or "Factory Reset" to wipe the device). After install is complete, you will be prompted to remove your USB drive.
.. note:: Always perfer the fastest available USB 3.0+ port - typically this is blue or labeled "SS" (SuperSpeed)
.. tip:: Occasionally, you may need to make some changes in your BIOS, such as turning off Secure Boot, or allowing USB boot for install. See the `Community Hub <https://community.start9.com>`_ for guides or to get help.
#. Finally, continue to the :ref:`Initial Setup <initial-setup>`, :ref:`Manual Update <manual-update>`, or :ref:`Reset Password <reset-password>` instructions - depending on your need.

50
site/source/user-manual/flashing/index.rst
View File

@@ -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
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. 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 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.

37
site/source/user-manual/getting-started/index.rst Normal file
View File

@@ -0,0 +1,37 @@
.. _getting-started:
===============
Getting Started
===============
Welcome to Sovereign Computing! Follow the 2 guides below to get up and running with your personal server.
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Initial Setup
:link: initial-setup
:icon: scylla-icon scylla-icon--home
:class: large-4
:anchor: Start
Plug in, turn on, opt out
.. topic-box::
:title: Trust Root CA
:link: trust-ca
:icon: scylla-icon scylla-icon--testing
:class: large-4
:anchor: Setup
Securely integrate your clients
.. toctree::
:hidden:
:maxdepth: 2
initial-setup
trust-ca

74
site/source/user-manual/initial-setup.rst → site/source/user-manual/getting-started/initial-setup.rst
View File

@@ -43,7 +43,7 @@ Power On
#. Select "Start Fresh."
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60%
:width: 50%
:alt: Fresh Setup
.. note:: The "Recover" button is used for :ref:`hardware upgrades <upgrade-hardware>`, :ref:`restoring from backup <backup-restore>`, data migration, or disaster recovery.
@@ -51,7 +51,7 @@ Power On
#. Select your storage drive
.. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60%
:width: 50%
:alt: Select Drive
#. Create a master password for your server and click "Finish."
@@ -59,13 +59,13 @@ Power On
.. warning:: Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT.
.. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60%
:width: 50%
:alt: Create New Password
#. StartOS will initialize. This can take up to a few minutes.
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
:width: 50%
:alt: SSD Initialization
#. You are now hosting your own private server!
@@ -73,13 +73,13 @@ Power On
.. tip:: If you are in headless mode, click "Download This Page" to save your server address and certificate info to your computer.
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 60%
:width: 50%
:alt: Setup Complete
#. You may now log in. Continue to the section on :ref:`connecting<connecting>` to learn more about using your server over Tor and LAN.
#. Next, you will need to :ref:`Trust Your Root CA<trust-ca>` on the device you are connecting from. This is required and your server will not work properly with another device until complete.
.. figure:: /_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg
:width: 60%
:width: 50%
:alt: Setup Complete
.. _setup-troubleshooting:
@@ -88,10 +88,7 @@ Troubleshooting
---------------
If you are experiencing issues with setup, try the following:
#. Confirm that the server is plugged into both power and Ethernet
- An ethernet network with DHCP server must be available at setup. Most routers provide this.
#. Confirm that the server is plugged into both power and Ethernet
#. Confirm your phone/computer is **not** connected to a "Guest" network
#. Confirm your phone/computer is not using a VPN, or that if you are, that it allows LAN connections, such as the examples below:
@@ -106,58 +103,3 @@ If you are experiencing issues with setup, try the following:
- Once in the router config settings, find the section that lists the devices on your network. You should see a device labeled ``start``. Take note of the associated IP address and enter it into your browser's URL field to enter the setup.
You can always to `reach out to support <https://start9.com/contact>`_ if you need a hand.
Server Models With Speakers
---------------------------
.. _sounds-bepchime:
Server Lite, Server Pure, and Server One (2022 and older) have an internal speaker and may provide the following audio feedback:
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/BEP.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* "bep" - Starting up
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/CHIME.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* "chime" - Server is ready
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/FLATLINE.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* "flatline" - Server initialization failed / no network connection
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* Beethoven's 5th - Something has gone wrong and Diagnostic Mode has been launched on ``http://start.local``, please check here for solutions.
Raspberry Pi Lights
-------------------
Server Lite has 2 status lights:
- Red - Power. This will be on solid when powered up and running normally.
- Green - SD Card. This will display when there is SD Card activity, such as during OS installation. It may be off, flashing, or on solid during normal operation.
Server One (2022) has 2 additional lights:
- Blue power button - Power. This will be on solid when powered up and running normally.
- Blue drive light - SSD. This will display when there is SSD activity. It may be off, flashing, or on solid during normal operation.

59
site/source/user-manual/getting-started/trust-ca.rst Normal file
View File

@@ -0,0 +1,59 @@
.. _trust-ca:
=============
Trust Root CA
=============
Trust your server's Root CA to achieve encrypted communications on LAN, access services on LAN, and enhance connection speeds over Tor. Select the OS of the device you are accessing your server with:
.. caution:: This is a required step, and you server will not work properly until it is complete
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Linux
:link: ../../../guides/device-guides/dg-linux/lan-linux
:icon: scylla-icon scylla-icon--linux
:class: large-4
:anchor: Connect
Integrate Linux devices
.. topic-box::
:title: Mac
:link: ../../../guides/device-guides/dg-mac/lan-mac
:icon: scylla-icon scylla-icon--apple
:class: large-4
:anchor: Connect
Integrate Mac devices
.. topic-box::
:title: Windows
:link: ../../../guides/device-guides/dg-windows/lan-windows
:icon: scylla-icon scylla-icon--windows
:class: large-4
:anchor: Connect
Integrate Windows devices
.. topic-box::
:title: Android
:link: ../../../guides/device-guides/dg-android/lan-android
:icon: scylla-icon scylla-icon--android
:class: large-4
:anchor: Connect
Integrate Android devices
.. topic-box::
:title: iOS
:link: ../../../guides/device-guides/dg-ios/lan-ios
:icon: scylla-icon scylla-icon--ios
:class: large-4
:anchor: Connect
Integrate iOS devices

45
site/source/user-manual/index.rst
View File

@@ -3,26 +3,35 @@
===========
User Manual
===========
Welcome to the StartOS user manual. Here you will discover all that your server can do!
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Getting Started
:link: getting-started
:icon: scylla-icon scylla-icon--getting-started
:class: large-4
:anchor: Begin
Get started with your Start9 server
.. topic-box::
:title: StartOS Overview
:link: overview
:icon: scylla-icon scylla-icon--roadmap
:class: large-4
:anchor: Explore
Get the lay of the sovereign land
.. toctree::
:includehidden:
:hidden:
:maxdepth: 2
initial-setup
connecting/index
dashboard-overview
updating
backups/index
flashing/index
reset-password
customize
managing-services
service-guides/index
sessions
wifi
ssh
alt-registries
device-guides/index
upgrade-hardware/index
getting-started/index
overview/index

6
site/source/user-manual/alt-registries.rst → site/source/user-manual/overview/alt-registries.rst
View File

@@ -1,8 +1,8 @@
.. _alt-registries:
======================
Alternative Registries
======================
===========================
Managing Service Registries
===========================
It is critical to Start9's mission that Start9 is **not** a central point of failure. Software distribution is critical infrastructure and therefore the Start9 Marketplace supports adding and accessing of custom registries for maximum resiliency and decentralization.
The most basic method Start9 has made available is the ability to use and distribute packages in their ``.s9pk`` form, which can be simply hosted as a file anywhere you'd like, even on your Start9 server (see below)! Start9 has also built open source tools for the Marketplace UI, to keep the community in maximum control with minimal inconvenience.

0
site/source/user-manual/backups/backup-advanced.rst → site/source/user-manual/overview/backup-restore/backup-advanced.rst
View File

25
site/source/user-manual/backups/backup-create.rst → site/source/user-manual/overview/backup-restore/backup-create.rst
View File

@@ -3,35 +3,34 @@
======
Backup
======
Backing up your server is easy and secure. Backups are encrypted with your master password.
.. contents::
:depth: 2
:local:
Backing up your server is easy and secure. Backups are encrypted with your master password.
.. warning:: Create frequent backups to avoid loss of data!
.. tip:: Create frequent backups to keep your data safe!
Setup Device
------------
Select your platform for detailed instructions on how to create a Network Folder for creating backups. This can include a drive in, or attached to, a device on your network. Otherwise, you may backup directly to a :ref:`physical drive<backup-physical>`, attached to your server.
Select your platform for detailed instructions on how to create a Network Folder for creating backups (recommended). Otherwise, you may backup to a physical drive, attached in addition to your main server's SSD.
* :ref:`Linux Network Folder <backup-linux>`
.. toctree::
:maxdepth: 1
* :ref:`Mac Network Folder <backup-mac>`
Linux Network Folder <backup-setup/backup-linux>
Mac Network Folder <backup-setup/backup-mac>
Windows Network Folder <backup-setup/backup-windows>
Synology Network Folder <backup-setup/backup-synology>
TrueNAS Network Folder <backup-setup/backup-truenas>
Physical Drive <backup-setup/backup-physical>
* :ref:`Windows Network Folder <backup-windows>`
* :ref:`Synology Network Folder <backup-synology>`
* :ref:`TrueNAS Network Folder <backup-truenas>`
* :ref:`Physical Drive <backup-physical>`
.. _backup-create:
Create Backup
-------------
#. Go to *System > Create Backup*
.. figure:: /_static/images/config/backup.png

7
site/source/user-manual/backups/backup-setup/backup-physical.rst → site/source/user-manual/overview/backup-restore/backup-physical.rst
View File

@@ -3,15 +3,14 @@
========================
Backup to Physical Drive
========================
.. warning:: Create frequent backups to avoid loss of data!
.. tip:: Create frequent backups to avoid loss of data!
.. youtube:: KJRO9wGOOVw
:width: 100%
The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder<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.
The recommended method of backup (including with external drives) is to setup a :ref:`Network Folder<backup>` via your OS. However, you may use an external drive plugged directly into your server.
.. warning:: If you still choose to plug into your Start9 server, this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One (NASPi Geekworm case with built-in power management) and Server Pro users can safely ignore this warning.
.. warning:: If you are using a low-powered device (like a RasPi), this drive MUST have external power, or be connected via a powered USB hub in order to prevent any data corruption due to power constraints! Server One and Server Pure users can safely ignore this warning.
#. Ensure your backup drive is properly formatted. The recommended format at this time is ``exFAT``. **Do not** use ``fat32``.

0
site/source/user-manual/backups/backup-restore.rst → site/source/user-manual/overview/backup-restore/backup-restore.rst
View File

0
site/source/user-manual/backups/backup-setup/backup-synology.rst → site/source/user-manual/overview/backup-restore/backup-synology.rst
View File

0
site/source/user-manual/backups/backup-setup/backup-truenas.rst → site/source/user-manual/overview/backup-restore/backup-truenas.rst
View File

3
site/source/user-manual/backups/index.rst → site/source/user-manual/overview/backup-restore/index.rst
View File

@@ -48,4 +48,7 @@ In addition to the safe-keeping of a good master password, maintaining good back
backup-create
backup-restore
backup-physical
backup-synology
backup-truenas
backup-advanced

33
site/source/user-manual/overview/change-password.rst Normal file
View File

@@ -0,0 +1,33 @@
.. _change-password:
===============
Password Change
===============
This guide is for changing your password from the web-UI. If you forgot your password and want to reset it, see the :ref:`reset password guide<reset-password>`.
#. Login to the web-UI and navigate to System > Change Master Password
.. figure:: /_static/images/config/password_change_ui-1.png
:width: 60%
#. A warning will be displayed. Select `CONTINUE`.
.. figure:: /_static/images/config/password_change_ui-2.png
:width: 60%
#. Fill out the Change Master Password form by entering
a. Your current password
b. Your desired new password
c. Retype your new password
d. Click `Save`
.. figure:: /_static/images/config/password_change_ui-3.png
:width: 60%
#. You will see a notice pop up near the bottom of the screen informing you that you've successfully changed your password:
.. figure:: /_static/images/config/password_change_ui-4.png
:width: 60%

11
site/source/user-manual/overview/connecting/connecting-ff.rst Normal file
View File

@@ -0,0 +1,11 @@
.. _connecting-ff:
=====================
Firefox Configuration
=====================
Select your OS below to configure Firefox for encrypted sessions and Tor compatability. See our :ref:`Device Guides<device-guides>` section for all your client's setup guides.
:ref:`Linux<ff-linux>`
:ref:`Mac<ff-mac>`
:ref:`Windows<ff-windows>`
:ref:`Android<ff-android>`

60
site/source/user-manual/overview/connecting/connecting-lan.rst Normal file
View File

@@ -0,0 +1,60 @@
.. _connecting-lan:
===============
LAN Connections
===============
Whenever you are connected to the same Local Area Network (LAN) as your Start9 server, it is best to access your Start9 server's LAN Address (.local URL). LAN connections are fast and secure and do not even require Internet access!
Select your OS below to connect via LAN. See our :ref:`Device Guides<device-guides>` section for all your client's setup guides.
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Linux
:link: ../../../../guides/device-guides/dg-linux/lan-linux
:icon: scylla-icon scylla-icon--linux
:class: large-4
:anchor: Connect
Integrate Linux devices
.. topic-box::
:title: Mac
:link: ../../../../guides/device-guides/dg-mac/lan-mac
:icon: scylla-icon scylla-icon--apple
:class: large-4
:anchor: Connect
Integrate Mac devices
.. topic-box::
:title: Windows
:link: ../../../../guides/device-guides/dg-windows/lan-windows
:icon: scylla-icon scylla-icon--windows
:class: large-4
:anchor: Connect
Integrate Windows devices
.. topic-box::
:title: Android
:link: ../../../../guides/device-guides/dg-android/lan-android
:icon: scylla-icon scylla-icon--android
:class: large-4
:anchor: Connect
Integrate Android devices
.. topic-box::
:title: iOS
:link: ../../../../guides/device-guides/dg-ios/lan-ios
:icon: scylla-icon scylla-icon--ios
:class: large-4
:anchor: Connect
Integrate iOS devices

32
site/source/user-manual/overview/connecting/connecting-tor.rst Normal file
View File

@@ -0,0 +1,32 @@
.. _connecting-tor:
===============
Tor Connections
===============
You can connect to your Start9 server from anywhere in the world, privately and anonymously, by using its unique Tor Address (``.onion`` URL).
.. note:: Tor connections can sometimes be unreliable and have higher latency than normal internet connections.
Select your OS below to connect via Tor. See our :ref:`Device Guides<device-guides>` section for all your client's setup guides.
:ref:`Linux<tor-linux>`
:ref:`Mac<tor-mac>`
:ref:`Windows<tor-windows>`
:ref:`Android<tor-android>`
:ref:`iOS<tor-ios>`
Using TorBrowser
-------------------
.. caution:: Tor Browser will allow you to use your Start9 server's ``.onion`` URL without any manual configuration, however *all* connections are proxied via Tor, so you will not be able to access your Start9 server's ``.local`` LAN address with it. `Using Firefox <#using-firefox>`_ is recommended over TorBrowser.
* Linux, Mac, Windows, Android
* `Tor Browser <https://torproject.org/download/>`_
* iOS
* iOS lacks a well-functioning Tor Browser. Use :ref:`Firefox<tor-ios>`.

11
site/source/user-manual/connecting/index.rst → site/source/user-manual/overview/connecting/index.rst
View File

@@ -1,8 +1,8 @@
.. _connecting:
==========
Connecting
==========
===================
Network Connections
===================
.. raw:: html
@@ -36,5 +36,6 @@ Connecting
:maxdepth: 2
:hidden:
Lan <connecting-lan/index>
Tor <connecting-tor/index>
connecting-lan
connecting-tor
connecting-ff

0
site/source/user-manual/customize.rst → site/source/user-manual/overview/customize.rst
View File

6
site/source/user-manual/dashboard-overview.rst → site/source/user-manual/overview/dashboard-overview.rst
View File

@@ -1,8 +1,8 @@
.. _dashboard-overview:
==================
Dashboard Overview
==================
=========
Dashboard
=========
.. contents::
:depth: 2

22
site/source/user-manual/overview/index.rst Normal file
View File

@@ -0,0 +1,22 @@
.. _overview:
================
StartOS Overview
================
Welcome to StartOS! Get familiar with your server by discovering all the available features.
.. toctree::
:includehidden:
:maxdepth: 1
dashboard-overview
change-password
managing-services
backup-restore/index
customize
updating
connecting/index
sessions
ssh
wifi
alt-registries

0
site/source/user-manual/managing-services.rst → site/source/user-manual/overview/managing-services.rst
View File

0
site/source/user-manual/sessions.rst → site/source/user-manual/overview/sessions.rst
View File

0
site/source/user-manual/ssh.rst → site/source/user-manual/overview/ssh.rst
View File

0
site/source/user-manual/updating.rst → site/source/user-manual/overview/updating.rst
View File

0
site/source/user-manual/wifi.rst → site/source/user-manual/overview/wifi.rst
View File

48
site/source/user-manual/reset-password.rst
View File

@@ -1,48 +0,0 @@
.. _reset-password:
===================
Reset Your Password
===================
.. contents::
:depth: 2
:local:
#. Download and flash the latest version of StartOS, using the appropriate :ref:`flashing guide <flashing>` for your hardware.
#. Plug the flashed drive into a USB port (preferably USB3 - blue in color). Power on your server, ensuring it is plugged in to Ethernet.
.. note:: Server will power up and then initialize. If you have a speaker, you will hear first hear a _bep_ then a _chime_ sound to indicate the device is ready.
#. Using a phone or computer connected to the same network, open up a browser and go to http://start.local. Follow the directions to "Re-install OS, preserving data". Follow the prompts after removing the drive and rebooting, visit http://start.local again.
#. Select "Recover".
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
:width: 60%
#. Select "Use Existing Drive".
.. figure:: /_static/images/setup/screen3-use_existing.png
:width: 60%
#. Select your server's data drive.
.. figure:: /_static/images/setup/screen4-use_existing_drive_selection.png
:width: 60%
#. Enter and confirm a new password. This time, save it somewhere safe!
.. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60%
#. Your server will initialize again (all previous data will be recovered).
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. Your password change is complete!
.. tip:: The "Go to Emassy Login" button will not be usable until you click download. The address information and root certificate contained in this download will not have changed from what you were using before this whole process so if you do not require it you can close this tab and simply go to your server's Lan or Tor address.
.. figure:: /_static/images/setup/setup_complete_pre_download.png
:width: 60%

26
site/source/user-manual/service-guides/bitcoin/bitcoin-cli.rst
View File

@@ -1,26 +0,0 @@
.. _bitcoin-cli:
===========
Bitcoin CLI
===========
Instructions for accessing the bitcoind service in order to issue commands directly.
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
#. First, you will need SSH access. Please see the :ref:`setup instructions <ssh>` for details.
#. Access your server and then you can interact with the bitcoind docker container using the following syntax:
.. code-block:: bash
sudo docker exec -ti bitcoind.embassy bitcoin-cli COMMAND
.. tip:: For example ``sudo docker exec -ti bitcoind.embassy bitcoin-cli getnetworkinfo``
A list of possible commands can be found `here <https://developer.bitcoin.org/reference/rpc/>`__.
You can also drop into a shell using::
sudo docker exec -ti bitcoind.embassy bash
and then enter ``bitcoin-cli`` commands. When you are finished, simply type ``exit``...

176
site/source/user-manual/service-guides/bitcoin/bitcoin-integrations.rst
View File

@@ -1,176 +0,0 @@
.. _bitcoin-integrations:
====================
Bitcoin Integrations
====================
.. contents::
:depth: 2
:local:
Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your server's node, to complete your sovereign Bitcoin stack!
.. _blockstream-green:
Blockstream Green
-----------------
**Available For**
- Android
- iOS
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/blockstreamgreen/guide.md>`__.
.. _blue-wallet-bitcoin:
BlueWallet
----------
**Available For**
- Android
- iOS
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/bluewallet/guide.md>`__.
.. _electrum:
Electrum
--------
**Available For**
- Android
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/electrum/guide.md>`__.
.. _fully-noded:
FullyNoded
----------
**Available For**
- iOS
- macOS
**Instructions**
#. In Fully Noded, go to `Settings > Node Manager > +`
#. Enter your Bitcoin Core credentials. You can do this in one of two ways:
(A) Use Fully Noded to scan your QuickConnect QR code (located in `Services > Bitcoin Core > properties`); or
(B) copy/paste your Bitcoin Core Tor Address (located in `Services > Bitcoin Core > Interfaces`) with :8332 appended, as well as you rpc username and password (located in `Services > Bitcoin Core > Config > RPC Settings`).
.. _ledger-live:
.. Ledger Live
.. ===========
.. .. tip:: Built for use with Ledger hardware devices
.. .. warning:: UNTESTED
.. _nunchuk:
Nunchuk
-------
**Available For**
- Android
- iOS
- Linux
- macOS
- Windows
**Instructions**
#. Install the `Electrs` service from the Start9 Marketplace
#. Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/nunchuk/guide.md>`__.
.. _samourai:
Samourai
--------
.. note:: Not Possible at this time - Requires Dojo Stack
.. _sparrow:
Sparrow
-------
**Available For**
- Linux
- macOS
- Windows
**Instructions**
Connect Sparrow directly to your `Bitcoin Core`:
* Follow this `guide <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
**CAUTION** Until we get per-user rpc restrictions built into Bitcoin Core, this is technically more dangerous than using the electrum server method, because it requires createwallet and similar RPC calls. However, exploiting it relies on there being a vulnerability in Bitcoin Core. Likely there isn't, but if this makes you uneasy, please use the electrs method below.
**OPTIONAL** (but less reliable) -- Connect Sparrow to Electrs via Tor:
#. Install the `Electrs` service from the Start9 Marketplace
#. Follow this `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
.. _specter-wallet:
Specter
-------
**Available For**
- Linux
- macOS
- StartOS
- Windows
**Instructions**
Follow the guide for `macOS <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/macos.md>`__ or `Windows <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/windows.md>`__.
.. _trezor-suite:
Trezor Suite
------------
.. tip:: Built for use with Trezor hardware devices
**Available For**
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/trezor/guide.md>`__.

60
site/source/user-manual/service-guides/bitcoin/blockchain-copy.rst
View File

@@ -1,60 +0,0 @@
.. _blockchain-copy:
====================
Blockchain Migration
====================
.. contents::
:depth: 2
:local:
.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
If you have already synced the Bitcoin blockchain to the tip on one server, and would like to skip IBD on another server, follow this guide.
.. note:: The following guide requires that you have already :ref:`setup SSH on both Start9 servers<ssh>`.
In this guide, we will refer to your synced server as example-aaa.local and the server with no Bitcoin synced as example-bbb.local. Of course, please replace example-aaa and example-bbb with your corresponding Start9 servers' unique `adjective-noun` names.
**Install but don't start Bitcoin Core on the blockchain-less server**
#. Log into `https://example-bbb.local` and install Bitcoin Core (**Marketplace > Bitcoin > Bitcoin Core > Install**). Do *NOT* yet **CONFIGURE** or **START** Bitcoin Core.
**Prep your server with the synced blockchain**
#. Stop the Bitcoin Core service on `https://example-aaa.local` (**Services > Bitcoin Core > Stop**)
#. :ref:`Open an ssh session <connecting-via-ssh>` to example-aaa.local
#. Once at the shell, perform the following commands
.. code-block:: bash
sudo -i
mkdir -m 0700 -p .ssh
ssh-keygen -t ed25519 -N '' -f .ssh/example-bbb.key
chmod 600 .ssh/example-bbb.key*
cat .ssh/example-bbb.key.pub
#. Copy the output from the cat command into example-bbb's **System > SSH > Add New Key** text field:
.. figure:: /_static/images/walkthrough/ssh_key_add.jpg
#. Back on the shell of example-aaa.local, do the following (don't forget to replace example-bbb in the rsync command below before you perform it):
.. code-block:: bash
cd /embassy-data/package-data/volumes/bitcoind/data/main/
rsync -e "ssh -i ~/.ssh/example-bbb.key" -povgr --append-verify --rsync-path="sudo mkdir -p /embassy-data/package-data/volumes/bitcoind/data/main ; sudo rsync" ./{blocks,chainstate} start9@example-bbb.local:/embassy-data/package-data/volumes/bitcoind/data/main/
#. Wait some hours until the copy is complete. On a gigabit network, the limiting factor will be the write speed of your SSD on the receiving server. When it is complete, clean up a bit:
.. code-block:: bash
rm .ssh/example-bbb.key*
exit
#. Switch back to `https://example-bbb.local`, selecting **Services > Bitcoin Core**, **CONFIGURE**, configure it as desired, **SAVE** and then **START** your Bitcoin Core service. You should see it begin at 99%+ pre-synced.
#. You can now restart your Bitcoin Core service on `https://example-aaa.local` via **Services > Bitcoin Core > Start**.
.. _bitcoin-service:

14
site/source/user-manual/service-guides/bitcoin/index.rst
View File

@@ -1,14 +0,0 @@
.. _bitcoin-service:
=======
Bitcoin
=======
These guides will help you to setup external tools to connect or interact with :ref:`Bitcoin<bitcoin>`, such as a wallet.
.. toctree::
:maxdepth: 1
bitcoin-integrations
bitcoin-cli
blockchain-copy

18
site/source/user-manual/service-guides/index.rst
View File

@@ -1,18 +0,0 @@
.. _service-guides:
==============
Service Guides
==============
These guides will help you to setup external tools to connect or interact with specific :ref:`Services<managing-services>`.
.. toctree::
:maxdepth: 2
bitcoin/index
jellyfin/index
lightning/index
matrix
nextcloud/index
specter/index
vaultwarden/index

16
site/source/user-manual/service-guides/jellyfin/index.rst
View File

@@ -1,16 +0,0 @@
.. _jellyfin-service:
========
Jellyfin
========
Jellyfin is a self-hosted media server capable of serving a variety of content such as movies, shows, music, books, and photos.
.. note:: Jellyfin is not configured to store media files; Instead the media files 'live' on service dependencies - Filebrowser and/or Nextcloud.
Follow the guide below to get the most out of your Jellyfin server.
.. toctree::
:maxdepth: 2
jellyfin-clients

60
site/source/user-manual/service-guides/jellyfin/jellyfin-clients.rst
View File

@@ -1,60 +0,0 @@
.. _jellyfin-clients:
================
Jellyfin Clients
================
.. contents::
:depth: 2
:local:
.. _jellyfin-webapp:
After setup has been completed per the Jellyfin Service instructions on your Server, there are many ways to connect to and use your Jellyfin server.
.. note:: While the Jellyfin server is accessable over tor for many clients, connecting over LAN via your Jellyfin ``.local`` URL is recommended for the best streaming experience.
Web Application
---------------
1. Launch the Jellyfin Web Application from the desired interface (``.local`` recommended). If you are having trouble connecting, make sure your browser and OS have been setup to connect to :ref:`LAN <connecting-lan>` or :ref:`Tor <connecting-tor>` depending on the interface you are trying to connect to.
Mobile Apps
-----------
Android
=======
Before proceeding, make sure your Android device has been setup to connect over :ref:`LAN <lan-android>`. If you are connecting over tor, you will need to :ref:`Setup Tor <tor-android>`.
1. Visit the app store of your choice and download the Jellyfin app.
2. Upon entering the app, you will be prompted for a host; paste the URL (``.local`` recommended) of your Jellyfin server in this field and you should see your media splash page. If you are getting connection errors, make sure you are connected to the same LAN and a VPN is not in use on your Android device.
iOS
===
Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN <lan-ios>`. If you are connecting over tor, you will need to :ref:`Setup Tor <tor-ios>`.
1. Open the Apple app store and download the Jellyfin app.
2. Upon entering the app, you will be prompted for a host; paste the URL (``.local`` recommended) of your Jellyfin server in this field and you should see your media splash page. If you are getting connection errors, make sure you are connected to the same LAN and a VPN is not in use on your Apple device.
Desktop Apps
------------
MacOS
=====
Before proceeding, make sure your Apple device has been setup to connect over :ref:`LAN <lan-mac>`.
1. Download the .dmg file for `Jellyfin Media Player <https://github.com/jellyfin/jellyfin-media-player/releases>`_
2. Upon entering the app, you will be prompted for a host; paste the ``.local`` URL (``.onion`` is not supported) of your Jellyfin server in this field and you should see your media splash page. If you are getting connection errors, make sure you are connected to the same LAN and a VPN is not in use on your Apple device.
Other Clients
-------------
Jellyfin has numerous other `clients <https://jellyfin.org/downloads/>`_, not all of which have been tested at the time of this writing. If you are able to test (successfully or unsucessfully) an app not documented in this guide, your feedback would be much appreciated.
.. note:: Some clients such as 'Jellyfin for Roku' and 'Swiftfin' (tvOS) are not configured to use Local DNS - as a result, these clients are unable to resolve private urls like ``.local``.

73
site/source/user-manual/service-guides/lightning/alby-cln.rst
View File

@@ -1,73 +0,0 @@
.. _alby-cln:
====
Alby
====
Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between Alby and your **Core Lightning** node.
If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
#. On the Alby welcome screen, select **Get Started**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Click **Start9** then **Core Lightning**.
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/lightning/alby-cln-0.png
:width: 50%
:alt: alby-cln-0
#. You will see the following fields to fill out:
.. figure:: /_static/images/lightning/alby-cln-empty.png
:width: 40%
:alt: alby-cln-empty
#. For "Host" this is your Peer Interface - find this at the top of **Interfaces** within the CLN service on your Start9 server. Copy the address shown here but remove the *http://* at the start and paste it into **Host** within Alby:
.. figure:: /_static/images/lightning/cln-peer-interface.png
:width: 40%
:alt: cln-peer-interface
#. For **Public key** enter your **Node Id** found at the top of **Properties** within the CLN service on your server.
.. figure:: /_static/images/lightning/cln-nodeid.png
:width: 40%
:alt: cln-nodeid
#. For **Rune** you will need to install the `Spark <https://marketplace.start9.com/marketplace/spark-wallet>`_ service on your server, launch the UI, click in the bottom left where you see "v0.3.2" or something similar, and click **Console**.
.. figure:: /_static/images/lightning/enable-console-spark.png
:width: 40%
:alt: enable-console-spark
#. Enter "commando-rune", hit **execute** and then copy what you see after **rune:** and paste it into Alby.
.. figure:: /_static/images/lightning/commando-rune.png
:width: 40%
:alt: commando-rune
#. Leave the **Port** as 9735. It should look like this:
.. figure:: /_static/images/lightning/alby-cln-filled-out.png
:width: 40%
:alt: alby-cln-filled-out
#. Click **Continue**. Once the connection is completed you will see a success page that displays the balance of your CLN node in Sats.
.. figure:: /_static/images/lightning/alby-cln-success.png
:width: 40%
:alt: alby-cln-success
Alby is now connected to your CLN node over Tor!

109
site/source/user-manual/service-guides/lightning/alby-lnbits.rst
View File

@@ -1,109 +0,0 @@
.. _alby-lnbits:
Alby
----
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>`.
.. note:: This will work with either LND *or* CLN as your underlying node!
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<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
#. On the Alby welcome screen, select **Get Started**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Click **Start9** then **LNbits**:
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/services/lnbits/alby-lnbits-select.png
:width: 50%
:alt: alby-lnbits-select
#. You will be brought to this page:
.. figure:: /_static/images/services/lnbits/alby-lnbits-fields.png
:width: 40%
:alt: alby-lnbits-fields
#. Head back to LNbits and select the wallet you created then click on the arrow to the right of **API Info**:
.. figure:: /_static/images/services/lnbits/lnbits-api-dropdown.png
:width: 55%
:alt: api-info-dropdown
#. Copy the **Admin key** and paste it into Alby:
.. figure:: /_static/images/services/lnbits/lnbits-admin-key.png
:width: 50%
:alt: lnbits-admin-key
.. figure:: /_static/images/services/lnbits/alby-lnbits-admin-key.png
:width: 45%
:alt: alby-lnbits-admin-key
#. Head back to your Start9 server's LNbits service page and select **Interfaces**:
.. figure:: /_static/images/services/lnbits/lnbits-interfaces.png
:width: 55%
:alt: lnbits-interfaces
#. Copy the Tor Address:
.. figure:: /_static/images/services/lnbits/lnbits-interfaces-tor-address.png
:width: 65%
:alt: lnbits-interfaces-tor-address
#. Head back to Alby and paste what you just copied into **LNbits URL**, select **Tor (native)** then hit **Continue**:
.. figure:: /_static/images/services/lnbits/alby-lnbits-fields-complete.png
: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<connecting-tor>` on your system and that your browser is :ref:`configured to use Tor.<tor-firefox>`
#. Once connected you should see the following success page:
.. figure:: /_static/images/lightning/alby-cln-success.png
:width: 40%
:alt: alby-cln-success
Alby is now connected to your lightning node via LNbits!
#. You can now allocate sats to this wallet within LNbits by clicking the **+** icon here:
.. figure:: /_static/images/services/lnbits/lnbits-plus-icon-2.png
:width: 60%
:alt: plus-icon-2
Let's add 1000 satoshis:
.. figure:: /_static/images/services/lnbits/lnbits-1000-sats-2.png
:width: 40%
:alt: add-1000-sats
.. figure:: /_static/images/services/lnbits/lnbits-1000-sats-added-2.png
:width: 40%
:alt: sats-added
#. Alby should now show a balance:
.. figure:: /_static/images/services/lnbits/alby-lnbits-1000-sats.png
:width: 25%
:alt: alby-balance
#. You can also receive funds the normal way by hitting **Receive** within Alby.
.. figure:: /_static/images/services/lnbits/alby-receive.png
:width: 25%
:alt: alby-receive
.. note:: Funds received this way must be sent from another lightning node, not the node underneath LNbits. A lightning payment that originates and terminates at the same node is technically a rebalance, not a normal payment.
You're now setup with Alby and LNbits!

45
site/source/user-manual/service-guides/lightning/alby-lnc.rst
View File

@@ -1,45 +0,0 @@
.. _alby-lnc:
====
Alby
====
Alby is a browser extension that can be connected to your lightning node a number of ways.
This guide will go over **direct connections** between **Alby and LND** using **LNC**.
.. tip:: If you'd like to connect using LND's REST API see :ref:`here<alby-lnd>`. If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
.. note:: Requires the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service and only possible with LND nodes.
Available For:
- Chrome-based browsers
- Firefox
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
#. On the Alby welcome screen, select **Get Started**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Click on **Start9** then on **Lightning Terminal (LNC)**.
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/lightning/alby-start9-lnc.png
:width: 50%
:alt: alby-start9-lnc
#. You will see the following screen. Launch the Lightning Terminal service UI from your Start9 server and do as instructed below:
.. figure:: /_static/images/lightning/alby-lnc-fields.png
:width: 50%
:alt: alby-lnd-fields
#. Click **Continue** and you will see this once you successfully connect:
.. figure:: /_static/images/lightning/alby-success.png
:width: 50%
:alt: alby-success

49
site/source/user-manual/service-guides/lightning/alby-lnd.rst
View File

@@ -1,49 +0,0 @@
.. _alby-lnd:
====
Alby
====
Alby is a browser extension that can be connected to your lightning node a number of ways. This guide will go over direct connections between Alby and your **LND node**.
If you'd like to connect via `LNbits <https://marketplace.start9.com/marketplace/lnbits>`_ which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
.. note:: We are going to connect using Tor so that Alby will be able to connect from anywhere.
#. Make sure you are already :ref:`running Tor<connecting-tor>` on your system and we suggest using Firefox which must be :ref:`configured to use Tor.<tor-firefox>`
#. Download the Alby extension by visiting the `Alby Github <https://github.com/getAlby/lightning-browser-extension#installation>`_, selecting your browser, and installing.
#. On the Alby welcome screen, select **Get Started**.
#. Create a strong password and store it somewhere safe, like your Vaultwarden password manager.
#. On the next screen, select **Other Wallets** and click **Connect**.
#. Select **Start9** and then **LND**:
.. figure:: /_static/images/lightning/alby-start9.png
:width: 50%
:alt: alby-start9
.. figure:: /_static/images/lightning/alby-select-lnd.png
:width: 50%
:alt: alby-select-lnd
#. Copy the **LND Connect REST URL** from your LND service page's **Properties** section and paste it into Alby:
.. figure:: /_static/images/lightning/lnd-connect-rest-url.png
:width: 60%
:alt: lnd-connect-rest-url
#. Alby will pick up that you are connecting over Tor and suggest using their Companion App (only needed if your browser isn't setup to use Tor) or using Tor natively which you will be able to do. Select **TOR (native)** and click **Continue**:
.. figure:: /_static/images/lightning/alby-lnd-rest-entered.png
:width: 50%
:alt: alby-lnd-rest-entered
.. note:: If this does not work, please ensure that :ref:`Tor is running on your system<connecting-tor>` and that :ref:`Firefox is configured to use it.<tor-firefox>` 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.
.. figure:: /_static/images/lightning/alby-success.png
:width: 60%
You are now setup to use your LND node from anywhere using Alby!

137
site/source/user-manual/service-guides/lightning/bluewallet.rst
View File

@@ -1,137 +0,0 @@
.. _blue-wallet:
BlueWallet
----------
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>` with **LND** as your underlying node.
.. warning:: **This will not work with CLN as your underlying node!**
#. Bluewallet requires that we use the LnbHub extension in order to connect to LNbits.
#. To do this, click **Manage Extensions**:
.. figure:: /_static/images/services/lnbits/manage-extensions.png
:width: 50%
:alt: manage-extensions
#. Click **MANAGE** under the LndHub extension:
.. figure:: /_static/images/services/lnbits/lndhub-manage.png
:width: 40%
:alt: lndhub-manage
#. Click the two arrows on the right, then click install:
.. figure:: /_static/images/services/lnbits/arrows-install.png
:width: 40%
:alt: arrows-install
#. Now ensure that it says **Activated** underneath LndHub and then click **Extensions** on the left:
.. figure:: /_static/images/services/lnbits/activated-click-extensions.png
:width: 40%
:alt: activated-click-extensions
#. Click **ENABLE**:
.. figure:: /_static/images/services/lnbits/extensions-enable.png
:width: 40%
:alt: extensions-enable
#. Click **OPEN** *or* **LndHub** under *Extensions*:
.. figure:: /_static/images/services/lnbits/lndhub-open.png
:width: 40%
:alt: lndhub-open
#. Make sure the wallet you just created is selected below the two QR codes:
.. figure:: /_static/images/services/lnbits/lndhub-select-wallet.png
:width: 40%
:alt: lndhub-select-wallet
#. Open up BlueWallet and click on the three dots in the top right:
.. figure:: /_static/images/services/lnbits/bluewallet-three-dots.jpg
:width: 20%
#. Click "Network" then "Tor settings":
.. figure:: /_static/images/services/lnbits/bluewallet-network.jpg
:width: 20%
.. figure:: /_static/images/services/lnbits/bluewallet-tor-settings.jpg
:width: 20%
#. Click "Start" and it should say "Done" after a short time:
.. figure:: /_static/images/services/lnbits/bluewallet-tor-start.jpg
:width: 20%
.. figure:: /_static/images/services/lnbits//bluewallet-tor-done.jpg
:width: 20%
#. Head back to the main screen and click the **"+"** sign:
.. figure:: /_static/images/services/lnbits/bluewallet-add-wallet.jpg
:width: 20%
#. Click "Import wallet":
.. figure:: /_static/images/services/lnbits/bluewallet-plus.jpg
:width: 20%
#. Click "Scan or import a file"
.. note:: Screenshots not possible for this step!
#. *If you only want this wallet to be able to RECEIVE PAYMENTS, scan this QR code:*
.. figure:: /_static/images/services/lnbits/left-qr.png
:width: 40%
:alt: left-qr
*If you are happy for this wallet to be able to both receive and MAKE payments scan this QR code:*
.. figure:: /_static/images/services/lnbits/right-qr.png
:width: 40%
:alt: right-qr
#. You'll see this once the wallet is added:
.. figure:: /_static/images/services/lnbits/bluewallet-wallet-added.jpg
:width: 30%
:alt: bluewallet-with-funds
#. You can now allocate sats to this wallet within LNbits by clicking the **"+"** icon here:
.. figure:: /_static/images/services/lnbits/plus-icon.png
:width: 60%
:alt: plus-icon
Let's add 1000 satoshis:
.. figure:: /_static/images/services/lnbits/add-1000-sats.png
:width: 60%
:alt: add-1000-sats
.. figure:: /_static/images/services/lnbits/1k-sats.png
:width: 60%
:alt: 1k-sats
#. BlueWallet should now show a balance:
.. figure:: /_static/images/services/lnbits/blue-wallet-balance.jpg
:width: 25%
:alt: blue-wallet-balance
#. You can also receive funds the normal way by hitting "Receive" within BlueWallet.
.. figure:: /_static/images/services/lnbits/blue-wallet-receive.jpg
:width: 25%
:alt: blue-wallet-receive
.. note:: Funds received this way must be sent from another lightning node, not the LND node underneath LNbits. A lightning payment that originates and terminates at the same node is technically a rebalance, not a normal payment.
Congratulations! BlueWallet is set up and ready to use lightning via your own lightning node - furthermore it will only be able to use your node in the way you allow it, via LNbits.

17
site/source/user-manual/service-guides/lightning/connecting-cln.rst
View File

@@ -1,17 +0,0 @@
.. _connecting-cln:
==================================
Connect Directly to Core Lightning
==================================
Core Lightning is one of the two lightning implementations found on Start9 servers. It was created and is maintained by `Blockstream <https://blockstream.com>`_.
If you want to connect a wallet to it, you can do so using one of the following guides:
.. toctree::
:maxdepth: 1
alby-cln
ride-the-lightning
spark
zeus-cln-direct

63
site/source/user-manual/service-guides/lightning/connecting-lnbits.rst
View File

@@ -1,63 +0,0 @@
.. _connecting-lnbits:
======
LNbits
======
The concept
-----------
LNbits allows you to create a wallet that makes use of your node with only an alloted amount of sats. This restriction can be very helpful for if you only want to have a small amount for spending on your phone without making your entire lightning balance available. You can even allow other people to have wallets you create for them - think giving your children an allowance. They can start with a set amount (can be zero) and simply spend what you initially make available. They can also earn more for themselves as they will have the freedom to issue their own invoices - all while making use of your node.
.. tip:: All wallets created this way are ultimately bound by the capacity of your node. If one wallet is allocated 10,000 sats but your underlying node only has 9000 sats of outbound capacity, payments will simply fail.
What lightning node should I use?
---------------------------------
This will work for both **Core Lightning (CLN)** and **LND** *but* if you want to connect :ref:`Zeus<zeus-lnbits>` or :ref:`BlueWallet<blue-wallet>` to LNbits then **this will only work with LND** as the underlying node. This is because the LNDhub plugin will be required.
If you are looking to connect the `Alby <https://github.com/getAlby/lightning-browser-extension#installation>`_ browser extension to your LNbits wallet, that will work with **both CLN** *and* **LND**.
Setting up LNbits
-----------------
.. 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<tor-firefox>`. This also requires having :ref:`native tor setup<tor-os>`.
#. 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<lightning-intro>`.
.. figure:: /_static/images/services/lnbits/lnbits-lnd-cln-installed.png
:width: 40%
:alt: lnbits-lnd-cln-installed
.. tip:: Remember - if you intend to connect BlueWallet or Zeus, that will only be possible with LND. Alby can work with both.
#. Head to LNbits on your server, click on **Properties** and copy the address under **(Tor) Superuser Account**:
.. figure:: /_static/images/services/lnbits/tor-super-user.png
:width: 40%
:alt: tor-super-user
#. Paste this address into your browser and you'll see the following screen - click **I understand**:
.. figure:: /_static/images/services/lnbits/superuser-first-open.png
:width: 60%
:alt: superuser-first-open
.. note:: This isn't a concern on StartOS as all wallets created will have the address they generated stored within **Properties** within the LNbits serivce.
#. Now a default wallet will have already been generated - highlighted on the top left. We'll rename it by clicking **Rename wallet** entering **android-zeus-wallet** then clicking **UPDATE NAME**:
.. figure:: /_static/images/services/lnbits/rename-default-wallet.png
:width: 60%
:alt: rename-default-wallet
.. note:: I have called the wallet "android-zeus-wallet" but it is fine to use other wallets.
Now you can proceed to connect one of the following wallets to LNbits using the guides below:
.. toctree::
:maxdepth: 1
alby-lnbits
bluewallet
zeus-lnbits

17
site/source/user-manual/service-guides/lightning/connecting-lnd.rst
View File

@@ -1,17 +0,0 @@
.. _connecting-lnd:
=======================
Connect Directly to LND
=======================
The following wallets can connect directly to LND via LND's REST API.
.. tip:: If you'd like to connect via LNbits instead, click :ref:`here<connecting-lnbits>`.
.. toctree::
:maxdepth: 1
alby-lnd
ride-the-lightning
zap
zeus-lnd-direct

19
site/source/user-manual/service-guides/lightning/connecting-lndc.rst
View File

@@ -1,19 +0,0 @@
.. _connecting-lndc:
===============================================
Connect to LND via Lightning Node Connect (LNC)
===============================================
Lightning Node Connect (LNC) provides a very simple way to connect to an LND node that **does not require the Tor network**.
This is **not** the same as **connecting directly to LND** for which guides can be found :ref:`here<connecting-lnd>`.
.. note:: This requires installing the `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_ service on your Start9 server.
The following two guides go over how to connect wallets to LND via LNC.
.. toctree::
:maxdepth: 1
alby-lnc
zeus-lnc

43
site/source/user-manual/service-guides/lightning/index.rst
View File

@@ -1,43 +0,0 @@
.. _lightning-service:
=========
Lightning
=========
The following guide will get you up and running with a lightning node and walk you through opening your first channel.
.. toctree::
:maxdepth: 1
lightning-first-channel
Now that you're up and running, it's time to connect an interface so that you can use your node to make and receive payments from anywhere!
If you're using **Core Lightning (CLN)** and would like a direct connection you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-cln
If you're using **LND**, you can select one of the following options:
.. toctree::
:maxdepth: 2
connecting-lnd
If you would like to connect to LND via Lightning Node Connect **(LNC)** in order to avoid using Tor, you can do so with Alby and Zeus via the Lightning Terminal service:
.. toctree::
:maxdepth: 2
connecting-lndc
If you'd like to allocate only a portion of your lightning node's liquidity to a wallet or have a wallet that can receive but not make payments, you can use **LNbits** - LNbits allows you to create a wallet that makes use of your node with only an alloted amount of sats and it works with both **Core Lightning** and **LND**.
.. toctree::
:maxdepth: 3
connecting-lnbits

194
site/source/user-manual/service-guides/lightning/lightning-first-channel.rst
View File

@@ -1,194 +0,0 @@
.. _lightning-intro:
==========================
Opening Your First Channel
==========================
.. contents::
:depth: 2
:local:
Here we'll show you how to install a lightning node and how to open a channel with Start9!
Running a Node and Making a Channel with Start9
_______________________________________________
#. First, ensure that you have Bitcoin Core installed, running, and synced:
.. figure:: /_static/images/lightning/bitcoin-synced.png
:width: 60%
:alt: bitcoin-synced
#. Install a lightning node. There are two options we offer on the `Start9 marketplace <https://marketplace.start9.com>`_ - LND and Core Lightning. In this guide we're going to use Core Lightning (CLN). Though you can use LND and the process will be almost exactly the same.
.. figure:: /_static/images/lightning/two-impls-marketplace.png
:width: 60%
:alt: two-impls-marketplace
#. Install one of the above lightning implementations - as mentioned in this guide we'll use CLN.
.. figure:: /_static/images/lightning/cln-installing.png
:width: 60%
:alt: cln-installing
#. You'll see CLN say **Needs Config**. Click **Configure**:
.. figure:: /_static/images/lightning/cln-needs-config.png
:width: 60%
:alt: cln-needs-config
#. You can leave the settings as their default values and hit **SAVE**.
.. figure:: /_static/images/lightning/cln-save-config.png
:width: 60%
:alt: cln-save-config
#. Now hit **Start** and wait for CLN to sync up to the network. This may take a few hours.
.. figure:: /_static/images/lightning/cln-syncing.png
:width: 60%
:alt: cln-syncing
#. Once the **Synced** health check turns green (as below) you can proceed to the next step.
.. figure:: /_static/images/lightning/cln-green.png
:width: 60%
:alt: cln-green
#. To interact with your node we will use Ride The Lightning (RTL) - this is a service that provides a graphical user interface for our lightning node.
This will work with either (or both!) lightning implementations.
.. figure:: /_static/images/lightning/rtl-in-marketplace1.png
:width: 60%
:alt: rtl-marketplace
#. Install it and click on **Configure** just like with CLN.
.. figure:: /_static/images/lightning/rtl-needs-config.png
:width: 60%
:alt: rtl-needs-config
#. It will default to LND. In this case we are using a CLN node instead, so we will change the default setting as shown:
.. figure:: /_static/images/lightning/rtl-config-lnd.png
:width: 60%
:alt: rtl-config-lnd
Change to Core Lightning (CLN) and hit OK:
.. figure:: /_static/images/lightning/rtl-change-to-cln.png
:width: 60%
:alt: rtl-change-to-cln
Hit **Save**:
.. figure:: /_static/images/lightning/rtl-config-save.png
:width: 60%
:alt: rtl-config-save
#. Now hit **Start**:
.. figure:: /_static/images/lightning/rtl-start.png
:width: 60%
:alt: rtl-start
#. With RTL started, click **Properties**:
.. figure:: /_static/images/lightning/rtl-click-properties.png
:width: 60%
:alt: rtl-click-properties
#. Copy the automatically generated password:
.. figure:: /_static/images/lightning/rtl-copy-pass.png
:width: 60%
:alt: rtl-copy-pass
#. Head back to the RTL service and click **Launch UI**:
.. figure:: /_static/images/lightning/rtl-launch-ui.png
:width: 60%
:alt: rtl-launch-ui
Enter the copied password and log in:
.. figure:: /_static/images/lightning/rtl-enter-pass.png
:width: 60%
:alt: rtl-enter-pass
.. note:: You can add the password to your password manager for convenience.
#. Once in RTL, click **On-chain** then click **Generate Address**:
.. figure:: /_static/images/lightning/rtl-generate-address.png
:width: 60%
:alt: rtl-generate-address
#. Send bitcoin to the generated address to add funds to your lightning wallet:
.. figure:: /_static/images/lightning/rtl-address-generated.png
:width: 60%
:alt: rtl-address-generated
.. note:: Please do not send money to the address pictured above as we will not receive it. If you are intent on sending us money please `head here <https://donate.start9.com>`_
#. Once your sats confirm on-chain you'll see this:
.. figure:: /_static/images/lightning/rtl-on-chain.png
:width: 60%
:alt: rtl-on-chain
#. Now we must add a peer with which to make channels. In this example we will be opening a channel with Start9 so we will add Start9's node as a peer. Click **Peers/Channels**:
.. figure:: /_static/images/lightning/rtl-peers-channels.png
:width: 60%
:alt: rtl-peers-channels
#. Click **Peers** then **Add Peer**:
.. figure:: /_static/images/lightning/rtl-peers-add-peer.png
:width: 60%
:alt: rtl-peers-add-peer
#. Enter the details of the lightning node you'd like to open a channel with. Start9's node can be found `here <https://1ml.com/node/025d28dc4c4f5ce4194c31c3109129cd741fafc1ff2f6ea53f97de2f58877b2295>`_ and is what we'll use in this example. You can use another node if you like - ideally one that is well connected. Once chosen and added as below, click **Add Peer**:
.. figure:: /_static/images/lightning/rtl-start9-node-info.png
:width: 60%
:alt: rtl-start9-node-info
.. note:: The syntax is as follows **NodePublicKey@ipaddress:port** - If it's a Tor node it will be **PublicKey.onion:port** instead.
#. Then you can enter an amount (the size of the channel), select Private Channel (unless you want a public channel - see below), and a Fee Rate (check a `block explorer <https://mempool.space>`_ for an idea of current necessary fees):
.. figure:: /_static/images/lightning/rtl-open-channel.png
:width: 60%
:alt: rtl-open-channel
.. note:: Here we are creating a very small channel with a capacity for payments of only a few dollars. You will likely want your channel to be larger than this so that it's actually usable for reasonably sized payments. Channels this small may well get closed by the remote peer.
.. note:: Using a private channel is what we advise as a default. You may wish for the channel to be public if you intend on becoming a routing node or for other reasons.
#. You will now see your channel in **Channels** -> **Pending/Inactive**:
.. figure:: /_static/images/lightning/rtl-pending-inactive.png
:width: 60%
:alt: rtl-pending-inactive
#. Once the transaction opening the channel gets added to a block your channel will soon appear here under **Open**:
.. figure:: /_static/images/lightning/rtl-open-channels.png
:width: 60%
:alt: rtl-open-channels
#. To make a payment head to the **Transactions** tab and press **Send Payment**:
.. figure:: /_static/images/lightning/rtl-transactions-tab.png
:width: 60%
:alt: rtl-transactions-tab
#. That's it! You now have a lightning node running with a channel open ready to send payments on the lightning network!
.. note:: You will not be able to receive payments until you have inbound liquidity in your channel. After completing the above process you will only have outbound liquidity. Inbound liquidity can be created by making payments, having someone open a channel to you or via more sophisticated channel creation.
If you want to connect other applications or wallets to your node, please see the guides :ref:`here<lightning-service>`.

10
site/source/user-manual/service-guides/lightning/ride-the-lightning.rst
View File

@@ -1,10 +0,0 @@
.. _rtl:
Ride the Lightning
------------------
This can simply be installed by going to your Start9 Server's marketplace, clicking on **Ride The Lightning** and then installing the latest version. Once installed you can configure it to work with either - or both - Core Lightning and LND!
.. figure:: /_static/images/lightning/marketplace-rtl.png
:width: 55%
:alt: rtl-within-marketplace

36
site/source/user-manual/service-guides/lightning/spark.rst
View File

@@ -1,36 +0,0 @@
.. _spark:
Spark
-----
.. note:: Compatible with Core Lightning (CLN) only
Available For:
- `Android <https://github.com/shesek/spark-wallet/releases>`_
- `StartOS <https://marketplace.start9.com/marketplace/spark-wallet>`_
- `iOS as a PWA <https://github.com/shesek/spark-wallet#progressive-web-app>`_
.. warning:: Please be careful - there are multiple fake "Spark Wallets" out there. The above links have been verified and can be trusted.
To use Spark, you simply install it as a service on your Start9 Server. You can then use it to operate your CLN node by clicking **Launch UI** within the service:
.. note:: This will act as a server as well, and is required if you want to use the mobile app.
.. figure:: /_static/images/lightning/spark-launch-ui.png
:width: 45%
:alt: spark-launch-ui
If you would like to connect a mobile client you can click **Properties**:
.. figure:: /_static/images/lightning/spark-properties.png
:width: 45%
:alt: spark-properties
and then click on the button below to reveal the **Pairing URL** which you then scan with your mobile device.
.. figure:: /_static/images/lightning/spark-pairing.png
:width: 45%
:alt: spark-pairing
.. tip:: On iOS you cannot scan this QR code due to PWAs being forbidden from using the camera. You can instead simply copy and paste the Pairing URL.

27
site/source/user-manual/service-guides/lightning/zap.rst
View File

@@ -1,27 +0,0 @@
.. _zap:
Zap
---
Available on `Android <https://play.google.com/store/apps/details?id=zapsolutions.zap>`_ and `iOS <https://apps.apple.com/us/app/zap-bitcoin-lightning-wallet/id1406311960>`_.
.. note:: Compatible with LND only
#. Install Zap via your phone's app store.
#. Go to Settings and activate Tor.
#. Go to **Add a Wallet**
#. Locate the **LND Connect REST URL** from your LND service page's **Properties** section:
.. figure:: /_static/images/lightning/lnd-properties.png
:width: 55%
:alt: lnd-properties
#. Display the QR code by clicking on the following button:
.. figure:: /_static/images/lightning/lnd-connect-qr-code.png
:width: 55%
:alt: lnd-rest
#. Scan the QR code with your phone.
Zap is now connected to your LND node!

25
site/source/user-manual/service-guides/lightning/zeus-cln-direct.rst
View File

@@ -1,25 +0,0 @@
.. _zeus-cln:
Zeus
----
Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning. If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
Available For:
- Android
- iOS
.. note:: Works with both Core Lightning (CLN) and LND! If you'd like to connect Zeus to LND instead - please use :ref:`this guide<zeus-lnd>`.
#. Download the Zeus: Bitcoin and Lightning wallet from your mobile device's application store.
#. Open your Start9 server's web interface and log in
#. Select Services -> Core Lightning
#. Select "Properties"
#. Click the QR code next to "REST API Quick Connect" to display the QR code
#. Open Zeus on your mobile device and go to Settings / Get Started -> Connect a node -> +
#. Select "Use Tor"
#. Change "Node interface" to "Core Lightning (c-lightning-REST)"
#. Press "SCAN C-LIGHTNING-REST QR"
#. Press "SAVE NODE CONFIG"

124
site/source/user-manual/service-guides/lightning/zeus-lnbits.rst
View File

@@ -1,124 +0,0 @@
.. _zeus-lnbits:
Zeus
----
.. note:: This is not the same as connecting Zeus directly to your lightning node - using LNbits allows us to allocate a specific amount of funds to Zeus instead of giving it full access to your lightning node. We can also use LNbits to permit Zeus to **just receive** satoshis, or the ability to both **receive and spend** satoshis.
.. note:: This guide assumes you have already setup LNbits as per :ref:`this guide <connecting-lnbits>` with **LND** as your underlying node.
.. warning:: **This will not work with CLN as your underlying node!**
#. Zeus requires that we use the LnbHub extension in order to connect to LNbits.
#. To do this, click **Manage Extensions**:
.. figure:: /_static/images/services/lnbits/manage-extensions.png
:width: 50%
:alt: manage-extensions
#. Click **MANAGE** under the LndHub extension:
.. figure:: /_static/images/services/lnbits/lndhub-manage.png
:width: 40%
:alt: lndhub-manage
#. Click the two arrows on the right, then click install:
.. figure:: /_static/images/services/lnbits/arrows-install.png
:width: 40%
:alt: arrows-install
#. Now ensure that it says **Activated** underneath LndHub and then click **Extensions** on the left:
.. figure:: /_static/images/services/lnbits/activated-click-extensions.png
:width: 40%
:alt: activated-click-extensions
#. Click **ENABLE**:
.. figure:: /_static/images/services/lnbits/extensions-enable.png
:width: 40%
:alt: extensions-enable
#. Click **OPEN** *or* **LndHub** under *Extensions*:
.. figure:: /_static/images/services/lnbits/lndhub-open.png
:width: 40%
:alt: lndhub-open
#. Make sure the wallet you just created is selected below the two QR codes:
.. figure:: /_static/images/services/lnbits/lndhub-select-wallet.png
:width: 40%
:alt: lndhub-select-wallet
#. Install `Zeus <https://zeusln.app/>`_.
#. Open it up and click **SCAN NODE CONFIG**.
.. figure:: /_static/images/services/lnbits/scan-node-config.jpg
:width: 25%
:alt: scan-node-config
#. *If you only want this wallet to be able to RECEIVE PAYMENTS, scan this QR code:*
.. figure:: /_static/images/services/lnbits/left-qr.png
:width: 40%
:alt: left-qr
*If you are happy for this wallet to be able to both receive and MAKE payments scan this QR code:*
.. figure:: /_static/images/services/lnbits/right-qr.png
:width: 40%
:alt: right-qr
#. Once scanned, name the wallet if you wish, then hit **SAVE NODE CONFIG**.
.. figure:: /_static/images/services/lnbits/save-node-config.jpg
:width: 25%
:alt: save-node-config
#. Zeus will now connect to your node and you'll see this screen:
.. figure:: /_static/images/services/lnbits/new-wallet-screen-zeus.png
:width: 25%
:alt: new-wallet-screen-zeus
.. tip:: If it doesn't work, please manually restart the Zeus app.
#. You can now add sats to this wallet in two ways. You can allocate sats within LNbits by clicking the **+** icon here:
.. figure:: /_static/images/services/lnbits/plus-icon.png
:width: 60%
:alt: plus-icon
Let's add 1000 satoshis:
.. figure:: /_static/images/services/lnbits/add-1000-sats.png
:width: 60%
:alt: add-1000-sats
.. figure:: /_static/images/services/lnbits/1k-sats.png
:width: 60%
:alt: 1k-sats
Alternatively you can simply hit **Request** in Zeus and receive by generating a standard lightning invoice:
.. figure:: /_static/images/services/lnbits/zeus-request.png
:width: 20%
:alt: zeus-request
.. note:: This will only work if your node has inbound liquidity. And you cannot send sats from the LND node LNbits is using as that is not a regular lightning payment - that is a reblanace.
#. Once you have added sats, you can click on this button within Zeus and see your new balance:
.. figure:: /_static/images/services/lnbits/zeus-balance-button.png
:width: 20%
:alt: zeus-balance-button
.. figure:: /_static/images/services/lnbits/zeus-balance.png
:width: 20%
:alt: zeus-balance
Congratulations! Zeus is set up and ready to use lightning via your own lightning node - furthermore it will only be able to use your node in the way you allow it, via LNbits.

77
site/source/user-manual/service-guides/lightning/zeus-lnc.rst
View File

@@ -1,77 +0,0 @@
.. _zeus-lnc:
====
Zeus
====
Lightning Node Connect (LNC) provides a very simple way to connect to an LND node. In this guide we'll cover how to connect to LND via LNC with Zeus.
Zeus is available for `Android <https://zeusln.app/zeus-v0.7.5-universal.apk>`_ & `iOS <https://apps.apple.com/us/app/zeus-ln/id1456038895>`_.
.. note:: If you'd like to connect to LND using LND REST instead, follow :ref:`this guide<zeus-lnd>`. If you'd like to connect to LND via LNbits which allows allocation of funds, follow :ref:`this guide<connecting-lnbits>`.
#. Install `Lightning Terminal <https://marketplace.start9.com/marketplace/lightning-terminal>`_
#. Click **LAUNCH UI**:
.. figure:: /_static/images/lightning/lit-launch-ui.png
:width: 40%
:alt: lit-launchUI
#. The password can be found in **Properties**:
.. figure:: /_static/images/lightning/lit-properties.png
:width: 40%
:alt: lit-properties
#. Copy it by clicking this square:
.. figure:: /_static/images/lightning/lit-properties-x.png
:width: 40%
:alt: copy-password
#. Paste it into Lightning Terminal and click **Submit**:
.. figure:: /_static/images/lightning/lit-paste-pass.png
:width: 40%
:alt: lit-paste-pass
#. Click on **Lightning Node Connect**:
.. figure:: /_static/images/lightning/lit-lnc1.png
:width: 40%
:alt: lit-lnc1
#. Click **Create a new session**:
.. figure:: /_static/images/lightning/lit-lnc2.png
:width: 40%
:alt: lit-lnc2
#. Name the wallet and click **Submit**:
.. figure:: /_static/images/lightning/lit-lnc3.png
:width: 40%
:alt: lit-lnc3
#. Click on the QR code:
.. figure:: /_static/images/lightning/lit-lnc4.png
:width: 40%
:alt: lit-lnc4
#. Install `Zeus <https://zeusln.app/>`_ if not already installed.
#. Open up Zeus and click **SCAN NODE CONFIG** then scan the QR code.
.. figure:: /_static/images/lightning/zeus-scan-node-config.jpg
:width: 25%
:alt: zeus-scan-node-config
#. Click **SAVE NODE CONFIG**:
.. figure:: /_static/images/lightning/zeus-save-node-config.jpg
:width: 25%
:alt: zeus-save-node-config
Zeus is now setup to connect to your LND node via LNC!

44
site/source/user-manual/service-guides/lightning/zeus-lnd-direct.rst
View File

@@ -1,44 +0,0 @@
.. _zeus-lnd:
Zeus
----
Zeus is a powerful mobile wallet that can be connected directly to both LND and Core Lightning (CLN). If you'd like to connect via LNbits which allows allocation of funds, please see :ref:`this guide<connecting-lnbits>`.
Zeus is available for `Android <https://zeusln.app/zeus-v0.7.5-universal.apk>`_ & `iOS <https://apps.apple.com/us/app/zeus-ln/id1456038895>`_.
This guide will go over how to connect Zeus to **LND**. If you'd like to connect Zeus to CLN instead - please use :ref:`this guide<zeus-cln>`.
#. Download the Zeus from your mobile device's application store.
#. In your Start9 server's **services** tab, select **LND**.
.. figure:: /_static/images/lightning/lnd-within-services.png
:width: 40%
:alt: lnd-services
#. Click **Properties**:
.. figure:: /_static/images/lightning/lnd-properties.png
:width: 40%
:alt: lnd-properties
#. Click the QR code icon highlighted below to display the **LND Connect REST URL** QR code:
.. figure:: /_static/images/lightning/lnd-connect-qr-code.png
:width: 40%
:alt: lnd-connect-qrcode
#. Open Zeus on your mobile device and click **SCAN NODE CONFIG**:
.. figure:: /_static/images/services/lnbits/scan-node-config.jpg
:width: 25%
:alt: scan-node-config
#. Scan the QR Code displayed on the server's LND Connect REST URL screen.
#. Zeus will fill in your node details based on the information in the QR code.
#. Click **SAVE NODE CONFIG**
Zeus is now setup to access and control your LND node!

34
site/source/user-manual/service-guides/matrix.rst
View File

@@ -1,34 +0,0 @@
.. _matrix:
======
Matrix
======
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"
#. 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.
.. figure:: /_static/images/services/matrix/synapse-admin-1.png
:width: 60%
:alt: Synapse Admin
#. In the "Users" tab, you will notice the admin user already created.
#. In the "Users" tab, click "+ Create"
.. figure:: /_static/images/services/matrix/synapse-admin-2.png
:width: 60%
:alt: Synapse Admin
#. Choose a User-ID, Displayname, and Password for your account. Optionally enter an email address under the 3PIDs section. It is not recommended to make this user a Server Administrator, as it is best to limit admin access.
.. figure:: /_static/images/services/matrix/synapse-admin-3.png
:width: 60%
:alt: Synapse Admin

13
site/source/user-manual/service-guides/nextcloud/index.rst
View File

@@ -1,13 +0,0 @@
.. _nextcloud-service:
=========
Nextcloud
=========
These guides will help you to setup tools to connect or interact with Nextcloud.
.. toctree::
:maxdepth: 1
nextcloud-setup/index
nextcloud-apps/index

33
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/index.rst
View File

@@ -1,33 +0,0 @@
.. _nextcloud-apps:
=============================
Nextcloud Apps & Integrations
=============================
Nextcloud is highly extensible and even has its own `App Store <https://apps.nextcloud.com/>`_. The following guides will help you with the setup, connection, and use of Start9-curated Nextcloud Apps as well as third-party integrations for your server.
Apps
----
.. toctree::
:maxdepth: 1
nc-bookmarks
nc-calendar
nc-contacts
nc-cookbook
nc-files
nc-maps
nc-memories
nc-music
nc-news
nc-notes
nc-photos
Integrations
------------
.. toctree::
:maxdepth: 1
joplin

105
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/joplin.rst
View File

@@ -1,105 +0,0 @@
.. _nc-joplin:
==================
Joplin Integration
==================
`Joplin <https://joplinapp.org/>`_ is an open source note-taking app. Capture your thoughts and securely access them from any device. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your notes synced.
Clients available for:
- Desktop
- Linux
- Mac
- Windows
- Mobile
- Android
- iOS
Connecting Joplin to Nextcloud (Mac Desktop Example)
----------------------------------------------------
This guide will go over how to connect Joplin running on a desktop machine to your Start9 server's Nextcloud over LAN.
.. note:: This guide assumes your Nextcloud username is "embassy," replace with your username if different.
You will need your device set up to connect via :ref:`LAN<connecting-lan>` first.
#. First go into Nextcloud on your server and click on the "Files" app icon.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup0.png
:width: 30%
:alt: Click on Folders
#. Click on the + icon, then "New folder".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup1.png
:width: 30%
:alt: New Folder
#. Create a new folder called "joplin" and click the arrow to the right.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup3.png
:width: 30%
:alt: Joplin Directory
#. Click on "Files settings" in the bottom left and copy the WebDAV link.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup4.png
:width: 30%
:alt: Files Settings
.. figure:: /_static/images/nextcloud/joplin/joplin-setup5.png
:width: 30%
:alt: WedDAV Link
#. Open up Joplin, click on "Joplin" in the top left and click "Preferences" (on Mac).
.. figure:: /_static/images/nextcloud/joplin/joplin-setup7.png
:width: 30%
:alt: Preferences
#. Click on "Synchronisation".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup8.png
:width: 30%
:alt: Click on Synchronisation
#. Under "Synchronisation target" select "Nextcloud", paste the WebDAV and append onto the end of it "joplin" so the entire URL should look like this (replace ``xxxx`` with your unique Nextcloud LAN address): ``https://xxxx.local/remote.php/dav/files/embassy/joplin``.
.. figure:: /_static/images/nextcloud/joplin/joplin-setup9.png
:width: 30%
:alt: Click on Synchronization
#. Under "Nextcloud username" enter "embassy" (or your username).
#. Under "Nextcloud password" enter your password.
#. The username and password for your Nextcloud can be found in your server's UI by clicking on the Nextcloud service then clicking on "Properties".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup10.png
:width: 30%
:alt: Select Nextcloud and enter URL
.. figure:: /_static/images/nextcloud/joplin/joplin-setup11.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Now click "Show advanced settings".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup12.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Scroll down then check the box that says "Ignore TLS certificate errors".
.. figure:: /_static/images/nextcloud/joplin/joplin-setup13.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. Now scroll back up and select "Check sychronisation configuration" and you should see the following success message:
.. figure:: /_static/images/nextcloud/joplin/joplin-setup14.png
:width: 30%
:alt: Select Nextcloud and enter URL
#. You have now connected your Joplin client to your Start9 server's Nextcloud and your notes will sync automatically!

46
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-bookmarks.rst
View File

@@ -1,46 +0,0 @@
.. _nc-bookmarks:
===================
Nextcloud Bookmarks
===================
`Nextcloud Bookmarks <https://apps.nextcloud.com/apps/bookmarks>`_ is software for sorting, tagging, searching, sharing, and (most importantly) syncing your browser's bookmarks via your server. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your bookmarks synced.
Clients available for:
- Mobile
- Android
- Desktop Browsers
- Chrome
- Edge
- Firefox
NC App Setup
------------
#. Begin by downloading Bookmarks from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Bookmarks." Click it to get started.
- At this point you can begin adding bookmarks directly into the app, or import them from a browser. These are always available by accessing your Nextcloud from your client devices.
- The real power here is in the ability to import or sync across devices. There are several clients that can accomplish this, which can be found on the `NC Bookmarks Github Page <https://github.com/nextcloud/bookmarks#third-party-clients>`_. For our example, and the recommended option if you click "Sync with your browser" from the Bookmarks welcome page, is `Floccus <https://floccus.org/>`_.
#. (Optional) In the "Settings" menu in the bottom-left, you may change the Nextcloud location in which to store your bookmarks. If you change this or create a new folder, be sure to reflect this change in Floccus below.
Browser & Mobile Setups
-----------------------
Floccus (Browser & Android)
...........................
#. Download the appropriate Floccus extension for your browser or app from the App Store, F-Droid, or Play Store.
#. Open the Floccus browser extension and click "+NEW ACCOUNT", select "Nextcloud Bookmarks", and then add your server address and login via Nextcloud.
#. (Optional) Edit the folder paths if changed above and select a local folder to save bookmarks to.
#. On the final setup page, use the defaults unless you are absolutely sure what you are doing. Click "Continue" and you're ready to sync!
.. note:: Repeat this process for any additional devices or browsers that you'd like to keep in sync.

31
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-calendar.rst
View File

@@ -1,31 +0,0 @@
.. _nc-calendar:
==================
Nextcloud Calendar
==================
`Nextcloud Calendar <https://apps.nextcloud.com/apps/calendar>`_ is software for managing and syncing calendars, events, and tasks between your devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your calendars synced.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. On the latest Start9 Nextcloud service, Calendar is included by default. If coming from an older install, begin by downloading Calendar from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Calendar." Click it to get started.
- At this point you can begin using the Calendar right away in the web UI. All changes will be reflected in any currently synced client devices, or on any added in future.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

31
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-contacts.rst
View File

@@ -1,31 +0,0 @@
.. _nc-contacts:
==================
Nextcloud Contacts
==================
`Nextcloud Contacts <https://apps.nextcloud.com/apps/contacts>`_ is software for managing and syncing your contacts between your devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your contacts synced.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. On the latest Start9 Nextcloud service, Contacts is included by default. If coming from an older install, begin by downloading Contacts from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Contacts." There is also a quick access icon in the top-right. Click either to get started.
- At this point you can begin using your Contacts app right away in the WebUI. All changes will be reflected in any currently synced client devices, or on any added in future.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

45
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-cookbook.rst
View File

@@ -1,45 +0,0 @@
.. _nc-cookbook:
==================
Nextcloud Cookbook
==================
`Nextcloud Cookbook <https://apps.nextcloud.com/apps/cookbook>`_ is software for viewing, syncing, and organizing recipes. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your recipes synced.
Clients available for:
- Mobile
- Android
- iOS
NC App Setup
------------
#. Begin by downloading Cookbook from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Cookbook." Click it to get started.
#. You can now start adding recipes. Simply find a recipe online and copy the URL into the box on the left. In most cases, this will be translated into an easy-to-read recipe with ingredients and steps, and without all the distractions and junk included with most recipe pages.
.. tip:: Tag and categorize your recipes! Basic settings are available in the bottom-left menu.
Mobile Setups
-------------
Nextcloud Cookbook (Android / iOS)
..................................
There are 2 versions of this app available on Android, and one on iOS. Check this `repository <https://github.com/nextcloud/cookbook/>`_ for details.
#. Go to your app store of choice and install the Nextcloud Cookbook app.
#. (Android connection) You can select a previously connected Nextcloud account, or scan an app-specific QR, created under Nextcloud's main menu -> Personal Settings -> Security
#. (iOS connection) You will be prompted to enter the following:
- Server URL - get this from your server's Services -> Nextcloud -> Interfaces (LAN is recommended)
- Username - get this from your server's Services -> Nextcloud -> Properties (admin is default)
- Password - get this from your server's Services -> Nextcloud -> Properties
.. note:: You may need to enable "self-signed certificates" for LAN. This is safe to do as you are the signer of the cert and owner of all involved hardware.
#. As soon as you connect and sync, you will see your Cookbook!

29
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-files.rst
View File

@@ -1,29 +0,0 @@
.. _nc-files:
===============
Nextcloud Files
===============
Nextcloud Files is software for managing and syncing your data between your devices. In practice it functions similarly to the file explorer on your computer. Files also serves as the base storage on your server for all the other apps that may need to access your data, such as documents, multimedia, and syncing apps. This even includes data storage for other Start9 services on your server, such as Jellyfin and Start9 Pages.
Integrations available for:
- Mobile
- Android
- iOS
- Desktop
- Linux
- Mac
- Windows
NC App Setup
------------
#. You will find an icon in your top menu for "Files." Click here to get started.
- You can begin using your Files app right away in the web UI. All changes will be reflected in any currently synced client devices, or on any added in future.
.. warning:: Keep in mind that if you delete a file in one location, it may be deleted across all locations!! Start with some test folders/files in order to understand how the syncing system works with your devices.
Client Integrations
-------------------
Client integrations can all be found in the :ref:`initial setup guides<nextcloud-setup>` for your device.

22
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-maps.rst
View File

@@ -1,22 +0,0 @@
.. _nc-maps:
==============
Nextcloud Maps
==============
`Nextcloud Maps <https://apps.nextcloud.com/apps/maps>`_ is software for viewing and managing your places. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your maps synced.
No clients available at this time.
NC App Setup
------------
#. Begin by downloading Maps from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Maps." Click it to get started.
#. You can now browse `OpenStreetMap <https://www.openstreetmap.org/>`_, get directions, create favorite locations, add photos, and share custom maps.
.. tip:: You can find the settings for Maps in the bottom-left
.. note:: This is basic software at this time, havnig just reached 1.0, but features are planned by the developers for linking mobile devices for finding a lost or stolen device as well as fitness tracking and other modern location services.

27
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-memories.rst
View File

@@ -1,27 +0,0 @@
.. _nc-memories:
==================
Nextcloud Memories
==================
`Nextcloud Memories <https://apps.nextcloud.com/apps/memories>`_ is software for viewing, managing, and organizing your photos. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your photos synced.
Clients available for:
- Mobile
- Android
NC App Setup
------------
#. Begin by downloading Memories from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Memories." Click it to get started.
#. You will see an image that says "Click Here To Start" - click it and select your media directory.
.. tip:: You can find the settings for Memories under the top-right menu -> Administrative Settings -> Memories
Desktop & Mobile Setups
-----------------------
This is currently a webUI only application, but you can use the same clients as those supported by :ref:`Nextcloud Photos<nc-photos>`.

34
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-music.rst
View File

@@ -1,34 +0,0 @@
.. _nc-music:
===============
Nextcloud Music
===============
`Nextcloud Music <https://apps.nextcloud.com/apps/music>`_ is software for organizing and playing your music as well as managing and streaming podcasts and internet radio. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your music synced.
Clients available for:
- Mobile
- Android
- iOS
- Garmin Watch
- Desktop:
- Linux
- Mac
- Windows
NC App Setup
------------
#. Begin by downloading Music from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Music." Click it to get started.
#. You can now play existing music from your Nextcloud Files, or add an internet radio station or podcast feed!
.. tip:: You can set the media directory path in the 'Settings' menu on the bottom-left
Desktop & Mobile Setups
-----------------------
Nextcloud Music can be used by clients that support Ampache or Subsonic. See all the options in the 'Settings' menu on the bottom-left, or see the `Ampache client list <https://github.com/owncloud/music/wiki/Ampache>`_ or the `Subsonic client list <https://github.com/owncloud/music/wiki/Subsonic>`_.

33
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-news.rst
View File

@@ -1,33 +0,0 @@
.. _nc-news:
==============
Nextcloud News
==============
`Nextcloud News <https://apps.nextcloud.com/apps/news>`_ is software for managing and viewing RSS feeds. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your feeds synced.
Clients available for:
- Mobile
- Android
- iOS
- SailfishOS
- Desktop:
- Linux
- Mac
- Windows
- Unix Terminal
NC App Setup
------------
#. Begin by downloading News from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "News." Click it to get started.
- You can now add your favorite RSS feeds from the left-hand panel.
Desktop & Mobile Setups
-----------------------
Nextcloud News can be synced with a wide range of clients across almost any platform you can imagine. See all the options on the `official client list <https://nextcloud.github.io/news/clients/>`_.

49
site/source/user-manual/service-guides/nextcloud/nextcloud-apps/nc-notes.rst
View File

@@ -1,49 +0,0 @@
.. _nc-notes:
===============
Nextcloud Notes
===============
`Nextcloud Notes <https://apps.nextcloud.com/apps/notes>`_ is software for managing and syncing your notes across devices. First set up your :ref:`client devices<nextcloud-setup>`, so that Nextcloud will automatically keep your notes synced.
Clients available for:
- Mobile
- Android
- iOS
- Desktop:
- Unix Terminal
NC App Setup
------------
#. Begin by downloading Notes from your Nextcloud service's App Store (Top-right menu -> Apps).
.. tip:: Use the "Search" function to quickly find the App you are looking for
#. Once installed/enabled, you will get a new icon in your top menu for "Notes." Click it to get started.
- You can now use the web UI to record your notes.
.. tip:: Markdown is supported
Desktop & Mobile Setups
-----------------------
The real beauty of Notes is being able to sync to your mobile devices for use on the go.
Nextcloud Notes (Android)
.........................
#. Download the Nextcloud Notes app from your favorite app store (Aurora, F-Droid, or Play Store).
#. On the opening screen, select your existing Nextcloud account. If one does not exist, make sure to start with your :ref:`client setup<nextcloud-setup>` or you can hit "Add Account," then create an app passcode QR under Nextcloud's main top-right menu -> Personal Settings -> Hamburger (3 lines) Menu > Security > Devices & Sessions > "Create new app password" and scan it to grant access.
#. You existing notes will now sync, or you can create your first note to test!
Nextcloud Notes (iOS)
.....................
#. Download the Nextcloud Notes app from the App Store.
#. Enter your Nextcloud server URL from your server: Nextcloud -> Interfaces (LAN recommended).
#. You will be redirected and asked for your username and password, both can be found on your server: Nextcloud -> Properties. Then Grant Access.
#. You'll be returned to the setup screen, just tap "Done," your existing notes will now sync, or you can create your first note to test!

Some files were not shown because too many files have changed in this diff Show More