mirror of
https://github.com/goauthentik/authentik.git
synced 2026-06-18 03:19:51 +03:00
website: fix typos (#20996)
This commit is contained in:
@@ -6,7 +6,7 @@ This page describes how to debug different components of an authentik instance,
|
||||
|
||||
## authentik Server & Worker (Python)
|
||||
|
||||
The majority of the authentik codebase is in Python, running in Gunicorn for the server and Dramatiq for the worker. These instructions show how this code can be debugged/inspected. The local debugging setup requires a setup as described in [Full development environment](./full-dev-environment.mdx)
|
||||
The majority of the authentik codebase is in Python, running in Gunicorn for the server and Dramatiq for the worker. These instructions show how this code can be debugged or inspected. The local debugging setup requires the setup described in [Full development environment](./full-dev-environment.mdx).
|
||||
|
||||
Note that authentik uses [debugpy](https://github.com/microsoft/debugpy), which relies on the "Debug Adapter Protocol" (DAP). These instructions demonstrate debugging using [Visual Studio Code](https://code.visualstudio.com/), however they should be adaptable to other editors that support DAP.
|
||||
|
||||
@@ -28,7 +28,7 @@ Whichever process is first started listens on port `9901`. Additional processes
|
||||
|
||||
When debugging an authentik instance running in containers, there are some additional steps that need to be taken in addition to the steps above.
|
||||
|
||||
A local clone of the authentik repository is required to be able to set breakpoints in the code. The locally checked out repository must be on the same version/commit as the authentik version running in the containers. To checkout version 2024.12.3 for example, you can run `git checkout version/2024.12.3`.
|
||||
A local clone of the authentik repository is required to set breakpoints in the code. The locally checked out repository must be on the same version/commit as the authentik version running in the containers. To check out version 2024.12.3, for example, run `git checkout version/2024.12.3`.
|
||||
|
||||
The debug port needs to be accessible on the local machine. By default, this is port 9901. Additionally, the container being debugged must be started as `root`, because additional dependencies need to be installed on startup.
|
||||
|
||||
@@ -50,7 +50,7 @@ services:
|
||||
|
||||
After re-creating the containers with `AUTHENTIK_DEBUGGER` set to `true` and the port mapped, the steps are identical to the steps above.
|
||||
|
||||
If the authentik instance is running on a remote server, the `.vscode/launch.json` file needs to be adjusted to point to the IP of the remote server. Alternatively, it is also possible to forward the debug port via an SSH tunnel, using `-L 9901:127.0.0.1:9901`.
|
||||
If the authentik instance is running on a remote server, the `.vscode/launch.json` file needs to be adjusted to point to the IP of the remote server. Alternatively, you can forward the debug port via an SSH tunnel, using `-L 9901:127.0.0.1:9901`.
|
||||
|
||||
## authentik Server / Outposts (Golang)
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ If you're focusing solely on frontend development, you can create a minimal deve
|
||||
echo "AUTHENTIK_TAG=gh-next" >> ./lifecycle/container/.env
|
||||
echo "AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-next" >> ./lifecycle/container/.env
|
||||
echo "AUTHENTIK_LOG_LEVEL=debug" >> ./lifecycle/container/.env
|
||||
echo "GIT_BUILD_HASH="dev"" >> ./lifecycle/container/.env
|
||||
echo 'GIT_BUILD_HASH="dev"' >> ./lifecycle/container/.env
|
||||
```
|
||||
|
||||
3. Create a Docker Compose override file (`compose.override.yml`) in the root of the repository. This will override the volume configurations for the local configuration file (`local.env.yml`) and mount the directory for the frontend code (`web`) into the docker containers. Docker will automatically mount the web files generated by the build process. The `local.env.yml` mount is optional, but allows you to override the default configuration.
|
||||
@@ -48,7 +48,7 @@ If you're focusing solely on frontend development, you can create a minimal deve
|
||||
- ./local.env.yml:/local.env.yml
|
||||
```
|
||||
|
||||
4. From the repository root, run the front-end build script. This will install the npm packages needed to run the frontend project and start the project in watch mode.
|
||||
4. From the repository root, run the frontend build script. This will install the npm packages needed to run the frontend project and start the project in watch mode.
|
||||
|
||||
```shell
|
||||
make node-install
|
||||
|
||||
@@ -131,7 +131,7 @@ make migrate
|
||||
```
|
||||
|
||||
:::info
|
||||
If you ever want to start over, use `make dev-reset` which drops and restores the authentik PostgreSQL database to the state it was after you ran after `make migrate`.
|
||||
If you ever want to start over, use `make dev-reset`, which drops and restores the authentik PostgreSQL database to the state it was in after you ran `make migrate`.
|
||||
:::
|
||||
|
||||
## 5. Running authentik
|
||||
@@ -159,7 +159,7 @@ To set a password for the default admin user (**akadmin**):
|
||||
1. Navigate to http://localhost:9000/if/flow/initial-setup/ in your browser.
|
||||
2. Follow the prompts to set up your admin account.
|
||||
|
||||
From now on, you can now access authentik at http://localhost:9000 using the credentials you defined in Step 2.
|
||||
From now on, you can access authentik at http://localhost:9000 using the credentials you defined in Step 2.
|
||||
|
||||
## 6. Build the frontend
|
||||
|
||||
@@ -183,7 +183,7 @@ When `AUTHENTIK_DEBUG` is set to `true` (the default for the development environ
|
||||
|
||||
### Recovery key
|
||||
|
||||
If you can't login anymore or the authentication flow repeats (perhaps due to an incorrectly configured stage or a failed flow import), you can create a recovery key by running this command in your terminal:
|
||||
If you can no longer log in or the authentication flow repeats (perhaps due to an incorrectly configured stage or a failed flow import), you can create a recovery key by running this command in your terminal:
|
||||
|
||||
`uv run ak create_recovery_key 10 akadmin`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user