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

README: update

Browse source
This commit is contained in:
WilliButz 2023-12-20 21:33:10 +01:00
parent be532175cd
commit 4a61f8afb4
No known key found for this signature in database
GPG key ID: FB0513677AB15BEA
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -20,8 +20,10 @@ Please note that this project is not directly affiliated with the official [auth
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`. 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) * [poetry2nix-python-overrides.nix](./poetry2nix-python-overrides.nix)
contains overrides and fixes for building the python env contains overrides and fixes for building the python env
* [test.nix](./test.nix) * [minimal-vmtest.nix](./tests/minimal-vmtest.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. A minimal NixOS VM test. Confirms that the services configured by the module start and manually goes through the initial setup flow. Some screenshots are taken during test execution to confirm that the frontend is rendered correctly.
* [components](./components/default.nix)
An overridable scope, including the individual authentik components. An example for how to create a custom scope is provided in [override-scope.nix](./tests/override-scope.nix).
## Usage ## Usage
@ -71,7 +73,7 @@ Add authentik-nix to your flake, import the module and configure it. Relevant se
# flake.nix # flake.nix
{ {
inputs.authentik-nix = { inputs.authentik-nix = {
url = "github:mayflower/authentik-nix"; url = "github:nix-community/authentik-nix";
## optional overrides. Note that using a different version of nixpkgs can cause issues, especially with python dependencies ## optional overrides. Note that using a different version of nixpkgs can cause issues, especially with python dependencies
# inputs.nixpkgs.follows = "nixpkgs" # inputs.nixpkgs.follows = "nixpkgs"