Skip to content

Commit

Permalink
Merge pull request #6 from Janik-Haag/readme
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
Janik-Haag committed May 3, 2024
2 parents fe8ba57 + aef6a5b commit 202e9ec
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down

0 comments on commit 202e9ec

Please sign in to comment.