eliott/authentik
1
0
Fork 0
mirror of https://github.com/goauthentik/authentik synced 2026-05-01 11:57:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

website/docs: add e2e testing steps (#15656)

Browse Source 
* Add e2e testing steps.

* Apply suggestion
This commit is contained in:
Dewi Roberts
2025-07-18 19:07:45 +01:00
committed by GitHub
parent 33f83bec46
commit 8eedfe5c4e
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
website/docs/developer-docs/setup/full-dev-environment.mdx
View File

@@ -26,8 +26,8 @@ import Tabs from "@theme/Tabs";
## Services Setup
For PostgreSQL and Redis, you can use the `docker-compose.yml` file in `/scripts`.To use these pre-configured database instances, navigate to the `/scripts` directory in your local copy of the authentik git repo, and run `docker compose up -d`.
You can also use a native install, if you prefer.
For PostgreSQL and Redis, you can use the `docker-compose.yml` file in `/scripts`. To use these pre-configured database instances, navigate to the `/scripts` directory in your local copy of the authentik git repo, and start the services by running `docker compose up -d`.
Alternatively, you can also use a native install, if you prefer.
:::info
If you use locally installed databases, the PostgreSQL credentials given to authentik should have permissions for `CREATE DATABASE` and `DROP DATABASE`, because authentik creates a temporary database for tests.
@@ -147,6 +147,18 @@ To define a password for the default admin (called **akadmin**), you can manuall
In case of issues in this process, feel free to use `make dev-reset` which drops and restores the authentik PostgreSQL instance to a "fresh install" state.
:::
## End-to-End (E2E) Setup
To run E2E tests, navigate to the `/tests/e2e` directory in your local copy of the authentik git repo, and start the services by running `docker compose up -d`.
You can then view the Selenium Chrome browser via [http://localhost:7900/](http://localhost:7900) using the password: `secret`.
Alternatively, you can connect directly via VNC on port `5900` using the password: `secret`.
:::note
When using Docker Desktop, host networking needs to be enabled via **Docker Settings** > **Resources** > **Network** > **Enable host networking**.
:::
## Submitting Pull Requests
Before submitting a pull request, run the following commands in the same directory as your local authentik git repository: