From 8b8edb6ddee38972d757e96eeddd8228296ebfce Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Tue, 30 Nov 2021 11:31:00 -0700 Subject: [PATCH] DIY updates --- source/getting-started/diy.rst | 96 +++++++++++++++++++++++++++------- 1 file changed, 76 insertions(+), 20 deletions(-) diff --git a/source/getting-started/diy.rst b/source/getting-started/diy.rst index ee5a478..4a98728 100644 --- a/source/getting-started/diy.rst +++ b/source/getting-started/diy.rst @@ -12,8 +12,7 @@ DIY Guide By popular demand, we are pleased to present this "Do it Yourself" (DIY) guide for the Start9 Embassy personal server! -.. warning:: This DIY guide is for EmbassyOS version 0.2.13. A substantive change will be made to this guide for EmbassyOS v0.3.0 scheduled for release in Q3 2021. When 0.3.0 launches it will REQUIRE hardware updates, which you can find `here `__. - +.. warning:: This DIY guide has directions for EmbassyOS versions 0.2.x and versions 0.3.x. When 0.3.0 launches it will REQUIRE hardware updates, which you can find `here `__. Please keep in mind that version 0.3.x is not yet available for purchase!! Please stay tuned to our community channels for updates. Motivation @@ -31,13 +30,11 @@ There are four reasons you might prefer to build your own Embassy instead of pur #. You just like building things. -Hardware -======== +Building EmbassyOS Versions 0.2.x +================================= -Components (EmbassyOS versions 0.2.x) -------------------------------------- - -.. note:: For newer versions of EmbassyOS (0.3.0 and above), please see the new hardware requirements `here `__. These pieces are *in addition* to the hardware below. +Hardware: Components +-------------------- #. `Raspberry Pi 4B (8GB) `_ #. `Power supply for Raspberry Pi 4B `_ @@ -45,12 +42,12 @@ Components (EmbassyOS versions 0.2.x) #. `High endurance microSD `_ (recommended 128GB or more) #. `GPIO mini speaker/buzzer `_ (These often sell out, please let us know if this link needs to be refreshed) #. Ethernet cable -#. MicroSD → USB adapter (if no microSD port on your computer) +#. MicroSD → USB adapter (or you may have a microSD port on your computer) `*` If you use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan `_. -Assembly Instructions ---------------------- +Hardware: Assembly Instructions +------------------------------- #. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`. @@ -60,18 +57,15 @@ Assembly Instructions That's it. Place the Raspberry Pi 4 board (with speaker attached), into its case. -Getting EmbassyOS -================= - -Purchasing ----------- +Getting EmbassyOS: Purchasing +----------------------------- You can purchase EmbassyOS `here `_. This is by far the easiest path to get up and running. Depending on your Internet speed, the download should take between 5 and 30 minutes. -Building from Source --------------------- +Getting EmbassyOS: Building from Source +--------------------------------------- If you have the proper tooling and are comfortable using the command line, you can build EmbassyOS from `source `_, which is made available under the `Start9 Personal Use License `_. @@ -81,7 +75,7 @@ Thanks to our community members who have kindly put together these guides! * A technically focused guide by `t0mmysm1th `_ Installing EmbassyOS -==================== +-------------------- Whether you purchase EmbassyOS from us or build it yourself, you need to flash it onto a microSD card. @@ -96,7 +90,69 @@ Whether you purchase EmbassyOS from us or build it yourself, you need to flash i :width: 60% :alt: Balena Etcher Dashboard -#. Once the image is flashed and verified, you may remove the micro SD and insert it into your Embassy. +#. Once the image is flashed and verified, you may remove the micro SD, insert it into your Embassy, and power up the device. +#. The Embassy is now ready for use, and you may following the normal :ref:`setup ` instructions. ``*`` + +``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete. + +Building EmbassyOS Versions 0.3.x +================================= + +Hardware: Components +-------------------- + +#. `Raspberry Pi 4B (8GB) `_ +#. `Power supply for Raspberry Pi 4B `_ Make sure this is at minimum 15w and 3.5a. +#. Case for Raspberry Pi 4B (`passive cooling recommended `_ `*`) +#. A `16GB microSD card `_ (no need for bigger). If you have ABSOLUTELY NO data to migrate, you may choose to re-use the card already in your Embassy. +#. `GPIO mini speaker/buzzer `_ (These often sell out, please let us know if this link needs to be refreshed) +#. Ethernet cable +#. MicroSD → USB adapter (or you may have a microSD port on your computer) +#. An external drive (1TB minimum, 2TB SSD recommended), or an `internal drive `_ with an `USB enclosure `_, as sold with our upgrade kits. MUST CONNECT OVER USB 3.0 + +`*` If you use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan `_. + +Hardware: Assembly Instructions +------------------------------- + +#. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`. + + .. figure:: /_static/images/diy/pins.png + :width: 60% + :alt: Speaker board spec + +#. Place the Raspberry Pi 4 board (with speaker attached), into its case. +#. Plug in the external drive to one of the USB 3.0 (blue) slots + +Getting EmbassyOS: Purchasing +----------------------------- + +You can purchase EmbassyOS `here `_. This is by far the easiest path to get up and running. + +Depending on your Internet speed, the download should take between 5 and 30 minutes. + +Getting EmbassyOS: Building from Source +--------------------------------------- + +A detailed build guide will be available around the time of the v0.3.0 release (or now, if you snoop around our GitHub long enough). + +Installing EmbassyOS +-------------------- + +Whether you purchase EmbassyOS from us or build it yourself, you need to flash it onto a microSD card. + +#. Download `balenaEtcher `_ onto your Mac, Windows, or Linux computer. +#. Insert the microSD card into your computer, either directly or using an adapter. +#. Open balenaEtcher. +#. Click `Select Image`, then find and select your copy of EmbassyOS. +#. Click `Select Target`, then find and select your micro SD card. +#. Click `Flash!` You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal. + + .. figure:: /_static/images/diy/balena.png + :width: 60% + :alt: Balena Etcher Dashboard + +#. Once the image is flashed and verified, you may remove the micro SD, insert it into your Embassy, and power up the device. #. The Embassy is now ready for use, and you may following the normal :ref:`setup ` instructions. ``*`` ``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete.