website/docs: add developer docs for frontend-only

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-06-21 21:25:56 +02:00
parent f6026fdb13
commit 2bbad64dc3
4 changed files with 56 additions and 3 deletions

View File

@ -0,0 +1,39 @@
---
title: Frontend-only development environment
---
If you want to only make changes on the UI, you don't need a backend running from source. You can user the docker-compose install with a few customizations.
1. Clone the git repo from https://github.com/goauthentik/authentik
2. In the cloned repository, follow the docker-compose installation instructions [here](../../docs/installation/docker-compose)
3. Add the following entry to your `.env` file:
```
AUTHENTIK_WEB__LOAD_LOCAL_FILES=true
```
This will cause authentik to load static files from a folder and ignore the bundeled files.
4. Add this volume mapping to your compose file
```yaml
version: '3.2'
services:
# [...]
server:
# [...]
volumes:
- ./web:/web
```
This makes the local web files available to the authentik server.
5. Run `docker-compose up -d` to apply those changes to your containers.
6. Run `make gen-web` in the project root directory to generate the API Client used by the web interfaces
7. `cd web`
8. Run `npm i` and then `npm run watch` to start the build process.
You can now access authentik on http://localhost:9000 (or https://localhost:9443).
You might also want to complete the initial setup under `/if/flow/initial-setup/`.

View File

@ -1,6 +1,5 @@
---
title: Getting started
slug: /
title: Full development environment
---
## Backend

View File

@ -0,0 +1,7 @@
---
title: Developer documentation
slug: /
---
Welcome to the authentik developer documentation. authentik is fully open source and can be found here: https://github.com/goauthentik/authentik

View File

@ -2,7 +2,15 @@ module.exports = {
docs: [
{
type: "doc",
id: "local-dev-environment",
id: "index",
},
{
type: "doc",
id: "full-dev-environment",
},
{
type: "doc",
id: "frontend-only-dev-environment",
},
{
type: "doc",