### Install Seq Service with a Service Account

Source: https://datalust.co/docs/service-account-requirements

Use these commands to stop, uninstall, install, and start the Seq Windows service with a specified service account. Ensure the account has 'Log on as a Service' rights beforehand. The username format must be DOMAIN\user or MACHINE\user.

```bash
seq service stop
seq service uninstall
seq service install -u <DOMAIN\user> -p <password>
seq service start

```

--------------------------------

### Install and Start Seq Windows Service

Source: https://datalust.co/docs/unattended-installation

Configure and start the Seq Windows Service, specifying storage location and listen URI.

```powershell
seq service install --storage="C:\ProgramData\Seq" --listen="http://localhost:5341"
seq service start

```

--------------------------------

### Install seqcli as a global tool

Source: https://datalust.co/docs/command-line-client

Install the Seq CLI tool globally using the .NET CLI. This command requires the .NET SDK to be installed.

```bash
dotnet tool install --global seqcli

```

--------------------------------

### Seq.json Configuration Example

Source: https://datalust.co/docs/json-config

An example Seq.json configuration file demonstrating various API settings.

```json
{
  "api": {
    "ingestionPorts": [
      45341
    ],
    "canonicalUri": null,
    "corsAllowedOrigins": [],
    "frameAncestors": [],
    "hardSessionExpirySeconds": null,
    "hstsIncludeSubDomains": false,
    "hstsMaxAge": 31536000,
    "idleSessionExpirySeconds": 172800,
    "ingestionPort": null,
    "listenUris": [
      "https://seq.example.com",
      "https://seq.example.com:45341"
    ],
    "redirectHttpToHttps": false,
    "minRequestBodyDataRateBytesPerSecond": 240.0,
    "minRequestBodyDataRateGracePeriodMilliseconds": 5000,
    "globalRateLimit": null,
    "globalQueueLimit": null,
    "ingestRateLimit": null,
    "ingestQueueLimit": null,
  }
}
```

--------------------------------

### Install Winston and winston-seq

Source: https://datalust.co/docs/using-nodejs

Install the necessary packages for Winston structured logging with Seq.

```bash
npm install @datalust/winston-seq winston

```

--------------------------------

### Seq Configuration Example

Source: https://datalust.co/docs/urls

An example of how Seq's listen URIs are represented in the Seq.json configuration file.

```json
"api": {
    "listenUris": [
      "http://seq.example.com:5341"
    ]
  },

```

--------------------------------

### Install Seq Chart

Source: https://datalust.co/docs/using-helm

Install the Seq chart to create a cluster-internal Seq instance with persistent storage.

```bash
helm install my-seq datalust/seq

```

--------------------------------

### Example Seq Init Script

Source: https://datalust.co/docs/init-scripts

This is an example of a bash script that can be used for Seq initialization. It performs a backup restore operation.

```bash
#!/bin/bash
seqsvr restore --from-latest -y

```

--------------------------------

### Start a New Seq Container with a Shell

Source: https://datalust.co/docs/getting-a-shell-to-a-container

Use this command to launch a new Seq container and immediately get a bash shell. This is useful for running Seq commands interactively before the web server starts.

```bash
docker run \
  -it \
  --rm \
  datalust/seq shell

```

--------------------------------

### Start Seq Service

Source: https://datalust.co/docs/configuring-a-clustered-seq-node

After configuring the Seq node, use this command to start the Seq service.

```powershell
seq service start
```

--------------------------------

### Download Seq MSI Installer

Source: https://datalust.co/docs/unattended-installation

Use Invoke-WebRequest to download a specific version of the Seq MSI installer.

```powershell
Invoke-WebRequest "https://datalust.co/download/begin?version=5.1.3364" -outfile "Seq.msi"

```

--------------------------------

### Install Bunyan and bunyan-seq

Source: https://datalust.co/docs/using-nodejs

Install the Bunyan logger and the bunyan-seq package for sending logs to Seq.

```bash
npm install --save bunyan
npm install --save bunyan-seq

```

--------------------------------

### Setup Sample Environment

Source: https://datalust.co/docs/command-line-client

Configures a Seq instance with sample dashboards, signals, and users. Use the `-y` flag to bypass confirmation prompts.

```bash
seqcli sample setup
```

--------------------------------

### Install an app package

Source: https://datalust.co/docs/command-line-client

Install an app package from a NuGet feed. Specify the package ID and optionally the version and feed ID.

