Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add QNAP installation instructions #2377

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions .vuepress/docs-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ module.exports = [
'installation/openhabian',
'installation/armbian',
'installation/docker',
'installation/qnap',
'installation/synology',
['installation/security', 'Security'],
['installation/reverse-proxy', 'Reverse Proxy']
Expand Down
47 changes: 47 additions & 0 deletions installation/qnap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: documentation
title: QNAP NAS
---

:::

# QNAP NAS

[QNAP NAS](https://www.qnap.com/en) is a server solution for home and business, allowing the installation of additional packages.

## Prerequisite - X86_64 or ARM64 platform

You need to install openHAB from [here](https://www.myqnap.org/product/openhab/). It contains the latest stable OH version and Zulu17 JDK.

The easiest way is to install the [MyQNAP repo](https://www.myqnap.org/install-the-repo/) and install openHAB from there so that updates are shown when published.

QNAP NAS is based on Linux but it has limitations since it is not a full server. Therefore, it is recommended to use [WinSCP](https://winscp.net/eng/index.php) to access `userdata`, `addons` and `conf` folders, etc.

### USB dongles

USB dongles may or may not work as QTS (QNAP's operating system) might not include the necessary drivers. However, you can install [USB serial drivers](https://www.myqnap.org/product/usb-serial-drivers/) (preferrably from MyQNAP repo), maybe it will include missing drivers for the dongle. In case of doubt use network dongles instead.

### Manual update

If you decide to replace MyQNAP's distribution with an official openHAB one, for example to install another OH version or even a milestone, you can update openHAB manually:

- Stop openhab (using "App Center")
- Navigate to OpenHab3 folder (physical address may be /share/CACHEDEV3_DATA/.qpkg/OpenHab3 but this depends on your install)
- Do a backup of OpenHab3 folder
- delete folder runtime
- inside folder userdata, delete folders cache, etc, and tmp
- Download the desired openHAB version from github (zip file)
- Unzip and copy to OpenHab3 folder (folders only, do not replace `start.sh`)
- Give runtime/bin/karaf and runtime/bin/backup X permission (you may use F9 in WinSCP)
- Edit /etc/config/qpkg.conf to specify the installed version (also update `Build` field to disable automatic updates)
- Start openhab (using "App Center")

### Other interesting packages provided by the MyQNAP repo

- Mosquitto (needs configuration after install)
- NodeJS v22 (required by zigbee2mqtt)
- QGit (required to install / update zigbee2mqtt)
- Node Red
- FFMpeg (complement to `IP Camera` binding)
- QPython312 (required by `HABApp`)
- UniFi (complement to `UniFi` binding)
Loading