Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
6e29fec
Created an immich migration guide
acknologia Dec 12, 2025
ad68211
Adds release notes for January 21, 2026
jerodfritz Jan 21, 2026
181bb39
Merge pull request #145 from eshtek/release/2026-01-13
jerodfritz Jan 21, 2026
e304e9c
Update latest release note to call out additional polish
jerodfritz Jan 21, 2026
3a22925
Merge pull request #146 from eshtek/release/2026-01-13
jerodfritz Jan 21, 2026
7a74ae2
Update minimum required Immich version for migration
acknologia Jan 21, 2026
e346358
Merge pull request #110 from eshtek/immich-migration-guide
acknologia Jan 21, 2026
0e90bcd
Merge branch 'dev' of https://github.com/eshtek/hexos-docs into dev
acknologia Jan 21, 2026
369ceed
added https:// to links
acknologia Jan 21, 2026
837a5d9
Merge pull request #147 from acknologia/hotfix-for-immich-migration-g…
acknologia Jan 21, 2026
2d8964c
update link for folder access
jerodfritz Jan 21, 2026
a95f3f7
Merge pull request #148 from eshtek/fix/folder-access-link
jerodfritz Jan 21, 2026
e5532f5
Create ApplicationErrors.md
acknologia Jan 21, 2026
1ef3f20
updating troubleshooting
acknologia Jan 21, 2026
12f9e68
added screenshots
acknologia Jan 21, 2026
f9376ce
Merge pull request #150 from acknologia/Application-Troubleshooting-g…
acknologia Jan 21, 2026
a296cea
Restructures troubleshooting guide navigation
jerodfritz Jan 21, 2026
75c4ff7
Creates link to app curation reset guide
jerodfritz Jan 21, 2026
33f10de
Merge pull request #151 from eshtek/feature/guide-links
jerodfritz Jan 21, 2026
2c71786
Adds note about updated troubleshooting guides to latest release notes
jerodfritz Jan 21, 2026
339e491
Merge pull request #152 from eshtek/release/01-21-2026-guides
jerodfritz Jan 21, 2026
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
14 changes: 12 additions & 2 deletions docs/.vitepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,17 @@ const sidebar: DefaultTheme.SidebarItem[] = [
collapsed: true,
items: [
{ text: 'Overview', link: '/troubleshooting/' },
{ text: 'Avoid USB Drives', link: '/troubleshooting/common-issues/AvoidUSBDrives' },
{ text: 'Clear Browser Cache', link: '/troubleshooting/common-issues/ClearCache' },
{
text: 'Common Issues',
link: '/troubleshooting/common-issues/',
collapsed: true,
items: [
{ text: 'Application Errors', link: '/troubleshooting/common-issues/ApplicationErrors' },
{ text: 'Avoid USB Drives', link: '/troubleshooting/common-issues/AvoidUSBDrives' },
{ text: 'Clear Browser Cache', link: '/troubleshooting/common-issues/ClearCache' },
{ text: 'Immich Migration', link: '/troubleshooting/common-issues/ImmichMigration' },
]
},
]
},
{
Expand Down Expand Up @@ -139,6 +148,7 @@ const sidebar: DefaultTheme.SidebarItem[] = [
collapsed: true,
items: [
// auto-generated-release-notes-start
{ text: '2026-01-21', link: '/release-notes/command-deck/2026-01-21' },
{ text: '2026-01-13', link: '/release-notes/command-deck/2026-01-13' },
{ text: '2026-01-08', link: '/release-notes/command-deck/2026-01-08' },
{ text: '2025-12-30', link: '/release-notes/command-deck/2025-12-30' },
Expand Down
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
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
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.
27 changes: 27 additions & 0 deletions docs/release-notes/command-deck/2026-01-21.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# January 21, 2026 - Mobile Dialogs, App Lifecycle, Polish, HexOS Local Prep

This release introduces improved app lifecycle management, mobile-optimized dialogs, and lays the groundwork for HexOS Local.

## Enhancements

### App Lifecycle Management

App start and stop operations are now individually orchestrated, providing better progress tracking and improved update workflows. App cards display server messages directly from TrueNAS, surfacing any startup configuration issues or lifecycle problems immediately for faster troubleshooting.

### Mobile-Optimized Dialogs

We're testing a new dialog on mobile to give better accessibility and reach. These appear as traditional modals on desktop and slide-up drawers on mobile. These have been applied to folders, users, and network settings.

### Interface Polish

We've refined the header styling and various UI elements throughout the interface. This includes improved input field borders and focus states, consistent button styling across dialogs, better light/dark mode transitions for dialog titles, and fixed button sizing inconsistencies.

### HexOS Local Preparation

This release also pushes a large block of code behind the scenes that will support the coming soon [HexOS Local](https://docs.hexos.com/blog/2025-11-25.html)

### Additional Guides

We've expanded our troubleshooting section with more guides for common issues. Check out the [latest here](/troubleshooting/common-issues/).

**NOTE:** This update was applied automatically to your Command Deck. You may need to clear your cache. Help with clearing your cache is available [here](/troubleshooting/common-issues/ClearCache).
1 change: 1 addition & 0 deletions docs/release-notes/command-deck/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ For users who are actively connected during an update, there may be a brief down
<!-- auto-generated-year-sections-start -->
## 2026 Releases

- [**2026-01-21**](./2026-01-21) - Mobile Dialogs, App Lifecycle, Polish, HexOS Local Prep
- [**2026-01-13**](./2026-01-13) - UI Improvements & Goldeye System Updates
- [**2026-01-08**](./2026-01-08) - HexOS Curated Apps & Enhanced Diagnostics

Expand Down
218 changes: 218 additions & 0 deletions docs/troubleshooting/common-issues/ApplicationErrors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
# Application Troubleshooting Guide

## Installation

- If installation fails once, try again immediately
- If it still fails check error
- This can be done by pressing the bell icon at the top of HexOS deck
- If HexOS shows an unknown error you can find more details by entering TrueNAS and selecting the clipboard icon
::: details How to view the error in TrueNAS
1) Login to [HexOS Deck Settings](https://deck.hexos.com/settings)
2) Select the TrueNAS Button
![](../../public/assets/screenshots/app-troubleshooting-guide/1.png)
3) Login to TrueNAS
- Username: truenas_admin
- Password: What was selected when installing HexOS
![](../../public/assets/screenshots/app-troubleshooting-guide/2.png)
4) Click on the clipboard icon at the top of the screen
![](../../public/assets/screenshots/app-troubleshooting-guide/3.png)
:::

## Updating

An App has to be running for it to updated. <br>
It is good practice to update apps regularly.

::: details How to update

1) Open the [HexOS Deck applications](Https://deck.hexos.com/applications) section
2) Select your app
3) Select the Update button on the Application info card
![](../../public/assets/screenshots/app-troubleshooting-guide/4.png)
:::
### If an app is not working after an application update

