Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/.vitepress/theme/Layout.vue
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,12 @@ watch(

<template>
<DefaultTheme.Layout />
<noscript>
<iframe
src="https://www.googletagmanager.com/ns.html?id=GTM-524ZLZQB"
height="0"
width="0"
style="display: none; visibility: hidden"
></iframe>
</noscript>
</template>
36 changes: 36 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,48 @@ import './custom.css'
import Breadcrumb from './Breadcrumb.vue'
import Layout from './Layout.vue'
import { h } from 'vue'
import type { EnhanceAppContext } from 'vitepress'

declare global {
interface Window {
dataLayer: Record<string, unknown>[]
}
}

const GTM_ID = 'GTM-524ZLZQB'

function injectGtmScript(): void {
if (document.querySelector(`script[src*="googletagmanager.com/gtm.js?id=${GTM_ID}"]`)) return

window.dataLayer = window.dataLayer || []
window.dataLayer.push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' })

const script = document.createElement('script')
script.async = true
script.src = `https://www.googletagmanager.com/gtm.js?id=${GTM_ID}`
document.head.appendChild(script)
}

export default {
extends: DefaultTheme,
Layout() {
return h(Layout, null, {
'doc-before': () => h(Breadcrumb)
})
},
enhanceApp({ router }: EnhanceAppContext) {
if (typeof window === 'undefined') return

injectGtmScript()

router.onAfterRouteChanged = (to: string) => {
window.dataLayer = window.dataLayer || []
window.dataLayer.push({
event: 'page_view',
page_path: to,
page_location: window.location.href,
page_title: document.title
})
}
}
}
54 changes: 26 additions & 28 deletions docs/getting-started/installation/InstallGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ 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

[![Boot Screen](https://hub.hexos.com/uploads/monthly_2024_11/Capture.PNG.68aa841b48189723e75377b4eae0e4f5.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture.PNG.68aa841b48189723e75377b4eae0e4f5.PNG "Enlarge image")
![Boot Screen](../../public/assets/screenshots/Installation-guide/1.png "Enlarge image")

### Installation Menu

- 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")
![Installation Menu](../../public/assets/screenshots/Installation-guide/2.png "Enlarge image")

### Select Installation Drive

Expand All @@ -75,45 +75,37 @@ What you see now will depend on how many drives you have in your server. The dri
- **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")
![Drive Selection](../../public/assets/screenshots/Installation-guide/3.png "Enlarge image")

### Confirm Drive Erasure

- Confirm you understand the selected drive(s) will be **FULLY ERASED**

[![Drive Erasure Warning](https://hub.hexos.com/uploads/monthly_2024_11/Capture4.PNG.20de862b21fdbe599a413abfc6bc5db6.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture4.PNG.20de862b21fdbe599a413abfc6bc5db6.PNG "Enlarge image")
![Drive Erasure Warning](../../public/assets/screenshots/Installation-guide/4.png "Enlarge image")

### User Account Setup

- **Important**: Choose the first option: "Administrative user (truenas_admin)"
- If you accidentally select the wrong option, [see this solution](https://hub.hexos.com/topic/103-illustrated-installation-guide-start-here/#findComment-1958) or restart the installation <!-- TODO: migrate this hub forum link -->

[![User Account Setup](https://hub.hexos.com/uploads/monthly_2024_11/Capture5.PNG.f7af55f85dc45fff3932704006737410.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture5.PNG.f7af55f85dc45fff3932704006737410.PNG "Enlarge image")

### Set Root Password

- Set the root password - <span style="color: red;">**Save this password, you'll need it later**</span>
- Set the root password for the administrative user `truenas_admin`
- <span style="color: red;">**Save this password, you'll need it later**</span>
- **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) <!-- TODO: migrate this hub forum link -->

[![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")

### EFI Boot Options

- Choose "Yes" for newer hardware (generally recommended)

[![EFI Boot Options](https://hub.hexos.com/uploads/monthly_2024_11/Capture7.PNG.882149a9a6a418c51547772762cab939.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture7.PNG.882149a9a6a418c51547772762cab939.PNG "Enlarge image")
![Root Password Setup](../../public/assets/screenshots/Installation-guide/6.png "Enlarge image")

### Installation Progress

- The installer will run for a few minutes...

[![Installation Progress](https://hub.hexos.com/uploads/monthly_2024_11/Capture8.PNG.415546fcc3c0eddfc6051012a28c8a7e.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture8.PNG.415546fcc3c0eddfc6051012a28c8a7e.PNG "Enlarge image")
![Installation In Progress](../../public/assets/screenshots/Installation-guide/7.png "Enlarge image")

### Installation Complete

- Remove the install USB and restart your machine
- Remove the install USB

![Installation Complete](../../public/assets/screenshots/Installation-guide/8.png "Enlarge image")

[![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")
- Restart your Machine

![Restart](../../public/assets/screenshots/Installation-guide/9.png "Enlarge image")

## First Boot

Expand All @@ -122,20 +114,26 @@ What you see now will depend on how many drives you have in your server. The dri
- The boot select screen will appear again - ignore it
- The default option is correct and will auto-select

[![First Boot Screen](https://hub.hexos.com/uploads/monthly_2024_11/Capture10.PNG.6dd4a02dcdb72261ad0857b5af351bb1.PNG)](https://hub.hexos.com/uploads/monthly_2024_11/Capture10.PNG.6dd4a02dcdb72261ad0857b5af351bb1.PNG "Enlarge image")
![First Boot Screen](../../public/assets/screenshots/Installation-guide/10.png "Enlarge image")

### System Startup

- The console will display startup information
- **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)
![System Startup](../../public/assets/screenshots/Installation-guide/11.png "Enlarge image")

### Success!

- 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
- The "Console Setup" screen shows when your server has fully booted

![Console Setup Screen](../../public/assets/screenshots/Installation-guide/12.png "Enlarge image")

**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)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading