Custom Configuration

openmediavault is not a replacement for webmin, where you can configure all options in the web interface. Options are already preconfigured to make it easier for the average user to install and start using the NAS server.

As mentioned before in the FAQ openmediavault takes full control of some services, making it difficult to intervene configuration files. Changes manually added to configuration files will eventually overwritten at some stage by the openmediavault system.

To overcome this there are some options available to modify some of the default openmediavault configuration options and values, like the use of environmental variables.

Environmental Variables

The web interface does not provide access to ALL the configuration aspects of a complex system like openmediavault. However, the system allows to change some advanced settings through the use of environment variables. To set or change these variables, login to your openmediavault system using SSH and edit the file /etc/default/openmediavault.

Put the variable you want to change at the end of the file with the new value. Ensure the value is declared with double quotes.

For example we are going to change the default sftp server for SSH service.


Make your changes and save them. To apply the custom settings you need to execute the following commands as root:

# monit restart omv-engined
# omv-salt stage run prepare
# omv-salt stage run deploy

A list of available environment variables can be collected via:

# grep -r "default:OMV_" /srv/salt/omv/ | cut -d ":" -f3 | cut -d "'" -f1 | sort | uniq

The list of environmental variables used for /etc/fstab filesystem with the defaults options and how to use them is described here.

The SaltStack states

If you want to deploy custom configuration settings, then you could add additional Salt states. Please check out the SaltStack documentation for more information how Salt and SLS files are working.

The openmediavault SLS files are located in /srv/salt/omv/.