```bash
seqcli app install --package-id 'Seq.App.JsonArchive'
```

--------------------------------

### app install

Source: https://datalust.co/docs/command-line-client

Installs an app package from a NuGet feed to the Seq server.

```APIDOC
## app install

### Description
Install an app package.

### Method
`seqcli app install`

### Parameters
#### Options
- `--package-id=VALUE` (string) - Required - The package id of the app to install
- `--version=VALUE` (string) - Optional - The package version to install; the default is to install the latest version
- `--feed-id=VALUE` (string) - Optional - The id of the NuGet feed to install the package from; may be omitted if only one feed is configured
- `-s`, `--server=VALUE` (string) - Optional - The URL of the Seq server; by default the `connection.serverUrl` config value will be used
- `-a`, `--apikey=VALUE` (string) - Optional - The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used
- `--profile=VALUE` (string) - Optional - A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used
- `--json` - Print output in newline-delimited JSON (the default is plain text)
- `--no-color` - Don't colorize text output
- `--force-color` - Force redirected output to have ANSI color (unless `--no-color` is also specified)
- `--storage=VALUE` (string) - Optional - The folder where `SeqCli.json` and other data will be stored; falls back to `SEQCLI_STORAGE_PATH` from the environment, then the `seqcli forwarder` service's configured storage path (Windows only), then `/root`

### Example
```
seqcli app install --package-id 'Seq.App.JsonArchive'
```
```

--------------------------------

### Create a new app instance

Source: https://datalust.co/docs/command-line-client

Use this command to create a new instance of an installed app. You can specify a title, the app ID, and any required properties.

```bash
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p To=ops@example.com
```

--------------------------------

### Install OpenTelemetry Python SDK Packages

Source: https://datalust.co/docs/tracing-from-python

Install the necessary OpenTelemetry SDK packages using pip. Ensure you have opentelemetry-api, opentelemetry-sdk, and opentelemetry-exporter-otlp installed.

```bash
pip install opentelemetry-api  
pip install opentelemetry-sdk  
pip install opentelemetry-exporter-otlp

```

--------------------------------

### Start Seq Service After Migration

Source: https://datalust.co/docs/migrating-legacy-dr-clusters-to-ha

After migrating the leader node, use the `seq service start` command to bring the service back online.

```bash
seq service start
```

--------------------------------

### Install Serilog Seq and Console Sinks

Source: https://datalust.co/docs/using-serilog

Install the necessary Serilog packages for Seq and console output using the .NET CLI.

```bash
dotnet add package Serilog.Sinks.Seq
dotnet add package Serilog.Sinks.Console
```

--------------------------------

### Install Forwarder Service

Source: https://datalust.co/docs/command-line-client

Installs the Seq log forwarder as a Windows service. This is a preview command and requires the `--pre` flag.

```APIDOC
## `forwarder install`

### Description
Install the forwarder as a Windows service.

### Command
`seqcli forwarder install`

### Note
> Preview command: only available when the `--pre` command-line flag is specified. This command is supported on **Windows** platforms only.

### Options
#### Query Parameters
- **--storage=VALUE** (string) - Optional - The folder where `SeqCli.json` and other data will be stored; falls back to `SEQCLI_STORAGE_PATH` from the environment, then the `seqcli forwarder` service's configured storage path (Windows only), then `/root`.
- **-l, --listen=VALUE** (string) - Optional - Set the address `seqcli forwarder` will listen at; http://127.0.0.1:15341/ is used by default.
- **-u, --username=VALUE** (string) - Optional - The name of a Windows account to run the service under; if not specified the `NT AUTHORITY\LocalService` account will be used.
- **-p, --password=VALUE** (string) - Optional - The password for the Windows account to run the service under.
```

--------------------------------

### Install SerilogTracing Packages

Source: https://datalust.co/docs/serilogtracing

Installs the necessary SerilogTracing packages and Serilog sink for console logging.

```bash
dotnet add package SerilogTracing
dotnet add package SerilogTracing.Expressions
dotnet add package SerilogTracing.Instrumentation.AspNetCore
dotnet add package SerilogTracing.Instrumentation.SqlClient 
dotnet add package Serilog.Sinks.Console

```

--------------------------------

### Install Serilog Packages

Source: https://datalust.co/docs/importing-log-files

Install the necessary Serilog packages for file logging and compact JSON formatting from NuGet.

