advantys/workflowgen-sql repository overview

docker volume create wfgen-sql-data
docker run -d --name wfgen-sql --env-file ./database.env \
  -v wfgen-sql-data:/var/opt/mssql -p 1433:1433 \
  advantys/workflowgen-sql:10.5.0-ubuntu-24.04

docker volume create wfgen-sql-data
docker run -d --name wfgen-sql --env-file .\database.env `
  -v wfgen-sql-data:C:\wfgen\sql -p 1433:1433 `
  advantys/workflowgen-sql:10.5.0-express-win-ltsc2022

docker volume create wfgen-sql-data
docker run -d --name wfgen-sql --env-file ./database.env \
  -v wfgen-sql-data:/var/opt/mssql -p 1433:1433 \
  advantys/workflowgen-sql:9.7.0-ubuntu-22.04

# Create volume for database persistence
docker volume create wfgen-sql-data

# Run container (examples: 9.7.0 or 8.3.5)
docker run -d `
  --name wfgen-sql `
  --env-file .\database.env `
  -v wfgen-sql-data:C:\wfgen\sql `
  -p 1433:1433 `
  advantys/workflowgen-sql:9.7.0-express-win-ltsc2019
  
# Or, for Windows Server 2022:
# advantys/workflowgen-sql:9.7.0-express-win-ltsc2022
  
# Or for v8:
# advantys/workflowgen-sql:8.3.5-express-win-ltsc2019

# database.env for Linux
SA_PASSWORD=yourStrong(!)Password
WFGEN_DATABASE_USER_PASSWORD=myStrong(?)Password
ACCEPT_EULA=Y
# Free for production use
MSSQL_PID=Express

WFGEN_DATABASE_CONNECTION_STRING=Data Source=wfgen-sql;Initial Catalog=WFGEN;User ID=WFGEN_USER;Password=<your-password>;TrustServerCertificate=True

WFGEN_DATABASE_CONNECTION_STRING=Data Source=wfgen-sql;Initial Catalog=WFGEN;User ID=sa;Password=<SA-password>;TrustServerCertificate=True

# Create secrets
echo "yourStrong(!)Password" | docker secret create SA_PASSWORD -
echo "myStrong(?)Password" | docker secret create WFGEN_DATABASE_USER_PASSWORD -

# Create service with secrets
docker service create \
  --name wfgen-sql \
  --secret SA_PASSWORD \
  --secret WFGEN_DATABASE_USER_PASSWORD \
  -e SA_PASSWORD_FILE=/run/secrets/SA_PASSWORD \
  -e WFGEN_DATABASE_USER_PASSWORD_FILE=/run/secrets/WFGEN_DATABASE_USER_PASSWORD \
  -e ACCEPT_EULA=Y \
  advantys/workflowgen-sql:9.7.0-ubuntu-22.04

# Create secrets
"yourStrong(!)Password" | docker secret create SA_PASSWORD -
"myStrong(?)Password" | docker secret create WFGEN_DATABASE_USER_PASSWORD -

# Create service with secrets
docker service create `
  --name wfgen-sql `
  --secret SA_PASSWORD `
  --secret WFGEN_DATABASE_USER_PASSWORD `
  -e SA_PASSWORD_FILE=C:\ProgramData\Docker\secrets\SA_PASSWORD `
  -e WFGEN_DATABASE_USER_PASSWORD_FILE=C:\ProgramData\Docker\secrets\WFGEN_DATABASE_USER_PASSWORD `
  -e ACCEPT_EULA=Y `
  advantys/workflowgen-sql:9.7.0-express-win-ltsc2019

# Required
SA_PASSWORD=yourStrong(!)Password
WFGEN_DATABASE_USER_PASSWORD=myStrong(?)Password

# Required for Linux only
ACCEPT_EULA=Y

# Recommended for v10 Linux (specify SQL Server edition)
MSSQL_PID=Developer

# Optional
WFGEN_DATABASE_CONTAINMENT=Y
WFGEN_DATABASE_USER_USERNAME=WFGEN_USER
WFGEN_ADMIN_USERNAME=wfgen_admin
WFGEN_ADMIN_PASSWORD=admin123
WFGEN_AUTH_APPLICATION=Y

