Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 2.2 KB

README.md

File metadata and controls

38 lines (28 loc) · 2.2 KB

authentik-nix

A Nix flake providing a package, NixOS module and basic VM test for authentik

TOC

Important Note

Please note that this project is not directly affiliated with the official authentik project. Most importantly this means that there is no official support for this packaging and deployment approach. Therefore, please refrain from opening issues for the official project when running into problems with this flake. Feel free to open issues here. If in doubt, please open an issue here first so we can make sure that it's not directly related to this packaging/deployment approach before escalating to the official project.

Overview

  • flake.nix This flake provides packages (server, worker, outposts, ...) as outputs directly and via the overlay output, a NixOS module and a simple VM integration test for the module.
  • module.nix The NixOS module configures authentik services, redis and (by default) a local postgres instance. The upstream default authentik configuration can be partially overridden by setting desired parameters under services.authentik.settings.
  • poetry2nix-python-overrides.nix contains overrides and fixes for building the python env
  • test.nix A minimal NixOS VM test. Confirms that the services configured by the module start and manually goes through the initial setup flow. Two screenshots are taken during test execution to confirm that the frontend is rendered correctly.
  • web-package-lock.json Version 2 package-lock.json of the lockfile located upstream under web/package-lock.json. This is currently a requirement for napalm2nix (see nix-community/napalm#55 (comment) )

Usage

  • WiP

Updating

  • WiP

License

This project is released under the terms of the MIT License. See LICENSE. Consult the upstream project for information about authentik licensing.