```powershell
Install-Package Serilog.Sinks.File
Install-Package Serilog.Formatting.Compact

```

--------------------------------

### Get Help Information

Source: https://datalust.co/docs/command-line-client

Displays help information for available commands. Use --markdown to generate documentation.

```bash
seqcli help search
```

--------------------------------

### Install pygelf for GELF logging

Source: https://datalust.co/docs/using-python

Install the `pygelf` package using pip to enable GELF logging.

```bash
$ pip install pygelf

```

--------------------------------

### Define App Settings in App Definition

Source: https://datalust.co/docs/seq-apps-in-other-languages

Package an app definition file with your executable to specify available settings. This example defines a single setting 'propertyToTotal'.

```json
{
  "name": "Total Example",
  "description": "Keeps and prints a running total of a numeric property.",
  "executable": "total.exe", 
  "settings": {
    "propertyToTotal": {
      "displayName": "Property to total",
      "helpText": "The name of a numeric property for the app to detect and report the total of."
    }
  }
}

```

--------------------------------

### Install semlogr and Seq sink

Source: https://datalust.co/docs/using-ruby

Install the necessary gems for semlogr and its Seq sink to enable structured logging to Seq.

```bash
gem install semlogr
gem install semlogr-sinks-seq
```

--------------------------------

### Start Seq Forwarder Service

Source: https://datalust.co/docs/command-line-client

Starts the Seq forwarder Windows service. This is a preview command and only available on Windows.

```bash
seqcli forwarder start
```

--------------------------------

### Install Seq Appender for log4net

Source: https://datalust.co/docs/using-log4net

Install the Seq.Client.Log4Net and Log4Net.Async packages using the Visual Studio Package Manager console.

```powershell
PM> Install-Package Seq.Client.Log4Net
PM> Install-Package Log4Net.Async

```

--------------------------------

### Create App Instance

Source: https://datalust.co/docs/command-line-client

Creates a new instance of an installed app on the Seq server. You can specify the app title, the app ID, and various properties or settings.

```APIDOC
## `appinstance create`

### Description
Create an instance of an installed app.

### Command
`seqcli appinstance create`

### Options
- `-t`, `--title=VALUE`: A title for the app instance
- `--app=VALUE`: The id of the installed app package to instantiate
- `-p`, `--property=NAME=VALUE`: Specify name/value settings for the app, e.g. `-p ToAddress=example@example.com -p Subject="Alert!"
- `--stream[=VALUE]`: Stream incoming events to this app instance as they're ingested; optionally accepts a signal expression limiting which events should be streamed, for example `signal-1,signal-2`
- `--overridable=VALUE`: Specify setting names that may be overridden by users when invoking the app
- `-s`, `--server=VALUE`: The URL of the Seq server; by default the `connection.serverUrl` config value will be used
- `-a`, `--apikey=VALUE`: The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used
- `--profile=VALUE`: A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used
- `--json`: Print output in newline-delimited JSON (the default is plain text)
- `--no-color`: Don't colorize text output
- `--force-color`: Force redirected output to have ANSI color (unless `--no-color` is also specified)
- `--storage=VALUE`: The folder where `SeqCli.json` and other data will be stored; falls back to `SEQCLI_STORAGE_PATH` from the environment, then the `seqcli forwarder` service's configured storage path (Windows only), then `/root`

### Example
```
seqcli appinstance create -t 'Email Ops' --app hostedapp-314159 -p To=ops@example.com
```
```

--------------------------------

### Add OpenTelemetry .NET SDK Packages

Source: https://datalust.co/docs/opentelemetry-net-sdk-traces

Use the `dotnet add package` command to install the required OpenTelemetry .NET SDK packages. Include prerelease packages if necessary.

```bash
dotnet add package OpenTelemetry.Extensions.Hosting
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
dotnet add package OpenTelemetry.Exporter.Console
dotnet add package OpenTelemetry.Instrumentation.AspNetCore
dotnet add package OpenTelemetry.Instrumentation.Http
dotnet add package --prerelease OpenTelemetry.Instrumentation.SqlClient
```

--------------------------------

### Add Seq.Apps NuGet Package

Source: https://datalust.co/docs/writing-seq-apps

Install the necessary Seq.Apps NuGet package to begin developing Seq applications.

```bash
dotnet add package Seq.Apps

```

--------------------------------

### Install NLog.Targets.Seq NuGet Package

Source: https://datalust.co/docs/using-nlog

Use this command to add the Seq target for NLog to your project.

```bash
dotnet add package NLog.Targets.Seq

