<p align="center">
    <img src="assets/logo-no-background.png" alt="The Nazara Logo" style="width:60%; max-width:300px;" />
</p>

**Welcome to Nazara's documentation hub!**

Nazara is a Rust tool used to automate the registration and update process of machines and VMs in the
IPAM tool [NetBox](https://netboxlabs.com/docs/netbox/).

```admonish bug title="Found a bug?" 
Please [Open an issue on Codeberg](https://codeberg.org/nazara-project/Nazara/issues).
```

## Compatibility

We strive to make sure to stay compatible with the most recent NetBox version. Here you can see which version
of Nazara is compatible with which version of NetBox (and if we still support it). When major ports to new
versions of NetBox happen - which usually includes breaking changes - the old version of Nazara will be moved
to its own branch and tagged accordingly.

|Nazara Version  |NetBox Version               |Branch           |maintained?|
|----------------|-----------------------------|-----------------|---|
|`v0.1.1`        |`v4.3.x`, `v4.4.x`, `4.5.x`  |`main`           |yes|
|`v0.1.0`        |`v4.3.x`, `v4.4.x` and newer |`version/0.1.0`  |no |
|`v0.1.0_beta.3` |`v4.3.x`, `v4.4.x` and newer |`version/beta-3` |no |
|`v0.1.0_beta.2` |`v4.3.x`, `v4.4.x`           |`version/beta-2` |no |
|`v0.1.0_beta.1` |`v4.3.x`                     |`version/beta-1` |no |
|`v0.1.0_alpha.2`|`v3.6.x`                     |`version/alpha-2`|no |

Maintenance work on these older versions is not planned currently.

```admonish warning
Nazara was developed for and on Linux systems. We have no plans to support Windows or Mac in the forseeable future.
If you would like to add support for this, please open a discussion in our GitHub repository.
```

## Distribution Channels

This is an overview of channels through which you can get Nazara.

|Platform/Channel|Version|Offical?|
|-|-|-|
|[`crates.io`](https://crates.io/crates/nazara)|`v0.1.0`|yes|
|openSUSE Tumbleweed|--coming soon--|--coming soon--|

For information about who maintains a package you are looking for, try
looking into the `PACKAGERS.md` file in our project's root directory.
