From aef6a5ba678f5ec66fc4db414aaedbf20262ea58 Mon Sep 17 00:00:00 2001 From: "Janik H." Date: Fri, 3 May 2024 20:07:11 +0200 Subject: [PATCH] update readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9dfa845..4f02678 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ # NixBox -A very work in progress nixos ipam implantation. -Trying to integrate with netbox. +A very work in progress NixOS IPAM implantation. +Trying to integrate with NetBox. -Netbox doesn't model routing topology which sucks for us since we want to know things like the default-gateway to dynamically generate NixOS config. -There is quite a few issues about it, see: +NetBox doesn't model routing topology which sucks for us since we want to know things like the default-gateway to dynamically generate NixOS config. +There are quite a few issues about it, see: - https://github.com/netbox-community/netbox/discussions/6030 ## Usage -You can follow the usage examples, since we can just interact with the demo instance at https://demo.netbox.org +You can follow the usage examples, since we can just interact with the demo instance at https://demo.netbox.dev The login credentials are admin:admin -### Export data from a existing netbox instance +### Export data from an existing NetBox instance First we need to get a api token to authenticate against the api. -And store it in `NIXBOX_NETBOX_TOKEN` so nixbox can +And store it in `NIXBOX_NETBOX_TOKEN` so NixBox can ```bash export NIXBOX_NETBOX_TOKEN=$(curl -s -X POST -H "Content-Type: application/json" -H "Accept: application/json; indent=4" https://demo.netbox.dev/api/users/tokens/provision/ --data '{ "username": "admin", "password": "admin" }' | jq -r -e .key) ``` -Now you can run the nixbox cli to fetch the data: +Now you can run the NixBox CLI to fetch the data: ```bash nix run github:Janik-Haag/nixbox -- export ```