OMV Quick Configuration Guide

OMV QUICK CONFIGURATION GUIDE

This is a quick guide to make a standard OMV setup with samba and several docker containers running.

Just follow the steps. This is for those users who want to get their server up and running quickly. There are no explanations, if you need to understand something about what you are doing consult the openmediavault documentation and omv-extras to find the information, everything is explained there.

If you want to get the server up and running but have no interest in knowing what you are doing, keep reading. You can always investigate later why you made these configurations.

ISSUES TO CONSIDER

• This procedure is designed for a system with a single data unit. OMV is installed on a USB stick or SD card and docker and user data on a single independent disk. Customize it if necessary.
  • USB stick (or SD card) -> OMV operating system
  • 1 HDD (or SSD or nvme or ...) -> Docker and user data
• If at any time during this process the OMV Interface stops responding press Ctrl+Shift+R to clear the browser cache.
• When a yellow bar appears after any action in the GUI, it is necessary to click on the button to apply changes and then on Yes.
• You can change the folder names to your language, but if you do, you must do it everywhere, not just when you create the folder.

INSTALLATION

Install OMV on your server on a USB flash drive or SD card (16GB or 32GB is enough). If you install Debian first and then OMV, uses a 64-bit image.

When you get to the OMV interface, stop and follow the steps below.

INITIAL SETTINGS

System | Update Management | Updates ->

• Click on the [Check for new updates] button.
• Click on the [Install updates] button.

Shutdown the server.

Connect a drive (SATA o USB).

Start the server. Login to OMV. http://[[Your_Server_IP]]

• User = admin
• Password = openmediavault

Click on the top right button [User Settings].

• Click on the [Change Password] button and change the password.

System | Workbench ->

• Port = 8888
• Press [Save] button (You will lose connection to the OMV GUI).

Login to OMV. http://[SERVER_IP]:8888

• User = admin
• Password = [[your new password]]

Click on the top right button [User Settings].

• Click on [Dashboard] button and click on [Select all and Save].

System | Date & Time ->

• Time zone = Select your time zone
• Use NTP server -> Active
• Time Servers = pool.ntp.org
• Press [Save] burtton.

System | Notification | Settings ->

• Set the appropriate values to receive notifications with your email account. When you have finished press [Test] button and check if you have received an email.

System | Update Management | Updates -> Click on the [Install Updates] button.

OMV-EXTRAS AND PLUGINS

Note: If you have installed OMV via a script (Raspberry, arm,...) you should already have omv-extras and openmediavault-flashmemory installed, you just need to install openmediavault-compose. If you installed OMV using an ISO you need to install omv-extras, openmediavault-flashmemory and openmediavault-compose.

Install omv-extras:

• Option 1: Connect via SSH as the root user and run:
  • sudo wget -O - https://github.com/OpenMediaVault-Plugin-Developers/packages/raw/master/install | sudo bash
• Option 2: System | Scheduled Tasks -> [Create] ->
  • Command = wget -O - https://github.com/OpenMediaVault-Plugin-Developers/packages/raw/master/install | bash -> Click Save
  • Select the task (yellow color) -> Click [Run] -> Close
  • Select the task (yellow color) -> Click [Delete] -> Yes

Install openmediavault-flashmemory:

• System | Plugins -> Search openmediavault-flashmemory -> Select it (yellow color) -> Click [Install] -> [Confirm] -> [Yes]

Install openmediavault-compose:

• System | omv-extras -> Click on [Docker repo] (must be active) -> [Save]
• System | Plugins -> Search openmediavault-compose -> Select it (yellow color) -> Click [Install] -> [Confirm] -> [Yes] -> [Close] -> Ctrl+Shift+R (Clear the browser cache, this may vary in your browser)

STORAGE

Important note: This procedure will delete all existing data on the drive.

Note: This procedure is designed for a system with a single data unit. Customize it if necessary.

Storage | Disks -> Select your disk (yellow color) -> [Wipe] -> [Confirm] -> [Yes] -> [Quick] -> [Close]

Storage | S.M.A.R.T. | Settings -> Click [Enabled] -> [Save]

