mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
copy changes
This commit is contained in:
Matt Hill
@@ -1,14 +1,16 @@
|
||||
.. _diy-arm:
|
||||
.. _diy-pi:
|
||||
|
||||
===============
|
||||
DIY Guide (ARM)
|
||||
DIY Guide (Raspberry Pi)
|
||||
===============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Start9 is committed to ensuring that embassyOS is accessible. It will always be possible to build a comprable device to those sold by Start9. You can use the following guide to build your own Embassy One, the Raspberry Pi-based device available from the `Start9 Store <store.start9.com>`_. If any links are broken or sold out, or if you need help or want to share your experience, please `head to our forums <https://community.start9.com/>`_. Want to support Sovereign Computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
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>`_.
|
||||
|
||||
For help with this guide or to share your experience with other, 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%
|
||||
@@ -69,6 +71,10 @@ You can follow along with this `written guide <https://community.start9.com/t/di
|
||||
.. 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 (ARM) Guide <flashing-arm>` to complete your Embassy One build.
|
||||
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.
|
||||
@@ -8,8 +8,9 @@ DIY Guide (x86)
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Start9 is committed to ensuring that embassyOS is accessible. It will always be possible to build a comprable device to those sold in the `Start9 Store <https://store.start9.com>`_. You can use the following guide to build your own Embassy with readily available hardware. If you need help or want to share your experience, please `head to our forums <https://community.start9.com/>`_. Want to support Sovereign Computing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
Start9 is committed to ensuring that embassyOS is accessible. This guide is to install embassyOS on most x86 platforms. Start9's x86-based Embassy Pro is available for purchase on the `Start9 Store <https://store.start9.com/products/embassy-pro>`_.
|
||||
|
||||
For help with this guide or to share your experience with other, 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
|
||||
--------
|
||||
@@ -21,12 +22,16 @@ With x86 support, embassyOS can now be run on a very wide array of hardware. Yo
|
||||
|
||||
Minimum OS Requirements
|
||||
.......................
|
||||
The specs below would be acceptable for an Embassy running minimal services with minimal storage needs
|
||||
|
||||
- Single vCPU Core 2Ghz
|
||||
- 4GB RAM
|
||||
- 64GB Storage
|
||||
|
||||
Recommended OS Requirements
|
||||
...........................
|
||||
If you intend to run Bitcoin or store any meaningful amount of data, you will need
|
||||
|
||||
- Quad-Core CPU 2.5Ghz+
|
||||
- 8GB+ RAM
|
||||
- 1TB+ Storage
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
===
|
||||
DIY
|
||||
===
|
||||
Here you will find guides for building your own Embassy! Currently, embassyOS is supported on the Raspberry Pi (ARM architecture), and on most desktops, laptops, mini PCs, servers, and virtualization solutions (x86).
|
||||
Here you will find guides for building your own Embassy! Currently, embassyOS supports the Raspberry Pi and on most x86 platforms (desktops, laptops, mini PCs, servers, and virtual machines).
|
||||
|
||||
Motivation
|
||||
----------
|
||||
@@ -22,11 +22,11 @@ There are several reasons you might prefer to build your own Embassy instead of
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: DIY (ARM)
|
||||
:link: diy-arm
|
||||
:title: DIY (Raspberry Pi)
|
||||
:link: diy-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: ARM Architecture
|
||||
:anchor: View Guide
|
||||
|
||||
Build an Embassy using a Raspberry Pi
|
||||
|
||||
@@ -35,7 +35,7 @@ There are several reasons you might prefer to build your own Embassy instead of
|
||||
:link: diy-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: x86 Architecture
|
||||
:anchor: View Guide
|
||||
|
||||
Build an Embassy on an x86 machine
|
||||
|
||||
@@ -43,7 +43,7 @@ There are several reasons you might prefer to build your own Embassy instead of
|
||||
:hidden:
|
||||
:maxdepth: 1
|
||||
|
||||
diy-arm
|
||||
diy-pi
|
||||
diy-x86
|
||||
|
||||
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
|
||||
@@ -15,11 +15,11 @@ Embassy Devices & eOS
|
||||
|
||||
Embassy One
|
||||
-----------
|
||||
Embassy One is a plug 'n' play hardware device, based on the `Raspberry Pi <https://www.raspberrypi.org/>`_, assembled in-house by Start9. The current iteration features an internal SSD, speaker, active cooling, and power management in a custom AIO (all-in-one) case. Embassy One comes pre-loaded with :ref:`embassyOS<embassy-os>`. For more details, check out the `Embassy One tech specs <https://store.start9.com/collections/embassy/products/embassy>`_.
|
||||
Embassy One is a plug 'n' play hardware device, based on the `Raspberry Pi <https://www.raspberrypi.org/>`_, assembled in-house by Start9. The current iteration features an internal SSD, speaker, active cooling, and power management in a custom AIO (all-in-one) case. Embassy One comes pre-loaded with :ref:`embassyOS<embassy-os>`. For more details, check out the `Embassy One tech specs <https://store.start9.com/products/embassy-one>`_.
|
||||
|
||||
Embassy Pro
|
||||
-----------
|
||||
Embassy Pro is a plug 'n' play hardware device, based on the `Librem Mini <https://puri.sm/products/librem-mini/>`_, built by `Purism <https://puri.sm/about/>`_. The Pro features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. Embassy Pro comes pre-loaded with :ref:`embassyOS<embassy-os>`. For more details, check out the `Embassy Pro tech specs <https://store.start9.com/products/embassy-pro-presale>`_.
|
||||
Embassy Pro is a plug 'n' play hardware device, based on the `Librem Mini <https://puri.sm/products/librem-mini/>`_, built by `Purism <https://puri.sm/about/>`_. The Pro features a custom-built circuit board with active cooling, and an open-source firmware / boot stack. Embassy Pro comes pre-loaded with :ref:`embassyOS<embassy-os>`. For more details, check out the `Embassy Pro tech specs <https://store.start9.com/products/embassy-pro>`_.
|
||||
|
||||
.. _embassy-os:
|
||||
|
||||
@@ -27,7 +27,7 @@ embassyOS
|
||||
---------
|
||||
embassyOS (eOS) is a Linux-based operating system custom built for self-hosting open source software. eOS has a range of features that allow anyone to run their own server software without needing all of the traditionally required systems administration skills. Features such as advanced dependency management, sensible default configuration with potential for customization, and a sleek GUI make for a smooth user experience with minimal reliance on the developers for people with all levels of technical expertise.
|
||||
|
||||
Currently, 2 builds of eOS exist, one for the ARM architecture (Embassy One) and one for x86 (Embassy Pro). We currently only support the Raspberry Pi and Librem Mini hardware platforms, however with some minor tweaking, our builds should work on many other ARM and x86 devices. We hope to officially support more platforms soon, and we highly encourage hacking and community builds! Drop in our :ref:`community channels<contact>` to learn more and collaborate!!
|
||||
Currently, 2 builds of eOS exist, one for the Raspberry Pi (Embassy One) and one for x86 (Embassy Pro). We currently only support the Raspberry Pi and Librem Mini hardware platforms, however with some minor tweaking, our builds should work on many other ARM and x86 devices. We hope to officially support more platforms soon, and we highly encourage hacking and community builds! Drop in our :ref:`community channels<contact>` to learn more and collaborate!!
|
||||
|
||||
.. _sounds:
|
||||
|
||||
|
||||
@@ -3,11 +3,11 @@
|
||||
===================
|
||||
Flashing (Firmware)
|
||||
===================
|
||||
This page is for existing Librem Mini owners ONLY. This will allow you to flash the custom firmware on your Librem to neutralize the Intel Management Engine (IME) and add embassyOS-specific tweaks to your system, such that it will operate just as an Embassy Pro bought from Start9 would. If you need hardware and want all the benefits listed here, you'll have to `buy an Embassy Pro <https://store.start9.com>`_.
|
||||
This page is for existing Librem Mini owners ONLY. This will allow you to flash the custom firmware on your Librem to neutralize the Intel Management Engine (IME) and add embassyOS-specific tweaks to your system, such that it will operate just as an Embassy Pro bought from Start9 would. If you need hardware and want all the benefits listed here, you'll have to `buy an Embassy Pro <https://store.start9.com/products/embassy-pro>`_.
|
||||
|
||||
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/pureboot/-/tree/start9-intel-wifi>`_.
|
||||
|
||||
.. note:: You will need a USB drive, formatted FAT32
|
||||
.. note:: USB drive *must* be formatted for FAT32
|
||||
|
||||
#. Download the firmware (``pureboot-librem_mini_v2-basic_usb_autoboot.rom.gz``) from `Purism's git repository <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_ and extract it.
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
.. _flashing-arm:
|
||||
.. _flashing-pi:
|
||||
|
||||
==============
|
||||
Flashing (ARM)
|
||||
Flashing (Raspberry Pi)
|
||||
==============
|
||||
This guide is for flashing embassyOS to a micro SD card in order to install it to an ARM architecture device, namel the Raspberry Pi. Support for other ARM devices will come in future. 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-embassyos-v0-3-3/66/2>`_.
|
||||
This guide is for flashing embassyOS to a micro SD card in order to install it on a Raspberry Pi.
|
||||
|
||||
.. note:: You will need a micro SD card of at least 16GB in size, 32GB recommended
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
==============
|
||||
Flashing (x86)
|
||||
==============
|
||||
This guide is for flashing embassyOS to a USB drive in order to install it to an x86 architecture device. This will include most desktops, laptops, mini PCs, servers, and virtualization solutions. 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-embassyos-v0-3-3/66/2>`_.
|
||||
This guide is for flashing embassyOS to a USB drive in order to install it to an x86 architecture device. This will include most desktops, laptops, mini PCs, servers, and virtual machines. 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-embassyos-v0-3-3/66/2>`_.
|
||||
|
||||
.. note:: You will need a USB drive of at least 16GB in size
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
Flashing
|
||||
========
|
||||
|
||||
Here you will find our flashing guides for ARM (Raspberry Pi) and x86 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get embassyOS-specific firmware.
|
||||
Here you will find our flashing guides for Raspberry Pi and x86 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get embassyOS-specific firmware.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -13,11 +13,11 @@ Here you will find our flashing guides for ARM (Raspberry Pi) and x86 (most desk
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (ARM)
|
||||
:link: flashing-arm
|
||||
:title: Flashing (Raspberry Pi)
|
||||
:link: flashing-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: ARM Architecture
|
||||
:anchor: View Guide
|
||||
|
||||
Flash embassyOS for use on a Raspberry Pi
|
||||
|
||||
@@ -26,7 +26,7 @@ Here you will find our flashing guides for ARM (Raspberry Pi) and x86 (most desk
|
||||
:link: flashing-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: x86 Architecture
|
||||
:anchor: View Guide
|
||||
|
||||
Flash embassyOS for use on an x86 machine
|
||||
|
||||
@@ -43,7 +43,7 @@ Here you will find our flashing guides for ARM (Raspberry Pi) and x86 (most desk
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
flashing-arm
|
||||
flashing-pi
|
||||
flashing-x86
|
||||
flashing-firmware
|
||||
|
||||
|
||||
@@ -8,13 +8,12 @@ Reset Your Password
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
#. Obtain the latest copy of embassyOS by `downloading it from Github <https://github.com/Start9Labs/embassy-os/releases/latest>`_. Under `Assets` near the bottom of the page, click to download eos.tar.gz (on Linux/MacOS) or eos.zip (on Windows).
|
||||
#. Flash the downloaded image to your microSD card, using :ref:`this guide <flashing>`.
|
||||
#. Insert the microSD card into your Embassy and power it on.
|
||||
#. Download and flash the latest version of embassyOS, using the appropriate :ref:`flashing guide <flashing>` for your hardware.
|
||||
#. Power on your Embassy, ensuring it is plugged in to Ethernet.
|
||||
|
||||
.. note:: Embassy will power up and then initialize. Once complete, you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
|
||||
.. note:: Embassy 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.
|
||||
|
||||
#. On your computer, open up a browser and go to http://embassy.local.
|
||||
#. Using a phone or computer connected to the same network, open up a browser and go to http://embassy.local.
|
||||
|
||||
#. Select "Recover".
|
||||
|
||||
@@ -26,19 +25,12 @@ Reset Your Password
|
||||
.. figure:: /_static/images/setup/screen1-restore_or_useexisting.jpg
|
||||
:width: 60%
|
||||
|
||||
#. As instructed, plug in your embassyOS data drive and it will be detected.
|
||||
#. Select your Embassy data drive
|
||||
|
||||
.. 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 (blue) USB 3.0 port
|
||||
|
||||
#. Wait a moment while it reads the data from your drive.
|
||||
|
||||
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
|
||||
:width: 60%
|
||||
|
||||
#. Enter and confirm a new password of at least 12 characters when prompted. Save this password somewhere safe.
|
||||
#. Enter and confirm a new password. This time, save it somewhere safe!
|
||||
|
||||
.. figure:: /_static/images/setup/screen5-set_password.jpg
|
||||
:width: 60%
|
||||
|
||||
Reference in New Issue
Block a user