Protect your site
After these five steps, no single key can change what your website asks wallets to sign: your CI only proposes each release, your approvers approve it in their own wallets, and TapeOut circuit #6 decides when it may go live. Users who run Guard are checked against exactly what you sealed.
You need: Node.js 18+, a static site built by GitHub Actions (output folder such as dist/), a wallet on X Layer with ~0.001 OKB, and three approver addresses.
1 · Install the CLI
In your project folder:
npm install -g signetguard signet --version signet keygen
The signetguard package: one file, no dependencies, Node 18+. The same package is also served here: npm install -g {{ORIGIN}}/signetguard-0.1.0.tgz.
signet keygen creates your CI proposer key in .signet/proposer.key (git-ignored) and prints only its address. Keep the address for step 2. The key can propose and publish releases; it can never approve one.
2 · Create your gate
Open Protect a site in the dashboard, connect your wallet (it offers to switch to X Layer), and enter your domain, three approver addresses, the CI proposer address from step 1, a recovery address kept offline and, optionally, a guardian that can only freeze. Two transactions: 1. Reserve the domain, then, two blocks later, 2. Create the gate (≈ 0.000013 OKB of gas). The page then shows your gate address.
3 · Prove you control the domain
In your project folder, with your domain and the gate address from step 2:
signet link app.example.org 0xYourGateAddress signet domain public
signet link writes signet.config.json (commit it). signet domain public writes public/.well-known/signet.json naming your gate; use the folder your build copies to the site root. Serve it with Access-Control-Allow-Origin: * so the dashboard and badge can read it (Cloudflare Pages and Netlify: add to public/_headers):
/.well-known/signet.json Access-Control-Allow-Origin: *
(Vercel: the same header in vercel.json.) Deploy your site once with the file, then check:
signet domain --check
Only someone who controls the domain can publish this file. Guard, the dashboard, the badge and the watchtower ignore a gate until its domain serves this file naming it, so nobody can seal a domain they don't control.
4 · Add the GitHub workflow
- Repository → Settings → Secrets and variables → Actions → New secret
SIGNET_PROPOSER_KEY= the content of.signet/proposer.key. Then delete the file from your machine. - Send the CI proposer address ≈ 0.0005 OKB on X Layer for gas (propose + publish + the release's manifest files).
- Add
.github/workflows/signet.yml, with your own build and deploy commands:
name: Signet release
on:
push:
branches: [main]
jobs:
release:
runs-on: ubuntu-latest
timeout-minutes: 360
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci && npm run build # your build; output in dist/
- run: npm install -g signetguard@0.1.0
- name: Seal and propose (the CI key can only propose)
run: signet verify dist && signet seal dist && signet propose dist --reuse
env:
SIGNET_PROPOSER_KEY: ${{ secrets.SIGNET_PROPOSER_KEY }}
- name: Wait for the approvals and the timelock, then publish (the circuit decides)
run: signet wait dist --publish --timeout 19800
env:
SIGNET_PROPOSER_KEY: ${{ secrets.SIGNET_PROPOSER_KEY }}
- name: Deploy (only reached after the release is published)
run: echo "your deploy command here"
Deploy only after signet wait succeeds: that is what makes an unapproved build unable to go live. A first release is tier 10 (2 approvals + 24 h), longer than a 6-hour GitHub job: when the job times out, re-run it after the 24 h; propose --reuse finds the same proposal.
5 · Approve your first release, add the badge
Push to main. The workflow proposes release #1. Two approvers open the dashboard, open your domain, read Diff Guard, and click Approve in their own wallets. After the timelock the workflow publishes and deploys.
Then open {{ORIGIN}}/app#/badge/<your domain> and copy the "Sealed by Signet" badge into your site footer. It links to a live page that reads the chain.
Your gate starts in observe mode (Guard reports, never blocks). Switch to enforce in the dashboard when your releases flow cleanly.