trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

website/docs: add go requirement

Browse source 
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-07-26 22:52:58 +02:00
parent 7c6a96394b
commit c3ae3e02f3
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
website/developer-docs/full-dev-environment.md
View file

@ -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.