```

--------------------------------

### Example Internal Error Report

Source: https://datalust.co/docs/internal-error-reporting

This example illustrates the level of detail collected when error telemetry is enabled and a reply email address is supplied. Note that parameter values are not included, only placeholders.

```text
Time:      2018-11-15T20:10:19.8362537Z
Version:   5.0.9000
Instance:  j00foew4qjofe2ijofp4
Email:     admin@example.com
Event:     Error serving {RequestUrl} (token: {ErrorToken}) 
Exception: System.InvalidOperationException: An er... ---> System.Net.WebException: The r...
   at System.Net.HttpWebRequest.GetResponse()
   at NuGet.RequestHelper.GetResponse(Func`1 createRequest, Action`1 prepareRequest,
       IProxyCache proxyCache, ICredentialCache credentialCache, ICredentialProvider credentialProvider)
   at NuGet.HttpClient.GetResponse()
   at NuGet.RedirectedHttpClient.GetResponseUri(HttpClient client)
   at NuGet.RedirectedHttpClient.EnsureClient()


```

--------------------------------

### Get Help for a Command

Source: https://datalust.co/docs/server-command-line

Use this command to display detailed help information for a specific Seq command.

```bash
seq help <command>
```

```bash
seqsvr help <command>
```

--------------------------------

### Stop, Migrate, and Start Seq Service

Source: https://datalust.co/docs/converting-a-standalone-seq-instance-into-a-cluster

Use these commands to stop the Seq service, migrate the metadata store to a new SQL Server database, and then restart the service.

```bash
seq service stop
seq metastore to-mssql --connection-string="{Cluster State Database Connection String}"
seq service start
```

--------------------------------

### Configure Ingress for Seq UI and Ingestion API

Source: https://datalust.co/docs/using-helm

Install the Seq chart with custom configuration to enable ingress for both the Seq UI and the ingestion API. This example uses an Nginx ingress controller.

```bash
helm install -f config.yaml my-seq datalust/seq

```

```yaml
# config.yaml
ingress:
  annotations:
    kubernetes.io/ingress.class: nginx

ui:
  ingress:
    enabled: true
    path: /
    hosts:
      - seq.mydomain.com

ingestion:
  ingress:
    enabled: true
    path: /
    hosts:
      - ingestion.seq.mydomain.com

```

--------------------------------

### List Supported Seq Server Settings

Source: https://datalust.co/docs/command-line-client

Use the `setting names` command to display a list of all configurable server settings.

```bash
seqcli setting names
```

--------------------------------

### Install OpenTelemetry Python SDK dependencies

Source: https://datalust.co/docs/using-python

Install the necessary OpenTelemetry packages for logging and tracing.

```bash
pip install opentelemetry-api
pip install opentelemetry-sdk
pip install opentelemetry-exporter-otlp

```

--------------------------------

### Full Restore Seq Init Script

Source: https://datalust.co/docs/backup-and-restore-docker

Initialize a fresh data volume with a backup file and restore Seq. Replace 'your-secret-key' with your actual secret key and 'backup.seqbac' with your backup filename. The backup file must be placed in the Backups/ directory.

```bash
seqsvr restore -y --enable-apps --secret-key="your-secret-key" --backup="/data/Backups/backup.seqbac"

```

--------------------------------

### Install OpenTelemetry JavaScript SDK Dependencies

Source: https://datalust.co/docs/tracing-from-nodejs

Install the necessary OpenTelemetry packages for Node.js tracing.

```bash
> npm install @opentelemetry/api @opentelemetry/auto-instrumentations-node 
@opentelemetry/exporter-trace-otlp-proto @opentelemetry/instrumentation-http 
@opentelemetry/resources @opentelemetry/sdk-trace-node

```

--------------------------------

### Ingest Sample Data with Seq CLI

Source: https://datalust.co/docs/migrating-seq-data

Use the Seq CLI to send sample data to a Seq server. Ensure the Seq server is running and accessible at the specified address.

```bash
seqcli sample ingest -s http://localhost:5342

