Installation on Debian

You can install openmediavault on an existing Debian installation as well.

Note

The installation of openmediavault will be denied if a graphical desktop environment is detected.

Note

openmediavault does not import any existing settings of your system, except for network and time related settings. Existing settings will be overwritten if the service is managed by openmediavault. Please reconfigure these services via the web interface.

To do so, simply install the system using the Debian netinst images. After that apply the commands below. Please do not install a graphical desktop environment or web server, use a minimal server installation only (SSH server and standard system utilities). For a step by step install guide have a look into the Debian minimal install guide.

On ARM devices, please check if there’s an appropriate Armbian image available. Make sure you are using the correct Debian version that openmediavault is based on. After installing Armbian, then use the armbian-config tool to install OMV in a single step with all performance and reliability tweaks included. If there’s no Armbian image for your device, simply follow the steps outlined below.

On Raspberry Pi OS the below instructions only partially work. Please refer to a specific installation script

Install the openmediavault keyring manually:

apt-get install --yes gnupg
wget --quiet --output-document=- https://packages.openmediavault.org/public/archive.key | gpg --dearmor | tee "/etc/apt/trusted.gpg.d/openmediavault-archive-keyring.gpg"

Add the package repositories:

cat <<EOF >> /etc/apt/sources.list.d/openmediavault.list
deb https://packages.openmediavault.org/public shaitan main
# deb https://downloads.sourceforge.net/project/openmediavault/packages shaitan main
## Uncomment the following line to add software from the proposed repository.
# deb https://packages.openmediavault.org/public shaitan-proposed main
# deb https://downloads.sourceforge.net/project/openmediavault/packages shaitan-proposed main
## This software is not part of OpenMediaVault, but is offered by third-party
## developers as a service to OpenMediaVault users.
# deb https://packages.openmediavault.org/public shaitan partner
# deb https://downloads.sourceforge.net/project/openmediavault/packages shaitan partner
EOF

Note

If you are a user in mainland China, TUNA provides mirroring services.

Install the openmediavault package:

export LANG=C.UTF-8
export DEBIAN_FRONTEND=noninteractive
export APT_LISTCHANGES_FRONTEND=none
apt-get update
apt-get --yes --auto-remove --show-upgraded \
    --allow-downgrades --allow-change-held-packages \
    --no-install-recommends \
    --option DPkg::Options::="--force-confdef" \
    --option DPkg::Options::="--force-confold" \
    install openmediavault-keyring openmediavault

Populate the openmediavault database with several existing system settings, e.g. the network configuration:

omv-confdbadm populate

Note

Right now only /etc/network/interfaces is parsed to get the current network configuration. If the network is configured a different way (e.g. via systemd or NetworkManager), then the database is not populated and does not contain the necessary information to deploy the network configuration with netplan for systemd-networkd and systemd-resolved. In that case use omv-firstaid to do the initial network configuration instead of the following step.

Re-deploy the network configuration via the services used by openmediavault:

omv-salt deploy run systemd-networkd

Or alternatively use omv-firstaid to do the initial network configuration.