Download and set up the Verdictan gateway

Download for Linux x64

CLI gateway

Download the gateway package for your operating system. Use it to apply configured policy in your development environment.

Download shell installer

Terminal

After you install verdictan, use a shell or script to complete each setup step.

curl -fsSLO https://github.com/verdictan/packages/releases/latest/download/verdictan-installer.sh

Choose an installation option for macOS, Windows or Linux.

0.1.26Latest release

Read the installation guide →

Setup steps

Set up the gateway

macOS

Install through Homebrew or the shell installer from GitHub Releases.

  1. 1

    Install the gateway

    Install through Homebrew or run the shell installer from the latest GitHub Release.

    brew install verdictan/tap/verdictan

# Or use the shell installer
curl -fsSL https://verdictan.com/install | sh
  2. 2

    Verify the installation

    Run verdictan --version. Then run verdictan doctor to check the workstation.

    verdictan --version
verdictan doctor
  3. 3

    Create a starter configuration

    Run verdictan init to create policy-config.yaml. Review the file before you route traffic.

    verdictan init
  4. 4

    Start the gateway

    Lint policy-config.yaml. Test the policy configuration. Deploy it to your agent in Configurations in the Console. Export the runtime and upstream settings. Then start the gateway.

    verdictan policy lint --file policy-config.yaml
verdictan policy test --json
# Deploy policy-config.yaml to the local-evaluation agent in Configurations in the Console.
export VERDICTAN_API_TOKEN="vdt_your_gateway_runtime_token"
export VERDICTAN_UPSTREAM_URL="https://api.openai.com"
export VERDICTAN_UPSTREAM_API_KEY="sk-..."
verdictan gateway run --listen 0.0.0.0:41002 --agent local-evaluation

Linux (x86_64)

Add the signed APT or RPM repository for managed updates, or download a package from GitHub Releases.

  1. 1

    Install the gateway

    Use APT on Debian or Ubuntu. Use DNF on CentOS, RHEL, Fedora or Amazon Linux 2023.

    if command -v apt-get >/dev/null 2>&1; then
  sudo apt-get update
  sudo apt-get install --yes curl gnupg
  key_file="$(mktemp)"
  curl -fsSL https://verdictan.github.io/packages/keys/verdictan-packages.asc -o "$key_file"
  key_fingerprint="$(gpg --show-keys --with-colons "$key_file" | awk -F: '$1 == "fpr" { print $10; exit }')"
  if [ "$key_fingerprint" = "C694419015D84CDBC336FD4C0EBEAF084212D66A" ]; then
    sudo gpg --dearmor --yes -o /usr/share/keyrings/verdictan-packages.gpg "$key_file"
    sudo curl -fsSL https://verdictan.github.io/packages/apt/verdictan.list -o /etc/apt/sources.list.d/verdictan.list
    sudo apt-get update
    sudo apt-get install verdictan
    rm -f "$key_file"
  else
    printf 'Unexpected Verdictan package key: %s\n' "$key_fingerprint" >&2
    rm -f "$key_file"
    false
  fi
elif command -v dnf >/dev/null 2>&1; then
  sudo curl -fsSL https://verdictan.github.io/packages/rpm/verdictan.repo -o /etc/yum.repos.d/verdictan.repo
  sudo dnf install verdictan-gateway
else
  printf 'This host needs apt-get or dnf.\n' >&2
  false
fi
  2. 2

    Verify the installation

    Run verdictan --version. Then run verdictan doctor to check the host.

    verdictan --version
verdictan doctor
  3. 3

    Create a starter configuration

    Run verdictan init to create policy-config.yaml. Review the file before you route traffic.

    verdictan init
  4. 4

    Start the gateway

    Lint policy-config.yaml. Test the policy configuration. Deploy it to your agent in Configurations in the Console. Export the runtime and upstream settings. Then start the gateway.

    verdictan policy lint --file policy-config.yaml
verdictan policy test --json
# Deploy policy-config.yaml to the local-evaluation agent in Configurations in the Console.
export VERDICTAN_API_TOKEN="vdt_your_gateway_runtime_token"
export VERDICTAN_UPSTREAM_URL="https://api.openai.com"
export VERDICTAN_UPSTREAM_API_KEY="sk-..."
verdictan gateway run --listen 0.0.0.0:41002 --agent local-evaluation

Linux (ARM64)

Run the shell installer or download the ARM64 archive from GitHub Releases for ARM64 Linux systems.

  1. 1

    Install the gateway

    Run the shell installer or extract verdictan from the ARM64 archive into /usr/local/bin.

    curl -fsSL https://verdictan.com/install | sh
  2. 2

    Verify the installation

    Run verdictan --version. Then run verdictan doctor to check the host.

    verdictan --version
verdictan doctor
  3. 3

    Create a starter configuration

    Run verdictan init to create policy-config.yaml. Review the file before you route traffic.

    verdictan init
  4. 4

    Start the gateway

    Lint policy-config.yaml. Test the policy configuration. Deploy it to your agent in Configurations in the Console. Export the runtime and upstream settings. Then start the gateway.

    verdictan policy lint --file policy-config.yaml
verdictan policy test --json
# Deploy policy-config.yaml to the local-evaluation agent in Configurations in the Console.
export VERDICTAN_API_TOKEN="vdt_your_gateway_runtime_token"
export VERDICTAN_UPSTREAM_URL="https://api.openai.com"
export VERDICTAN_UPSTREAM_API_KEY="sk-..."
verdictan gateway run --listen 0.0.0.0:41002 --agent local-evaluation

Windows (x86_64)

Install through Scoop, the PowerShell installer, or the ZIP archive from GitHub Releases.

  1. 1

    Install the package

    Install through Scoop or run the PowerShell installer from GitHub Releases.

    scoop bucket add verdictan https://github.com/verdictan/packages
scoop install verdictan

# Or use the PowerShell installer
Invoke-WebRequest -Uri "https://github.com/verdictan/packages/releases/latest/download/verdictan-installer.ps1" -OutFile verdictan-install.ps1
powershell.exe -ExecutionPolicy Bypass -File .\verdictan-install.ps1
  2. 2

    Verify the installation

    Run verdictan --version. Then run verdictan doctor.

    verdictan --version
verdictan doctor
  3. 3

    Create a starter configuration

    Run verdictan init to create policy-config.yaml. Review the file before you route traffic.

    verdictan init
  4. 4

    Start the gateway

    Lint policy-config.yaml. Test the policy configuration. Deploy it to your agent in Configurations in the Console. Export the runtime and upstream settings. Then start the gateway.

    verdictan policy lint --file policy-config.yaml
verdictan policy test --json
# Deploy policy-config.yaml to the local-evaluation agent in Configurations in the Console.
$env:VERDICTAN_API_TOKEN = "vdt_your_gateway_runtime_token"
$env:VERDICTAN_UPSTREAM_URL = "https://api.openai.com"
$env:VERDICTAN_UPSTREAM_API_KEY = "sk-..."
verdictan gateway run --listen 0.0.0.0:41002 --agent local-evaluation

After you install verdictan

Continue your setup

Quickstart

Validate a configuration. Then send your first governed request through the gateway.

Start the quickstart

Policy catalog

Review configurable controls for data protection, safety, compliance workflows, routing and human review.

Review policy controls

Install guide

Follow the complete installation and configuration instructions for each supported platform.

Read the installation guide

Go to the complete documentation at verdictan.com/docs.