```

--------------------------------

### Run a SeqApp Plugin

Source: https://datalust.co/docs/command-line-client

Host a .NET SeqApp plugin by specifying the directory containing its assemblies. App properties can be set using the -p option.

```bash
seqcli tail --json | seqcli app run -d "./bin/Debug/netstandard2.2" -p ToAddress=example@example.com
```

--------------------------------

### Create a new user with seqcli

Source: https://datalust.co/docs/command-line-client

Use this command to create a new user. Pass the password via stdin for enhanced security. Specify display name, roles, and other attributes as needed.

```bash
seqcli user create -n alice -d 'Alice Example' -r 'User (read/write)' --password-stdin
```

--------------------------------

### Run Seq with SQL Server Metastore via Environment Variable

Source: https://datalust.co/docs/using-sql-server-as-a-metastore

Start Seq using a SQL Server metastore by setting the `SEQ_METASTORE_MSSQL_CONNECTIONSTRING` environment variable. This ensures Seq uses the specified database for its metastore.

```bash
SEQ_METASTORE_MSSQL_CONNECTIONSTRING="Initial Catalog=seq-local;Integrated Security=True" seq run
```

--------------------------------

### List all configuration fields

Source: https://datalust.co/docs/command-line-client

Displays all fields and their values currently set in the `SeqCli.json` configuration file.

```bash
seqcli config list

```

--------------------------------

### Begin OpenTelemetry Configuration (ASP.NET Core)

Source: https://datalust.co/docs/opentelemetry-net-sdk-traces

Initiate the OpenTelemetry SDK configuration for an ASP.NET Core application using `builder.Services.AddOpenTelemetry()`.

```csharp
builder.Services.AddOpenTelemetry()


```

--------------------------------

### Test Restore Seq Init Script (No Apps)

Source: https://datalust.co/docs/backup-and-restore-docker

Use this init script for testing backups in a temporary location. Omitting `--enable-apps` prevents accidental triggering of alerts and integrations.

```bash
seqsvr restore -y --secret-key="your-secret-key" --backup="/data/Backups/backup.seqbac"

```

--------------------------------

### Silent Seq MSI Installation

Source: https://datalust.co/docs/unattended-installation

Install the Seq MSI silently using msiexec.exe, preventing the Seq Administration app from launching.

```powershell
Start-Process -Wait -FilePath msiexec -ArgumentList '/quiet /i Seq.msi WIXUI_EXITDIALOGOPTIONALCHECKBOX=0 INSTALLFOLDER="C:\Program Files\Seq"'

```

--------------------------------

### Configure Diagnostic Instance using Environment Variables

Source: https://datalust.co/docs/converting-a-standalone-seq-instance-into-a-cluster

Set up a Seq instance for cluster diagnostics using environment variables. This method is an alternative to using the 'seq config set' commands.

```bash
SEQ_DIAGNOSTICS_OTLP_ENDPOINT={Diagnostic Instance Ingestion URI}
SEQ_DIAGNOSTICS_OTLP_PROTOCOL=http/protobuf
SEQ_DIAGNOSTICS_OTLP_HEADERS=X-Seq-ApiKey={Diagnostic Instance API Key}
SEQ_DIAGNOSTICS_OTLP_METRICSSAMPLING_INTERVAL_SECONDS=10

```

--------------------------------

### Update an Installed SeqApp

Source: https://datalust.co/docs/command-line-client

Update an installed SeqApp by its name or ID. Options are available to update all apps, specify a version, or force an update.

```bash
seqcli app update -n 'HTML Email'
```

--------------------------------

### List installed app packages

Source: https://datalust.co/docs/command-line-client

List installed app packages on the Seq server. You can filter by package ID or a specific app ID.

```bash
seqcli app list
```

--------------------------------

### List Setting Names

Source: https://datalust.co/docs/command-line-client

Print the names of all supported settings. This command lists all available server settings that can be managed.

```APIDOC
## `setting names`

### Description
Print the names of all supported settings.

### Command
```
seqcli setting names
```
```

--------------------------------

### Update Seq App

Source: https://datalust.co/docs/command-line-client

Update an installed app package to a newer version. You can update a specific app by its name or ID, or update all installed apps.

```APIDOC
## `app update`

### Description
Update an installed app package.

### Command
`seqcli app update`

### Options
#### ID
- `-i`, `--id=VALUE`: The id of a single installed app to update.

#### Name
- `-n`, `--name=VALUE`: The name of the installed app to update.

#### All
- `--all`: Update all installed apps; not compatible with `-i` or `-n`.

#### Version
- `--version=VALUE`: The package version to update to; the default is to update to the latest version in the associated feed.

#### Force
- `--force`: Update the app even if the target version is already installed.

