Maint/more maintenance (#421)

* Fix build errors and broken links

* Update DIY system reqs

* Android Orbot update

* Minor fix

* Nextcloud external support

* Remove 0.2 hardware guides

* Simplify manual update directions

* Password reset clarification

* Add clarity around SSH access
This commit is contained in:
kn0wmad
2023-06-29 18:27:18 +00:00
committed by GitHub
parent 8343bf90c0
commit ac1870a0ac
23 changed files with 70 additions and 379 deletions

BIN
site/source/_static/images/tor/orbot0.png Normal file → Executable file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 150 KiB

BIN
site/source/_static/images/tor/orbot1.png Normal file → Executable file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 168 KiB

BIN
site/source/_static/images/tor/orbot_apps.png Normal file → Executable file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 262 KiB

After

Width:  |  Height:  |  Size: 174 KiB

BIN
site/source/_static/images/tor/orbot_menu.png Normal file → Executable file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 94 KiB

BIN
site/source/_static/images/tor/orbot_settings.png Normal file → Executable file

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 263 KiB

View File

@@ -21,19 +21,19 @@ Check out `this forum post <https://community.start9.com/t/known-good-hardware-m
.. _os-reqs:
Minimum OS Requirements
.......................
The specs below would be acceptable for a server running minimal services with minimal storage needs
=======================
The specs below would be acceptable for a server running minimal services with minimal storage needs:
- Single vCPU Core 2Ghz
- Single vCPU Core 2Ghz (boost)
- 4GB RAM
- 64GB Storage
- Ethernet port
Recommended OS Requirements
...........................
If you intend to run Bitcoin or store any meaningful amount of data, you will need
===========================
If you intend to run Bitcoin or store any meaningful amount of data, we recommend the following:
- Quad-Core CPU 2.5Ghz+
- Quad-Core CPU 2.5Ghz+ (boost)
- 8GB+ RAM
- 1TB+ Storage

View File

@@ -41,5 +41,5 @@ Learn
:hidden:
concepts/index
support/faq/index
../support/faq/index

View File

@@ -68,4 +68,4 @@ I am unable to reach my server via its xxxxxxxxxxxxxxxxxx.onion (Tor) address
I'm having an issue with a particular Service
---------------------------------------------
If a Service is crashing or acting up in some way, check the :ref:`Documentation<service-guides>` and :ref:`FAQ<faq-services>` for that particular Service. You can also check the "Logs" (on the service page), which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our :ref:`Community Channels<community-channels>` for immediate assistance.
If a Service is crashing or acting up in some way, check the :ref:`Documentation<service-guides>` and :ref:`FAQ<faq-services>` for that particular Service. You can also check the "Logs" (on the service page), which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels <https://start9.com/contact>`_ for immediate assistance.

View File

@@ -44,6 +44,11 @@ Mempool
=======
* Official Support: https://t.me/mempoolspace
Nextcloud
=========
* Official Support: https://nextcloud.com/support/
* Unofficial Telegram Community: https://t.me/Nextcloud
Photoview
=========
* Official Support: https://discord.gg/jQ392948u9

View File

@@ -11,71 +11,66 @@ Running Orbot
Orbot is a system wide proxy for your Android device that enables communications over Tor.
1. 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).
#. 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``
.. 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``
2. Launch Orbot.
.. figure:: /_static/images/tor/orbot0.png
:width: 30%
:alt: Orbot
3. Open the kebab menu in the upper right hand corner and select `Settings`:
#. Tap "Start VPN".
.. figure:: /_static/images/tor/orbot_menu.png
:width: 50%
:alt: Orbot menu
.. figure:: /_static/images/tor/orbot1.png
:width: 30%
:alt: Orbot starting
4. Make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked:
#. Orbot will start up the Tor service. Once complete, you will see:
.. figure:: /_static/images/tor/orbot_settings.png
:width: 50%
:alt: Orbot settings
.. figure:: /_static/images/tor/orbot2.png
:width: 30%
:alt: Orbot running
5. Go back, and tap start:
#. Open the kebab menu in the bottom right hand corner and select `Settings`:
.. figure:: /_static/images/tor/orbot_start.png
:width: 50%
:alt: Orbot start
.. figure:: /_static/images/tor/orbot_menu.png
:width: 30%
:alt: Orbot settings
6. Orbot will start up the Tor service. Once complete, you will see:
#. Make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked:
.. figure:: /_static/images/tor/orbot_started.png
:width: 50%
:alt: Orbot started
.. figure:: /_static/images/tor/orbot_settings.png
:width: 30%
:alt: Orbot menu
7. 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.
#. 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.
1. Disable Private DNS on your device. To switch it off, navigate to:
#. Disable Private DNS on your device. Navigate to: ``Settings > Network & Internet > Advanced > Private DNS > Off`` and toggle Private DNS to "off".
``Settings > Network & Internet > Advanced > Private DNS > Off``
.. figure:: /_static/images/tor/private_dns_off.png
:width: 30%
:alt: Private DNS off
.. figure:: /_static/images/tor/private_dns_off.png
:width: 50%
:alt: Private DNS off
#. Tap `Select Apps`, and add the apps you want to utilize Tor.
Toggle Private DNS to "off"
.. figure:: /_static/images/tor/orbot_apps.png
:width: 30%
:alt: Orbot apps
2. Launch Orbot and toggle VPN Mode on:
.. figure:: /_static/images/tor/orbot_vpn.png
:width: 50%
:alt: Orbot vpn mode
Toggle VPN Mode to "on"
Under `Tor-Enabled Apps`, click the gear icon and add apps you want to utilize Tor.
.. figure:: /_static/images/tor/orbot_apps.png
:width: 50%
:alt: Orbot apps
Examples of applications that need this feature are:
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):

