From c3ae3e02f31b07b9452533d3461828e806acb2b2 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Mon, 26 Jul 2021 22:52:58 +0200 Subject: [PATCH] website/docs: add go requirement Signed-off-by: Jens Langhammer --- website/developer-docs/full-dev-environment.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/website/developer-docs/full-dev-environment.md b/website/developer-docs/full-dev-environment.md index cfb14bdd1..5dea10d05 100644 --- a/website/developer-docs/full-dev-environment.md +++ b/website/developer-docs/full-dev-environment.md @@ -8,6 +8,7 @@ To create a local development setup for authentik, you need the following: - Python 3.9 - pipenv, which is used to manage dependencies, and can be installed with `pip install pipenv` +- Go 1.16 - PostgreSQL (any recent version will do) - Redis (any recent version will do) @@ -24,11 +25,13 @@ log_level: debug secret_key: "A long key you can generate with `pwgen 40 1` for example" ``` -Afterwards, you can start authentik by running `./manage.py runserver`. Generally speaking, authentik is a Django application. +Afterwards, you can start authentik by running `make run`. + +Generally speaking, authentik is a Django application, ran by gunicorn, proxied by a Go application. The Go application serves static files. Most functions and classes have type-hints and docstrings, so it is recommended to install a Python Type-checking Extension in your IDE to navigate around the code. -Before committing code, run `make lint` to ensure your code is formatted well. This also requires `pyright`, which can be installed with npm. +Before committing code, run `make lint` to ensure your code is formatted well. This also requires `pyright@1.1.136`, which can be installed with npm. Run `make gen` to generate an updated OpenAPI document for any changes you made.