Storage | S.M.A.R.T. | Devices -> Select your disk (yellow color) -> [Edit] -> Click [Monitoring enabled] (Active) -> [Save]

Storage | S.M.A.R.T. | Scheduled Tasks -> [Create] ->

• Device = Select your device
• Type = Short self-test
• Day of week = Sunday
• [Save]

Storage | File Systems -> [Create and mount a file system] -> [EXT4] ->

• Device = Select the disk you just cleaned -> [Save] -> [Close]
• File system = Select the file system you just created -> [Save]

Storage | Shared Folders -> [Create] ->

• Name = docker (or whatever name you want for the docker installation folder)
• Select a file system = File system you just created
• [Save]

Press [Create] again ->

• Name = appdata (or whatever name you want for the persistent app data folder)
• Select a file system = File system you just created
• [Save]

Press [Create] again ->

• Name = data (or whatever name you want for your server's data folder)
• Select a file system = File system you just created
• [Save]

Press [Create] again ->

• Name = documents (or whatever name you want for the documents folder within your server data)
• Select a file system = File system you just created
• Relative path = data/documents/ (make sure the "data" and "documents" names match the ones you set above)
• [Save]

Press [Create] again ->

• Name = media (or whatever name you want for the media folder within your server data)
• Select a file system = File system you just created
• Relative path = data/media/ (make sure the "data" and "media" names match the ones you set above)
• [Save]

DOCKER-COMPOSE

Storage | Shared Folders -> In the docker folder line copy the absolute path with the button next to the path.

Services | Compose | Settings ->

• Docker -> Docker storage = Paste the path in this field, it will be something similar to /srv/dev-disk-by-uuid-8a3c0a8f-75bb-47b0-bccb-cec13ca5bb85/docker (make sure the "docker" name matches what you set above)
• [Save]

Services | Compose | Settings ->

• Compose Files -> Shared folder = appdata (make sure the name "appdata" matches what you set above)
• Data -> Shared folder = data (make sure the "data" name matches what you set above)
• [Save]

System | Date & Time -> Copy your value from the Time zone field. For example: Europe/Madrid

Services | Compose | Files -> [Edit global environment file] button -> In Global Environment copy and paste:

PUID=1000
PGID=100
TZ=Europe/Madrid

Replace Europe/Madrid with yours.

USERS

Important note: Create the users in order. First the user appuser (or whatever) so that it has the UID=1000. Then create the users you want. Once the users have been created, you can check the UID by opening the corresponding column with the upper right button in the form of a table. If appuser is not 1000, you must take this into account to modify the global environment variables file from the previous section accordingly.

Users | Users -> [Create] -> [Create] ->

• Name = appuser (or whatever name you want for the designated user for the containers, don't use your usual user)
• Password = Write down a strong password and write it down somewhere.
• Confirm password = the same
• Select Groups = users
• [Save]
• Select appuser (yellow color) (Or the name you chose for "appuser") -> [Shared Folder Permissions] ->

  
  

  
  

  • Click data [Read/Write] (yellow color) (Or the name you chose for "data")
  • Click appdata [Read/Write] (yellow color) (Or the name you chose for "appdata")
  • [Save]

Users | Users -> [Create] -> [Create] ->

• Name = Now write your name here, or whatever you want, this will be your username.
• Password = Write down a strong password and write it down somewhere.
• Confirm password = the same
• Select Groups = users
• [Save]
• Select your user (yellow color) -> [Shared Folder Permissions] ->
  • Click data [Read/Write] (yellow color) (Or the name you chose for "data")
  • [Save]

Users | Users -> [Create] -> [Create] -> If you want another user, repeat the previous process. Assign the permissions you want for the second user.

SAMBA

Services | SMB/CIFS | Settings -> [Enabled] (active) -> [Save]

Services | SMB/CIFS | Shares -> [Create] ->

• Shared folder => Select documents (choose the name you set for the "documents" within your server data)
• Save

Services | SMB/CIFS | Shares -> [Create] ->

• Shared folder => Select media (choose the name you set for the "media" files within your server data)
• [Save]

In Windows type in the file manager bar \\[[YOUR_SERVER_IP]] (replace [[YOUR_SERVER_IP]] with the value of your server's IP), enter your username and password configured in the previous step and accept. You will be able to access /documents and /media (choose the folder names you defined above)

DOCKER CONTAINERS

In the following posts there are some containers prepared to install directly with this server configuration. Just copy and paste and these containers will be working, no need to modify anything. Choose the ones you need.

• JELLYFIN
• PLEX
• NEXTCLOUD AIO (with or without reverse proxy)
• NGINX PROXY MANAGER
• SYNCTHING
• CALIBRE
• CALIBRE-WEB
• HEIMDALL
• TRANSMISSION
• AIRSONIC-ADVANCED
• DUPLICATI

The openmediavault-compose plugin has examples for other containers. You will need to adapt these examples by modifying the configurations to suit your system before deploying them.

If you want to delve deeper into the use of docker, consult this document. Docker in OMV from the omv-extras wiki.

JELLYFIN

Services | Compose | Files -> Create ->

Name = jellyfin

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  jellyfin:
    image: lscr.io/linuxserver/jellyfin:latest
    container_name: jellyfin
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./library:/config
      - CHANGE_TO_COMPOSE_DATA_PATH/media:/media
    ports:
      - 8096:8096
    restart: unless-stopped

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media:/media -> Adapt the "media" name to the one you chose for the media files on your server if you have changed it.

Select jellyfin file (yellow color) -> Up

Access Jellyfin at http://[SERVER_IP]:8096

More information here https://docs.linuxserver.io/images/docker-jellyfin

PLEX

Services | Compose | Files -> Create ->

Name = plex

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  plex:
    image: lscr.io/linuxserver/plex:latest
    container_name: plex
    network_mode: host
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
      - VERSION=docker
    volumes:
      - ./library:/config
      - CHANGE_TO_COMPOSE_DATA_PATH/media/tvseries:/tv
      - CHANGE_TO_COMPOSE_DATA_PATH/media/movies:/movies
    restart: unless-stopped

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media:/media/tvseries -> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "tvseries".

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media:/media/movies-> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "movies".

Select plex file (yellow color) -> Up

Access Plex at http://[SERVER_IP]:32400/web

More information here https://docs.linuxserver.io/images/docker-plex

NEXTCLOUD AIO

There are two options to install Nextcloud AIO. You can install Nextcloud AIO behind a reverse proxy or not.

If you use a reverse proxy you will be able to publish other services on the internet, if you don't want to do so you can install Nextcloud AIO without proxy and everything will work automatically. In both cases Nextcloud will be accessible from the internet.

OPTION 1: NEXTCLOUD AIO WITHOUT PROXY

This will install Nextcloud AIO without proxy. Nextcloud will be accessible from the outside but you will not be able to publish other services besides Nextcloud. If you want to install a proxy go to option 2.

Services | Compose | Files -> Create ->

Name = nextcloud

File => copy and paste this, then press Save:

services:
  nextcloud-aio-mastercontainer:
    image: nextcloud/all-in-one:latest
    restart: always
    container_name: nextcloud-aio-mastercontainer
    volumes:
      - nextcloud_aio_mastercontainer:/mnt/docker-aio-config
      - /var/run/docker.sock:/var/run/docker.sock:ro
    ports:
      - 80:80
      - 8080:8080
      - 8443:8443
    environment:
      - NEXTCLOUD_DATADIR=CHANGE_TO_COMPOSE_DATA_PATH/nextcloud_data
volumes:
  nextcloud_aio_mastercontainer:
    name: nextcloud_aio_mastercontainer

Note: - NEXTCLOUD_DATADIR=CHANGE_TO_COMPOSE_DATA_PATH/nextcloud_data -> Choose the one you want for "nextcloud_data".

Select nextcloud file (yellow color) -> Up

Access Nextcloud AIO at https://[SERVER_IP]:8080

Accept the certificate to access, copy the password and follow the instructions to configure Nextcloud AIO here from screenshot of Nextcloud AIO setup. You will need a domain pointing to your server and opening ports 80 and 443 on your router.

OPTION 2: NEXTCLOUD AIO WITH PROXY

This will install Nextcloud AIO + Nginx Proxy Manager. Nexctloud will be accessible from the outside and you will also be able to access other services.

To continue the installation with proxy you must previously install Nginx Proxy Manager following the steps in the following post . Then come back and continue with Nextcloud AIO.

If you already have NPM installed, you must configure it to divert traffic to Nextcloud. Access NPM at http://[SERVER_IP]:81 and follow these images:

nextcloudnpm1.png

Note: If http://localhost:11000 does not work for you, you can configure your server's IP instead: http://[SERVER_IP]:11000

Note: your-nc-domain -> Enter the domain you have created for Nextcloud here. It must point to your server from the internet. You can configure one for free here https://www.duckdns.org/

nextcloudnpm2.png

nextcloudnpm3.png

client_body_buffer_size 512k;

proxy_read_timeout 86400s;

client_max_body_size 0;

More information here https://github.com/nextcloud/a…xy.md#nginx-proxy-manager

You are now ready to install Nextcloud AIO with the reverse proxy options:

Services | Compose | Files -> Create ->

Name = nextcloud

File => copy and paste this, then press Save:

services:
  nextcloud-aio-mastercontainer:
    image: nextcloud/all-in-one:latest
    restart: always
    container_name: nextcloud-aio-mastercontainer
    volumes:
      - nextcloud_aio_mastercontainer:/mnt/docker-aio-config
      - /var/run/docker.sock:/var/run/docker.sock:ro
    ports:
      - 8080:8080
    environment:
      - APACHE_PORT=11000
      - NEXTCLOUD_DATADIR=CHANGE_TO_COMPOSE_DATA_PATH/nextcloud_data
volumes:
  nextcloud_aio_mastercontainer:
    name: nextcloud_aio_mastercontainer

Note: - NEXTCLOUD_DATADIR=CHANGE_TO_COMPOSE_DATA_PATH/nextcloud_data -> Choose the one you want for "nextcloud_data".

Select nextcloud file (yellow color) -> Up

Access Nextcloud AIO at https://[SERVER_IP]:8080

Accept the certificate to access, copy the password and follow the instructions to configure Nextcloud AIO here from the screenshot of Nextcloud AIO setup. You will need a domain pointing to your server and opening ports 80 and 443 on your router.

NGINX PROXY MANAGER

Services | Compose | Files -> Create ->

Name = npm

File => copy and paste this, then press Save:

version: '3.8'
services:
  app:
    image: 'jc21/nginx-proxy-manager:latest'
    restart: unless-stopped
    ports:
      - '80:80'
      - '443:443'
      - '81:81'
    environment:
      PUID: ${PUID}
      PGID: ${PGID}
      X_FRAME_OPTIONS: "sameorigin"
    volumes:
      - ./data:/data
      - ./letsencrypt:/etc/letsencrypt

Select npm file (yellow color) -> Up

Access Nginx Proxy Manager at http://[SERVER_IP]:81

More information here https://nginxproxymanager.com/

SYNCTHING

Services | Compose | Files -> Create ->

Name = syncthing

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  syncthing:
    image: lscr.io/linuxserver/syncthing:latest
    container_name: syncthing
    hostname: syncthing #optional
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
      - CHANGE_TO_COMPOSE_DATA_PATH/documents/sync_data1:/data1
      - CHANGE_TO_COMPOSE_DATA_PATH/documents/sync_data2:/data2
    ports:
      - 8384:8384
      - 22000:22000/tcp
      - 22000:22000/udp
      - 21027:21027/udp
    restart: unless-stopped

Note: - CHANGE_TO_COMPOSE_DATA_PATH/documents/sync_data1:/data1 -> Choose the one you want for "sync_data1".

Note: - CHANGE_TO_COMPOSE_DATA_PATH/documents/sync_data1:/data2 -> Choose the one you want for "sync_data2".

Select syncthing file (yellow color) -> Up

Access Syncthing at https://[SERVER_IP]:8384

More information here https://docs.linuxserver.io/images/docker-syncthing

CALIBRE

Services | Compose | Files -> Create ->

Name = calibre

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  calibre:
    image: lscr.io/linuxserver/calibre:latest
    container_name: calibre
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
    ports:
      - 18080:8080
      - 8181:8181
      - 8081:8081
    restart: unless-stopped

Select calibre file (yellow color) -> Up

Access Calibre at http://[SERVER_IP]:18080

More information here https://docs.linuxserver.io/images/docker-calibre

CALIBRE-WEB

Services | Compose | Files -> Create ->

Name = calibre-web

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  calibre-web:
    image: lscr.io/linuxserver/calibre-web:latest
    container_name: calibre-web
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
      - CHANGE_TO_COMPOSE_DATA_PATH/calibre_library:/books
    ports:
      - 8083:8083
    restart: unless-stopped

Note: - CHANGE_TO_COMPOSE_DATA_PATH/calibre_library:/books -> Choose the one you want for "calibre_library".

Select calibre-web file (yellow color) -> Up

Access Calibre-Web at http://[SERVER_IP]:8083

More information here https://docs.linuxserver.io/images/docker-calibre-web

HEIMDALL

Services | Compose | Files -> Create ->

Name = heimdall

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  heimdall:
    image: lscr.io/linuxserver/heimdall:latest
    container_name: heimdall
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
    ports:
      - 20080:80
      - 20443:443
    restart: unless-stopped

Select heimdall file (yellow color) -> Up

Access Heimdall at http://[SERVER_IP]:20080

More information here https://docs.linuxserver.io/images/docker-heimdall

TRANSMISSION

Services | Compose | Files -> Create ->

Name = transmission

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  transmission:
    image: lscr.io/linuxserver/transmission:latest
    container_name: transmission
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
      - CHANGE_TO_COMPOSE_DATA_PATH/media/downloads:/downloads
      - CHANGE_TO_COMPOSE_DATA_PATH/media/watch:/watch
    ports:
      - 9091:9091
      - 51413:51413
      - 51413:51413/udp
    restart: unless-stopped

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media/downloads:/downloads -> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "downloads".

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media/watch:/watch-> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "watch".

Select transmission file (yellow color) -> Up

Access Transmission at http://[SERVER_IP]:9091

More information here https://docs.linuxserver.io/images/docker-transmission

AIRSONIC-ADVANCED

Services | Compose | Files -> Create ->

Name = airsonic-advanced

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  airsonic-advanced:
    image: lscr.io/linuxserver/airsonic-advanced:latest
    container_name: airsonic-advanced
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
      - CHANGE_TO_COMPOSE_DATA_PATH/media/music:/music
      - CHANGE_TO_COMPOSE_DATA_PATH/media/playlists:/playlists
      - CHANGE_TO_COMPOSE_DATA_PATH/media/podcasts:/podcasts
    ports:
      - 4040:4040
    restart: unless-stopped

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media/music:/music -> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "music".

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media/playlists:/playlists -> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "playlists".

Note: - CHANGE_TO_COMPOSE_DATA_PATH/media/podcasts:/podcastas -> Adapt the name "media" to the one you chose for the media files on your server if you have changed it. Choose the one you want for "podcasts".

Select airsonic-advanced file (yellow color) -> Up

Access Airsonic-advanced at http://[SERVER_IP]:4040

More information here https://docs.linuxserver.io/images/docker-airsonic-advanced

DUPLICATI

Services | Compose | Files -> Create ->

Name = duplicati

File => copy and paste this, then press Save:

---
version: "2.1"
services:
  duplicati:
    image: lscr.io/linuxserver/duplicati:latest
    container_name: duplicati
    environment:
      - PUID=${PUID}
      - PGID=${PGID}
      - TZ=${TZ}
    volumes:
      - ./config:/config
      - CHANGE_TO_COMPOSE_DATA_PATH:/data
    ports:
      - 8200:8200
    restart: unless-stopped

Select duplicati file (yellow color) -> Up

Access Duplicati at https://[SERVER_IP]:8200

More information here https://docs.linuxserver.io/images/docker-duplicati