View File

@@ -9,11 +9,11 @@ Reset Your Password
:local:
#. Download and flash the latest version of StartOS, using the appropriate :ref:`flashing guide <flashing>` for your hardware.
#. Power on your server, ensuring it is plugged in to Ethernet.
#. 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.
#. 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".

View File

@@ -140,7 +140,7 @@ Sparrow
#. Follow this `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
.. _specter:
.. _specter-wallet:
Specter
-------
@@ -149,6 +149,7 @@ Specter
- Linux
- macOS
- StartOS
- Windows
**Instructions**

View File

@@ -9,3 +9,8 @@ There are two ways to use Specter with your Start9 server.
You can :ref:`run it as a service<specter-service>` in which case it will automatically connect to Bitcoin Core and can be optionally configured to connect via Electrs.
Alternatively you can `connect Specter Desktop via Tor <https://github.com/Start9Labs/bitcoind-wrapper/tree/master/docs/integrations/specter>`_.
.. toctree::
:maxdepth: 1
specter-service

View File

@@ -3,6 +3,9 @@
=========
Using SSH
=========
Like most Linux distributions, you can go "under-the-hood" via SSH (Secure Shell Protocol) if you choose. It's a good idea to have set up, but generally, all server access is recommended via the UI. If you are auditing, doing dev work, hacking (with an understanding of the consequences), or are directed to by a Start9 support tech, then you may need SSH access.
For security reasons, password access is not available in most situations, so you will need to add an SSH key to your server via the method below.
.. contents::
:depth: 2

View File

