datalust/seq repository overview

⁠Documentation

Detailed usage instructions are maintained in the Seq Documentation⁠.

⁠Getting started

Run Seq with container-local storage and all services on port 5341:

docker run --name seq -d --restart unless-stopped -e ACCEPT_EULA=Y -e SEQ_PASSWORD=<password> -p 5341:80 datalust/seq:latest

Run Seq with hashed default password, storage mounted from the host at /path/to/seq/data, the UI mapped on the host to localhost:80, and localhost:5341 mapped to allow ingestion only, and external (public) example.com URL:

PH=$(echo '<password>' | docker run --rm -i datalust/seq config hash)

docker run \
  --name seq \
  -d \
  --restart unless-stopped \
  -e ACCEPT_EULA=Y \
  -e SEQ_API_CANONICALURI=https://seq.example.com \
  -e SEQ_FIRSTRUN_ADMINPASSWORDHASH="$PH" \
  -v /path/to/seq/data:/data \
  -p 80:80 \
  -p 5341:5341 \
  datalust/seq

Replace <password> with an initial password for the admin user account.

⁠Ports and directories

The datalust/seq container uses the following ports and directories internally:

• :80 as the UI port. This port allows both ingestion and API requests.
• :5341 as the ingestion only port. This port doesn't allow API requests.
• /data as the Seq data directory.

⁠Environment variables

Environment variables used by Seq in the container.

• ACCEPT_EULA must be set to Y to indicate acceptance of the Seq EULA⁠
• SEQ_PASSWORD must be set when initializing new instances; alternatives include SEQ_FIRSTRUN_NOAUTHENTICATION=True to opt out of authentication, or SEQ_FIRSTRUN_ADMINPASSWORDHASH if a pre-hashed default password is supplied.
• SEQ_API_CANONICALURI can optionally specify the external URI used to reach the Seq container (required when generating inbound links in notifications/login redirects)

Other configuration settings (shown by seq config) can be set using environment variables with SEQ_ as a prefix, and the path to the setting converted into UPPER_SNAKE_CASE. Some examples are:

• api.ingestionPort becomes SEQ_API_INGESTIONPORT
• firstRun.adminPasswordHash becomes SEQ_FIRSTRUN_ADMINPASSWORDHASH
• storage.secretKey becomes SEQ_STORAGE_SECRETKEY

See the docs⁠ for a full list of supported configuration values.

⁠Memory limits

For Seq to accurately measure available memory, depending on the hosting infrastructure, it's often necessary to specify memory limits for the container. If the Seq container exits unexpectedly, or fails with out-of-memory errors, specify the --memory and --memory-swap arguments to docker run:

docker run --memory=16g --memory-swap=16g <other args> datalust/seq

The argument to these flags is the total memory that the system should provide for the container (more is better). Normally, both flags should have the same value, effectively disabling swap for the container.

⁠Supported tags

The Seq image uses a few tagging schemes so you can control how far you want your instance to upgrade:

• latest - the most recent production-ready image. Pulling this tag will include major version bumps.
• major / major.minor / major.minor.patch (eg 2020 / 2020.1 / 2020.1.4292) - the most recent production-ready image for the given major version. Specifying a minor or patch will keep your instance pinned to that minor or patch.
• preview - the most recent non-production preview image. NOTE: preview images can't be downgraded to latest without potential data loss.

⁠License

Seq is available under the terms of its End-User License Agreement⁠ (EULA). The Settings > License page within Seq includes a copy of the EULA in effect at the time of the corresponding Seq release.

The Individual license included with Seq lets developers run Seq locally, and supports solo developers in production. The Individual license is for individuals only. For multi-user licenses and pricing, please visit the Seq website⁠.

By passing the value Y in the ACCEPT_EULA environment variable, you are expressing that you have read and accepted the terms in Seq End User License Agreement applicable to the Seq Docker image that you intend to use.