Backup and Restore
EMQX Neuron offers three levels of backup, differing in scope and in when they apply.
| Method | Scope | When it applies |
|---|---|---|
| System backup and restore | All configuration: southbound driver and northbound application settings, tag lists, rules, files, and certificates | Before an upgrade, whole-instance migration, disaster recovery |
| Southbound device import and export | Southbound driver configuration and tags only | Migrating just the collection layer, promoting a test configuration to the plant |
| Backing up the data directory | Everything under /opt/neuronex/data | A cold backup taken during a maintenance window |
System backup and restore
Performed on Administration → System Configuration. Backup exports all configuration to a single file; restore imports that file and overwrites the current configuration.
WARNING
EMQX Neuron restarts automatically during a restore, interrupting collection and forwarding. Perform it inside a maintenance window.
Southbound device import and export
Performed at the top right of Data Collection → South Devices, exporting a JSON file. The scope is limited to southbound driver connection settings and tags; northbound applications, rules, and certificates are not included. See Bulk Configuration and Migration.
Backing up the data directory
Stop the service and copy the /opt/neuronex/data directory. This is a cold backup independent of runtime state; restore it by copying the directory back to the same path. For the directory layout, see Data Directory and Persistence.
In a container deployment the directory is mounted on the host with -v, so backing up the host directory is enough. See Deploy with Docker.
When to take a backup
- Before an upgrade. An upgrade does not overwrite
/opt/neuronex/data, but a backup allows a direct restore if you need to roll back. See Install from a Package · Upgrade. - Before a bulk tag change. Excel import overwrites tags of the same name, so export the current configuration first.
- In a master-backup deployment. Both instances need identical collection configuration; synchronize them with southbound device import and export. See Master-Backup Mode.
- After commissioning. Export and archive the final configuration so it can be restored quickly if hardware is replaced.