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/developer-docs/frontend-only-dev-environment.md
Jens Langhammer 2bbad64dc3 website/docs: add developer docs for frontend-only
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-06-21 21:25:56 +02:00

1.3 KiB

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

  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

    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/.