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. diff --git a/docs/getting-started/installation/InstallGuide.md b/docs/getting-started/installation/InstallGuide.md index b988b42e..33110421 100644 --- a/docs/getting-started/installation/InstallGuide.md +++ b/docs/getting-started/installation/InstallGuide.md @@ -1,9 +1,22 @@ # Illustrated Installation Guide -*by [@Mawson](https://hub.hexos.com/profile/14-mawson/?wr=eyJhcHAiOiJmb3J1bXMiLCJtb2R1bGUiOiJmb3J1bXMtY29tbWVudCIsImlkXzEiOjEwMywiaWRfMiI6NDY0fQ==)* +*by [@Mawson](https://hub.hexos.com/profile/14-mawson/)* with edits by [@gingerling](https://hub.hexos.com/profile/19534-gingerling/) + +## Before you Begin + +You will need: + +- [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 separate computer to create a bootable USB installer and set up your server after installation + ## Download the HexOS Installer -- Download the installer ISO from either link: +Start by downloading the HexOS installer. You can download the installer from either link below. + - [https://downloads.hexos.com/TrueNAS-SCALE-25.04.2.6-HexOS.iso](https://downloads.hexos.com/TrueNAS-SCALE-25.04.2.6-HexOS.iso) - [https://hexos-downloads.sfo3.cdn.digitaloceanspaces.com/TrueNAS-SCALE-25.04.2.6-HexOS.iso](https://hexos-downloads.sfo3.cdn.digitaloceanspaces.com/TrueNAS-SCALE-25.04.2.6-HexOS.iso) - SHA256 Checksum: `e8ed99a322affe0969b82b866161a9f6acbc1561e3cc7b2efb2bf120ffe2e856` @@ -11,20 +24,39 @@ ## 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 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 - 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 create the installation USB - 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 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 +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 @@ -32,14 +64,16 @@ ### 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") ### 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, 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") @@ -58,8 +92,8 @@ ### 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) +- 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") @@ -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