trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
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/setup/frontend-dev-environment.md
dependabot[bot] b40caf12df
core: bump node from 18 to 20 (#5329) 
* core: bump node from 18 to 20

Bumps node from 18 to 20.

---
updated-dependencies:
- dependency-name: node
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* bump node everywhere, fixup go ci

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* bump versions in docs

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jens Langhammer <jens@goauthentik.io>
2023-04-21 13:54:23 +03:00

1.7 KiB
Raw Blame History

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.

Prerequisites

  • Node (any recent version should work, we use 20.x to build)
  • Make (again, any recent version should work)
  • Docker and docker-compose

:::info Depending on platform, some native dependencies might be required. On macOS, run brew install node@20, and for docker brew install --cask docker :::

Instructions

  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_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-next
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-next
AUTHENTIK_LOG_LEVEL=debug

    This will cause authentik to use the beta images.

  4. Add this volume mapping to your compose file

    version: "3.2"

services:
    # [...]
    server:
        # [...]
        volumes:
            - ./web:/web
            - ./local.env.yml:/local.env.yml

    This makes the local web files and the config file available to the authentik server.

  5. Run docker-compose up -d to apply those changes to your containers.

  6. cd web

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