tamipes/authentik-nix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: provide basic project overview

Browse source
This commit is contained in:
WilliButz 2023-06-12 14:13:13 +02:00
parent e079fe0719
commit 16a034e9f8
No known key found for this signature in database
GPG key ID: FB0513677AB15BEA
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -14,10 +14,25 @@ Please note that this project is not directly affiliated with the official [auth
## Overview ## Overview
* [flake.nix](./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](./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](./poetry2nix-python-overrides.nix)
contains overrides and fixes for building the python env
* [test.nix](./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](./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 https://github.com/nix-community/napalm/issues/55#issuecomment-1466354584 )
## Usage ## Usage
* WiP
## Updating ## Updating
* WiP
## License ## License
This project is released under the terms of the MIT License. See [LICENSE](./LICENSE). This project is released under the terms of the MIT License. See [LICENSE](./LICENSE).
Consult [the upstream project](https://github.com/goauthentik/authentik) for information about authentik licensing. Consult [the upstream project](https://github.com/goauthentik/authentik) for information about authentik licensing.