Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update/diy (#383)

Browse Source 
* Initial Setup maintenance

* DIY update

* Minor edits to Setup
This commit is contained in:
kn0wmad
2023-05-18 19:26:16 +00:00
committed by GitHub
parent bca23d3a40
commit 0add5b2d16
5 changed files with 134 additions and 193 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_embassy_login.jpg → site/source/_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

81
site/source/diy/diy-pi.rst
View File

@@ -1,80 +1,25 @@
.. _diy-pi:
========================
DIY Guide (Raspberry Pi)
========================
=============================
DIY Guidelines (Raspberry Pi)
=============================
.. contents::
:depth: 2
:local:
Start9 is committed to ensuring that embassyOS is accessible. It will always be possible to build your own Embassy similar to the ones we sell. This guide is to build a device exactly like Start9's Embassy One, available for purchase on the `Start9 Store <https://store.start9.com/products/embassy-one>`_.
Start9 is committed to ensuring that sovereign computing is accessible. It will always be possible to build your own Start9 server similar to the ones we sell. This guide is to build a device exactly like Start9's Server One, available for purchase on the `Start9 Store <https://store.start9.com/products/server-one>`_.
For help with this guide or to share your experience with others, please `head to our community forum <https://community.start9.com/>`_. Want to support Sovereign Computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
For more guidance or to share your experience with others, please `head to our community forum <https://community.start9.com/>`_. Want to support sovereign computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
.. figure:: /_static/images/diy/pi.png
:width: 40%
:alt: Raspberry Pi
Hardware Requirements
---------------------
- Raspberry Pi 4 (8GB RAM model)
Hardware
--------
The first thing you'll need to do is gather the hardware and assemble it. Below is the "official" hardware spec. For an alternate build option, see this `Geekworm NAS Case guide <https://community.start9.com/t/diy-embassy-using-geekworm-nas-case-w-optional-ups>`_.
- Power Supply (20w - 5v/4a recommended)
Parts
=====
#. `Geekworm NASPi v2.0 <https://geekworm.com/products/geekworm-naspi-2-5-sata-hdd-ssd-kit-for-raspberry-pi-4-model-b?_pos=2&_sid=06be31b61&_ss=r&variant=39426059731032>`_ ~$60 USD
- SD Card (128GB or 256GB recommended)
- It is important to get the 2.0 version as it has the ability to power back on automatically following a power outage.
- MAKE SURE YOU GET THE CORRECT POWER SUPPLY FOR YOUR REGION
#. `Raspberry Pi 4 (8GB RAM model) <https://www.amazon.com/LANDZO-Raspberry-Pi-Model-8gb/dp/B08R87H4RR/>`_ ~$75-200 USD
- These have more than doubled in price in 2022. You may want to shop around, or buy used if need be.
#. `Internal SSD (1TB minimum) <https://www.amazon.com/Crucial-MX500-NAND-SATA-Internal/dp/B078211KBB>`_ ~$80 USD+
- 1TB minimum is recommended, however this all depends on your use-case.
- 1TB is plenty for a full Bitcoin/Lightning stack OR a good amount of file storage, but not both if you want your device to be useful for years to come. 2TB or more is recommended if it is in your budget. You can always upgrade this later, and storage keeps getting cheaper.
#. `SD Card (32GB) <https://www.amazon.com/dp/B07P14QHB7>`_ ~$10 USD
- A larger size is not necessary as it adds no benefit.
#. `Ethernet Cable (Cat5 or Cat6) <https://www.amazon.com/Monoprice-Flexboot-Ethernet-Patch-Cable/dp/B00AJHBZLM/>`_ ~$2 USD
- You may have one laying around. Keep in mind the length you will require, e.g., how far away will your Embassy be from your router? 3-6ft is normally plenty.
#. `Speaker <https://www.amazon.com/Corporate-Computer-Motherboard-Internal-Speaker/dp/B01527H4W2/>`_ ~$5 USD
- Not strictly required, but HIGHLY recommended.
#. `2-Pin Male-to-Male Power Wire <https://geekworm.com/products/usb3-0-connector?variant=33744636674136>`_ ~$5 USD
- Required if using a speaker or Noctua fan.
#. (Optional) `Noctua NF-A4x10 5v Fan (Get all below) <https://www.amazon.com/Noctua-Cooling-Bearing-NF-A4X10-FLX-5V/dp/B00NEMGCIA/>`_ ~$15 USD
- Recommended over the less-than-great Geekworm factory fan.
- None of the included screws are long enough, so you will need 2 screws (M3-.50x12), available online or at any hardware store for <$1 USD.
- 2x Male-to-Female jumper wires - unfortunately these only come in high quantities, so you may want to organize a group buy. ~$9
#. (Optional) MicroSD to USB adapter
- For flashing the OS. Not necessary if you have a way to mount an SD card already, such as an SD card slot on a laptop.
.. note:: Estimated total cost: ~$375-460+ with 1-2TB of storage
Assembly
========
You can follow along with this `written guide <https://community.start9.com/t/diy-embassy-one-geekworm-naspi-case>`_ and/or our assembly video below:
.. youtube:: Z1EW1TVgtow
:width: 100%
.. raw:: html
<div style="margin-bottom: 48px;">
Flash and Install embassyOS
---------------------------
After building your hardware build, you will need a copy of embassyOS. Head over to our :ref:`Flashing (Raspberry Pi) Guide <flashing-pi>` to complete your Embassy One build.
Flash and Install StartOS
-------------------------
After building your hardware build, you will need a copy of StartOS. Head over to our :ref:`Flashing (Raspberry Pi) Guide <flashing-pi>` to complete your build.

22
site/source/diy/diy-x86.rst
View File

@@ -1,27 +1,25 @@
.. _diy-x86:
==================
DIY Guide (x86_64)
==================
=======================
DIY Guidelines (x86_64)
=======================
.. contents::
:depth: 2
:local:
Start9 is committed to ensuring that embassyOS is accessible. This guide is to install embassyOS on most x86_64 platforms. The x86_64-based Server Pro is available for purchase on the `Start9 Store <https://store.start9.com/products/embassy-pro>`_.
Start9 is committed to ensuring that sovereign computing is accessible. This guide is to install StartOS on **most** x86_64 platforms (your mileage will vary). The x86_64-based Server One and Server Pure are available for purchase on the `Start9 Store <https://store.start9.com/products>`_.
For help with this guide or to share your experience with others, please `head to our community forum <https://community.start9.com/>`_. Want to support Sovereign Computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
For more guidance or to share your experience with others, please `head to our community forum <https://community.start9.com/>`_. Want to support sovereign computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
Hardware
--------
With x86_64 support, embassyOS can now be run on a very wide array of hardware. You can even try out or run eOS in a Virtual Machine (VM) without having to buy any hardware whatsoever! Check out `this forum post <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-embassyos-v0-3-3/>`_ for the most up-to-date list of known-good hardware.
StartOS can be run on a wide array of hardware. StartOS is based on Linux, and on its own, is fairly lightweight. The hardware you require will depend mostly on how you intend to use your server. If you want to use a Bitcoin stack, you will want 8GB+ of RAM and 1TB+ of storage. If you mostly intend to use your server to store and manage files/passwords, then RAM will be less important and storage will depend on your needs. Check the current size of your existing storage solution (such as Dropbox or iCloud) to estimate your needs. You can also test or run StartOS in a Virtual Machine (VM) without having to buy any hardware whatsoever!
You can install embassyOS directly to your hardware, however, for advanced functionality (such as extensible storage), or if you experience issues with a bare metal install, we recommend installation with a hypervisor, such as Proxmox. A community member (Cyph3rp9nk) has written `a fantastic guide <https://telegra.ph/Guide-to-building-a-Bitcoin-Super-Node-02-27>`_ on how to do this.
Check out `this forum post <https://community.start9.com/t/known-good-hardware-master-list-hardware-capable-of-running-embassyos-v0-3-3/>`_ for the most up-to-date list of known-good hardware. For advanced functionality (such as extensible storage), or if you experience issues with a bare metal install, we recommend installation with a hypervisor, such as Proxmox. A community member (Cyph3rp9nk) has written `a fantastic guide <https://telegra.ph/Guide-to-building-a-Bitcoin-Super-Node-02-27>`_ on how to do this.
.. _os-reqs:
.. note:: embassyOS is based on Linux, and on its own, is fairly lightweight. The hardware you require will depend mostly on how you intend to use your server. If you intend to use a Bitcoin stack, you will want at least 8GB of RAM and 1TB of storage. If you mostly intend to use your server to store and manage files/passwords, then RAM will be less important and storage will depend on your needs. Check the current size of your existing storage solution (such as Dropbox or iCloud) to get an idea what you will require.
Minimum OS Requirements
.......................
The specs below would be acceptable for a server running minimal services with minimal storage needs
@@ -39,6 +37,6 @@ If you intend to run Bitcoin or store any meaningful amount of data, you will ne
- 8GB+ RAM
- 1TB+ Storage
Flash and Install embassyOS
---------------------------
After building your hardware, you will need a copy of embassyOS. Head over to our :ref:`Flashing (x86_64) Guide <flashing-x86>` to complete your Start9 server build.
Flash and Install StartOS
-------------------------
After building your hardware, you will need a copy of StartOS. Head over to our :ref:`Flashing (x86_64) Guide <flashing-x86>` to complete your Start9 server build.

14
site/source/diy/index.rst
View File

@@ -3,11 +3,11 @@
===
DIY
===
Here you will find guides for building your own Server! Currently, embassyOS supports the Raspberry Pi and on most x86_64 platforms (desktops, laptops, mini PCs, servers, and virtual machines).
Here you will find guidelines for building your own Start9 server! Currently, StartOS is known to work well on the Raspberry Pi and on **most** x86_64 platforms (desktops, laptops, mini PCs, servers, and virtual machines). ARM builds are also available, but are relativey untested.
Motivation
----------
There are several reasons you might prefer to build your own Embassy instead of purchasing one from us:
There are several reasons you might prefer to build your own server instead of purchasing one from Start9:
#. You already own the necessary hardware and would like to re-purpose it.
#. You want to save on shipping or import costs to your location.
@@ -26,18 +26,18 @@ There are several reasons you might prefer to build your own Embassy instead of
:link: diy-pi
:icon: scylla-icon scylla-icon--apps
:class: large-4
:anchor: View Guide
:anchor: View Guidelines
Build an Embassy using a Raspberry Pi
Build a Start9 server using a Raspberry Pi
.. topic-box::
:title: DIY (x86_64)
:link: diy-x86
:icon: scylla-icon scylla-icon--overview
:class: large-4
:anchor: View Guide
:anchor: View Guidelines
Build an Embassy on an x86_64 machine
Build a Start9 server using an x86_64 machine
.. toctree::
:hidden:
@@ -46,4 +46,4 @@ There are several reasons you might prefer to build your own Embassy instead of
diy-pi
diy-x86
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
Appreciate what we're doing? Please consider `donating to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_ or `contributing time/talent to the movement <https://start9.com/contribute>`_.

210
site/source/user-manual/initial-setup.rst
View File

@@ -3,8 +3,7 @@
=============
Initial Setup
=============
Check out the video below for a guide on setting up your Embassy!
Check out the video below for a guide on setting up your Start9 server!
.. youtube:: HI9WDq0tWm4
:width: 60%
@@ -17,14 +16,103 @@ Check out the video below for a guide on setting up your Embassy!
:depth: 2
:local:
Powering On
-----------
Power On
--------
#. Connect your server to power and Ethernet.
.. caution:: If you built StartOS from `source <https://github.com/start9labs/start-os>`_, it may take up to 20 minutes to first initialize.
#. Power the device on and select which mode you would like to continue in on the tab below:
You can either boot your server as-is (headless mode) or add a monitor, mouse, and keyboard (kiosk mode). Server Lite (Raspberry Pi) is currently headless **only**. Headless is the default and recommended option. All control of your server can be done from your computer or mobile device.
.. tabs::
.. group-tab:: Headless Mode
Ensure the device you are using (desktop/laptop or mobile) is connected to the same network as your server.
.. caution:: Sometimes a router will have a "guest WiFi network," which might be different than the network your server is placed on via ethernet.
Visit ``http://start.local`` from your web browser.
.. group-tab:: Kiosk Mode
Once your server boots, if you've attached a monitor, keyboard and mouse, you can set it up using the graphical kiosk mode. A familiar browser interface will display the StartOS setup page.
#. Select "Start Fresh."
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60%
: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.
#. Select your storage drive
.. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60%
:alt: Select Drive
#. Create a master password for your server and click "Finish."
.. 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%
: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%
:alt: SSD Initialization
#. You are now hosting your own private server!
.. 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%
: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.
.. figure:: /_static/images/setup/screen9-startfresh_complete-savedfile-go_to_start_login.jpg
:width: 60%
:alt: Setup Complete
.. _setup-troubleshooting:
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 one. If such ethernet connectivity is not available, or there is another hardware issue, you may hear this sound:
#. 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:
- Mullvad - Go to "Settings -> VPN Settings -> Local Network Sharing"
- ProtonVPN - Go to "Preferences -> Connection -> Allow LAN Connections"
#. Visit or refresh (ctrl+shift+R - Linux/Windows, cmd+shift+R - Mac) the start.local page in a web browser
#. To avoid networking issues, it is recommended to use your `primary` router, not an extender or mesh router.
#. Very rarely, your firewall settings may block mDNS. In this case:
- From your browser, navigate to your router configuration settings. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand.
- 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 :ref:`reach out to support<contact>` if you need a hand.
Server Models With Speakers
---------------------------
.. _sounds-bepchime:
#. Connect your Embassy to power and Ethernet.
#. If all is well, you will hear 2 distinct sounds:
Server Pure and Server One (2022 and older) have an internal speaker and may provide the following audio feedback:
.. raw:: HTML
@@ -42,115 +130,25 @@ Powering On
Your browser does not support the audio element.
</audio>
* "chime" - Embassy is ready
* "chime" - Server is ready
.. caution:: Glance through the :ref:`troubleshooting<setup-troubleshooting>` section if you hear any different sounds.
If you followed the DIY guide and built embassyOS from source code, it may take up to 20 minutes to first initialize.
.. raw:: HTML
You can either boot your Embassy with no monitor (headless mode) or with a monitor, mouse, and keyboard (kiosk mode). The Embassy One (based on a Raspberry Pi) currently does not have the ability to do kiosk mode. The Embassy One and the Embassy Pro (x86_64) both work in headless mode, as the local ethernet network must be available to setup your Embassy.
<audio controls>
<source src="/_static/sounds/FLATLINE.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
Power the device on and select which mode you would like to continue in on the tab below:
.. tabs::
.. group-tab:: Headless Mode
Ensure the device you are using (desktop/laptop or mobile) is connected to the same network as your Embassy.
.. caution:: Sometimes a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet.
Visit http://embassy.local from your web browser.
.. group-tab:: Kiosk Mode
Once your Embassy boots, if you've attached a monitor, keyboard and mouse, you can set it up using the graphical kiosk mode. A familiar browser interface will display the embassyOS setup page.
.. caution:: If you followed the DIY guide and your graphics card or monitor is unsupported hardware, you may not see the intended setup screen. If so, simply click on the "Headless Mode" tab above.
#. Select "Start Fresh"
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.jpg
:width: 60%
:alt: Fresh Setup
.. note:: The "Recover" button is used for :ref:`migrating from 0.2.x <upgrade-hardware>`, :ref:`restoring from backup <backup-restore>`, transferring data from a disk used in an old Embassy into a new one, or simply attaching an old Embassy's data drive to a new setup.
#. Select your storage drive
.. figure:: /_static/images/setup/screen4-select_storage.jpg
:width: 60%
:alt: Select Drive
#. Create a master password for your Embassy and click "Finish"
.. 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%
:alt: Create New Password
#. The drive will be initialized for a few minutes
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
:alt: SSD Initialization
#. Your Embassy is now a private website on the private web!
.. tip:: If you used headless mode, click "Download This Page" to save your Embassy address and certificate info to your computer.
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 60%
:alt: Setup Complete
#. Finally, you will be able to login to your newly setup Embassy. Continue to the section on :ref:`connecting` to learn more about using your Embassy over Tor and LAN.
.. figure:: /_static/images/setup/screen9-startfresh_complete-savedfile-go_to_embassy_login.jpg
:width: 60%
:alt: Setup Complete
.. _setup-troubleshooting:
Troubleshooting
---------------
If you are experiencing issues with setup, try the following:
#. Confirm that the Embassy is plugged into both power and Ethernet
- An ethernet network with DHCP server must be available at setup. Most routers provide one. If such ethernet connectivity is not available, or there is another hardware issue, you may hear this sound:
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/FLATLINE.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
#. Confirm the Embassy emitted two sounds when powering on: :ref:`a bep and a chime<sounds-bepchime>`
#. 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, it allows LAN connections, such as the options below:
- Mullvad - Go to "Settings -> VPN Settings -> Local Network Sharing"
- ProtonVPN - Go to "Preferences -> Connection -> Allow LAN Connections"
#. Visit or Refresh the embassy.local page in a web browser
#. To avoid networking issues, it is recommended to use your `primary` router, not an extender or mesh router.
#. Very rarely, your firewall settings may block mDNS. In this case:
- From your browser, navigate to your router configuration settings. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand.
- Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "embassy". Take note of the associated IP address and enter it into your browser's URL field to enter the setup.
- In some cases, if you are working with a very old image of embassyOS, the device name will show up as `start9-shortcode`. If this is the case, and you want to start fresh, wiping out the previous install and all data residing on it, :ref:`flash the newest version of embassyOS<flashing>`.
* "flatline" - Server initialization failed / no network connection
Raspberry Pi Lights
-------------------
The Raspberry Pi has 2 status 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.
Embassy One (NASPi case) has 2 additional lights.
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.
If you are still having issues, please :ref:`contact support <contact>`.