From 9ac808ee98521d9b56abd8d8e85694242c8671d9 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Mon, 4 Oct 2021 17:54:06 +0200 Subject: [PATCH] website/docs: add missing pipenv instructions Signed-off-by: Jens Langhammer --- website/developer-docs/setup/full-dev-environment.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/website/developer-docs/setup/full-dev-environment.md b/website/developer-docs/setup/full-dev-environment.md index d73077436..9c1af96d3 100644 --- a/website/developer-docs/setup/full-dev-environment.md +++ b/website/developer-docs/setup/full-dev-environment.md @@ -6,6 +6,8 @@ title: Full development environment To create a local development setup for authentik, you need the following: +### Requirements + - Python 3.9 - pipenv, which is used to manage dependencies, and can be installed with `pip install pipenv` - Go 1.16 @@ -14,6 +16,13 @@ To create a local development setup for authentik, you need the following: For PostgreSQL and Redis, you can use the docker-compose file in `scripts/`. You can also use a native install, if you prefer. +### Setup + +```shell +pipenv shell # Creates a python virtualenv, and activates it in a new shell +pipenv sync --dev # Install all required dependencies, including development dependencies +``` + To configure authentik to use the local databases, create a file in the authentik directory called `local.env.yml`, with the following contents ```yaml