# v10 Linux
docker run -d --env-file ./database.env advantys/workflowgen-sql:10.5.0-ubuntu-24.04

# v9 Linux
docker run -d --env-file ./database.env advantys/workflowgen-sql:9.7.0-ubuntu-22.04

# v8/v9 Windows
docker run -d --env-file .\database.env advantys/workflowgen-sql:9.7.0-express-win-ltsc2019

# Using named volume (recommended)
docker volume create wfgen-sql-data
docker run -d -v wfgen-sql-data:/var/opt/mssql advantys/workflowgen-sql:10.5.0-ubuntu-24.04

# Using bind mount
docker run -d -v /host/path/to/mssql:/var/opt/mssql advantys/workflowgen-sql:9.7.0-ubuntu-22.04

# Using named volume (recommended)
docker volume create wfgen-sql-data

# v10 (SQL Server 2025)
docker run -d -v wfgen-sql-data:C:\wfgen\sql advantys/workflowgen-sql:10.5.0-express-win-ltsc2022

# v9 (SQL Server 2017/2022)
docker run -d -v wfgen-sql-data:C:\wfgen\sql advantys/workflowgen-sql:9.7.0-express-win-ltsc2019

# Using bind mount
docker run -d -v C:\host\path:C:\wfgen\sql advantys/workflowgen-sql:9.7.0-express-win-ltsc2019

# Interactive PowerShell session
docker exec -it wfgen-sql pwsh

# Execute single command
docker exec wfgen-sql pwsh -Command "Get-Date"

# Interactive PowerShell session
docker exec -it wfgen-sql powershell

# Execute single command
docker exec wfgen-sql powershell -Command "Get-Date"

# Interactive bash session
docker exec -it wfgen-sql bash

# Execute single command
docker exec wfgen-sql bash -c "ls -la /var/opt/mssql"

# Stop container (preserves data if volumes are mapped)
docker stop wfgen-sql

# Start existing container
docker start wfgen-sql

# Restart container
docker restart wfgen-sql

# Remove container (data persists in volumes)
docker rm wfgen-sql

# View container logs
docker logs wfgen-sql

# Follow logs in real-time
docker logs -f wfgen-sql

# View last 100 lines
docker logs --tail 100 wfgen-sql

# Check container status
docker ps --filter name=wfgen-sql

# Linux container
docker exec -it wfgen-sql pwsh -NoLogo -NoProfile

# Windows container
docker exec -it wfgen-sql powershell -NoLogo -NoProfile

$sqlParams = @{ ServerInstance = 'localhost'; TrustServerCertificate = $true }
if ($PSVersionTable.PSVersion.Major -le 5 -or $IsWindows) {
    $sqlParams.ServerInstance = '.\SQLEXPRESS'
} else {
    Import-Module /usr/local/lib/Utils.psm1 -Function Get-EnvVar -Prefix WFG
    $sqlParams.Username = 'sa'
    $sqlParams.Password = Get-WFGEnvVar 'MSSQL_SA_PASSWORD' -TryFile -DefaultValue (Get-WFGEnvVar 'SA_PASSWORD' -TryFile)
    if (-not $sqlParams.Password) { throw 'Set the SQL password or its _FILE secret first.' }
}

# Verify database is accessible
Invoke-Sqlcmd -Query 'SELECT DB_NAME()' -Database WFGEN @sqlParams

# Verify WorkflowGen tables exist (should return 64 tables)
Invoke-Sqlcmd -Query "SELECT COUNT(*) AS TableCount FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = 'dbo'" -Database WFGEN @sqlParams

# Check admin user
Invoke-Sqlcmd -Query 'SELECT TOP 1 USERNAME FROM USERS WHERE ID_USER = 1' -Database WFGEN @sqlParams

