Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

restructure docs

Browse Source
This commit is contained in:
Matt Hill
2023-11-06 12:34:37 -07:00
parent 80651a6609
commit fe79d71e7c
150 changed files with 404 additions and 1866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
site/source/flashing-guides/firmware-pure.rst Normal file
View File

@@ -0,0 +1,51 @@
.. _flashing-firmware-pure:
======================
Firmware (Server Pure)
======================
This page is for Server Pure / Purism Librem Mini users ONLY. This firmware is custom for these devices.
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_. You will need a USB flash drive, formatted FAT32, to flash the firmware to your server.
.. caution:: USB drive **must** be formatted FAT32
#. `Download the latest firmware from Purism's git repository <https://source.puri.sm/firmware/releases/-/raw/master/librem_mini_v2/custom/pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-28.1.rom.gz>`_ and extract it.
#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-28.1.rom`` file onto your USB drive, then eject the drive and insert it into your (powered down) server. USB 3.0 (blue ports) will be faster.
.. note:: You'll need a monitor and keyboard plugged into your server for this operation
#. Turn on the server while pressing the ``ESC`` key on the keyboard repeatedly until you see the PureBoot Basic Boot Menu screen. Select "Options -->"
.. figure:: /_static/images/flashing/flash_firmware-pro-step1-pureboot_basic_boot_menu-options.jpg
:width: 30%
#. Select "Flash/Update the BIOS"
.. figure:: /_static/images/flashing/flash_firmware-pro-step2-flash_update_the_bios.jpg
:width: 30%
#. Select "Flash the firmware with a new ROM, erase settings"
.. figure:: /_static/images/flashing/flash_firmware-pro-step3-flash_firmware_with_new_rom.jpg
:width: 30%
#. The system will ask if you want to proceed flashing the BIOS with a new ROM, select "Yes"
.. figure:: /_static/images/flashing/flash_firmware-pro-step4-proceed_yes.jpg
:width: 30%
#. Choose the file that we downloaded and copied to the USB stick earlier: ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-28.1.rom``
.. figure:: /_static/images/flashing/flash_firmware-pro-step5-select_your_file.jpg
:width: 30%
#. Confirm you want to proceed with the flash by selecting "Yes"
.. figure:: /_static/images/flashing/flash_firmware-pro-step6-proceed_yes.jpg
:width: 30%
#. The BIOS will be reflashed with the new firmware. This may take a few minutes. When complete, remove the firmware USB, then select "OK" to complete the process.
.. figure:: /_static/images/flashing/flash_firmware-pro-step7-flashed_successfully.jpg
:width: 30%

17
site/source/flashing-guides/index.rst Normal file
View File

@@ -0,0 +1,17 @@
.. _flashing:
===============
Flashing Guides
===============
Here you will find our flashing guides for the Raspberry Pi and x86_64 (most desktops, laptops, mini PCs, servers, etc) architectures. Librem Mini owners can use the firmware flashing guide to get StartOS-specific firmware.
.. toctree::
:maxdepth: 1
os-pi
os-x86
firmware-pure
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.

73
site/source/flashing-guides/os-pi.rst Normal file
View File

