libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Fix ambiguity about custom providers in containers.adoc (#22162)

Browse source 
Amplified the explanation of how to include custom providers in a Dockerfile.

Added code to provide context.

Closes #22161

Co-authored-by: Erick G. Hagstrom <erick.hagstrom@innovationhub-act.org>
This commit is contained in:
Erick G. Hagstrom 2023-08-23 03:19:22 -04:00 committed by GitHub
parent 94089bd492
commit afaa8c2db9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/guides/server/containers.adoc
View file

@ -54,12 +54,23 @@ The build process includes multiple stages:
* In the final image, additional configuration options for the hostname and database are set so that you don't need to set them again when running the container. * In the final image, additional configuration options for the hostname and database are set so that you don't need to set them again when running the container.
* In the entrypoint, the `kc.sh` enables access to all the distribution sub-commands. * In the entrypoint, the `kc.sh` enables access to all the distribution sub-commands.
To install custom providers, you just need to define a step to include the JAR file(s) into the `/opt/keycloak/providers` directory: To install custom providers, you just need to define a step to include the JAR file(s) into the `/opt/keycloak/providers` directory.
This step must be placed before the line that `RUNs` the `build` command, as below:
[source, dockerfile] [source, dockerfile]
---- ----
# A example build step that downloads a JAR file from a URL and adds it to the providers directory # A example build step that downloads a JAR file from a URL and adds it to the providers directory
FROM quay.io/keycloak/keycloak:latest as builder
...
# Add the provider JAR file to the providers directory
ADD --chown=keycloak:keycloak <MY_PROVIDER_JAR_URL> /opt/keycloak/providers/myprovider.jar ADD --chown=keycloak:keycloak <MY_PROVIDER_JAR_URL> /opt/keycloak/providers/myprovider.jar
...
# Context: RUN the build command
RUN /opt/keycloak/bin/kc.sh build
---- ----
=== Installing additional RPM packages === Installing additional RPM packages