2019-02-19 18:59:45 +00:00
# Keycloak
2013-07-02 13:38:51 +00:00
2019-02-19 18:59:45 +00:00
Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.
2016-01-21 08:48:36 +00:00
2019-02-19 18:59:45 +00:00
This repository contains the source code for the Keycloak Server, Java adapters and the JavaScript adapter.
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
2021-12-21 07:45:58 +00:00
If you've 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
2021-11-08 12:16:00 +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
To run Keycloak download the distribution from our [website ](https://www.keycloak.org/downloads.html ). Unzip and run:
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
2019-02-19 18:59:45 +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
2019-02-19 18:59:45 +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
2019-02-19 18:59:45 +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
2019-02-19 18:59:45 +00:00
Before contributing to Keycloak please read our [contributing guidelines ](CONTRIBUTING.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 Documentation ](https://github.com/keycloak/keycloak-documentation ) - Documentation for Keycloak
* [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
* [Keycloak Node.js Admin Client ](https://github.com/keycloak/keycloak-nodejs-admin-client ) - Node.js library for Keycloak Admin REST API
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 )
