{"id":21702822,"url":"https://github.com/openpj/keycloak-docker-quickstart","last_synced_at":"2025-06-21T16:35:44.368Z","repository":{"id":152888157,"uuid":"150221016","full_name":"OpenPj/keycloak-docker-quickstart","owner":"OpenPj","description":"Keycloak Maven SDK for managing the entire lifecycle of your extensions with Docker","archived":false,"fork":false,"pushed_at":"2023-02-08T17:07:58.000Z","size":417,"stargazers_count":33,"open_issues_count":0,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-06-03T10:02:17.701Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"FreeMarker","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenPj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2018-09-25T06:57:16.000Z","updated_at":"2024-08-30T16:36:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"bdefb603-306d-4616-b701-ddaf853ad58e","html_url":"https://github.com/OpenPj/keycloak-docker-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenPj%2Fkeycloak-docker-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenPj%2Fkeycloak-docker-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenPj%2Fkeycloak-docker-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenPj%2Fkeycloak-docker-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenPj","download_url":"https://codeload.github.com/OpenPj/keycloak-docker-quickstart/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenPj%2Fkeycloak-docker-quickstart/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258928024,"owners_count":22779559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T21:20:13.297Z","updated_at":"2025-06-21T16:35:39.356Z","avatar_url":"https://github.com/OpenPj.png","language":"FreeMarker","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Keycloak Docker Quickstart\nThis project is aimed to manage Keycloak extensions using a fully Maven lifecycle.\nThe current supported component are the following:\n\n*  keycloak-assembly\n*  keycloak-identity-providers\n*  keycloak-integration-tests\n*  keycloak-theme\n\nDeveloped and tested on Keycloak 20.0.1.\n\n## Requirements\nIn order to use this project, you need to install the following components:\n\n* Apache Maven 3.8.x\n* Docker\n\n\n## Keycloak Assembly\nThis is the Maven assembly module for deploying the platform in any environment that is not currently supporting Docker.\nThe final artifact for this module is a folder tree as the following:\n\n* realm-config\n* themes\n\n## Keycloak Identity Providers\nMain module that includes all the needed custom providers and authenticators.\nThe default project contains only a single custom authenticator but you can easily add new providers following the same configuration approach.\n\n**Custom Authenticator**\nThis is the implementation of the secret question provider taken from the Keycloak examples folder.\n\n## Keycloak Integration Tests\nThis module will install and run all the artifacts using Docker.\nIt can include also your own code for integration tests after executing your custom image.\n\n**Building**\n```\nmvn clean package\n```\n\nThis will also regenerate the Dockerfile in the project root.\n\n**Running Integration Tests**\n\nTo execute integration tests you can run the following command:\n\n```\nmvn clean integration-test\n```\n\nA specific Maven property (docker.keepRunning) is provided to decide if keep running the container after the execution of tests or not.\nPlease consider that the default value is true, this means that you have to manually stop the container after executing integration-test.\n\n\n## Saving and running the Custom Keycloak Docker image\nIn order to execute the build process locally of the Docker image **custom/keycloak:latest**\n```\nmvn clean package\nmvn install\n```\n\nAfter the startup of Keycloak, you can access as admin/admin from the admin console URL:\n```\nhttp://localhost:8080\n```\n\nA quickstart realm is provided to test your extensions.\n\nTo dynamically regenerate the Dockerfile and build only the Docker image:\n```\nmvn clean package\ndocker build -t custom/keycloak:${project.version} .\n```\n\nRun the latest Docker image:\n\n```\ndocker run -p 8080:8080 -p 9090:9090 custom/keycloak:${project.version}\n```\n\n## Keycloak Themes\nThis module includes the default example of themes with the addition of the secret question sample templates taken from the default authenticator.\n\n## Deliverables\n\n**Overlays**\n\n| Source | Target deployment | Artifact |\n| -------- | -------- | -------- |\n| /src/main/realm-config | /opt/keycloak/data/import | Folder |\n| /keycloak-theme/target/keycloak-theme-${project.version}.jar | /opt/keycloak/themes | JAR |\n| /keycloak-identity-providers/keycloak-identity-provider-authenticator/target/keycloak-identity-provider-authenticator-${project.version}.jar | /opt/keycloak/providers | JAR |\n\n**Docker image**\nThe Docker image is written inside your local repo but it is also available in the following path:\n\n```\n/target/docker/custom/keycloak/${project.version}/tmp/docker-build.tar.gz\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpj%2Fkeycloak-docker-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenpj%2Fkeycloak-docker-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpj%2Fkeycloak-docker-quickstart/lists"}