If your app stopped working immediately after an update you can go into TrueNAS and roll back a previous version of your app.
> Note: Some applications may have bugs when rolled back
::: details Instructions for rolling back an application

1) Login to [HexOS Deck Settings](https://deck.hexos.com/settings)
![](../../public/assets/screenshots/app-troubleshooting-guide/1.png)
2) Select the TrueNAS Button
3) Login to TrueNAS
- Username: truenas_admin
- Password: What was selected when installing HexOS
![](../../public/assets/screenshots/app-troubleshooting-guide/2.png)
4) Navigate to the `Apps` tab on the left sidebar menu
![](../../public/assets/screenshots/app-troubleshooting-guide/5.png)
5) Click on your application
6) Select the `Rollback` option on the `Application Info` card
![](../../public/assets/screenshots/app-troubleshooting-guide/6.png)
7) Select the most recent version of the app that worked and rollback
![](../../public/assets/screenshots/app-troubleshooting-guide/7.png)
:::

## Resetting App Curation

If the settings on an app were changed in TrueNAS you can use `Reset App Curation` to bring it back to the HexOS default configuration.
> Note: This can be used to update your application settings if HexOS has updated the curation.
::: details How to Reset App Curation
1) Open [Hexos Deck Application](https://deck.hexos.com/application) section
2) Select the app
3) Select the `options` button on the application info card
![](../../public/assets/screenshots/app-troubleshooting-guide/8.png)
4) Select `Reset App Curation`
![](../../public/assets/screenshots/app-troubleshooting-guide/9.png)
:::


## Application not showing up with the bookmarked link

- Open directly from HexOS Deck
- Check if your server's IP address has been updated

## App not starting

If apps are not starting after recent hardware changes you can try the following <br>
Motherboard changed: Try opening the app from HexOS Deck as your sever IP Address may have changed <br>
GPU changed: Try disabling GPU pass-through and disable using a gpu in the application configuration to troubleshoot <br>
::: details How to turn off GPU pass-through
1) Select the app in HexOS deck
2) Press the `options` button on the applications info card
![](../../public/assets/screenshots/app-troubleshooting-guide/20.png)
3) Press `Configure in TrueNAS`
![](../../public/assets/screenshots/app-troubleshooting-guide/11.png)
4) Scroll all the way to the bottom and uncheck GPU related options
![](../../public/assets/screenshots/app-troubleshooting-guide/12.png)
5) Press the Update button
![](../../public/assets/screenshots/app-troubleshooting-guide/13.png)
:::

