074e2ec723
The projects "Keycloak Node,js Admin Client" and "Keycloak Documentation" have been moved to this repository, so the links can be removed.
67 lines
2.1 KiB
Markdown
67 lines
2.1 KiB
Markdown
# 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've 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)
|