Seq Documentation and Support

Welcome to the Seq documentation hub. You'll find comprehensive guides and documentation to help you start working with Seq as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Backup and Restore

Seq creates daily backups of metadata and configuration, including API keys, users, signals and apps. Events are not backed up by this process - use the replication, JSON archive or file archive apps for redundant event storage if necessary.

🚧

Encrypted Storage

To protect sensitive information, Seq applies AES-256 encryption to backup files.

An encryption key is required when restoring backups: please ensure you follow the instructions below for retrieving and storing the master encryption key.

📘

Backup and restore for Docker/Linux

Seq supports the same backup and restore functionality on both Windows and Docker/Linux. The instructions given below use the Windows seq.exe command line; to invoke the same commands on Docker/Linux, pass them to the datalust/seq container directly, with the persistent storage volume mounted to /data.

For example:

docker run -v $HOST_PATH_TO_SEQ:/data datalust/seq show-key

Where the instructions mention the seq service start and seq service stop commands, you'll need to substitute docker start ..., docker stop ..., or your container orchestrator's equivalents.

Obtaining the Master Encryption Key

Seq encrypts sensitive data internally (or hashes it when round-trip decryption is not required, as in the case of user passwords).

As a further protection, backups are also fully encrypted.

This is performed using AES-256 with a key stored in Seq.json. On Windows, the value in the configuration file is protected using DPAPI, so it cannot be backed up directly.

To obtain the master key, open an administrative command prompt on the Seq server machine and invoke:

seq show-key

The key is a base-64 encoded value. Save this in a secure location so that backups can be restored.

📘

Each named Seq instance has a unique master key. Specify the instance name with -n name.

Automatic Backup

Seq will automatically back up configuration on a daily basis. The .seqbac files created are stored in the \Backups directory under the Storage root path.

Backups can be retrieved directly from disk, or downloaded from the web UI in Settings > Backups.

Seven days of backups will be retained, after which Seq will delete the oldest backup file when new backups are created.

Configuring Backup

Backup settings can be customized in Settings > Backup > Backup Settings.

When specifying the time of day at which to back up, UTC is used.

Restoring from Backup

To restore from a backup:

  1. Install Seq on the new machine. The version must be identical to the one used when creating the backup. Contact support if you need assistance locating this.
  2. Start Seq so that the default configuration is created and data storage initialized.
  3. On the Seq server machine, at an administrative command prompt, run the series of commands below.
seq service stop
seq restore --master-key="1234567abcdef=" --backup="C:\Data\seq_20150101.seqbac"
seq service start

All commands require the -n parameter if named instances are in use.

🚧

To avoid accidentally triggering production apps and alerts when testing backups, the restore process by default sets all Seq App instances to manual input only.

To change this behavior, pass --enable-apps to the seq restore command. Otherwise, apps will need to be manually re-enabled through the user interface once the Seq server has been restored.

Updated about a month ago


Backup and Restore


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.