keycloak-scim/README.md

# Keycloak

Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.

This repository contains the source code for the Keycloak Server, Java adapters and the JavaScript adapter.


## Help and Documentation

* [Documentation](https://www.keycloak.org/documentation.html)
* [User Mailing List](https://groups.google.com/d/forum/keycloak-user) - Mailing list for help and general questions about Keycloak


## Reporting Security Vulnerabilities

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).


## Reporting an issue

If you believe you have discovered a defect in Keycloak, please open [an issue](https://github.com/keycloak/keycloak/issues).
Please remember to provide a good summary, description as well as steps to reproduce the issue.


## Getting started

To run Keycloak, download the distribution from our [website](https://www.keycloak.org/downloads.html). Unzip and run:

    bin/kc.[sh|bat] start-dev

Alternatively, you can use the Docker image by running:

    docker run quay.io/keycloak/keycloak start-dev
    
For more details refer to the [Keycloak Documentation](https://www.keycloak.org/documentation.html).


## Building from Source

To build from source, refer to the [building and working with the code base](docs/building.md) guide.


### Testing

To run tests, refer to the [running tests](docs/tests.md) guide.


### Writing Tests

To write tests, refer to the [writing tests](docs/tests-development.md) guide.


## Contributing

Before contributing to Keycloak, please read our [contributing guidelines](CONTRIBUTING.md).


## Other Keycloak Projects

* [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


## License

* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`# Keycloak`
Initial commit 2013-07-02 13:38:51 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.`
Updated readme 2016-01-21 08:48:36 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`This repository contains the source code for the Keycloak Server, Java adapters and the JavaScript adapter.`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00

Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`## Help and Documentation`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`* [Documentation](https://www.keycloak.org/documentation.html)`
Update README.md 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`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00

Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`## Reporting Security Vulnerabilities`

Minor spelling adjustments (#23106) 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).`
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00

			`## Reporting an issue`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Grammar mistakes in the README file The purpose of this pull request is to fix minor grammer mistakes in the README file. All mistakes were present in the form of missing commas. Resolves #13087 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).`
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`Please remember to provide a good summary, description as well as steps to reproduce the issue.`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00
			`## Getting started`

Grammar mistakes in the README file The purpose of this pull request is to fix minor grammer mistakes in the README file. All mistakes were present in the form of missing commas. Resolves #13087 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:`
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00
Update README.md 2022-03-24 19:44:12 +00:00			`bin/kc.[sh\|bat] start-dev`
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00
			`Alternatively, you can use the Docker image by running:`

Updates readme to new Quarkus container images (#10706) Closes #10564 2022-03-11 10:09:24 +00:00			`docker run quay.io/keycloak/keycloak start-dev`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`For more details refer to the [Keycloak Documentation](https://www.keycloak.org/documentation.html).`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
KEYCLOAK-7641 Add details on how to build server-only, including some fixes to poms 2018-06-15 14:32:20 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`## Building from Source`
KEYCLOAK-7641 Add details on how to build server-only, including some fixes to poms 2018-06-15 14:32:20 +00:00
Grammar mistakes in the README file The purpose of this pull request is to fix minor grammer mistakes in the README file. All mistakes were present in the form of missing commas. Resolves #13087 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.`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00

Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`### Testing`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Grammar mistakes in the README file The purpose of this pull request is to fix minor grammer mistakes in the README file. All mistakes were present in the form of missing commas. Resolves #13087 2022-07-13 14:04:49 +00:00			`To run tests, refer to the [running tests](docs/tests.md) guide.`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00

Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`### Writing Tests`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Grammar mistakes in the README file The purpose of this pull request is to fix minor grammer mistakes in the README file. All mistakes were present in the form of missing commas. Resolves #13087 2022-07-13 14:04:49 +00:00			`To write tests, refer to the [writing tests](docs/tests-development.md) guide.`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Update the readme with a reference on how to report vulnerabilities (#4541) 2017-10-16 10:27:11 +00:00
Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`## Contributing`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Grammar mistakes in the README file The purpose of this pull request is to fix minor grammer mistakes in the README file. All mistakes were present in the form of missing commas. Resolves #13087 2022-07-13 14:04:49 +00:00			`Before contributing to Keycloak, please read our [contributing guidelines](CONTRIBUTING.md).`
Updates to README.md 2015-04-14 08:38:25 +00:00

Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`## Other Keycloak Projects`
Updates to README.md 2015-04-14 08:38:25 +00:00
Update to repository documentation, including updated contributors guide 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`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00

Update to repository documentation, including updated contributors guide 2019-02-19 18:59:45 +00:00			`## License`
Updated README.md and started HackingOnKeycloak guide 2015-04-14 07:27:51 +00:00
Update README.md 2019-08-30 10:51:29 +00:00			`* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)`