UNCLASSIFIED

README.md 1.16 KB
Newer Older
sean.melissari's avatar
sean.melissari committed
1 2
# Keycloak

evan.rush's avatar
evan.rush committed
3 4
Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.

sean.melissari's avatar
sean.melissari committed
5
## Documentation
evan.rush's avatar
evan.rush committed
6

sean.melissari's avatar
sean.melissari committed
7
To learn more about Keycloak [go to the complete documentation](https://www.keycloak.org/documentation.html).
evan.rush's avatar
evan.rush committed
8

sean.melissari's avatar
sean.melissari committed
9
## Deployment
evan.rush's avatar
evan.rush committed
10

sean.melissari's avatar
sean.melissari committed
11
Refer to the official Helm [chart](https://github.com/codecentric/helm-charts/tree/master/charts/keycloak) for deployment instructions.
evan.rush's avatar
evan.rush committed
12

sean.melissari's avatar
sean.melissari committed
13
## Reporting Issues
evan.rush's avatar
evan.rush committed
14

sean.melissari's avatar
sean.melissari committed
15
Report any issues found with this image [here](https://repo1.dsop.io/dsop/dccscr/-/issues).
sean.melissari's avatar
sean.melissari committed
16 17 18

## Notes

sean.melissari's avatar
sean.melissari committed
19
Support for the following databases have been removed from the image.
sean.melissari's avatar
sean.melissari committed
20 21 22 23 24 25

* h2 (embedded)
* MySQL

Users may add support for MySQL by extending the image:
```
sean.melissari's avatar
sean.melissari committed
26
ENV JDBC_MYSQL_VERSION <version>
sean.melissari's avatar
sean.melissari committed
27 28 29 30 31 32
RUN mkdir -p /opt/jboss/keycloak/modules/system/layers/base/com/mysql/jdbc/main && \
    cd /opt/jboss/keycloak/modules/system/layers/base/com/mysql/jdbc/main && \
    curl -O https://repo1.maven.org/maven2/mysql/mysql-connector-java/$JDBC_MYSQL_VERSION/mysql-connector-java-$JDBC_MYSQL_VERSION.jar && \
    cp /opt/jboss/tools/databases/mysql/module.xml . && \
    sed "s/JDBC_MYSQL_VERSION/$JDBC_MYSQL_VERSION/" /opt/jboss/tools/databases/mysql/module.xml > module.xml
```