Deploy ShieldGraph Agent

Scan internal networks, databases, and services behind your firewall. Choose the deployment method that fits your network environment.

Agent Token

Generate a token to authenticate your agent with ShieldGraph.

Keep this token secret. It grants scan access to your account. Tokens are shown only once when generated.

Loading tokens...

Quick Install

The fastest way to install the ShieldGraph agent. Requires internet access on the target machine.

Step 1: Install the agent

Linux / macOS

curl -fsSL https://api.shieldgraph.com/api/v1/agents/install.sh | sh

This script detects your OS and architecture, downloads the correct binary, and installs it to /usr/local/bin.

Step 2: Run with your token

bash

shieldgraph-agent --token YOUR_AGENT_TOKEN

Or use an environment variable

bash

export SHIELDGRAPH_AGENT_TOKEN="YOUR_AGENT_TOKEN"
shieldgraph-agent

Run as a System Service

Set up the agent to start automatically on boot (Linux).

/etc/systemd/system/shieldgraph-agent.service

[Unit]
Description=ShieldGraph Security Agent
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
User=shieldgraph
Group=shieldgraph
ExecStart=/usr/local/bin/shieldgraph-agent --token YOUR_AGENT_TOKEN
Restart=always
RestartSec=10
LimitNOFILE=65536

# Security hardening
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
ReadWritePaths=/var/lib/shieldgraph

[Install]
WantedBy=multi-user.target

Setup commands

sudo useradd --system --no-create-home shieldgraph
sudo mkdir -p /var/lib/shieldgraph
sudo chown shieldgraph:shieldgraph /var/lib/shieldgraph
sudo cp shieldgraph-agent /usr/local/bin/shieldgraph-agent
sudo systemctl daemon-reload
sudo systemctl enable --now shieldgraph-agent
sudo systemctl status shieldgraph-agent