Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #6

Merged
merged 1 commit into from
May 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading