Commit graph

140 commits

Author SHA1 Message Date
Sutou Kouhei
358ab5512c
Add a description which port shoud be reverse proxied
I misunderstood how to configure reverse proxy with different
hostname/hostname-admin. So this description will help other users.

Closes #33559

Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-10-18 10:08:00 +02:00
Martin Bartoš
637ca2e138
[PERF] OpenTelemetry is initialized even when disabled (#34031)
Change host reference in logging guide

Fixes #33948

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-10-17 15:08:50 +02:00
foliengriller
316e00bb98
Unified case in Dockerfile Example (#33774)
This prevents a warning on build-time.
https://docs.docker.com/reference/build-checks/from-as-casing/

Signed-off-by: foliengriller <info@simpelwebservice.de>
2024-10-10 13:22:25 +02:00
Alexander Schwartz
7b85fc3319 Fix runaway formatting
Closes #33585

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-10-04 14:09:21 +02:00
Steven Hawkins
c092867c48
fix: correcting the container examples wrt hostname (#33542)
closes: #33539

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-10-04 10:27:52 +02:00
mposolda
41c72d46d2 Document users hashed passwords with argon2 does not work in FIPS environment
closes #33296

Signed-off-by: mposolda <mposolda@gmail.com>

Co-authored-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Marek Posolda <mposolda@gmail.com>
2024-10-03 08:47:45 +02:00
Pedro Aguiar
002560ef3e update/fix-typo-confFileValue-should-be-keystoreValue
- "confFileValue" appears twice consecutively in the same paragraph; the second occurrence should be "keystoreValue".

Thanks to Justin P for pointing that out in [1].

[1] https://github.com/keycloak/keycloak/discussions/33292

Signed-off-by: Pedro Aguiar <contact@codespearhead.com>
2024-10-02 19:33:48 +02:00
Steven Hawkins
f1a7a4804e
fix: adds additional info / warnings to hostname v2 (#33261)
* fix: adds additional info / warnings to hostname v2

closes: #24815

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* refining the proxy-headers language from #33209

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* adding hostname-strict-https

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* moving removed property check to the quarkus side

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* Update quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/HostnameV2PropertyMappers.java

Co-authored-by: Martin Bartoš <mabartos@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>

* Update docs/guides/server/hostname.adoc

Signed-off-by: Steven Hawkins <shawkins@redhat.com>

---------

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
2024-09-28 08:48:09 +00:00
Steven Hawkins
cf2ecf87f6
fix: add the proxy-protocol option (#33276)
* fix: add the proxy-protocol-enabled option

closes: #10492

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* Update docs/guides/server/reverseproxy.adoc

Co-authored-by: Martin Bartoš <mabartos@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>

---------

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
2024-09-27 23:44:59 +02:00
Václav Muzikář
fc76bad1fd Undeprecate https-trust-store-* options and enhance mTLS docs
Closes #33172

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2024-09-27 18:07:57 +02:00
mposolda
8f038f19dd Upgrade BCFIPS to 2.0
closes #30415

Signed-off-by: mposolda <mposolda@gmail.com>
2024-09-26 06:52:21 +02:00
Ryan Emerson
adb8d989f5 Allow Embedded Cache sizes to be configured via the CLI
Closes #31514

Signed-off-by: Ryan Emerson <remerson@redhat.com>
2024-09-24 14:35:24 +02:00
Steven Hawkins
3793d60104
fix: expanding more on proxy-headers and hostname concerns (#33211)
closes: #33209

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-09-24 09:42:52 +02:00
Martin Bartoš
84564f080a
Redirect to relative-path from the root path (#32868)
Closes #32863

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-09-18 16:37:28 +02:00
Martin Bartoš
45ef84a397
Possibility to separately specify log levels for log handlers - basic (#32779)
* Possibility to separately specify log levels for log handlers

Closes #32619

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>

* Edit properties description

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

---------

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2024-09-13 12:05:03 +02:00
Steven Hawkins
f0bf290c28
fix: add a reload period property (#32715)
closes: #23771

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-09-13 09:47:21 +02:00
Jon Koops
188893222f Remove references of statically served Keycloak JS from documentation
Closes #32821

Signed-off-by: Jon Koops <jonkoops@gmail.com>
2024-09-12 09:38:00 +02:00
Martin Bartoš
f6d880ea3f
Syslog: add necessary options to cover the major usability (#32316)
Closes #32314

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-09-06 16:20:52 +02:00
nxadm
3c16e2ac77
Document Syslog app-name option (#32524)
Closes #32525

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Claudio Ramirez <pub.claudio@gmail.com>
2024-09-02 12:10:15 +02:00
Peter Zaoral
7019287a67 Rename Dockerfile to Containerfile in the docs
Closes: #27947

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
2024-08-30 13:22:22 +02:00
Martin Bartoš
afcbf79582 OTEL: Profile Feature
Closes #32231

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-08-30 13:19:09 +02:00
Michal Hajas
af53af1506
Document persistent sessions are enabled by default
Closes #32387

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Pedro Ruivo <pruivo@users.noreply.github.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-08-30 09:20:58 +00:00
Steve Hawkins
c9779cfa24 fix: adding a first-class option for trusted proxies
closes: #32135

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-08-29 14:00:27 +02:00
Václav Muzikář
9bbfec5cdd
Remove GELF (#32230)
Closes #27365

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2024-08-28 21:25:05 +02:00
Steven Hawkins
29eb0171de
task: remove hostname v1 (#32352)
closes: #27731

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-08-28 17:48:06 +02:00
Steven Hawkins
2cbe476c52
fix: adding consistent language for the non-server commands (#32317)
closes: #29200

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-08-22 08:37:07 +02:00
Martin Bartoš
607ab01405
OTEL: Dynamic service name for tracing in K8s environment (#32140)
* OTEL: Dynamic service name for tracing in K8s environment

Closes #32095

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Update docs/guides/server/tracing.adoc

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

---------

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2024-08-21 17:22:36 +02:00
Steven Hawkins
087647dab3
fix: adding docs around client redirect uris and hostname-strict (#32101)
* fix: adding docs around admin client redirect uris and hostname-strict

closes: #31640

Signed-off-by: Steve Hawkins <shawkins@redhat.com>

* Update docs/documentation/upgrading/topics/changes/changes-25_0_0.adoc

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>

* Update docs/documentation/upgrading/topics/changes/changes-25_0_0.adoc

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>

---------

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2024-08-21 14:19:30 +00:00
Martin Bartoš
bf5cf47351
Management Interface is turned on even though nothing is exposed on it (#31938)
* Management Interface is turned on even though nothing is exposed on it

Fixes #31818

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* Remove conditional enablement, add relevancy description

Signed-off-by: Martin Bartoš <mabartos@redhat.com>

---------

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-08-19 15:52:59 +02:00
Martin Bartoš
3ff825807f Tracing - Configurable service name and resource attributes
Closes #32056

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-08-13 15:43:07 +02:00
Martin Bartoš
d17a48f8f8
Add docs for the OpenTelemetry tracing
Closes #31908

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2024-08-13 08:46:48 +02:00
Steven Hawkins
ea3937f37c
fix: always replacing placeholders (#31871)
closes: #31625

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-08-12 16:20:47 +00:00
Peter Zaoral
07cfdac862
Document admin bootstrapping and recovery
Closes: #30011

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2024-07-30 15:45:56 +02:00
Martin Kanis
fdc35919a0 Wrong command in exposing metrics from caches section
Closes #31413

Signed-off-by: Martin Kanis <mkanis@redhat.com>
2024-07-19 09:19:31 +02:00
rmartinc
764ef4831a Release notes and some notes for JavaKeystoreProvider changes
Closes #31226

Signed-off-by: rmartinc <rmartinc@redhat.com>
2024-07-17 10:44:45 +02:00
Steven Hawkins
4970a9b729
fix: deprecate KEYCLOAK_ADMIN and KEYCLOAK_ADMIN_PASSWORD
closes: #30658

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
2024-07-11 18:07:57 +02:00
Diego Garcia Lozano
2ff0d4e4f8
Update caching docs to match breaking changes in v25
In the latest Keycloak version (v25.0.1) the cache options are not build options anymore. They now have to be provided during runtime.

Closes #31050

Signed-off-by: Diego Garcia Lozano <diegogarcialozano95@gmail.com>
2024-07-04 11:54:32 +02:00
Pedro Aguiar
2316b8d82a
update: fix typo in hostname.adoc (#31007)
- `proxy_name` becomes `project_name`.

Signed-off-by: Pedro Aguiar <contact@codespearhead.com>
2024-07-02 16:50:38 +00:00
Václav Muzikář
bce7a29035
Document how Admin REST API endpoints work with Hostname config
Closes #30537

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
2024-06-28 09:31:41 +02:00
Martin Bartoš
30fdba00b5
Describe mTLS overrides for the management interface (#30735)
Closes #30094

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-06-26 12:02:36 +02:00
Steven Hawkins
1983bfc9b1
docs: remove reference to features-disabled=default (#30612)
closes: #29761

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-06-25 11:08:45 +02:00
rmartinc
e9c9efc3f4 Upgrade bc-fips to 1.0.2.5
Closes #26568
Closes #27884

Signed-off-by: rmartinc <rmartinc@redhat.com>
2024-06-25 11:07:27 +02:00
Andre F de M
0f061a75e2 Issue: 26568 - bcfips version bump and fixes
* bump BCFIPS to 1.0.2.5
               * fix bc-fips related test error
               * remove unused imports

               Closes: #26568

Signed-off-by: Andre F de M <trixpan@users.noreply.github.com>
2024-06-25 11:07:27 +02:00
Nikolai Prokoschenko
1019af91c9
Fix typo in importExport.adoc (#30731)
Signed-off-by: Nikolai Prokoschenko <nikolai.prokoschenko@kurzdigital.com>
2024-06-25 08:07:05 +00:00
julien-sarik
dd7e82cd16
Fix usage of management port in the documentation (#30653)
Health and metrics endpoints are documented as being served on port 8443 instead of 9000 in [the guide about Running Keycloak in a container](https://www.keycloak.org/server/containers#_starting_the_optimized_keycloak_container_image).

Closes #30652

Signed-off-by: julien <julien.sarik@gmail.com>
2024-06-21 12:59:13 +00:00
Wim Deblauwe
cc00566fae
Add missing space (#30394)
* Add missing space

Fix the website on https://www.keycloak.org/server/db showing some asciidoc related `ifeval` text

Closes #30417

Signed-off-by: Wim Deblauwe <wim.deblauwe@gmail.com>

* Review and rework for grammar and syntax

Closes #30417

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>

---------

Signed-off-by: Wim Deblauwe <wim.deblauwe@gmail.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-06-14 09:17:17 +02:00
daviddelannoy
d4fc5249c4
fix label error for persistent-user-sessions feature flag in documentation
Closes #30368

Signed-off-by: daviddelannoy <16318239+daviddelannoy@users.noreply.github.com>
2024-06-12 09:32:10 +00:00
Václav Muzikář
375ea9da03
Enhance masking around config-keystore (#30348)
Closes #30346

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2024-06-12 08:54:45 +02:00
MWarnecke
0c6558612f
Enhance documentation regarding edge termination (#30170)
Closes #29665

Signed-off-by: Michael Warnecke <WarneckeMichael@web.de>
2024-06-10 07:47:20 +00:00
Martin Bartoš
262fc09edc
OpenJDK 21 support (#28518)
* OpenJDK 21 support

Closes #28517

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Signed-off-by: Martin Bartoš <mabartos@redhat.com>

* x509 SAN UPN other name is not handled in JDK 21 (#904)

closes #29968

Signed-off-by: mposolda <mposolda@gmail.com>

---------

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
Signed-off-by: mposolda <mposolda@gmail.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Co-authored-by: Marek Posolda <mposolda@gmail.com>
2024-06-03 14:17:28 +02:00