mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-01 21:13:10 +00:00
Big refactor, many minor fixes (#441)
* Big refactor, many minor fixes * Link fixes, icon edits * Index and ToC fixes * update icons in theme lib and add to device guides index * WIP - refactor Initial setup, LAN, FF, others * First draft ready, many fixes and edits * Ooops - minor edits and changes on initial setup * Add change password guide (try 2). * Remove change password menu item from guides * Fix display bug, think different --------- Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Co-authored-by: gStart9 <george@start9labs.com>
This commit is contained in:
kn0wmad
56
site/source/guides/flashing/flashing-firmware.rst
Normal file
56
site/source/guides/flashing/flashing-firmware.rst
Normal file
@@ -0,0 +1,56 @@
|
||||
.. _flashing-firmware:
|
||||
|
||||
===================
|
||||
Flashing (Firmware)
|
||||
===================
|
||||
This page is for existing Librem Mini owners ONLY. This will add StartOS-specific tweaks to your system, such that it will operate just as a Start9 Pure bought from the `Start9 Store <https://store.start9.com/products/server-pro>`_.
|
||||
|
||||
The source code can be viewed on Purism's `firmware git repo <https://source.puri.sm/firmware/releases/-/tree/master/librem_mini_v2/custom>`_.
|
||||
|
||||
#. `Download the 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-26.rom.gz>`_ and extract it. You'll need a USB flash drive, formatted FAT32.
|
||||
|
||||
.. warning:: USB drive **must** be formatted for FAT32
|
||||
|
||||
#. Copy or move the resulting ``pureboot-librem_mini_v2-basic_usb_autoboot_blob_jail-Release-26.rom`` 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 while you see this screen:
|
||||
|
||||
.. figure:: /_static/images/flashing/flash_firmware-pro-step0-pureboot_screen.jpg
|
||||
:width: 30%
|
||||
|
||||
#. The PureBoot Basic Boot Menu screen will appear. 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-26.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 (and insert your StartOS USB if you are ready to install), then select "OK" to complete the process.
|
||||
|
||||
.. figure:: /_static/images/flashing/flash_firmware-pro-step7-flashed_successfully.jpg
|
||||
:width: 30%
|
||||
73
site/source/guides/flashing/flashing-pi.rst
Normal file
73
site/source/guides/flashing/flashing-pi.rst
Normal file
@@ -0,0 +1,73 @@
|
||||
.. _flashing-pi:
|
||||
|
||||
=======================
|
||||
Flashing (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:: DO NOT DO THIS UNLESS YOU HAVE AN EXTERNAL SSD. If you are running in a "Lite" configuration (everything on an SD card), then flashing in the manner proscribed below WILL ERASE ALL YOUR DATA! 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/guides/flashing/flashing-x86.rst
Normal file
78
site/source/guides/flashing/flashing-x86.rst
Normal file
@@ -0,0 +1,78 @@
|
||||
.. _flashing-x86:
|
||||
|
||||
=================
|
||||
Flashing (x86_64)
|
||||
=================
|
||||
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.
|
||||
50
site/source/guides/flashing/index.rst
Normal file
50
site/source/guides/flashing/index.rst
Normal file
@@ -0,0 +1,50 @@
|
||||
.. _flashing:
|
||||
|
||||
========
|
||||
Flashing
|
||||
========
|
||||
|
||||
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.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<div class="topics-grid grid-container full">
|
||||
|
||||
<div class="grid-x grid-margin-x">
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Raspberry Pi)
|
||||
:link: flashing-pi
|
||||
:icon: scylla-icon scylla-icon--apps
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash StartOS for use on a Raspberry Pi
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (x86_64)
|
||||
:link: flashing-x86
|
||||
:icon: scylla-icon scylla-icon--overview
|
||||
:class: large-4
|
||||
:anchor: View Guide
|
||||
|
||||
Flash StartOS for use on an x86_64 machine
|
||||
|
||||
.. topic-box::
|
||||
:title: Flashing (Firmware)
|
||||
:link: flashing-firmware
|
||||
:icon: scylla-icon scylla-icon--integrations
|
||||
:class: large-4
|
||||
:anchor: Librem Mini Firmware
|
||||
|
||||
Flash the custom firmware for StartOS on an existing Librem Mini
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
:maxdepth: 2
|
||||
|
||||
flashing-pi
|
||||
flashing-x86
|
||||
flashing-firmware
|
||||
|
||||
Appreciate what we're doing? Please consider a `donation to Start9 <https://btcpay.start9.com/apps/2Et1JUmJnDwzKncfVBXvspeXiFsa/crowdfund>`_.
|
||||
Reference in New Issue
Block a user