Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding navigation menu #1185

Closed
wants to merge 4 commits into from
Closed

Adding navigation menu #1185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
99d4bf6
Modify(doc): Edit the README file, added a table of content for easy …
Motouom Nov 7, 2024
3cdcc1d
Enhancement(doc): Edit the README file, edited the log level config f…
Motouom Nov 7, 2024
8666217
Edit the documentation
Motouom Nov 8, 2024
01e5a66
Edit changelog
Motouom Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]
### Added
- Add navigation to keycloak-config-cli README [#1185](https://github.com/adorsys/keycloak-config-cli/issues/1099)
### Added
- improved logging for realm retrieval errors [#1010](https://github.com/adorsys/keycloak-config-cli/issues/1010)
### Fixed
- Fix required action import handling for no-delete option [#834](https://github.com/adorsys/keycloak-config-cli/issues/834)
Expand Down
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@
[![codecov](https://codecov.io/gh/adorsys/keycloak-config-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/adorsys/keycloak-config-cli)
[![GitHub license](https://img.shields.io/github/license/adorsys/keycloak-config-cli)](https://github.com/adorsys/keycloak-config-cli/blob/main/LICENSE.txt)

# Table of Contents

- [Config Files](#config-files)
- [Variable Substitution](#variable-substitution)
- [Supported Substitutions](#supported-substitutions)
- [Logging](#logging)
- [JSON Logging Support](#json-logging-support)
- [Log Level](#log-level)
- [Supported Features](#supported-features)
- [Compatibility with Keycloak](#compatibility-with-keycloak)
- [Build this Project](#build-this-project)
- [Run Integration Tests](#run-integration-tests)
- [Run this Project](#run-this-project)
- [Docker](#docker)
- [Helm](#helm)
- [Configuration](#configuration)
- [CLI Options / Environment Variables](#cli-options--environment-variables)
- [Keycloak Options](#keycloak-options)
- [Import Options](#import-options)
- [Spring Boot Options](#spring-boot-options)
- [Perform Release](#perform-release)
- [Commercial Support](#commercial-support)


# keycloak-config-cli

keycloak-config-cli is a Keycloak utility to ensure the desired configuration state for a realm based on a JSON/YAML file. The format of the JSON/YAML file based on the export realm format. Store and handle the configuration files inside git just like normal code. A Keycloak restart isn't required to apply the configuration.
Expand Down
Loading