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

website/developer-docs: add notice about libxmlsec compatibility (#5553)

This commit is contained in:
Jens L 2023-05-09 23:46:27 +02:00 committed by GitHub
parent 51a56942bc
commit f164fff2e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -18,15 +18,19 @@ You can also use a native install, if you prefer.
## Backend Setup ## Backend Setup
:::info
Depending on your platform, some native dependencies might be required. On macOS, run `brew install libxmlsec1 libpq`, and for the CLI tools `brew install postgresql redis node@20`
:::
:::info
As long as [this issue](https://github.com/xmlsec/python-xmlsec/issues/252) is open, a workaround is required to install a compatible version of `libxmlsec1` with brew, see [this comment](https://github.com/xmlsec/python-xmlsec/issues/254#issuecomment-1511135314).
:::
```shell ```shell
poetry shell # Creates a python virtualenv, and activates it in a new shell poetry shell # Creates a python virtualenv, and activates it in a new shell
poetry install # Install all required dependencies, including development dependencies poetry install # Install all required dependencies, including development dependencies
``` ```
:::info
Depending on platform, some native dependencies might be required. On macOS, run `brew install libxmlsec1 libpq`, and for the CLI tools `brew install postgresql redis node@20`
:::
To configure authentik to use the local databases, we need a local config file. This file can be generated by running `make gen-dev-config`. To configure authentik to use the local databases, we need a local config file. This file can be generated by running `make gen-dev-config`.
To apply database migrations, run `make migrate`. This is needed after the initial setup, and whenever you fetch new source from upstream. To apply database migrations, run `make migrate`. This is needed after the initial setup, and whenever you fetch new source from upstream.