Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Content fixes #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Content fixes #1

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f637293
Content fixes
peschee Oct 3, 2022
52581ce
Remove admin2 feature
peschee Oct 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The following Maven command does the installation:
./mvnw clean initialize
```

After a successful execution the newly created Keycloak installation could be started with the factory settings by executing the `kc.sh start-dev` script from the `server/target/keycloak/bin` directory. Because we want to apply a custom configuration to this installation, we wait with starting up Keycloak until we have introduced the `config` module.
After a successful execution the newly created Keycloak installation could be started with the factory settings by executing the `kc.sh start-dev` script from the `./server/target/keycloak/bin` directory. Because we want to apply a custom configuration to this installation, we wait with starting up Keycloak until we have introduced the `config` module.

For passing a defined set of environment variables to the above script, we will use the wrapper script [run-keycloak.sh] from this module.

Expand All @@ -63,7 +63,7 @@ Since the migration to a Quarkus runtime the [configuration of Keycloak] is done

#### Build stage

In this project all properties of the build stage are configured in the [keycloak.conf] at `config/src/main/resources/keycloak/conf/`.
In this project all properties of the build stage are configured in the [keycloak.conf] at `./config/src/main/resources/keycloak/conf/`.

We set 4 build stage properties:

Expand All @@ -72,7 +72,7 @@ We set 4 build stage properties:
db=postgres

# features is a comma-separated list of features to be enabled
features=declarative-user-profile
features=declarative-user-profile,admin2
peschee marked this conversation as resolved.
Show resolved Hide resolved

# metrics-enabled is for exposing metrics (/metrics) endpoints
metrics-enabled=true
Expand All @@ -83,7 +83,7 @@ health-enabled=true

In the `generate-resources` phase of a Maven build this [keycloak.conf] file is copied to `${keycloak.dir}` (= `./server/target/keycloak`).

Please see [Keycloak/Guides/Server/All configuration/Build options](https://www.keycloak.org/server/all-config?f=build) for the list of all available build stage properties.
Please see [Keycloak / Guides / Server / All configuration / Build options](https://www.keycloak.org/server/all-config?f=build) for the list of all available build stage properties.

#### Runtime stage

Expand Down Expand Up @@ -150,12 +150,12 @@ In this project we support the following types of launching Keycloak:
Because we have configured the database in the above section with `db=postgres` we need an up & running instance of Postgres before launching Keycloak. The easiest way for that is by configuring the `KC_DB_URL` property (e.g. in [keycloak.specific.env]):

```properties
KC_DB_URL=jdbc:postgresql://host.docker.internal:15432/postgres
KC_DB_URL=jdbc:postgresql://localhost:15432/postgres
```

and then running the provided [docker-compose.yml](docker-compose/src/test/resources/postgres/docker-compose.yml) in `docker-compose/src/test/resources/postgres/`.

If you haven't executed a full build of this project, now is a good moment to execute `mvn clean install`.
If you haven't executed a full build of this project, now is a good moment to execute `./mvnw clean install`.

#### via IntelliJ run configuration

Expand Down Expand Up @@ -205,7 +205,7 @@ For a simple use this project provides also IntelliJ run configurations `kc.sh b

#### via docker-compose

The custom Keycloak instance from this project can also be started easily by docker-compose. The only prerequisite is that you have build this project before with `mvn clean install`, so that the container image has been created.
The custom Keycloak instance from this project can also be started easily by docker-compose. The only prerequisite is that you have build this project before with `./mvnw clean install`, so that the container image has been created.

```shell
keycloak-custom/docker-compose/target/keycloak
Expand Down Expand Up @@ -261,7 +261,7 @@ The `themes` module contains the custom themes, which should be available in the
Tooling
-------

The [Takari Maven Wrapper](https://github.com/takari/maven-wrapper) is used for the Maven setup for this project.
The [Apache Maven Wrapper](https://maven.apache.org/wrapper/) is used for the Maven setup for this project.



Expand All @@ -275,4 +275,4 @@ The [Takari Maven Wrapper](https://github.com/takari/maven-wrapper) is used for
[docker-compose.yml]: ./docker-compose/src/main/resources/docker-compose.yml
[keycloak.common.env]: ./docker-compose/src/main/resources/keycloak.common.env
[keycloak.specific.env]: ./docker-compose/src/main/resources/keycloak.specific.env
[secrets.env]: ./docker-compose/src/main/resources/secrets.env
[secrets.env]: ./docker-compose/src/main/resources/secrets.env