Skip to content

quick-start.md

Latest commit

 

History

History
75 lines (52 loc) · 2.21 KB

quick-start.md

File metadata and controls

75 lines (52 loc) · 2.21 KB

Quick Start

You will learn how to build update-ipsets from source, run it locally, and try its main features. The daemon starts quickly; the first full catalog download continues in the background.

Prerequisites

  • Go 1.26 or later
  • Git
  • pnpm
  • A terminal

Build from source

Clone the repository and build the binary:

git clone https://github.com/firehol/update-ipsets.git
cd update-ipsets
make build

This produces the update-ipsets binary in the project root. The build also installs and builds the embedded web UI with pnpm.

Run the daemon

Start the daemon with the bundled catalog on a local port:

./update-ipsets daemon \
  --config configs/firehol \
  --listen :18888 \
  --enable-all \
  --admin-auth-mode=disabled \
  --allow-unauthenticated-admin

Flags explained:

  • --config configs/firehol — use the bundled feed catalog
  • --listen :18888 — serve on port 18888
  • --enable-all — make the bundled catalog active without creating enable marker files first
  • --admin-auth-mode=disabled --allow-unauthenticated-admin — open admin for local testing (do not use in production)

Open the interfaces

The public site shows the feed explorer, IP search, and comparisons. The admin UI shows download/processing queues and feed status. On a fresh checkout, wait for the relevant feeds to finish downloading and processing before expecting query results.

Try the CLI

Look up which feeds contain an IP address:

./update-ipsets query 1.2.3.4

Count unique IPs across CIDR ranges using the iprange subcommand:

printf "1.0.0.0/8\n2.0.0.0/8\n" | ./update-ipsets iprange --count-unique

Compose sets and test membership:

./update-ipsets query --set "firehol_level1 + firehol_level2" 1.2.3.4

Next steps