@@ -0,0 +1,73 @@
.. _flashing-os-pi:
======================
StartOS (Raspberry Pi)
======================
This guide is for flashing StartOS to a micro SD card in order to install it on a Raspberry Pi with an external SSD. Please `contact support <https://start9.com/contact>`_ if you need to re-install your OS on a Server Lite (SD card storage).
.. warning:: If you are running in a "Lite" configuration (everything on an SD card), then flashing that SD card in the manner proscribed below WILL ERASE ALL YOUR DATA! If you need to reflash and you are NOT using an external SSD (ie. you have a Server Lite), please contact support for assistance instead.
Getting StartOS
---------------
Visit the `Github release page <https://github.com/Start9Labs/start-os/releases/latest>`_ to find the latest StartOS release.
At the bottom of the page, under "Assets," download the ``startos-..._raspberrypi.img.gz`` file.
.. figure:: /_static/images/flashing/raspi-asset.png
:width: 60%
:alt: Raspberry Pi Asset
Select your OS to continue:
.. tabs::
.. group-tab:: Linux
(Optional, but recommended) Verify the checksum against the one listed on GitHub (SHA256):
.. code-block::
sha256sum startos-0.3.4.2-efc56c0-20230525_raspberrypi.img.gz
.. group-tab:: Mac
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a terminal and entering:
.. code-block::
openssl dgst -sha256 startos-0.3.4.2-efc56c0-20230525_raspberrypi.img.gz
.. group-tab:: Windows
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening Windows PowerShell, changing your directory to where you downloaded the .img.gz file, and running `Get-FileHash`:
.. code-block::
cd Downloads
Get-FileHash startos-0.3.4.2-efc56c0-20230525_raspberrypi.img.gz
Installing StartOS
------------------
Once you have the StartOS ``.img.gz`` file, you will need to flash it onto a microSD card.
#. Download and install `balenaEtcher <https://www.balena.io/etcher/>`_ 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.gz`` file.
#. Click "Select Target" and select your microSD card.
.. warning:: BE ABSOLUTELY CERTAIN you have selected the correct target microSD card. Whatever drive you select will be **COMPLETELY ERASED**!!
#. Click "Flash!". You may be asked to approve the unusually large disk target and/or 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 server's SD card slot.
#. Finally, continue to the :ref:`Initial Setup <initial-setup>`, :ref:`Manual Update <manual-update>`, or :ref:`Reset Password <reset-password>` instructions - depending on your need.

78
site/source/flashing-guides/os-x86.rst Normal file
View File

@@ -0,0 +1,78 @@
.. _flashing-os-x86:
=============
StartOS (x86)
=============
This guide is for flashing StartOS to a USB drive in order to install it to an x86_64 architecture device. This will include most desktops, laptops, mini PCs, and servers. 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-startos/>`_.
.. note:: You will need a USB drive of at least 8GB in size
Getting StartOS
---------------
Visit the `Github release page <https://github.com/Start9Labs/start-os/releases/latest>`_ to find the latest StartOS release.
At the bottom of the page, under "Assets," download the ``x86_64.iso`` or ``x86_64-nonfree.iso`` file. The former image contains no proprietary software (built for the Server Pure). As the title implies, the latter, ``nonfree`` image, contains non-free (closed-source) software. This may be required for your hardware, especially for graphics and/or wireless device support.
.. figure:: /_static/images/flashing/x86_64-asset.png
:width: 60%
Select your OS to continue:
.. tabs::
.. group-tab:: Linux
(Optional, but recommended) Verify the checksum against the one listed on GitHub (SHA256):
.. code-block::
sha256sum startos-0.3.4.2-efc56c0-20230525_x86_64.iso
.. group-tab:: Mac
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening a terminal and entering:
.. code-block::
openssl dgst -sha256 startos-0.3.4.2-efc56c0-20230525_x86_64.iso
.. group-tab:: Windows
(Optional, but recommended) Verify the checksum against the one listed on GitHub by opening Windows PowerShell, changing your directory to where you downloaded the .img.gz file, and running `Get-FileHash`:
.. code-block::
cd Downloads
Get-FileHash startos-0.3.4.2-efc56c0-20230525_x86_64.iso
Installing StartOS
------------------
Once you have the StartOS image, you will need to flash it onto your USB drive.
#. Download `balenaEtcher <https://www.balena.io/etcher/>`_ onto your Linux, Mac, or Windows computer.
#. Insert your 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 ``.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 approve the unusually large disk target and/or enter your password. Both are normal.
#. After this completes, you may remove the newly flashed drive from your computer, and insert it into the device you intend to install StartOS onto.
#. Plug the USB drive into the device and power on. Follow the on-screen instructions to Install StartOS (use "Re-Install" to preserve data, or "Factory Reset" to wipe the device). After install is complete, you will be prompted to remove your USB drive.
.. note:: Always perfer the fastest available USB 3.0+ port - typically this is blue or labeled "SS" (SuperSpeed)
.. tip:: Occasionally, you may need to make some changes in your BIOS, such as turning off Secure Boot, or allowing USB boot for install. See the `Community Hub <https://community.start9.com>`_ for guides or to get help.
#. Finally, continue to the :ref:`Initial Setup <initial-setup>`, :ref:`Manual Update <manual-update>`, or :ref:`Reset Password <reset-password>` instructions - depending on your need.