---
title: Charmhub | Deploy NetBox K8S Charm using Charmhub - The Open Operator Collection
description: Deploy the latest version of NetBox K8S Charm as a Kubernetes Operator
  on any cloud.
url: https://charmhub.io/netbox-k8s/docs/how-to-configure-oidc
---

# NetBox K8S Charm

[Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

* [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

Platform:

4/stable 19

```
juju deploy netbox-k8s --channel 4/stable
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Relevant links

* [Homepage](https://github.com/canonical/netbox-k8s-operator)

---

#### Contacts

* [Submit a bug](https://github.com/canonical/netbox-k8s-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# Configure OIDC

The NetBox charm makes use of the oauth integration for OIDC. You can find
more information in [charmhub](https://charmhub.io/integrations/oauth).

OIDC is configured in NetBox using the library `python-social-core` with the [`OIDC` backend](https://python-social-auth.readthedocs.io/en/latest/backends/oidc.html).

To configure it, you only need to integrate your OIDC provider with NetBox K8s:

```
juju integrate hydra netbox-k8s
```

For NetBox to work, you may need to customise some of the following configuration options:

* `oidc-scopes`: OIDC scopes are used by an application during authentication to authorize access to a user’s details, like name and picture. It must include `openid` to be a valid OIDC.
* `oidc-redirect-path`: The redirect URL used by the OIDC provider to redirect back to NetBox application after the authorization is done.

NetBox configuration options for OIDC can be configured like:

```
juju config netbox-k8s oidc-scopes="openid profile email" oidc-redirect-path="/oauth/complete/oidc/"
```

---
