diff --git a/poetry.lock b/poetry.lock index 8a65e10..d2362f1 100644 --- a/poetry.lock +++ b/poetry.lock @@ -64,7 +64,7 @@ lxml = ["lxml"] [[package]] name = "certifi" -version = "2022.9.24" +version = "2022.12.7" description = "Python package for providing Mozilla's CA Bundle." category = "main" optional = false @@ -185,14 +185,11 @@ python-versions = ">=3.7" [[package]] name = "packaging" -version = "21.3" +version = "22.0" description = "Core utilities for Python packages" category = "main" optional = false -python-versions = ">=3.6" - -[package.dependencies] -pyparsing = ">=2.0.2,<3.0.5 || >3.0.5" +python-versions = ">=3.7" [[package]] name = "pathtools" @@ -243,17 +240,6 @@ python-versions = ">=3.6" [package.extras] plugins = ["importlib-metadata"] -[[package]] -name = "pyparsing" -version = "3.0.9" -description = "pyparsing module - Classes and methods to define and execute parsing grammars" -category = "main" -optional = false -python-versions = ">=3.6.8" - -[package.extras] -diagrams = ["railroad-diagrams", "jinja2"] - [[package]] name = "pytest" version = "5.4.3" @@ -634,7 +620,7 @@ socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] [[package]] name = "watchdog" -version = "2.1.9" +version = "2.2.0" description = "Filesystem events monitoring" category = "dev" optional = false @@ -751,10 +737,7 @@ markupsafe = [ {file = "MarkupSafe-2.1.1.tar.gz", hash = "sha256:7f91197cc9e48f989d12e4e6fbc46495c446636dfc81b9ccf50bb0ec74b91d4b"}, ] more-itertools = [] -packaging = [ - {file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"}, - {file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"}, -] +packaging = [] pathtools = [ {file = "pathtools-0.1.2.tar.gz", hash = "sha256:7c35c5421a39bb82e58018febd90e3b6e5db34c5443aaaf742b3f33d4655f1c0"}, ] @@ -770,10 +753,6 @@ py = [ {file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"}, ] pygments = [] -pyparsing = [ - {file = "pyparsing-3.0.9-py3-none-any.whl", hash = "sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"}, - {file = "pyparsing-3.0.9.tar.gz", hash = "sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb"}, -] pytest = [ {file = "pytest-5.4.3-py3-none-any.whl", hash = "sha256:5c0db86b698e8f170ba4582a492248919255fcd4c79b1ee64ace34301fb589a1"}, {file = "pytest-5.4.3.tar.gz", hash = "sha256:7979331bfcba207414f5e1263b5a0f8f521d0f457318836a7355531ed1a4c7d8"}, @@ -909,33 +888,7 @@ tornado = [ ] typing-extensions = [] urllib3 = [] -watchdog = [ - {file = "watchdog-2.1.9-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a735a990a1095f75ca4f36ea2ef2752c99e6ee997c46b0de507ba40a09bf7330"}, - {file = "watchdog-2.1.9-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6b17d302850c8d412784d9246cfe8d7e3af6bcd45f958abb2d08a6f8bedf695d"}, - {file = "watchdog-2.1.9-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ee3e38a6cc050a8830089f79cbec8a3878ec2fe5160cdb2dc8ccb6def8552658"}, - {file = "watchdog-2.1.9-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:64a27aed691408a6abd83394b38503e8176f69031ca25d64131d8d640a307591"}, - {file = "watchdog-2.1.9-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:195fc70c6e41237362ba720e9aaf394f8178bfc7fa68207f112d108edef1af33"}, - {file = "watchdog-2.1.9-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:bfc4d351e6348d6ec51df007432e6fe80adb53fd41183716017026af03427846"}, - {file = "watchdog-2.1.9-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:8250546a98388cbc00c3ee3cc5cf96799b5a595270dfcfa855491a64b86ef8c3"}, - {file = "watchdog-2.1.9-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:117ffc6ec261639a0209a3252546b12800670d4bf5f84fbd355957a0595fe654"}, - {file = "watchdog-2.1.9-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:97f9752208f5154e9e7b76acc8c4f5a58801b338de2af14e7e181ee3b28a5d39"}, - {file = "watchdog-2.1.9-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:247dcf1df956daa24828bfea5a138d0e7a7c98b1a47cf1fa5b0c3c16241fcbb7"}, - {file = "watchdog-2.1.9-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:226b3c6c468ce72051a4c15a4cc2ef317c32590d82ba0b330403cafd98a62cfd"}, - {file = "watchdog-2.1.9-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d9820fe47c20c13e3c9dd544d3706a2a26c02b2b43c993b62fcd8011bcc0adb3"}, - {file = "watchdog-2.1.9-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:70af927aa1613ded6a68089a9262a009fbdf819f46d09c1a908d4b36e1ba2b2d"}, - {file = "watchdog-2.1.9-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:ed80a1628cee19f5cfc6bb74e173f1b4189eb532e705e2a13e3250312a62e0c9"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_aarch64.whl", hash = "sha256:9f05a5f7c12452f6a27203f76779ae3f46fa30f1dd833037ea8cbc2887c60213"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_armv7l.whl", hash = "sha256:255bb5758f7e89b1a13c05a5bceccec2219f8995a3a4c4d6968fe1de6a3b2892"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_i686.whl", hash = "sha256:d3dda00aca282b26194bdd0adec21e4c21e916956d972369359ba63ade616153"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_ppc64.whl", hash = "sha256:186f6c55abc5e03872ae14c2f294a153ec7292f807af99f57611acc8caa75306"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:083171652584e1b8829581f965b9b7723ca5f9a2cd7e20271edf264cfd7c1412"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_s390x.whl", hash = "sha256:b530ae007a5f5d50b7fbba96634c7ee21abec70dc3e7f0233339c81943848dc1"}, - {file = "watchdog-2.1.9-py3-none-manylinux2014_x86_64.whl", hash = "sha256:4f4e1c4aa54fb86316a62a87b3378c025e228178d55481d30d857c6c438897d6"}, - {file = "watchdog-2.1.9-py3-none-win32.whl", hash = "sha256:5952135968519e2447a01875a6f5fc8c03190b24d14ee52b0f4b1682259520b1"}, - {file = "watchdog-2.1.9-py3-none-win_amd64.whl", hash = "sha256:7a833211f49143c3d336729b0020ffd1274078e94b0ae42e22f596999f50279c"}, - {file = "watchdog-2.1.9-py3-none-win_ia64.whl", hash = "sha256:ad576a565260d8f99d97f2e64b0f97a48228317095908568a9d5c786c829d428"}, - {file = "watchdog-2.1.9.tar.gz", hash = "sha256:43ce20ebb36a51f21fa376f76d1d4692452b2527ccd601950d69ed36b9e21609"}, -] +watchdog = [] wcwidth = [ {file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"}, {file = "wcwidth-0.2.5.tar.gz", hash = "sha256:c4d647b99872929fdb7bdcaa4fbe7f01413ed3d98077df798530e5b04f116c83"}, diff --git a/site/source/_static/images/flashing/amd64-asset.png b/site/source/_static/images/flashing/amd64-asset.png new file mode 100644 index 0000000..d5c05f9 Binary files /dev/null and b/site/source/_static/images/flashing/amd64-asset.png differ diff --git a/site/source/_static/images/flashing/raspi-tar-asset.png b/site/source/_static/images/flashing/raspi-tar-asset.png new file mode 100644 index 0000000..d35275e Binary files /dev/null and b/site/source/_static/images/flashing/raspi-tar-asset.png differ diff --git a/site/source/_static/images/flashing/raspi-zip-asset.png b/site/source/_static/images/flashing/raspi-zip-asset.png new file mode 100644 index 0000000..6a5478e Binary files /dev/null and b/site/source/_static/images/flashing/raspi-zip-asset.png differ diff --git a/site/source/_static/images/ssl/macos/mac-lan-setup0.png b/site/source/_static/images/ssl/macos/mac-lan-setup0.png new file mode 100644 index 0000000..ab16f14 Binary files /dev/null and b/site/source/_static/images/ssl/macos/mac-lan-setup0.png differ diff --git a/site/source/diy.rst b/site/source/diy.rst deleted file mode 100644 index 5bcec0a..0000000 --- a/site/source/diy.rst +++ /dev/null @@ -1,117 +0,0 @@ -.. _diy: - -========= -DIY Guide -========= - -.. contents:: - :depth: 2 - :local: - -.. figure:: /_static/images/diy/pi.png - :width: 40% - :alt: Raspberry Pi - - Raspberry Pi Board - -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. You can use the following guide to build your own Embassy One with readily available hardware. If any links are broken or sold out, please `head to our forums `_. - -Motivation ----------- -There are several reasons you might prefer to build your own Embassy instead of purchasing one from us: - - #. 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. - #. You do not trust Start9's supply chain. - #. You do not want to share your shipping address. - #. You like building things. - -Hardware --------- -The first thing you'll need to do is gather the hardware and assemble it. - -Parts -===== -#. `Geekworm NASPi v2.0 `_ ~$60 USD - - - 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) `_ ~$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) `_ ~$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) `_ ~$10 USD - - - A larger size is not necessary as it adds no benefit. - -#. `Ethernet Cable (Cat5 or Cat6) `_ ~$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 `_ ~$5 USD - - - Not strictly required, but HIGHLY recommended. - -#. `2-Pin Male-to-Male Power Wire `_ ~$5 USD - - - Required if using a speaker or Noctua fan. - -#. (Optional) `Noctua NF-A4x10 5v Fan (Get all below) `_ ~$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. - -Estimated total cost: - - - ~$375-460+ with 1-2TB of storage - -Assembly -======== -You can follow along with this `written guide `_ and/or our assembly video below: - - .. youtube:: Z1EW1TVgtow - :width: 100% - -.. raw:: html - -
-
- -Getting embassyOS ------------------ -After building your device, you need a copy of embassyOS. - - - Download the latest release of embassyOS from `our github `_, scroll to the Assets section, and download eos.tar.gz. - - This will soon be available as a more convenient download from our website. - -Installing embassyOS --------------------- -Next, you'll need to flash embassyOS 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. - - .. figure:: /_static/images/diy/balena.png - :width: 60% - :alt: Balena Etcher Dashboard - -#. Click "Select Image" and select your downloaded copy of embassyOS. -#. Click "Select Target" and select your 32GB microSD card. - - .. warning:: Be certain you have selected the correct target microSD card. Whatever target you select will be completely erased and replaced with embassyOS. - -#. Click "Flash!". You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal. -#. After the flash completes, you may remove the micro SD from the adapter, insert it into your Embassy's SD card slot, and continue to the :ref:`Initial Setup ` instructions. \ No newline at end of file diff --git a/site/source/diy/diy-arm.rst b/site/source/diy/diy-arm.rst new file mode 100644 index 0000000..69595dd --- /dev/null +++ b/site/source/diy/diy-arm.rst @@ -0,0 +1,74 @@ +.. _diy-arm: + +=============== +DIY Guide (ARM) +=============== + +.. 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 `_. If any links are broken or sold out, or if you need help or want to share your experience, please `head to our forums `_. Want to support Sovereign Computing? Please consider a `donation to Start9 `_. + + .. figure:: /_static/images/diy/pi.png + :width: 40% + :alt: Raspberry Pi + +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 `_. + +Parts +===== + #. `Geekworm NASPi v2.0 `_ ~$60 USD + + - 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) `_ ~$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) `_ ~$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) `_ ~$10 USD + + - A larger size is not necessary as it adds no benefit. + + #. `Ethernet Cable (Cat5 or Cat6) `_ ~$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 `_ ~$5 USD + + - Not strictly required, but HIGHLY recommended. + + #. `2-Pin Male-to-Male Power Wire `_ ~$5 USD + + - Required if using a speaker or Noctua fan. + + #. (Optional) `Noctua NF-A4x10 5v Fan (Get all below) `_ ~$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 `_ and/or our assembly video below: + + .. youtube:: Z1EW1TVgtow + :width: 100% + +Flash and Install embassyOS +--------------------------- +After building your hardware build, you will need a copy of embassyOS. Head over to our :ref:`Flashing (ARM) Guide ` to complete your Embassy One build. diff --git a/site/source/diy/diy-x86.rst b/site/source/diy/diy-x86.rst new file mode 100644 index 0000000..f8b6a61 --- /dev/null +++ b/site/source/diy/diy-x86.rst @@ -0,0 +1,36 @@ +.. _diy-x86: + +=============== +DIY Guide (x86) +=============== + +.. 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 in the `Start9 Store `_. 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 `_. Want to support Sovereign Computing? Please consider a `donation to Start9 `_. + + +Hardware +-------- +With x86 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 `_ for the most up-to-date list of known-good hardware. + +.. _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 Embassy. 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 +....................... +- Single vCPU Core 2Ghz +- 4GB RAM +- 64GB Storage + +Recommended OS Requirements +........................... +- Quad-Core CPU 2.5Ghz+ +- 8GB+ RAM +- 1TB+ Storage + +Flash and Install embassyOS +--------------------------- +After building your hardware build, you will need a copy of embassyOS. Head over to our :ref:`Flashing (x86) Guide ` to complete your Embassy build. diff --git a/site/source/diy/index.rst b/site/source/diy/index.rst new file mode 100644 index 0000000..ee404f8 --- /dev/null +++ b/site/source/diy/index.rst @@ -0,0 +1,49 @@ +.. _diy: + +=== +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). + +Motivation +---------- +There are several reasons you might prefer to build your own Embassy instead of purchasing one from us: + + #. 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. + #. You do not trust Start9's supply chain. + #. You do not want to share your shipping address. + #. You like building things. + +.. raw:: html + +
+ +
+ +.. topic-box:: + :title: DIY (ARM) + :link: diy-arm + :icon: scylla-icon scylla-icon--apps + :class: large-4 + :anchor: ARM Architecture + + Build an Embassy using a Raspberry Pi + +.. topic-box:: + :title: DIY (x86) + :link: diy-x86 + :icon: scylla-icon scylla-icon--overview + :class: large-4 + :anchor: x86 Architecture + + Build an Embassy on an x86 machine + +.. toctree:: + :hidden: + :maxdepth: 1 + + diy-arm + diy-x86 + +Appreciate what we're doing? Please consider a `donation to Start9 `_. diff --git a/site/source/index.rst b/site/source/index.rst index 5be628e..840276a 100644 --- a/site/source/index.rst +++ b/site/source/index.rst @@ -23,7 +23,7 @@ :title: User Manual :link: user-manual :icon: scylla-icon scylla-icon--knowledge-base - :class: large-6 + :class: large-4 :anchor: View Get started with your Embassy @@ -32,11 +32,20 @@ :title: Support :link: support :icon: scylla-icon scylla-icon--support - :class: large-6 + :class: large-4 :anchor: Get help Find answers to your questions +.. topic-box:: + :title: DIY + :link: diy + :icon: scylla-icon scylla-icon--memory-management + :class: large-4 + :anchor: Build your own + + Guides for builders, hackers, and tinkerers + .. topic-box:: :title: Learn :link: learn @@ -44,7 +53,7 @@ :class: large-4 :anchor: Get started - Read our FAQ and learn about platform concepts + Read our FAQ, watch videos, and understand platform concepts .. topic-box:: :title: Contribute @@ -68,10 +77,6 @@
-.. raw:: html - - - .. This is for the side navigation display .. toctree:: :maxdepth: 4 @@ -79,7 +84,7 @@ user-manual/index support/index + diy/index learn/index contribute/index developer-docs/index - diy diff --git a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst b/site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst index 900156f..d6bd2f3 100644 --- a/site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst +++ b/site/source/user-manual/connecting/connecting-lan/lan-os/lan-mac.rst @@ -14,6 +14,12 @@ Video Guide: :width: 60% :alt: LAN setup prompt +#. In the resulting box, choose "System" from the "Keychain" dropdown menu. Then click "Add." + + .. figure:: /_static/images/ssl/macos/mac-lan-setup0.png + :width: 60% + :alt: System Keychain + #. Enter your computer password when prompted. It will be imported into your mac's keychain. .. figure:: /_static/images/ssl/macos/certificate_untrusted.png diff --git a/site/source/user-manual/flashing.rst b/site/source/user-manual/flashing.rst deleted file mode 100644 index 069134f..0000000 --- a/site/source/user-manual/flashing.rst +++ /dev/null @@ -1,71 +0,0 @@ -.. _flashing: - -======== -Flashing -======== - -Getting embassyOS ------------------ -After building your device, you need a copy of embassyOS. - -* Visit the `latest embassyOS release page on Github `_ to download an image of embassyOS. It is ``eos.tar.gz`` for Linux/Mac and ``eos.zip`` for Windows. - -Extracting the image --------------------- - - .. warning:: Make sure you have at least 16gb available on your drive. - -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 - -Installing embassyOS --------------------- -Once you have the embassyOS image, you will need to flash it onto a microSD card. - -#. Download `balenaEtcher `_ 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 eos.img. -#. Click "Select Target" and select your 32GB microSD card. - - .. warning:: Be certain you have selected the correct target microSD card. Whatever target you select will be completely erased and replaced with embassyOS. - -#. Click "Flash!". You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal. -#. After the flash completes, you may remove the newly flashed micro SD card from any adapter, insert it into your Embassy's SD card slot, and continue to the :ref:`Initial Setup ` or :ref:`Update by reflashing ` instructions. diff --git a/site/source/user-manual/flashing/flashing-arm.rst b/site/source/user-manual/flashing/flashing-arm.rst new file mode 100644 index 0000000..55f9985 --- /dev/null +++ b/site/source/user-manual/flashing/flashing-arm.rst @@ -0,0 +1,89 @@ +.. _flashing-arm: + +============== +Flashing (ARM) +============== +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 `_. + + .. note:: You will need a micro SD card of at least 16GB in size, 32GB recommended + +Getting and Extracting the embassyOS Image +------------------------------------------ +Visit the `Github release page `_ to find the latest embassyOS release. Select your OS below to get the correct Asset and extraction directions. + +.. tabs:: + + .. group-tab:: Linux + + #. At the bottom of the page, under "Assets," download the ``embassyos_raspberrypi.tar.gz`` file and open a terminal in the directory you save it to. + + .. figure:: /_static/images/flashing/raspi-tar-asset.png + :width: 60% + + #. (Optional, but recommended) Verify the checksum against the one listed on GitHub: + + .. code-block:: + + sha256sum embassyos_raspberrypi.tar.gz + + #. Extract with: + + .. code-block:: + + tar -xzvf embassyos_raspberrypi.tar.gz + + .. group-tab:: Mac + + #. At the bottom of the page, under "Assets," download the ``embassyos_raspberrypi.tar.gz`` file. + + .. figure:: /_static/images/flashing/raspi-tar-asset.png + :width: 60% + + #. (Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a terminal and entering: + + .. code-block:: + + openssl dgst -sha256 embassyos_raspberrypi.tar.gz + + #. Right-click ``embassyos_raspberrypi.tar.gz``, click "open with," then click Archive Utility to extract. + + .. group-tab:: Windows + + #. At the bottom of the page, under "Assets," download the ``embassyos_raspberrypi.zip`` file + + .. figure:: /_static/images/flashing/raspi-zip-asset.png + :width: 60% + + #. (Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a CMD terminal and entering: + + .. code-block:: + + Get-FileHash embassyos_raspberrypi.zip + + #. Right-click eos.zip and click "Extract all" + +Installing embassyOS +-------------------- +Once you have extracted the embassyOS ``.img`` file, you will need to flash it onto a microSD card. + +#. Download `balenaEtcher `_ 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`` file. + +#. Click "Select Target" and select your microSD card. + + .. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target microSD card. Whatever target you select will be **COMPLETELY ERASED**!! + +#. Click "Flash!". You may be asked to (1) approve the unusually large disk target or (2) 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 Embassy's SD card slot. + +#. Finally, continue to the :ref:`Initial Setup `, :ref:`Manual Update `, or :ref:`Reset Password ` instructions - depending on your need. diff --git a/site/source/user-manual/flashing/flashing-firmware.rst b/site/source/user-manual/flashing/flashing-firmware.rst new file mode 100644 index 0000000..ad20a41 --- /dev/null +++ b/site/source/user-manual/flashing/flashing-firmware.rst @@ -0,0 +1,22 @@ +.. _flashing-firmware: + +=================== +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 `_. + +The source code can be viewed on Purism's `firmware git repo `_. + +.. note:: You will need a USB drive + +#. Download the firmware from `Purism's git repository `_. It does not need to be extracted. + + * ``pureboot-librem_mini_v2-basic_usb_autoboot.rom.gz`` + +#. Copy or move the 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, until you see the following screen: + + .. figure:: diff --git a/site/source/user-manual/flashing/flashing-x86.rst b/site/source/user-manual/flashing/flashing-x86.rst new file mode 100644 index 0000000..988c8ef --- /dev/null +++ b/site/source/user-manual/flashing/flashing-x86.rst @@ -0,0 +1,45 @@ +.. _flashing-x86: + +============== +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 `_. + + .. note:: You will need a USB drive of at least 16GB in size + +Getting embassyOS +----------------- +#. Visit the `Github release page `_ to find the latest embassyOS release. + +#. Select ``embassyos_amd64.iso`` from the "Assets" section at the bottom of the release. + + .. figure:: /_static/images/flashing/amd64-asset.png + :width: 60% + +Installing embassyOS +-------------------- +Once you have the embassyOS image, you will need to flash it onto your USB drive. + +#. Download `balenaEtcher `_ onto your Linux, Mac, or Windows computer. + +#. Insert the 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 ``embassyos_amd64.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 (1) approve the unusually large disk target or (2) enter your password. Both are normal. + +#. After this completes, you may remove the newly flashed drive from your computer, insert it into the device you intend to install embassyOS onto. + + .. note:: Always perfer the fastest available USB 3.0 port - typically this is blue or labeled "SS" (SuperSpeed) + +#. Finally, continue to the :ref:`Initial Setup `, :ref:`Manual Update `, or :ref:`Reset Password ` instructions - depending on your need. diff --git a/site/source/user-manual/flashing/index.rst b/site/source/user-manual/flashing/index.rst new file mode 100644 index 0000000..36984b0 --- /dev/null +++ b/site/source/user-manual/flashing/index.rst @@ -0,0 +1,15 @@ +.. _flashing: + +======== +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. + +.. toctree:: + :includehidden: + :maxdepth: 2 + + flashing-arm + flashing-x86 + flashing-firmware diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 867c347..3cf3360 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -15,7 +15,7 @@ Welcome to the embassyOS user manual. Here you will discover all that your Embas dashboard-overview updating backups/index - flashing + flashing/index reset-password customize managing-services