#### Server
- `-s`, `--server=VALUE`: The URL of the Seq server; by default the `connection.serverUrl` config value will be used.

#### API Key
- `-a`, `--apikey=VALUE`: The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used.

#### Profile
- `--profile=VALUE`: A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used.

#### JSON Output
- `--json`: Print output in newline-delimited JSON (the default is plain text).

#### No Color
- `--no-color`: Don't colorize text output.

#### Force Color
- `--force-color`: Force redirected output to have ANSI color (unless `--no-color` is also specified).

#### Storage
- `--storage=VALUE`: The folder where `SeqCli.json` and other data will be stored; falls back to `SEQCLI_STORAGE_PATH` from the environment, then the `seqcli forwarder` service's configured storage path (Windows only), then `/root`.

### Example
```
seqcli app update -n 'HTML Email'
```
```

--------------------------------

### Seq View Filter Example

Source: https://datalust.co/docs/managing-users

This is an example of a view filter that can be applied to a user to limit the data they can view in Seq. Only non-administrative users can have filtered views.

```csharp
Application = 'Patient Portal'

```

--------------------------------

### Twilio SMS Request Body Example

Source: https://datalust.co/docs/calling-webhooks

An example of a form-encoded request body for Twilio SMS, including message content and a URL to event results.

```text
To=%2B61404XXXXXX&MessagingServiceSid=xxxxxxxxxxxxxxxxxxxxxxxxx&Body={@m} {@x}

{uriencode(Source.ResultsUrl)}
```

--------------------------------

### Create Init Script for Metastore Migration

Source: https://datalust.co/docs/converting-a-standalone-seq-instance-into-a-cluster

This command is used within an init script to migrate the Seq metastore to a SQL Server database when a container restarts.

```bash
seqsvr metastore to-mssql --connection-string="{Cluster State Database Connection String}"
```

--------------------------------

### Start Seq Service

Source: https://datalust.co/docs/migrating-legacy-dr-clusters-to-ha

After the migration command completes successfully, use this command to start the Seq service on the node. This node will then become the leader of the new HA cluster.

```powershell
seq service start

```

--------------------------------

### Migrate Existing Instance to PostgreSQL Metastore

Source: https://datalust.co/docs/using-postgresql-as-a-metastore

Migrate an existing Seq instance's metastore to a PostgreSQL database using the `seqsvr metastore to-postgresql` command. Ensure the connection string is correctly specified.

```bash
seqsvr metastore to-postgresql --connection-string "Host=example;Port=5432;Database=seq"
```

--------------------------------

### Stop and Start Seq Service on Windows

Source: https://datalust.co/docs/recovering-from-broken-authentication-settings

Use these commands to stop and start the Seq service on a Windows host machine. This is often a prerequisite for running authentication commands.

```bash
seq service stop
seq service start
```

--------------------------------

### Apply license to Seq server

Source: https://datalust.co/docs/command-line-client

Apply a license to your Seq server by providing the certificate file. The license can be automatically refreshed if it's a subscription.

```bash
seqcli license apply --certificate="license.txt"

```

--------------------------------

### Stop and Start Seq Container with Docker

Source: https://datalust.co/docs/recovering-from-broken-authentication-settings

Commands to stop and start a Seq Docker container. These are typically used before and after running authentication-related commands within the container's context.

```bash
docker stop seq
docker start seq
```

--------------------------------

### List existing app instances

Source: https://datalust.co/docs/command-line-client

This command lists all app instances configured on your Seq server. You can filter by title or ID.

```bash
seqcli appinstance list
```

--------------------------------

### Run Seq Node with Docker

Source: https://datalust.co/docs/configuring-a-clustered-seq-node

This command demonstrates how to run a Seq node as a Docker container, configuring it via environment variables. Ensure the storage location has acceptable performance and sufficient space. This example uses PostgreSQL for the metastore.

```bash
docker run \
  --name seq \
  --hostname '{Node Name}' \
  -d \
  --restart unless-stopped \
  -v /var/lib/seq:/data \
  -p 80 \
  -p 5341 \
  -p 5344 \
  -e ACCEPT_EULA=Y \
  -e 'SEQ_STORAGE_SECRETKEY={Secret Key}' \
  -e 'SEQ_API_CANONICALURI={Load Balancer URI}' \
  -e 'SEQ_CLUSTER_CLUSTERLISTENURI={Node Cluster URI}' \
  -e 'SEQ_CLUSTER_INTERNALAPIURI={Node Internal API URI}' \
  -e SEQ_CLUSTER_ISENABLED=True \
  -e 'SEQ_DIAGNOSTICS_OTLP_ENDPOINT={Diagnostic Instance Ingestion URI}' \
  -e SEQ_DIAGNOSTICS_OTLP_PROTOCOL=http/protobuf \
  -e 'SEQ_DIAGNOSTICS_OTLP_HEADERS=X-Seq-ApiKey={Diagnostic Instance API Key}' \
  -e SEQ_DIAGNOSTICS_OTLP_METRICSSAMPLING_INTERVAL_SECONDS=10 \
  -e 'SEQ_FIRSTRUN_ADMINUSERNAME={Admin Username}' \
  -e 'SEQ_FIRSTRUN_ADMINPASSWORD={Initial Admin Password}' \
  -e SEQ_FIRSTRUN_REQUIREAUTHENTICATIONFORHTTPINGESTION=True \
  -e 'SEQ_METASTORE_POSTGRES_CONNECTIONSTRING={Cluster State Database Connection String}' \
  datalust/seq