@@ -29,47 +29,10 @@ Next, you may be prompted to refresh the browser window.
.. _manual-update:
Manual Update by Re-flashing
----------------------------
Manual Update
-------------
In some cases, it may be necessary to manually update by :ref:`re-flashing StartOS<flashing>`. Reasons might include:
.. tip:: This guide will cover how to recover existing StartOS 0.3.x service and user data with a newly flashed server.
#. Obtain the latest copy of StartOS either by `downloading <https://github.com/Start9Labs/start-os/releases/latest>`_ or `building from source <https://github.com/Start9Labs/start-os/tree/latest/build>`_.
#. :ref:`Flash the downloaded image <flashing>` to your microSD card.
#. Insert the microSD card into your server and power it on.
.. note:: Your server will power up and then initialize, a process of less than 5 minutes if you downloaded an image, or about 10-20 minutes if you built from source. Once complete you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
#. On your computer, open up a browser and go to http://start.local
#. 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 the drive you were using previously.
.. figure:: /_static/images/setup/screen4-use_existing_drive_selection.png
:width: 60%
#. Create a master password and click "Finish."
.. warning:: Choose a strong master password. If you don't wish to change your password from the previous version, just set it to the same thing it was before you began the upgrade. Write this password down. Store it somewhere safe. DO NOT LOSE IT.
.. figure:: /_static/images/setup/screen5-set_password.png
:width: 60%
:alt: Create A Password
#. You are now on the new version of StartOS, and the old version's data has been migrated to it! Continue to the section on :ref:`connecting` to learn more about using your server over Tor and LAN.
.. 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%
:alt: Setup Complete
- Updating from a beta or other experimental install
- :ref:`Reset your password<reset-password>`
- Something went wrong during an update (very rare)

View File

@@ -27,7 +27,7 @@ Upgrade Hardware
:class: large-5
:anchor: Upgrade
This is for if you purchased a NASPi upgrade kit from us
This is for upgrading a Pi to an all-in-one NASPi case
.. topic-box::
:title: Upgrade SSD
@@ -38,35 +38,10 @@ Upgrade Hardware
This is for replacing or upgrading your SSD
.. topic-box::
:title: Upgrade Kit v0.2 - v0.3
:link: upgrade-kit
:icon: scylla-icon scylla-icon--getting-started
:class: large-5
:anchor: Upgrade
This is for if you purchased an upgrade kit from us to migrate from StartOS v0.2.x to v0.3+
.. topic-box::
:title: Bring your own equipment
:link: upgrade-diy
:icon: scylla-icon scylla-icon--resource-center
:class: large-5
:anchor: Upgrade
This is for if you purchased your own hardware to migrate from StartOS v0.2.x to v0.3+
.. raw:: html
</div></div>
.. toctree::
:maxdepth: 2
:hidden:
@@ -74,7 +49,3 @@ Upgrade Hardware
Pro upgrade <upgrade-pro>
NASPi upgrade <naspi-upgrade>
SSD upgrade <ssd-upgrade>
Upgrade Kit <upgrade-kit>
DIY Hardware <upgrade-diy>

View File