$backupDirectory = if ($PSVersionTable.PSVersion.Major -le 5 -or $IsWindows) { 'C:\wfgen\backup' } else { '/var/opt/mssql/backup' }
New-Item -ItemType Directory -Path $backupDirectory -Force | Out-Null
$backupName = 'WFGEN_' + [guid]::NewGuid().ToString('N') + '.bak'
$backupPath = Join-Path $backupDirectory $backupName
$backupQuery = "BACKUP DATABASE [WFGEN] TO DISK = N'$backupPath'"
if ($backupDirectory -eq '/var/opt/mssql/backup') {
    $backupQuery += " WITH NOFORMAT, NOINIT, NAME = 'WFGEN-full', SKIP, NOREWIND, NOUNLOAD, STATS = 10"
}
Invoke-Sqlcmd -Query $backupQuery @sqlParams
$backupName
exit

# Linux container
backupName='WFGEN_<id>.bak'
docker cp "wfgen-sql:/var/opt/mssql/backup/$backupName" "./$backupName"

# Windows container
$backupName = 'WFGEN_<id>.bak'
docker stop wfgen-sql
if ($LASTEXITCODE -ne 0) { throw 'Container stop failed.' }
docker cp "wfgen-sql:C:\wfgen\backup\$backupName" ".\$backupName"
if ($LASTEXITCODE -ne 0) { throw 'Copy failed; keep the container stopped.' }
docker start wfgen-sql
if ($LASTEXITCODE -ne 0) { throw 'Container start failed.' }

# Linux host
docker exec wfgen-sql rm -- "/var/opt/mssql/backup/$backupName"

# Windows host
docker exec wfgen-sql powershell -NoProfile -Command "Remove-Item -LiteralPath 'C:\wfgen\backup\$backupName'"

# Linux container: prepare the directory, then copy from your host
docker exec wfgen-sql pwsh -NoLogo -NoProfile -Command "New-Item -ItemType Directory -Path /var/opt/mssql/backup -Force | Out-Null"
docker cp "./$backupName" "wfgen-sql:/var/opt/mssql/backup/$backupName"
docker exec -u 0 wfgen-sql chown mssql "/var/opt/mssql/backup/$backupName"
docker exec -u 0 wfgen-sql chmod u+r "/var/opt/mssql/backup/$backupName"

# Windows container: prepare the directory, then copy
docker exec wfgen-sql powershell -NoProfile -Command "New-Item -ItemType Directory C:\wfgen\backup -Force | Out-Null"
if ($LASTEXITCODE -ne 0) { throw 'Backup directory creation failed.' }
docker stop wfgen-sql
if ($LASTEXITCODE -ne 0) { throw 'Container stop failed.' }
docker cp ".\$backupName" "wfgen-sql:C:\wfgen\backup\$backupName"
if ($LASTEXITCODE -ne 0) { throw 'Copy failed; keep the container stopped.' }
docker start wfgen-sql
if ($LASTEXITCODE -ne 0) { throw 'Container start failed.' }

$backupName = 'WFGEN_<id>.bak' # Use the same complete filename.
$backupDirectory = if ($PSVersionTable.PSVersion.Major -le 5 -or $IsWindows) { 'C:\wfgen\backup' } else { '/var/opt/mssql/backup' }
$backupPath = Join-Path $backupDirectory $backupName
& {
    Invoke-Sqlcmd -Database master -Query 'ALTER DATABASE [WFGEN] SET OFFLINE WITH ROLLBACK IMMEDIATE' -ErrorAction Stop @sqlParams
    Invoke-Sqlcmd -Database master -Query "RESTORE DATABASE [WFGEN] FROM DISK = N'$backupPath' WITH FILE = 1, RECOVERY, NOUNLOAD, REPLACE, STATS = 5" -ErrorAction Stop @sqlParams
    Invoke-Sqlcmd -Database master -Query 'ALTER DATABASE [WFGEN] SET MULTI_USER WITH ROLLBACK IMMEDIATE' -ErrorAction Stop @sqlParams
}
exit

docker logs wfgen-sql

docker ps --filter name=wfgen-sql

docker port wfgen-sql

Invoke-Sqlcmd -Query 'SELECT @@VERSION' @sqlParams

docker logs -f wfgen-sql

# Should return 64 tables
Invoke-Sqlcmd -Query "SELECT COUNT(*) FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = 'dbo'" -Database WFGEN @sqlParams