```

--------------------------------

### Run Seq Interactively for Debugging

Source: https://datalust.co/docs/service-account-requirements

Attempt to start Seq interactively using 'runas' to diagnose startup issues if the service fails to start and log files provide no information. This can reveal server console output.

```bash
runas /user:<username> seq run
```

--------------------------------

### Show a Seq Server Setting Value

Source: https://datalust.co/docs/command-line-client

Use the `setting show` command to retrieve and display the current value of a specific server setting. The setting name is provided with the `-n` option.

```bash
seqcli setting show -n OpenIdConnectClientSecret
```

--------------------------------

### Start a New Seq Container with Shell and Mounted Data

Source: https://datalust.co/docs/getting-a-shell-to-a-container

This command starts a new Seq container with a shell, mounting an existing data volume. This allows you to work with your existing Seq data in a temporary container.

```bash
docker run \
  -it \
  --rm \
  -v $SEQ_DATA:/data \
  -e ACCEPT_EULA=Y \
  datalust/seq shell

```

--------------------------------

### Substring(str, start, length)

Source: https://datalust.co/docs/scalar-functions

Extract a substring from a string, starting at a specified index and with a specified length. If length is omitted or exceeds remaining characters, the rest of the string is returned. Out-of-bounds or negative indices/lengths result in an undefined outcome.

```APIDOC
## Substring(str, start, length)

### Description
Evaluates to the substring of string `str` from the zero-based index `start`, of `length` characters. If `length` is not specified, or exceeds the number of characters remaining after `start`, the result is the remainder of the string. The result is undefined if start is out of bounds, or if either `start` or `length` is negative. If any argument is undefined, the result is undefined.

### Result type
_any_
```

--------------------------------

### app list

Source: https://datalust.co/docs/command-line-client

Lists installed app packages on the Seq server.

```APIDOC
## app list

### Description
List installed app packages.

### Method
`seqcli app list`

### Parameters
#### Options
- `--package-id=VALUE` (string) - Optional - The package id of the app(s) to list
- `-i`, `--id=VALUE` (string) - Optional - The id of a single app to list
- `--json` - Print output in newline-delimited JSON (the default is plain text)
- `--no-color` - Don't colorize text output
- `--force-color` - Force redirected output to have ANSI color (unless `--no-color` is also specified)
- `--storage=VALUE` (string) - Optional - The folder where `SeqCli.json` and other data will be stored; falls back to `SEQCLI_STORAGE_PATH` from the environment, then the `seqcli forwarder` service's configured storage path (Windows only), then `/root`
- `-s`, `--server=VALUE` (string) - Optional - The URL of the Seq server; by default the `connection.serverUrl` config value will be used
- `-a`, `--apikey=VALUE` (string) - Optional - The API key to use when connecting to the server; by default the `connection.apiKey` config value will be used
- `--profile=VALUE` (string) - Optional - A connection profile to use; by default the `connection.serverUrl` and `connection.apiKey` config values will be used

### Example
```
seqcli app list
```
```

--------------------------------

### Quick Rollback Seq Restore Init Script

Source: https://datalust.co/docs/backup-and-restore-docker

Use this init script for a quick rollback to the latest nightly backup on the same data volume. Ensure the container environment is identical.

```bash
seqsvr restore -y --from-latest

```