@@ -1,158 +0,0 @@
.. _upgrade-diy:
=======================
Using your own hardware
=======================
.. contents::
:depth: 2
:local:
This guide will cover how to upgrade from StartOS version 0.2.x to version 0.3.x with your own equipment.
Hardware Requirements
---------------------
.. note::
If you purchased the `upgrade kit <https://store.start9.com/products/upgrade-kit>`_ from Start9, you should follow :ref:`this guide<upgrade-kit>`.
#. `32GB microSD card <https://www.amazon.com/dp/B07P14QHB7/>`_
#. `1TB solid state drive <https://www.amazon.com/Crucial-MX500-NAND-SATA-Internal/dp/B078211KBB>`_ minimum, 2TB+ recommended.
#. `Connector <https://www.amazon.com/Sabrent-2-5-Inch-Adapter-Optimized-EC-SSHD/dp/B011M8YACM>`_ or `enclosure <https://www.amazon.com/gp/product/B01LY97QE8>`_ for your drive.
#. `SD card adapter <https://www.amazon.com/gp/product/B000WR3Z3A>`_ for getting data from your SD card.
Downloading
-----------
#. Once you have all these you will need to `download StartOS v0.3.2.1 image from our github <https://github.com/Start9Labs/start-os/releases/tag/v0.3.2.1>`_, scroll to the Assets section, and download ``eos.tar.gz`` for Linux/Mac or ``eos.zip`` for Windows.
.. warning:: Only use v0.3.2.1 to perform this upgrade. Newer versions have deprecated the 02x to 03x flow, so you must choose this intermediate version first, then you can upgrade via the operating system to get to the latest version.
Extracting the image
--------------------
Linux
=====
#. Download the ``eos.tar.gz`` file and open a terminal in the directory you save it to
#. Extract with:
.. code-block::
tar -xzvf eos.tar.gz
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block::
sha256sum eos.img
Mac
===
#. Download the ``eos.tar.gz`` file
#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block::
openssl dgst -sha256 eos.img
Windows
=======
#. Download the ``eos.zip`` file
#. Right-click eos.zip and click "Extract all"
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block::
Get-FileHash eos.img
Flashing
--------
#. Once you have the image, flash it on to the 32GB SD card - the new one, **NOT** the one currently in your server!
.. tip:: The flashing software we recommend is `Balena Etcher <https://www.balena.io/etcher/>`_
.. _migrate-02-migrate:
Transfer Data
-------------
You may like to follow along with this video for clarity while transferring:
.. youtube:: ySd8uFJTbvQ
:width: 100%
#. Begin by going into your server, stopping all running services, and shutting down the device in the System tab.
#. Once you've heard the power-off sound, wait a few more seconds and then safely unplug the server.
#. Next, remove the SD card that is in your server and place it into the SD card adaptor, and then connect the adaptor to a USB port on your server.
#. Then take the new SD card with 0.3 on it and place it into the microSD card slot on your server (not into the adaptor - that is for the old SD card!)
#. Next, plug the SSD into one of the USB 3.0 (blue) ports on your server, then reconnect the Ethernet cable if not already connected.
#. Now the power cable can be connected and the server powered up.
Power Up
--------
#. The server will power up and then initialize, a process of less than 5 minutes if you downloaded the image, or about 10-20 minutes if you built from source. Once complete you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
#. On your computer, open up a browser and go to http://start.local
#. Pick `Recover`
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60%
#. Next, pick `Restore From Backup`
.. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
:width: 60%
#. You will be asked to select your old server SD card - select rootfs
.. figure:: /_static/images/setup/screen3-restore_drive.jpg
:width: 60%
#. On the next page you will be asked to select a storage device - here you should select your SSD.
.. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60%
.. note:: If your SSD does not show up, unplug it from the USB port and plug it back in a different USB 3.0 (blue) port
#. You will now need to make a password for your server. It needs to be a strong password. This password protects your server. It can be the same one that you used prior to migration, or a new one. Either way, make it strong, and make a backup of it.
.. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60%
#. Your server will now recover all your data from your old server and once finished, you will hear a _bep_, followed by a _chime_.
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. Now you will be provided with both a Tor and LAN address with which you can access your server. A file download will contain this important information, which you should keep somewhere safe. It is also a good idea to make bookmarks on the devices that you will use to access your server.
.. figure:: /_static/images/setup/screen7-upgrade_complete.jpg
:width: 60%
#. To use LAN safely, the SSL certificate will need to be added to whatever device you are using to access. This can be downloaded by clicking on "Download root CA" and installed by following the :ref:`instructions<connecting-lan>`.
#. You can now log in to your server via Tor or LAN, and you will be given the option of recovering your data on a service-by-service basis.
IMPORTANT NOTES
---------------
- You may remove your 0.2.x SD Card once you reach the success page. It is highly recommended to keep this card in a safe place for a few weeks to ensure your new server is working smoothly. After this you may wipe and repurpose the card however you wish.
- Do NOT use the old 0.2.x card again, unless instructed by a Start9 Support Tech, especially if you have funds on the Lightning Network, as it can lead to loss of funds!
- Please note that some services, such as LND, will have new Tor interfaces, and so you will need to add your new credentials to your integrations, such as Zap and Zeus wallets.
- For those recovering Bitwarden - it is now called Vaultwarden.
- For those recovering Bitcoin and changing to a full archival node: You will need to "Disable Pruning" in the config, and run the "Reindex Blockchain" Action, then restart the service upon completion of the sync.

