> For the complete documentation index, see [llms.txt](https://docs.keycloakify.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keycloakify.dev/keycloakify/v6/readme-1.md).

# Requirements

{% hint style="success" %}
This tool will be maintained to stay compatible with every Keycloak version starting from [Keycloak Version 11](https://github.com/keycloak/keycloak/releases/tag/11.0.3).

However, the default pages you will get (before you customize them) will always be the ones of Keycloak [v11.0.3](https://github.com/keycloak/keycloak/releases/tag/11.0.3) and some extra pages that didn't existed back then like `register-user-profile.ftl.`
{% endhint %}

### Supported Keycloak version

<details>

<summary>See versions Keycloakify have been tested with</summary>

* [11.0.3](https://hub.docker.com/layers/jboss/keycloak/11.0.3/images/sha256-4438f1e51c1369371cb807dffa526e1208086b3ebb9cab009830a178de949782?context=explore)
* [12.0.4](https://hub.docker.com/layers/jboss/keycloak/12.0.4/images/sha256-67e0c88e69bd0c7aef972c40bdeb558a974013a28b3668ca790ed63a04d70584?context=explore)
* [15.0.2](https://hub.docker.com/layers/jboss/keycloak/15.0.2/images/sha256-d8ed1ee5df42a178c341f924377da75db49eab08ea9f058ff39a8ed7ee05ec93?context=explore)
* [16.1.0](https://hub.docker.com/layers/jboss/keycloak/16.1.0/images/sha256-6ecb9492224c6cfbb55d43f64a5ab634145d8cc1eba14eae8c37e3afde89546e?context=explore)
* [17.0.1](https://github.com/keycloak/keycloak/releases/tag/17.0.1)
* [18.0.0](https://quay.io/repository/keycloak/keycloak?tab=tags\&tag=18.0.0)
* [18.0.2](https://quay.io/repository/keycloak/keycloak?tab=tags\&tag=18.0.2)
* [19.0.1](https://quay.io/repository/keycloak/keycloak?tab=tags\&tag=19.0.1)
* [20.0.1](https://quay.io/repository/keycloak/keycloak?tab=tags\&tag=20.0.1)

Latest release isn't in the list yet? It probably works fine, we just can't confirm it yet.

Older version are likely to be supported as well.

</details>

### Supported meta framworks

Only create-react-app projects (and by extension any app that builds with Webpack) are supported.

Next.js and Vite aren't supported, they could be (Next only in build static mode) but it would require extra work.

<details>

<summary>See more</summary>

This tool assumes you are bundling your app with [Webpack](https://webpack.js.org/).

It assumes there is a `build/` directory at the root of your react project directory, it's usually generated after running `yarn build`.

The `build/` directory is expected to contain an `index.html` file and a `build/static/` directory.

Keycloakify also assumes there is a public/ directory at the root of your react project that is used to make static files available.

Concretely Keycloakify assumes that if there is a `public/a/b.c/foo.txt` file. This file should be available at `https://localhost:<some_port>/a/b/c.foo.txt` when running your app in test mode (usually by firing yarn start).

For more detailed information see [this issue](https://github.com/InseeFrLab/keycloakify/issues/5#issuecomment-832296432).

**My framework isn't supported**

It doesn’t mean that you can't use Keycloakify but your Keycloak theme will need to be a standalone project.\
Find specific instructions about how to get started [**here**](https://github.com/codegouvfr/keycloakify-starter#standalone-keycloak-theme).

To share your styles between your main app and your login pages you will need to externalize your design system by making it a separate module. Checkout [ts-ci](https://github.com/garronej/ts_ci), it can help with that (example with [our design system](https://github.com/InseeFrLab/onyxia-ui)).

</details>

### Utility that needs to be installed

* `docker` must be up and running when running `start_keycloak_testing_container.sh`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.keycloakify.dev/keycloakify/v6/readme-1.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.