# App Specific Troubleshooting

::: details Immich
## Immich

> <span style="color: red;">Warning: Do Not uninstall immich as a troubleshooting step unless explicitly instructed to or are planning to start again fresh</span>

### Installation

If you uninstalled Immich and it is no longer re-installing
consider deleting the the old datasets and start over fresh
> <span style="color: red;">Warning: Deleting the old data sets will also delete the copy of your media on the server</span>

### Updating Immich

#### Firmware 1.135.0 and higher

Coming soon

#### Firmware below 1.135.0

Coming soon

### Mobile Application not functioning

Update the Immich app on both the server side and the mobile side

### Immich Media not showing up

Check the storage paths in the settings <br>
Uploads: (HDDs/SSDs)/Photos/immich <br>
Postgres: (HDDs/SSDs)/Applications/immich/postgres_data <br>


If your storage locations do not match and you installed Immich via HexOS, are on Immich version 2.0.0+ and have not modified Immich in TrueNAS then you can [`Reset App Curation`](/troubleshooting/common-issues/ApplicationErrors.html#resetting-app-curation)

:::
# What to do if you need more help with apps

Fill out the following template and share it in on [HexOS HUB](https://hub.hexos.com) or contact us at Support@hexos.com

## Template

TrueNAS Version: <br>
Application Version: <br>
Model of CPU: <br>
Model of GPU: <br>
Modifications made in TrueNAS: <br>
Description of problem: <br>
Troubleshooting steps attempted: <br>

::: details TrueNAS Version

TrueNAS Version can be found by
1) Login to [HexOS Deck Settings](https://deck.hexos.com/settings)
2) Select the TrueNAS Button
![](../../public/assets/screenshots/app-troubleshooting-guide/1.png)
3) Login to TrueNAS
- Username: truenas_admin
- Password: What was selected when installing HexOS
![](../../public/assets/screenshots/app-troubleshooting-guide/2.png)
4) On the system information card you will see your TrueNAS Version
![](../../public/assets/screenshots/app-troubleshooting-guide/19.png)

:::
::: details Application Version

The application Version can be found by
1) Login to [HexOS Deck Settings](https://deck.hexos.com/settings)
2) Select the TrueNAS Button
![](../../public/assets/screenshots/app-troubleshooting-guide/1.png)
3) Login to TrueNAS
- Username: truenas_admin
- Password: What was selected when installing HexOS
![](../../public/assets/screenshots/app-troubleshooting-guide/2.png)
4) Navigate to the `Apps` tab on the left sidebar menu
5) Click on your application
6) On the `Application Info` card you will see an `App Version`
![](../../public/assets/screenshots/app-troubleshooting-guide/15.png)
:::

::: details Model of CPU

The model of the CPU in your server can be found by
1) Login to [HexOS Deck Settings](https://deck.hexos.com/settings)
2) Select the TrueNAS Button
![](../../public/assets/screenshots/app-troubleshooting-guide/1.png)
3) Login to TrueNAS
- Username: truenas_admin
- Password: What was selected when installing HexOS
![](../../public/assets/screenshots/app-troubleshooting-guide/2.png)
4) On the `CPU Model` card you will see your CPU Model
:::

::: details Model of GPU
1) Login to [HexOS Deck Settings](https://deck.hexos.com/settings)
2) Select the TrueNAS Button
![](../../public/assets/screenshots/app-troubleshooting-guide/1.png)
3) Login to TrueNAS
- Username: truenas_admin
- Password: What was selected when installing HexOS
![](../../public/assets/screenshots/app-troubleshooting-guide/2.png)
4) Navigate to the `System` tab on the left sidebar menu
![](../../public/assets/screenshots/app-troubleshooting-guide/16.png)
5) Select `Shell`
![](../../public/assets/screenshots/app-troubleshooting-guide/17.png)
6) Type `lspci | egrep -i 'vga|3d|display'`
![](../../public/assets/screenshots/app-troubleshooting-guide/18.png)
:::
::: details Modifications made in TrueNAS

Example modifications
- App installed via TrueNAS not HexOS
- Storage pool created in TrueNAS not HexOS
- App configuration modified in TrueNAS
:::
::: details Description of the problem

Describe the problem
When did it start?
What steps did you take before the problem started?

Include any errors reports that HexOS or TrueNAS informs you of in this section.
:::
::: details Troubleshooting steps attempted

A brief overview of any steps you have tried.
:::
Loading