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

website/docs: add missing pipenv instructions 

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-10-04 17:54:06 +02:00
parent 0f00b27384
commit 9ac808ee98
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
website/developer-docs/setup/full-dev-environment.md
View File

@ -6,6 +6,8 @@ title: Full development environment
To create a local development setup for authentik, you need the following: To create a local development setup for authentik, you need the following:
### Requirements
- Python 3.9 - Python 3.9
- pipenv, which is used to manage dependencies, and can be installed with `pip install pipenv` - pipenv, which is used to manage dependencies, and can be installed with `pip install pipenv`
- Go 1.16 - 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. 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 To configure authentik to use the local databases, create a file in the authentik directory called `local.env.yml`, with the following contents
```yaml ```yaml