2024-03-15 08:38:30 +00:00
2013-07-02 13:38:51 +00:00
2024-03-15 10:25:21 +00:00
[](https://bestpractices.coreinfrastructure.org/projects/6818)
2024-10-03 19:51:03 +00:00
[](https://artifacthub.io/packages/olm/community-operators/keycloak-operator)
2024-03-15 10:25:21 +00:00
2024-03-15 08:38:30 +00:00
# Open Source Identity and Access Management
2016-01-21 08:48:36 +00:00
2024-03-15 08:38:30 +00:00
Add authentication to applications and secure services with minimum effort. No need to deal with storing users or authenticating users.
Keycloak provides user federation, strong authentication, user management, fine-grained authorization, and more.
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
## Help and Documentation
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
* [Documentation ](https://www.keycloak.org/documentation.html )
2019-12-09 20:09:11 +00:00
* [User Mailing List ](https://groups.google.com/d/forum/keycloak-user ) - Mailing list for help and general questions about Keycloak
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
## Reporting Security Vulnerabilities
2023-09-11 06:55:38 +00:00
If you have found a security vulnerability, please look at the [instructions on how to properly report it ](https://github.com/keycloak/keycloak/security/policy ).
2019-02-19 18:59:45 +00:00
## Reporting an issue
2015-04-14 07:27:51 +00:00
2022-07-13 14:04:49 +00:00
If you believe you have discovered a defect in Keycloak, please open [an issue ](https://github.com/keycloak/keycloak/issues ).
2019-02-19 18:59:45 +00:00
Please remember to provide a good summary, description as well as steps to reproduce the issue.
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
## Getting started
2022-07-13 14:04:49 +00:00
To run Keycloak, download the distribution from our [website ](https://www.keycloak.org/downloads.html ). Unzip and run:
2019-02-19 18:59:45 +00:00
2022-03-24 19:44:12 +00:00
bin/kc.[sh|bat] start-dev
2019-02-19 18:59:45 +00:00
Alternatively, you can use the Docker image by running:
2022-03-11 10:09:24 +00:00
docker run quay.io/keycloak/keycloak start-dev
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
For more details refer to the [Keycloak Documentation ](https://www.keycloak.org/documentation.html ).
2015-04-14 07:27:51 +00:00
2018-06-15 14:32:20 +00:00
2019-02-19 18:59:45 +00:00
## Building from Source
2018-06-15 14:32:20 +00:00
2022-07-13 14:04:49 +00:00
To build from source, refer to the [building and working with the code base ](docs/building.md ) guide.
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
### Testing
2015-04-14 07:27:51 +00:00
2022-07-13 14:04:49 +00:00
To run tests, refer to the [running tests ](docs/tests.md ) guide.
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
### Writing Tests
2015-04-14 07:27:51 +00:00
2022-07-13 14:04:49 +00:00
To write tests, refer to the [writing tests ](docs/tests-development.md ) guide.
2015-04-14 07:27:51 +00:00
2017-10-16 10:27:11 +00:00
2019-02-19 18:59:45 +00:00
## Contributing
2015-04-14 07:27:51 +00:00
2024-01-17 13:33:11 +00:00
Before contributing to Keycloak, please read our [contributing guidelines ](CONTRIBUTING.md ). Participation in the Keycloak project is governed by the [CNCF Code of Conduct ](https://github.com/cncf/foundation/blob/main/code-of-conduct.md ).
2015-04-14 08:38:25 +00:00
2019-02-19 18:59:45 +00:00
## Other Keycloak Projects
2015-04-14 08:38:25 +00:00
2019-02-19 18:59:45 +00:00
* [Keycloak ](https://github.com/keycloak/keycloak ) - Keycloak Server and Java adapters
* [Keycloak QuickStarts ](https://github.com/keycloak/keycloak-quickstarts ) - QuickStarts for getting started with Keycloak
* [Keycloak Node.js Connect ](https://github.com/keycloak/keycloak-nodejs-connect ) - Node.js adapter for Keycloak
2015-04-14 07:27:51 +00:00
2019-02-19 18:59:45 +00:00
## License
2015-04-14 07:27:51 +00:00
2019-08-30 10:51:29 +00:00
* [Apache License, Version 2.0 ](https://www.apache.org/licenses/LICENSE-2.0 )
