{"id":25933859,"url":"https://github.com/actcoding/keycloak-theme","last_synced_at":"2025-03-04T00:56:00.668Z","repository":{"id":278647419,"uuid":"936310867","full_name":"actcoding/keycloak-theme","owner":"actcoding","description":"🎨 Custom keycloak theme.","archived":false,"fork":false,"pushed_at":"2025-02-20T22:05:12.000Z","size":3543,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"act","last_synced_at":"2025-02-20T23:19:30.774Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/actcoding.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-20T21:50:00.000Z","updated_at":"2025-02-20T22:06:05.000Z","dependencies_parsed_at":"2025-02-20T23:19:33.731Z","dependency_job_id":"5ba6436d-308d-48e9-b9f1-205d522bb813","html_url":"https://github.com/actcoding/keycloak-theme","commit_stats":null,"previous_names":["actcoding/keycloak-theme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actcoding%2Fkeycloak-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actcoding%2Fkeycloak-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actcoding%2Fkeycloak-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actcoding%2Fkeycloak-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actcoding","download_url":"https://codeload.github.com/actcoding/keycloak-theme/tar.gz/refs/heads/act","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241763686,"owners_count":20016162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-04T00:56:00.116Z","updated_at":"2025-03-04T00:56:00.654Z","avatar_url":"https://github.com/actcoding.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n    \u003ci\u003e🚀 \u003ca href=\"https://github.com/ALMiG-Kompressoren-GmbH/tailcloakify\"\u003eTailcloakify\u003c/a\u003e V1  🚀\u003c/i\u003e\n    \u003cbr/\u003e\n    \u003cbr/\u003e\n\u003c/p\u003e\n\u003cimg src=\"./public/Tailcloakify-login-page.png\" alt=\"keycloak theme config\" width=\"1905\"\u003e\n\nTailcloakify is a [Keycloak](https://github.com/keycloak/keycloak) Theme that is based on \n[Keycloakify](https://github.com/keycloakify/keycloakify), layered with [TailwindCSS](https://github.com/tailwindlabs/tailwindcss) and inspired by [Keywind](https://github.com/lukin/keywind) \nUI design approach.\n\n# How to Use\n\n1. Place the provided JAR file in the \u003ckeycloak-home\u003e/providers/ directory or use the example Dockerfile from this repository to add the provided JAR file into your Docker Image.\n2. Set environment variables or localization messages to customize the theme with the out of the box configuration functionalities.\n3. Restart your Keycloak server or deploy your builded docker image to your server.\n4. Log in to the Keycloak Admin Console.  \nGo to Realm Settings \u003e Themes.  \nSelect the Tailcloakify login theme from the dropdown.  \nSave your settings.\n\n## Customizing the Theme\n\nTailcloakify provides ways of customizing your theme without the need to rebuild the theme while using a prebundled JAR file. This could include adding a background video/logo or customizing the footer behavior.\n\n## Environment variables\n\n| Name                                        | Description                                                                  |\n| ------------------------------------------- |------------------------------------------------------------------------------|\n| TAILCLOAKIFY_ADDITIONAL_SCRIPTS             | Use it to add other external scripts                                         |\n| TAILCLOAKIFY_BACKGROUND_LOGO_URL            | Use it to add an image of your logo                                          |\n| TAILCLOAKIFY_BACKGROUND_VIDEO_URL           | Use it to add a MP4 format background video on your register and login pages |\n| TAILCLOAKIFY_FAVICON_URL                    | Use it to add a url to your Favicon                                          |\n| TAILCLOAKIFY_FOOTER_IMPRINT_URL             | Use it to add an Impressum                                                   |\n| TAILCLOAKIFY_FOOTER_DATAPROTECTION_URL      | Use it to add url to your data protection document                           |\n| TAILCLOAKIFY_FOOTER_ORESTBIDACOOKIECONSENT  | Use it to integrate Orestbida cookie consent plugin                          |\n| TAILCLOAKIFY_FOOTER_ORESTBIDACOOKIECONSENT_GOOGLE_CAPTCHA  | Provide any falsy value to disable the cookie section for the google captcha                          |\n\n## Keycloak localization feature\n\nSome customizations are possible through Keycloak's Localization System, allowing setting up different configurations for each language. You can either add custom localization by adding those into the keycloak server or by manually setting them within the realm settings.\n\n| Name                     | Description                                                                        |\n| ------------------------ | ---------------------------------------------------------------------------------- |\n| backgroundLogoUrl        | The localized enabled alternative to env: TAILCLOAKIFY_BACKGROUND_LOGO_URL         |\n| backgroundVideoUrl       | The localized enabled alternative to env: TAILCLOAKIFY_BACKGROUND_VIDEO_URL        |\n| faviconUrl               | The localized enabled alternative to env: TAILCLOAKIFY_FAVICON_URL                 |\n| footerImprintUrl         | The localized enabled alternative to env: TAILCLOAKIFY_FOOTER_IMPRINT_URL          |\n| footerDataprotectionUrl  | The localized enabled alternative to env: TAILCLOAKIFY_FOOTER_DATAPROTECTION_URL   |\n\n# Developer Quick Start\n\nIf you want to customize the theme beyond the outlined capabilities, you can do so by forking this repository and performing manual changes yourself.\n\nHere do you find a Quick Start, how to setup your development environment:\n\n```bash\n  git clone https://github.com/ALMiG-Kompressoren-GmbH/tailcloakify\n  cd tailcloakify\n  yarn install  # Or use an other package manager, just be sure to delete the yarn.lock if you use another package manager.\n```\n\n## Testing the Theme Locally\n\n```bash\n  npm run dev\n```\n\nAlternatively, to run the theme locally via Keycloak:\n\n```bash\n  npx keycloakify start-keycloak\n```\n\nOr you can preview the pages using the storybook:\n\n```bash\n  npm run storybook\n```\n\n## Building the theme\n\nYou need to have [Maven](https://maven.apache.org/) installed to build the theme (Maven \u003e= 3.1.1, Java \u003e= 7).  \nThe `mvn` command must be in the $PATH.\n\n- On macOS: `brew install maven`\n- On Debian/Ubuntu: `sudo apt-get install maven`\n- On Windows: `choco install openjdk` and `choco install maven` (Or download from [here](https://maven.apache.org/download.cgi))\n\n```bash\n  npm run build-keycloak-theme\n```\n\nNote that by default Keycloakify generates multiple `.jar` files for different versions of Keycloak.  \n\n## GitHub Actions\n\nTailcloakify comes with a generic GitHub Actions workflow that builds the theme and publishes\nthe jars [as GitHub releases artifacts](https://github.com/ALMiG-Kompressoren-GmbH/tailcloakify/releases/tag/v1.1.5).  \nTo release a new version **just update the `package.json` version and push**.\n\nTo enable the workflow go to your fork of this repository on GitHub then navigate to:\n`Settings` \u003e `Actions` \u003e `Workflow permissions`, select `Read and write permissions`.\n\n# Contributing\n\nIf you would like to introduce additional changes, please read the [Contributing Guidelines](CONTRIBUTING.md).\n\n# Code of Conduct\n\nAnyone who interacts with Tailcloakify in any space, including but not limited to this GitHub repository, must follow\nour [Code of Conduct](CODE_OF_CONDUCT.md).\n\n# License\n\nLicensed under the [MIT License](LICENSE).\n\n# Authors\n\n[Paul Werner](https://github.com/paulwer)\n\n[Wayne Kirimi](https://github.com/waynemorphic)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factcoding%2Fkeycloak-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factcoding%2Fkeycloak-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factcoding%2Fkeycloak-theme/lists"}