Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.51 KB

README.md

File metadata and controls

54 lines (36 loc) · 1.51 KB
Raw

IPv4 Address Management für Freifunk Potsdam

built with nix

CI status

API

Wanna try it out? Current master is hosted for testing on https://ipam.erictapen.name/ip4/.

List registered IPv4 adresses

curl https://ipam.erictapen.name/ip4 \
  -H 'Accept: application/json' \ # This line can be omitted with curl, but in general ffp-ipam cares about the Accept header and serves HTML if wanted!
  -H 'x-api-key: ThisIsNotSecretYet'

Register a new address

curl https://ipam.erictapen.name/ip4/register \
 -H 'x-api-key: ThisIsNotSecretYet' \
 -H 'Content-Type: application/json' \
 --data '{ "ip4": "192.168.0.1/32", "contact": "mail@freifunk-potsdam.de", "location": "Behind the corner", "node_name": "mynodename" }'

Building the daemon

Dependencies

As this uses Rocket, you need a nightly version of rustc for building. Rustup is a way to get it.

Also you need pkgconfig and openssl to be installed. If you are using Nix, nix-shell should be enough to get them through shell.nix.

Building with Cargo

$ cargo build --release

Running the daemon

ffp-ipam \
  --listen 127.0.0.1 \
  --port 8000 \
  --token "ThisIsNotSecretYet" \
  --ip4-range "192.168.0.0/24" \
  --ip4-range "10.0.0.0/16" \
  /path/to/state/dir