DominusVault – Administrator Guide

Guide for IT administrators: initial configuration, database servers, repositories, users, backup plans, and day-to-day operation of the console.

1. First-time setup

After installation, open the panel in your browser. On first access the setup wizard starts. Complete each step:

1. Language – default interface language for your organization.
2. Application database – PostgreSQL connection where DominusVault stores settings, users, and plans. The wizard creates the required database and tables.
3. Administrator account – username, password, optional e-mail (password recovery and notifications).
4. E-mail (SMTP) – optional; used for backup reports and password reset links.
5. Backup repository – storage location for backup files (local disk or network share).
6. Encryption key – generated in the wizard; protects passwords and sensitive data in the application database. Store a backup of the key securely according to your organization’s policy.
7. Backup tools – optional paths to supporting programs (PostgreSQL, archiving). On Windows installations many tools are bundled with the product.
8. Summary – confirm and proceed to login.

Passwords and credentials are stored encrypted. Later changes are made under Settings.

2. Settings – overview

• Application – mail, push notifications (Gotify), default server and repository, report branding, backup archive format, compression, filename patterns, product update check.
• Servers – databases to back up (PostgreSQL, MySQL, MS SQL). Use Test connection before saving.
• Repositories – backup destinations. The usage table shows disk capacity and space used by backup files.
• Users – accounts, roles, blocking, permissions (see section 9).
• License – activation with a key or license file import.
• PostgreSQL tools – overview of detected tool versions and matching to PostgreSQL server versions.

3. Adding database servers

Under Settings → Servers add each backup source:

• Choose the engine: PostgreSQL, MySQL, or MS SQL Server.
• Enter host, port, user, and password (or authentication required by the engine).
• Run the connection test — save only after success.

For PostgreSQL the application automatically selects the correct backup tools for the server version. MS SQL backups may be stored in the product’s .dvb archive format.

Tip: use the host name or address visible from the machine or container where DominusVault runs — e.g. your LAN server name, not an address that only works from your desktop if it differs.

4. Backup repositories

A repository is where backup files are stored (local disk or network share). Subfolders are created per server and database. Before the first backup, configure at least one repository under Settings → Repositories (or in the /setup wizard) and run Test access.

Windows (installer .exe)

• Local disk – create a folder on the server with enough free space, e.g. D:\Backups\DominusVault, and enter that path in the panel. The Windows service account (or user running the app) needs read and write permission on that folder.
• Network share (SMB) – UNC path, e.g. \\fileserver\backups\dominusvault, with optional credentials. Ensure the DominusVault server can reach the NAS over the network.

Docker (application in a container)

In the panel, do not enter host paths (C:\..., D:\..., /mnt/...). For backups on the server’s local disk, always use the path visible inside the container:

/app/backups

That directory inside the container is mapped to a folder on the physical host so backups persist across container restarts.

Before you start:

1. Make sure the backup folder on the host exists (the install script creates it) and has enough space for planned backups.
2. On Linux: the directory must be writable by the user running Docker (typically chmod 775 on the backup folder; the install script sets ownership).
3. On Windows with Docker Desktop: C:\DominusVault\backup must be writable by Docker/WSL — the default install script handles this.
4. If you change the backup location, update DOMINUS_BACKUP_DIR in .env next to docker-compose.prod.yml before running docker compose up again; in the panel still enter /app/backups.

NAS / SMB in Docker (without a host folder mount): enter the UNC path \\server\share\backups and credentials in the panel — the application connects to the share directly from the container.

Common

• After adding a repository, use Test access — backups will fail if the application cannot write a file.
• The Manage backups button lets you browse files in a repository (server → database → list) and delete selected backups.
• The Clear backups button removes all backup files from the selected repository (after confirmation).
• The Import backup file section uploads a .dvb from another DominusVault installation. .dvb files require the Fernet key (master encryption key) from the source installation. You can save the file to the repository or decrypt and download .sql only without storing it.
• In the Backup/restore wizard, Upload backup from disk provides the same import flow from the wizard.
• On the dashboard, the Repository usage widget shows how much space backups use — it updates after a backup completes.

5. Backup plans

Under Backup plans define recurring or on-demand jobs:

• Servers and databases included in the plan.
• One or more target repositories.
• Schedule (e.g. nightly) and retention — how long to keep old backups.
• Optional e-mail report after the plan runs.

You can run a plan manually from the panel or trigger it from an external system scheduler — ask your deployment provider if you need automation outside the panel.

6. Notifications

E-mail (SMTP)

Configure your organization’s mail server: host, port, user, and password. Common ports are supported (25, 587 with STARTTLS, 465 with SSL). Use the test button in settings. Backup and restore reports can be sent as CSV and PDF attachments.

Gotify (optional)

Short push notifications to your own Gotify server — useful when you do not want to rely on e-mail alone. Enter server URL, application token, and priority in settings, then send a test notification.

7. Product license

Under License:

• Online activation – enter the license key from your vendor.
• Offline import – load a license file when the environment has no internet access.

The panel shows license status, edition, expiry, and limits (servers, databases, plans, etc.). Without a valid license, backup operations may be restricted.

8. Logs and audit

Under Logs:

• Application log – operation progress and diagnostic messages.
• Restore errors – problems during restore.
• Audit – who performed which action in the panel and when.

9. Users and permissions

Create accounts with the administrator or user role. You can further restrict:

• access to selected servers and databases,
• access to panel sections (table below).

Granting the Reports permission (step by step):

1. Sign in as administrator and open Settings.
2. Go to the Users tab.
3. For the chosen account, click Permissions (clipboard icon).
4. In the permissions panel, check Reports (and any other sections the user should access).
5. Click Save permissions. After refreshing the panel, the user will see Reports registry in the menu.

Administrators have access to all sections by default. A user without Reports checked will not see the registry tab — they can still use dashboard export if they have dashboard access.

10. Reports and retention

In Settings → Notifications configure SMTP, the report recipient address, and report retention (days; 0 = never delete). After each operation (backup, restore, upload, decrypt, migration) the system saves a CSV/PDF report in the Reports registry and in the _raporty folder inside the backup repository. In the same settings tab you can set the chart anomaly threshold (backup size drop in %) and enable red anomaly points on charts.

11. HTTPS and panel access

The panel may run over HTTP on an internal network or over HTTPS. In settings you can point to certificates for the built-in proxy, or — more often in organizations — HTTPS is terminated by an external reverse proxy in front of the application. The panel URL is defined by your infrastructure administrator.

12. Updates

Under Settings → Updates check whether a newer product version is available. The panel explains how to obtain the update (Windows installer or Docker image, depending on how you deployed). See Recent changes in the user menu for a version-by-version list of improvements.

13. In-app documentation

The Documentation menu opens the guide inside the panel. Administrators can switch between the user guide and administrator guide (button on the left or link at the top of the page). Additional HTML files may be included in the installation folder for viewing in a browser without logging in.

14. Interface language

Set the default language in the first-run wizard. Each user can change their own language in the user menu (top-right icon).

DominusVault – Database backup console. Copyright (c) DominuNet, Maciej Janas.