This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/docs/development/local-dev-environment.md

43 lines
1.2 KiB
Markdown
Raw Normal View History

---
title: Setting up a local dev environment
---
## Backend
2020-12-05 21:08:42 +00:00
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`
- PostgreSQL (any recent version will do)
- Redis (any recent version will do)
For PostgreSQL and Redis, you can use the docker-compose file in `scripts/`. You can also use a native install, if you prefer.
2020-12-05 21:08:42 +00:00
To configure authentik to use the local databases, create a file in the authentik directory called `local.env.yml`, with the following contents
```yaml
debug: true
postgresql:
user: postgres
log_level: debug
```
2020-12-05 21:08:42 +00:00
Afterwards, you can start authentik by running `./manage.py runserver`. Generally speaking, authentik is a Django application.
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.
## Frontend
By default, no transpiled bundle of the frontend is included. To build the UI, you need Node 12 or newer.
To build the UI, run these commands:
```
cd web/
npm i
npm run build
```
If you want to make changes to the UI, run `npm run watch` instead.