29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
# Keycloak Server
|
|
|
|
This app allows you to run a local development version of the Keycloak server.
|
|
|
|
### Running the Keycloak server
|
|
|
|
First, ensure that all dependencies are installed locally using PNPM by running:
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
After the dependencies are installed we can start the Keycloak server by running the following command:
|
|
|
|
```bash
|
|
pnpm run start
|
|
```
|
|
|
|
This will download the [Nightly version](https://github.com/keycloak/keycloak/releases/tag/nightly) of the Keycloak server and run it locally on port `8180`. If a previously downloaded version was found in the `server/` directory then that one will be used instead. If you want to download the latest Nightly version you can remove the server directory before running the command to start the server.
|
|
|
|
In order for the development version of the Admin UI to work you will have to import a custom client to the Keycloak server. This is only required during development as the development server for the Admin UI runs on a different port (more on that later).
|
|
|
|
Wait for the Keycloak server to be up and running and run the following command in a new terminal:
|
|
|
|
```bash
|
|
pnpm run import-client
|
|
```
|
|
|
|
You'll only have to run this command once, unless you remove the server directory or Keycloak server data.
|