mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-09 05:44:23 +00:00
226 lines
6.3 KiB
Markdown
226 lines
6.3 KiB
Markdown
# OpenMediaVault
|
|
|
|
NAS solution based on [Debian Linux][debian].
|
|
|
|
1. [TL;DR](#tldr)
|
|
1. [First access](#first-access)
|
|
1. [Make other users administrators](#make-other-users-administrators)
|
|
1. [Remove access for the default admin user](#remove-access-for-the-default-admin-user)
|
|
1. [Wake On Lan](#wake-on-lan)
|
|
1. [Power management](#power-management)
|
|
1. [CPU governor](#cpu-governor)
|
|
1. [Disk power options](#disk-power-options)
|
|
1. [OMV Extras](#omv-extras)
|
|
1. [ZFS](#zfs)
|
|
1. [Further readings](#further-readings)
|
|
1. [Sources](#sources)
|
|
|
|
## TL;DR
|
|
|
|
Default web UI login: `admin`:`openmediavault`<br/>
|
|
The root password is the one set during installation.
|
|
|
|
```sh
|
|
# Make other users administrators.
|
|
gpasswd -a 'me' 'openmediavault-admin'
|
|
usermod -aG 'openmediavault-admin' 'me'
|
|
|
|
# Revoke WebUI access from the 'admin' user.
|
|
gpasswd -d 'admin' 'openmediavault-admin'
|
|
deluser 'admin' 'openmediavault-admin'
|
|
|
|
# Install plugins from the CLI.
|
|
apt install 'openmediavault-clamav'
|
|
|
|
# Install OMV-Extras.
|
|
wget -O - 'https://github.com/OpenMediaVault-Plugin-Developers/packages/raw/master/install' | bash
|
|
|
|
# Disable the kernel's backports sources.
|
|
mv -v \
|
|
'/etc/apt/sources.list.d/openmediavault-kernel-backports.list' \
|
|
'/etc/apt/sources.list.d/openmediavault-kernel-backports.list.disabled'
|
|
|
|
# Upgrade packages.
|
|
sudo omv-upgrade
|
|
|
|
# Move to the next release.
|
|
# Includes upgrading the OS to the next version.
|
|
# E.g.: Debian 11 -> 12 + OMV 6 -> 7
|
|
tmux new-session -As 'omv-release-upgrade' "sudo omv-release-upgrade"
|
|
```
|
|
|
|
## First access
|
|
|
|
Default web UI login: `admin`:`openmediavault`<br/>
|
|
The root password is the one set during installation.
|
|
|
|
## Make other users administrators
|
|
|
|
Just add the user to the `openmediavault-admin` group:
|
|
|
|
```sh
|
|
gpasswd -a 'me' 'openmediavault-admin'
|
|
usermod -aG 'openmediavault-admin' 'me'
|
|
```
|
|
|
|
## Remove access for the default admin user
|
|
|
|
Only do this **after** you created another user and [made it an admin][make other users administrators].
|
|
|
|
From the safest to the less safe option:
|
|
|
|
1. Lock the account:
|
|
|
|
```sh
|
|
chage -E0 'admin'
|
|
```
|
|
|
|
1. Remove it from the `openmediavault-admin` group:
|
|
|
|
```sh
|
|
gpasswd -d 'admin' 'openmediavault-admin'
|
|
deluser 'admin' 'openmediavault-admin'
|
|
```
|
|
|
|
1. Delete it completely:
|
|
|
|
```sh
|
|
userdel -r 'admin'
|
|
deluser 'admin'
|
|
```
|
|
|
|
## Wake On Lan
|
|
|
|
The network interface **must** support this feature and it **must** be enabled in the BIOS.
|
|
|
|
WOL is **not** enabled by default in the kernel driver.<br/>
|
|
Enable the option under _Network_ > _Interfaces_, in **every** NIC's settings you want to respond.
|
|
|
|
## Power management
|
|
|
|
### CPU governor
|
|
|
|
Enabling the _Monitoring_ option under _System_ > _Power Management_ configures `cpufrequtils`.<br/>
|
|
For x86 architectures, this also sets the default governor to `conservative`. If the architecture is different, the
|
|
governor is set to `ondemand`.
|
|
|
|
### Disk power options
|
|
|
|
By default disks have no power management configured.
|
|
|
|
Editing a disk under _Storage_ > _Disks_ will allow to set these options for it:
|
|
|
|
- Advanced power management.
|
|
- Automatic acoustic management.<br/>
|
|
Not all drives support this.
|
|
- Spin down time.
|
|
- Write cache.
|
|
|
|
All the above options are configured using [`hdparm`][hdparm].
|
|
|
|
The APM values from the interface are resumed in seven steps.<br/>
|
|
To experiment with intermediate values:
|
|
|
|
- Edit `/etc/openmediavault/config.xml`.
|
|
- Find the `/storage/hdparm` xpath.
|
|
- Change the values for the disk.
|
|
- Run this command:
|
|
|
|
```sh
|
|
omv-salt deploy run hdparm
|
|
```
|
|
|
|
- Reboot.
|
|
- Check if APM has been set:
|
|
|
|
```sh
|
|
hdparm -I "/dev/sdX"
|
|
```
|
|
|
|
When setting a spin down time, make sure the APM value is set lower than `128`. It will not work otherwise.<br/>
|
|
The web framework does not narrow the APM options if the spin down time is set, nor it disables the spin down option
|
|
when a value higher than 128 is selected for APM.
|
|
|
|
## OMV Extras
|
|
|
|
From the CLI, as the `root` user:
|
|
|
|
1. Install [OMV-Extras]:
|
|
|
|
```sh
|
|
wget -O - \
|
|
'https://github.com/OpenMediaVault-Plugin-Developers/packages/raw/master/install' \
|
|
| bash
|
|
```
|
|
|
|
## ZFS
|
|
|
|
1. [Install OMV-Extras][omv extras].
|
|
1. Pick one:
|
|
|
|
- Disable the kernel's backports APT sources and stick to the mainline one.<br/>
|
|
Linux backport kernels are released quickly enough to leave the userland incomplete at times. This often happens
|
|
with ZFS, resulting in broken package issues.
|
|
|
|
```sh
|
|
mv -v \
|
|
'/etc/apt/sources.list.d/openmediavault-kernel-backports.list' \
|
|
'/etc/apt/sources.list.d/openmediavault-kernel-backports.list.disabled'
|
|
```
|
|
|
|
- Install the `openmediavault-kernel` plugin and use it to install the Proxmox kernel.<br/>
|
|
Debian does not build ZFS kernel modules into any of their kernels by default due to licensing conflicts. This may
|
|
result in an extensive build process during installation, which is prone to errors.
|
|
|
|
The Proxmox-Debian kernel has the ZFS kernel modules preinstalled by default. As kernel upgrades become available
|
|
and are performed, the userland for the Proxmox kernel will always have the required packages to support ZFS.
|
|
|
|
1. Install the `openmediavault-zfs` plugin.
|
|
1. Create pools and such.<br/>
|
|
You might need to wipe the disks first.
|
|
|
|
ZFS provides ACL support, but it is not enabled by default.<br/>
|
|
Just enable property in the pool or dataset.
|
|
|
|
## Further readings
|
|
|
|
- [Website]
|
|
- [Documentation]
|
|
- [Debian]
|
|
- [Proxmox]
|
|
- [OMV-Extras]
|
|
- [Disks maintenance]
|
|
- [ZFS]
|
|
|
|
### Sources
|
|
|
|
- [How to lock or disable an user account]
|
|
- [ZFS plugin for OMV6]
|
|
- [Software & Update Management]
|
|
|
|
<!--
|
|
Reference
|
|
═╬═Time══
|
|
-->
|
|
|
|
<!-- In-article sections -->
|
|
[make other users administrators]: #make-other-users-administrators
|
|
[omv extras]: #omv-extras
|
|
|
|
<!-- Knowledge base -->
|
|
[debian]: debian.md
|
|
[disks maintenance]: disks%20maintenance.md
|
|
[proxmox]: proxmox.md
|
|
[zfs]: zfs.md
|
|
|
|
<!-- Upstream -->
|
|
[documentation]: https://docs.openmediavault.org/en/latest/
|
|
[omv-extras]: https://wiki.omv-extras.org/
|
|
[software & update management]: https://docs.openmediavault.org/en/stable/various/apt.html
|
|
[website]: https://www.openmediavault.org/
|
|
[zfs plugin for omv6]: https://wiki.omv-extras.org/doku.php?id=docs_in_draft:zfs
|
|
|
|
<!-- Others -->
|
|
[hdparm]: https://linux.die.net/man/8/hdparm
|
|
[how to lock or disable an user account]: https://www.thegeekdiary.com/unix-linux-how-to-lock-or-disable-an-user-account/
|