From c20dc6fb2478379f4e00897c5d278124ad3bc08c Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Sun, 28 Sep 2025 15:24:58 +0100 Subject: [PATCH 1/5] Update InstallGuide.md Added before you begin section Short explainers at start of each section (ISO, USB wipe, drives list will depend on your drives) Added short getting to boot screen section with boot order and secure boot fix Added link to US keyboard layout an slight expansion of that Elaborated on check boot order tip and linked back to boot order info --- .../installation/InstallGuide.md | 71 ++++++++++++++----- 1 file changed, 53 insertions(+), 18 deletions(-) diff --git a/docs/getting-started/installation/InstallGuide.md b/docs/getting-started/installation/InstallGuide.md index e2e3faa3..0180ed4a 100644 --- a/docs/getting-started/installation/InstallGuide.md +++ b/docs/getting-started/installation/InstallGuide.md @@ -1,30 +1,62 @@ # Illustrated Installation Guide -*by [@Mawson](https://hub.hexos.com/profile/14-mawson/?wr=eyJhcHAiOiJmb3J1bXMiLCJtb2R1bGUiOiJmb3J1bXMtY29tbWVudCIsImlkXzEiOjEwMywiaWRfMiI6NDY0fQ==)* +*by [@Mawson](https://hub.hexos.com/profile/14-mawson/?wr=eyJhcHAiOiJmb3J1bXMiLCJtb2R1bGUiOiJmb3J1bXMtY29tbWVudCIsImlkXzEiOjEwMywiaWRfMiI6NDY0fQ==)* with edits by [@gingerling](https://hub.hexos.com/profile/19534-gingerling/) + +## Before you Begin + +You will need: + +- To [buy HexOS](https://hub.hexos.com/store/product/1-lifetime/) +- [NAS hardware and drives](https://docs.hexos.com/getting-started/overview.html#getting-started) +- A USB drive that you are happy to wipe +- To connect your server to the Wifi router with a cable +- A screen, keyboard and possibly mouse connected to your NAS +- A seperate computer to make an install disk and set up your server after install + ## Download the HexOS Installer -- Download the installer ISO from either link: - - [https://downloads.hexos.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso](https://downloads.hexos.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso) - - [https://hexos-downloads.sfo3.cdn.digitaloceanspaces.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso](https://hexos-downloads.sfo3.cdn.digitaloceanspaces.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso) - - SHA256 Checksum: `0d3ee32e5ecf011da78ddcb49d0866478fb6a1ddfeddd563f458a23641c8d1c5` -- _(current as of 6/26/25)_ +The first step is to download the ISO (disk image) to install HexOS from. You can download the installer ISO from either link below. + +- [downloads.hexos.com](https://downloads.hexos.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso) +- [hexos download on digitaloceanspaces.com](https://hexos-downloads.sfo3.cdn.digitaloceanspaces.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso) +- Checksum: `0d3ee32e5ecf011da78ddcb49d0866478fb6a1ddfeddd563f458a23641c8d1c5` +- _(current as of 6/26/25)_ ## Create Installation USB -- Download Balena Etcher: [https://etcher.balena.io/#download-etcher](https://etcher.balena.io/#download-etcher) +The next step is to put the ISO onto a usb stick, then this is used to install HexOS. The USB will be completely wiped while making the ISO so check that it’s not got anything important on it before starting. To make the ISO use Balena Etcher. + +- [Download Balena Etcher](https://etcher.balena.io/#download-etcher) onto your computer - Install and open Etcher - Select "Flash from File" and choose your downloaded ISO - Select your target USB drive - Click 'Flash!' -**Important**: Do not use Rufus - it causes issues for many users. Stick with Balena Etcher. +**Important**: Do not use Rufus to make the ISO - it causes issues for many users. Stick with Balena Etcher. ## Installation Process -- Insert the USB into your server and power it on +- Insert the USB into your server and power it on + +### Getting to the Boot Screen + +If you do not see the boot screen (shown in the next section) right away the following are common issues + +#### Boot device order + +Your NAS hardware might be trying to BOOT from a different drive, for example an old windows install on one of the hard drives. +To fix this first enter the BIOS - usually this is done by pressing F10, F2, F12, F1, or DEL while the machine is turning on. +Then in the BIOS change the order of boot drives so your USB ISO is at the top. Then save/restart. + +#### Disabling Secure Boothttps://docs.hexos.com/getting-started/overview.html#getting-started +If you see an error message about a “security policy violation” after booting, this is caused by [Secure Boot](https://en.wikipedia.org/wiki/UEFI#Secure_Boot) + +For instructions on how to disable secure boot search '[your motherboard model here] disable secure boot'. You can also search for the motherboard user manual, and search within that for 'secure boot'". ### Boot Screen +Once you see this screen, you are ready to boot into HexOS and install it: + - Select "Start HexOS Installation" (default) - This screen will pass automatically after a moment @@ -38,8 +70,10 @@ ### Select Installation Drive -- **Use arrow keys to navigate, spacebar to select your installation drive** -- "**[*]**" indicates the device is selected +What you see now will depend on how many drives you have in your server. The drive or drives you choose to install HexOS on will not be available to store data on. + +- **Use arrow keys to navigate, spacebar to select your installation drive or drives** +- "**[*]**" in the first column indicates the device is selected [![Drive Selection](https://hub.hexos.com/uploads/monthly_2024_11/Capture3.PNG.8efa34d929a7a8dd6e148ebc17172509.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture3.PNG.8efa34d929a7a8dd6e148ebc17172509.PNG "Enlarge image") @@ -59,7 +93,7 @@ ### Set Root Password - Set the root password - **save this password, you'll need it later** -- **Non-US keyboard users**: Be careful with special characters as the installer uses US keyboard layout. [See details here](https://hub.hexos.com/topic/103-illustrated-installation-guide-start-here/page/2/#findComment-8073) +- **Non-US keyboard users**: Be careful with special characters in the password. The installer uses a [US keyboard layout](https://en.wikipedia.org/wiki/British_and_American_keyboards#/media/File:KB_United_States-NoAltGr.svg). [See details here](https://hub.hexos.com/topic/103-illustrated-installation-guide-start-here/page/2/#findComment-8073) [![Root Password Setup](https://hub.hexos.com/uploads/monthly_2024_11/Capture6.PNG.2757a99cb3d6eff2456fae08f5d8af22.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture6.PNG.2757a99cb3d6eff2456fae08f5d8af22.PNG "Enlarge image") @@ -77,7 +111,7 @@ ### Installation Complete -- Remove the install USB and restart your server +- Remove the install USB and restart your machine [![Installation Complete](https://hub.hexos.com/uploads/monthly_2024_11/Capture9.PNG.b01ff55fcd882a5612dd01b299807662.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture9.PNG.b01ff55fcd882a5612dd01b299807662.PNG "Enlarge image") @@ -93,14 +127,15 @@ ### System Startup - The console will display startup information -- **Tip**: If boot fails, check your BIOS boot device order +- **Tip**: If boot fails, check that HexOS is at the top in your BIOS boot device order. The instructions are [at the top of this guide here](####boot-device-order). [![System Startup](https://hub.hexos.com/uploads/monthly_2024_11/Capture11.thumb.PNG.6a43deaa983d715784365f338659d44c.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture11.PNG.8d234b71bdcd3fbbdd5ad5389338e67f.PNG) ### Success! -- **Installation complete!** -- **Next step**: Head to [https://deck.hexos.com/](https://deck.hexos.com/) to configure your server -- The "Console Setup" screen shows when HexOS is running properly +- The "Console Setup" screen shows when HexOS is running properly +- **Installation complete!** +- **Next step**: Open a browser window on your laptop and go to [https://deck.hexos.com/](https://deck.hexos.com/) to configure your server + +[![Console Setup Screen](https://hub.hexos.com/uploads/monthly_2024_11/Capture12.thumb.PNG.44c581cd145b735c1ce98f591991f934.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture12.PNG.ad70047f68f85e17303c4c874af95fc1.PNG) -[![Console Setup Screen](https://hub.hexos.com/uploads/monthly_2024_11/Capture12.thumb.PNG.44c581cd145b735c1ce98f591991f934.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture12.PNG.ad70047f68f85e17303c4c874af95fc1.PNG) \ No newline at end of file From e0aefd94ab3d2720113fa8dd6ef0ed776fd66c2f Mon Sep 17 00:00:00 2001 From: Anna Morris Date: Wed, 1 Oct 2025 11:11:27 +0100 Subject: [PATCH 2/5] Update InstallGuide.md typo --- docs/getting-started/installation/InstallGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/installation/InstallGuide.md b/docs/getting-started/installation/InstallGuide.md index 0180ed4a..4dfd556f 100644 --- a/docs/getting-started/installation/InstallGuide.md +++ b/docs/getting-started/installation/InstallGuide.md @@ -48,7 +48,7 @@ Your NAS hardware might be trying to BOOT from a different drive, for example an To fix this first enter the BIOS - usually this is done by pressing F10, F2, F12, F1, or DEL while the machine is turning on. Then in the BIOS change the order of boot drives so your USB ISO is at the top. Then save/restart. -#### Disabling Secure Boothttps://docs.hexos.com/getting-started/overview.html#getting-started +#### Disabling Secure Boot If you see an error message about a “security policy violation” after booting, this is caused by [Secure Boot](https://en.wikipedia.org/wiki/UEFI#Secure_Boot) For instructions on how to disable secure boot search '[your motherboard model here] disable secure boot'. You can also search for the motherboard user manual, and search within that for 'secure boot'". From bd237d66fd38b90f51ebb56db3b085fe757b58be Mon Sep 17 00:00:00 2001 From: acknologia <64101826+acknologia@users.noreply.github.com> Date: Wed, 5 Nov 2025 14:56:39 -0500 Subject: [PATCH 3/5] Update InstallGuide.md updated wording for the before you begin section --- docs/getting-started/installation/InstallGuide.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/getting-started/installation/InstallGuide.md b/docs/getting-started/installation/InstallGuide.md index 4dfd556f..1ba4c59f 100644 --- a/docs/getting-started/installation/InstallGuide.md +++ b/docs/getting-started/installation/InstallGuide.md @@ -6,12 +6,12 @@ You will need: -- To [buy HexOS](https://hub.hexos.com/store/product/1-lifetime/) -- [NAS hardware and drives](https://docs.hexos.com/getting-started/overview.html#getting-started) -- A USB drive that you are happy to wipe -- To connect your server to the Wifi router with a cable -- A screen, keyboard and possibly mouse connected to your NAS -- A seperate computer to make an install disk and set up your server after install +- [To purchase a HexOS license](https://hub.hexos.com/store/product/1-lifetime/) +- [Server hardware](https://docs.hexos.com/getting-started/overview.html#getting-started) +- An 8 GB or larger USB drive that can be safely erased +- An ethernet cable to connect your server to your router or network switch +- A display, keyboard and optionally a mouse to connect to your server +- A seperate computer to create a bootable USB installer and set up your server after installation ## Download the HexOS Installer From 1194e8c51f3004eeb3de0a1a2f12f98c4c2ab76d Mon Sep 17 00:00:00 2001 From: acknologia <64101826+acknologia@users.noreply.github.com> Date: Mon, 10 Nov 2025 17:08:24 -0500 Subject: [PATCH 4/5] updated install guide simplified some wording, added emphasis to remembering root password. --- .../installation/InstallGuide.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/getting-started/installation/InstallGuide.md b/docs/getting-started/installation/InstallGuide.md index 1ba4c59f..2d91eaf2 100644 --- a/docs/getting-started/installation/InstallGuide.md +++ b/docs/getting-started/installation/InstallGuide.md @@ -1,6 +1,6 @@ # Illustrated Installation Guide -*by [@Mawson](https://hub.hexos.com/profile/14-mawson/?wr=eyJhcHAiOiJmb3J1bXMiLCJtb2R1bGUiOiJmb3J1bXMtY29tbWVudCIsImlkXzEiOjEwMywiaWRfMiI6NDY0fQ==)* with edits by [@gingerling](https://hub.hexos.com/profile/19534-gingerling/) +*by [@Mawson](https://hub.hexos.com/profile/14-mawson/)* with edits by [@gingerling](https://hub.hexos.com/profile/19534-gingerling/) ## Before you Begin @@ -11,11 +11,11 @@ You will need: - An 8 GB or larger USB drive that can be safely erased - An ethernet cable to connect your server to your router or network switch - A display, keyboard and optionally a mouse to connect to your server -- A seperate computer to create a bootable USB installer and set up your server after installation +- A separate computer to create a bootable USB installer and set up your server after installation ## Download the HexOS Installer -The first step is to download the ISO (disk image) to install HexOS from. You can download the installer ISO from either link below. +Start by downloading the HexOS installer. You can download the installer from either link below. - [downloads.hexos.com](https://downloads.hexos.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso) - [hexos download on digitaloceanspaces.com](https://hexos-downloads.sfo3.cdn.digitaloceanspaces.com/TrueNAS-SCALE-24.10.2.2-HexOS.iso) @@ -24,7 +24,7 @@ The first step is to download the ISO (disk image) to install HexOS from. You ca ## Create Installation USB -The next step is to put the ISO onto a usb stick, then this is used to install HexOS. The USB will be completely wiped while making the ISO so check that it’s not got anything important on it before starting. To make the ISO use Balena Etcher. +The next step is to put the .iso file onto a USB stick with Balena Etcher. The USB will be **erased** during this process. - [Download Balena Etcher](https://etcher.balena.io/#download-etcher) onto your computer - Install and open Etcher @@ -32,7 +32,7 @@ The next step is to put the ISO onto a usb stick, then this is used to install H - Select your target USB drive - Click 'Flash!' -**Important**: Do not use Rufus to make the ISO - it causes issues for many users. Stick with Balena Etcher. +**Important**: Do not use Rufus to create the installation USB - Stick with Balena Etcher. ## Installation Process @@ -44,8 +44,8 @@ If you do not see the boot screen (shown in the next section) right away the fol #### Boot device order -Your NAS hardware might be trying to BOOT from a different drive, for example an old windows install on one of the hard drives. -To fix this first enter the BIOS - usually this is done by pressing F10, F2, F12, F1, or DEL while the machine is turning on. +Your server might be trying to boot from a different drive, for example an old windows install on one of the hard drives. +To fix this first enter the BIOS - usually this is done by pressing F1, F2, F10, F12 or DEL while the machine is turning on. Then in the BIOS change the order of boot drives so your USB ISO is at the top. Then save/restart. #### Disabling Secure Boot @@ -64,7 +64,7 @@ Once you see this screen, you are ready to boot into HexOS and install it: ### Installation Menu -- After the system loads, choose option 1: "Install/Upgrade" +- Once the system loads, select option 1: "Install/Upgrade" [![Installation Menu](https://hub.hexos.com/uploads/monthly_2024_11/Capture2.PNG.0632104eaf1d3158bd759f4a8b595244.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture2.PNG.0632104eaf1d3158bd759f4a8b595244.PNG "Enlarge image") @@ -72,7 +72,7 @@ Once you see this screen, you are ready to boot into HexOS and install it: What you see now will depend on how many drives you have in your server. The drive or drives you choose to install HexOS on will not be available to store data on. -- **Use arrow keys to navigate, spacebar to select your installation drive or drives** +- **Use arrow keys to navigate, space-bar to select your installation drive or drives** - "**[*]**" in the first column indicates the device is selected [![Drive Selection](https://hub.hexos.com/uploads/monthly_2024_11/Capture3.PNG.8efa34d929a7a8dd6e148ebc17172509.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture3.PNG.8efa34d929a7a8dd6e148ebc17172509.PNG "Enlarge image") @@ -92,7 +92,7 @@ What you see now will depend on how many drives you have in your server. The dri ### Set Root Password -- Set the root password - **save this password, you'll need it later** +- Set the root password - **Save this password, you'll need it later** - **Non-US keyboard users**: Be careful with special characters in the password. The installer uses a [US keyboard layout](https://en.wikipedia.org/wiki/British_and_American_keyboards#/media/File:KB_United_States-NoAltGr.svg). [See details here](https://hub.hexos.com/topic/103-illustrated-installation-guide-start-here/page/2/#findComment-8073) [![Root Password Setup](https://hub.hexos.com/uploads/monthly_2024_11/Capture6.PNG.2757a99cb3d6eff2456fae08f5d8af22.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture6.PNG.2757a99cb3d6eff2456fae08f5d8af22.PNG "Enlarge image") From 12e7939c257871c272f37855c92d565bf358e7de Mon Sep 17 00:00:00 2001 From: acknologia <64101826+acknologia@users.noreply.github.com> Date: Sun, 23 Nov 2025 00:05:50 -0500 Subject: [PATCH 5/5] updated features/settings page adjusted formatting, reduced word count. updated with additional features. --- docs/features/settings/index.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/features/settings/index.md b/docs/features/settings/index.md index a4fc22f7..593cdd7f 100644 --- a/docs/features/settings/index.md +++ b/docs/features/settings/index.md @@ -1,28 +1,37 @@ # Settings -Need to tweak how your server behaves? This is where you'll find all the configuration options, from network setup to customizing your dashboard to choosing where different types of files get stored. +This is where you can adjust your server behavior and configuration. ## System ### Network -Configure your server's network connection and how devices reach it. Set up network interfaces with static IPs if needed, change your server's hostname, and handle advanced networking like VLANs for complex setups. +Configure your server's network connection and how devices reach it. +- Set up network interfaces with static IPs. +- Change your server's hostname. +- Advanced networking configuration options such as VLANs. ### Preferences Fine tune your HexOS experience with dashboard controls. -Toggle entire dashboard sections (storage, apps, system) or drill down to individual items - hide specific storage pools, system health metrics, processor info, memory usage, or individual network interfaces. Change your language, switch to dark mode, and enable [experimental features](/features/settings/experimental-features/). +- Toggle dashboard items or sections. +- Switch to dark mode. +- Enable [experimental features](/features/settings/experimental-features/). -## Reset Options +## Reset -Sometimes you need a fresh start, or want to hand your server off to someon eelse. Currently you have two options. +The reset settings allows for rolling back your server to a different state. - **Unclaim Server** will remove your server from our database. Nothing happens to the physical server. You will no longer be able to access it through HexOS, but it can be reclaimed. - **Wipe everything** will delete all data on all drives and reset your server to defaults. +- **Restore previous** will let you choose to go back to a previous point in time to undo any recent changes. (Pool data will not be affected) ## Applications ### Locations -A comprehensive location editor where you can customize paths for applications and folders. Set where applications install, choose storage locations for downloads, documents, media files, and more across your different storage pools. +A location editor which allows for customizations of system folder paths. +- Select where applications install. +- Choose the locations for downloads, documents, media, and other system folders across your storage pools. +>System folder locations can only be modified if no installed are are using it.