5.4.6 Backup and restore EventDB

All event data are stored in files in the directory /home/satnms/edb/.

Settings for the EventDB are also in different configuration files in /home/satnms. The chapter EventDB configuration explains which files are used.

Creating a backup simply involves copying all these files.

The most convenient way to create a backup is using the included satnms-backup tool. A normal backup of an MNC system will also include the EventDB. Please refer to the chapter Backup and restore MNC for details.

If you only want to back up the database only you can run satnms-backup with the command line argument --edb-only. This includes the complete directory /home/satnms/edb/ only, but not the additional configuration files in /home/satnms/. So it is intended to back up the events not the full EventDB configuration.

satnms-backup --edb-only

example output

satnms@dev:~$ satnms-backup --edb-only

starting satnms-backup 1.03

 ─┬─ testing user...
  ├─ INFO: actual user: satnms, UID: 1001
  ├─ OK: started as user satnms
  └─ done

 ─┬─ testing installed software packages...
  ├─ OK: Debian 12.13 based distribution
  ├─ INFO: package satnms4-backend installed
  ├─ INFO: package satnms4-satdb installed
  ├─ INFO: package satnms4-mnc installed

 ─┬─ testing environment...
  ├─ INFO: started at Thu  7 May 14:57:21 UTC 2026
  ├─ OK: loading global config /etc/satnms.rc
  ├─ OK: directory /home/satnms found
  ├─ OK: directory /home/public found
  ├─ INFO: backup filename: backup-dev-202605071457.tgz
  ├─ INFO: include: EDB
  └─ done

 ─┬─ prepare EDB backup...
  ├─ OK: directory /home/satnms/edb found
  ├─ INFO: added home/satnms/edb
  └─ done

 ─┬─ create archive file...
  ├─ INFO: backup to /home/public/backup-dev-202605071457.tgz
  ├─ OK: backup success, Total bytes written: 235520 (230KiB, 6.2MiB/s)
  ├─ OK: 37 file(s) in archive /home/public/backup-dev-202605071457.tgz
  └─ done

finished satnms-backup.

If you only want to restore only the event database you can run satnms-restore with the command line argument --edb-only:

satnms-backup --edb-only

This works also with backups which contains more then EventDB data. It is therefore possible to selectively restore only the event data from backup archives even if they are not created with --edb-only. As long as a backup includes the MNC service, the EventDB files will be also included.

example output

satnms@dev:~$ satnms-restore --edb-only

starting satnms-restore 1.03

 ─┬─ testing user...
  ├─ INFO: actual user: satnms, UID: 1001
  ├─ OK: started as user satnms
  └─ done

 ─┬─ testing installed software packages...
  ├─ OK: Debian 12.13 based distribution
  ├─ INFO: package satnms4-backend installed
  ├─ INFO: package satnms4-mnc installed
  ├─ INFO: package satnms4-satdb installed
  └─ done

 ─┬─ testing environment...
  ├─ INFO: started at Thu  7 May 15:01:40 UTC 2026
  ├─ OK: directory /home/satnms found
  ├─ OK: directory /home/public found
  ├─ INFO: include: EDB
  └─ done

 ─┬─ selecting archive...
  ├─ OK: adding backup-dev-202605071408.tgz
  ├─ OK: adding backup-dev-202605071410.tgz
  ├─ OK: adding backup-dev-202605071457.tgz
  ├─ INFO: selected: backup-dev-202605071457.tgz

 ─┬─ testing archive...
  ├─ OK: archive backup-dev-202605071407_edb.tgz found.
  ├─ OK: tested /home/public/backup-dev-202605071407_edb.tgz: 37 files and directories
  └─ done

 ─┬─ confirm archive...
  ├─ OK: restore of backup-dev-202605071407_edb.tgz on dev confirmed
  └─ done

 ─┬─ stopping services...
  └─ done

 ─┬─ restore EDB data...
  ├─ OK: directory /home/satnms/edb found
  ├─ INFO: restoring EDB ...
  ├─ OK: EDB directory: 37 files and directories extracted.
  └─ done

finished satnms-restore.