View File

@@ -1,94 +0,0 @@
.. _upgrade-kit:
======================
Setup with Upgrade Kit
======================
.. contents::
:depth: 2
:local:
This guide will cover how to upgrade from StartOS version 0.2.x to version 0.3.x.
.. note::
If you purchased your own equipment please follow :ref:`this guide<upgrade-diy>`.
Migrating Data
--------------
You may like to follow along with this video for clarity while migrating:
.. youtube:: A5Z7aX3x5eU
:width: 100%
#. Begin by going into your Start9 server, stopping all running services, and shutting down the device in the System tab.
#. Once you've heard the power-off sound, wait a few more seconds and then safely unplug the Start9 server.
#. Next, remove the OLD SD card that is in your Start9 server and place it into the SD card adaptor, and then connect the adaptor to any USB port on your Start9 server.
#. Then take the NEW 32GB microSD card with 0.3 on it and place it into the microSD card slot on your Start9 server. Be careful not to confuse the two microSD cards!
#. Next, plug the SSD into one of the USB 3.0 ports (the blue ones) on your Start9 server, then reconnect the Ethernet cable if not already connected.
#. Now the power cable can be connected and the Start9 server powered up.
Power Up
--------
#. The Start9 server will power up and then initialize, a process of less than 5 minutes. Once complete you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
#. On your computer, open up a browser and go to http://start.local
#. Pick `Recover`
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60%
#. Next, pick `Restore From Backup`
.. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
:width: 60%
#. You will be asked to select your old Start9 server SD card - select rootfs
.. figure:: /_static/images/setup/screen3-restore_drive.jpg
:width: 60%
#. On the next page you will be asked to select a storage device - here you should select your SSD.
.. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60%
.. note:: If your SSD does not show up, unplug it from the USB port and plug it back in a different USB 3.0 (blue) port
#. You will now need to make a password for your server. It needs to be a strong password. This password protects your server. It can be the same one that you used prior to migration, or a new one. Either way, make it strong, and make a backup of it.
.. figure:: /_static/images/setup/screen5-set_password.jpg
:width: 60%
#. StartOS will now recover all your data from your old server and once finished, you will hear a _bep_, followed by a _chime_.
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. Now you will be provided with both a Tor and LAN address with which you can access your server. A file download will contain this important information, which you should keep somewhere safe. It is also a good idea to make bookmarks on the devices that you will use to access your server.
.. figure:: /_static/images/setup/screen7-upgrade_complete.jpg
:width: 60%
#. To use LAN safely, the SSL certificate will need to be added to whatever device you are using to access. This can be downloaded by clicking on "Download root CA" and installed by following the :ref:`instructions<connecting-lan>`.
#. You can now log in to your server via Tor or LAN, and you will be given the option of recovering your data on a service-by-service basis.
IMPORTANT NOTES
---------------
- You may remove your 0.2.x SD Card once you reach the success page. It is highly recommended to keep this card in a safe place for a few weeks to ensure your migrated server is working smoothly. After this you may wipe and repurpose the card however you wish.
- Do NOT use the old 0.2.x card again, unless instructed by a Start9 Support Tech, especially if you have funds on the Lightning Network, as it can lead to loss of funds!
- Please note that some services, such as LND, will have new Tor interfaces, and so you will need to add your new credentials to your integrations, such as Zap and Zeus wallets.
- For those recovering Bitwarden - it is now called Vaultwarden.
- For those recovering Bitcoin and changing to a full archival node: You will need to "Disable Pruning" in the config, and run the "Reindex Blockchain" Action, then restart the service upon completion of the sync.