Commit graph

415 commits

Author SHA1 Message Date
Michal Hajas
eadd1c45c4
Document using AWS JDBC Wrapper in HA guide
Closes #27211

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-26 12:15:04 +00:00
Alexander Schwartz
25f2b52afd Remove the preview note from Keycloak's HA guide
Closes #27084

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-21 19:59:15 +01:00
Alexander Schwartz
5f56a9b356
Keycloak users should not need to understand the depths of Quarkus configuration to implement Keycloak HA (#27122)
Closes #27121

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-21 13:49:14 +01:00
Václav Muzikář
33425dacd9
Add proxy-headers option to the Keycloak CR (#27092)
Closes #25179

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2024-02-21 12:19:37 +01:00
Václav Muzikář
de60c9b469
Tweak the default memory request and limit in the Operator (#27170)
Closes #27169

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2024-02-21 10:03:17 +01:00
Václav Muzikář
fb49c21f90
Fix docs around --config-file option (#27129)
Closes #22540

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2024-02-19 15:13:09 +01:00
Alexander Schwartz
5f797e3e71
Update Keycloak HA Guide new resource limit settings (#27079)
Closes #27078

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-19 10:41:49 +01:00
Alexander Schwartz
7135b4ec4c
Add Amazon Aurora PostgreSQL to the list of tested databases (#27049)
Closes #27048

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-19 09:16:49 +01:00
Martin Bartoš
59007844d9
Supported option to specify resource management for pods in Keycloak CR (#26661)
Closes #26456

Signed-off-by: Martin Bartoš <mabartos@redhat.com>
2024-02-15 13:38:41 +01:00
Michal Hajas
83f3e91e4f
Use http-pool-max-threads in HA guides
Closes #26849

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-13 10:01:59 +00:00
Alexander Schwartz
786023fd06
Update HA guide about non-blocking probes (#26783)
Closes #26781

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-07 16:16:50 +01:00
Alexander Schwartz
486b199548 Make label for Keycloak container images configurable
Closes #26819

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-02-06 16:16:00 +01:00
Kamesh Akella
4459ed66ad update cpu sizing based on the hashing changes
Closes #26490

Signed-off-by: Kamesh Akella <kamesh.asp@gmail.com>
2024-02-05 14:41:44 +01:00
Michal Hajas
80de12d59a Update HA guides to use the new ISPN config options
Closes #26776

Signed-off-by: Michal Hajas <mhajas@redhat.com>
2024-02-05 11:40:08 +01:00
Pascal Paulis
2785bbd29b
added comment about MySQL Server parameter sql_generate_invisible_primary_key
Closes #23268

Signed-off-by: Pascal Paulis <ppaulis@gmail.com>
2024-02-05 10:36:31 +01:00
Steven Hawkins
66e45a335e
doc: noting the formats apply to spi options as well (#26648)
closes: #26468

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-01-31 16:09:47 +00:00
Steven Hawkins
f55e903092
Convert watching to polling and adding infinispan config file support (#26510)
Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-01-31 12:57:34 +00:00
Alexander Schwartz
c1ae9a0817
Prevent blank after backslash which breaks shell execution (#26632)
Closes #26631

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-31 13:17:31 +01:00
Martin Kanis
84603a9363
Map Store Removal: Rename Legacy* classes (#26273)
Closes #24105

Signed-off-by: Martin Kanis <mkanis@redhat.com>
2024-01-23 13:50:31 +00:00
Thomas Darimont
cc7d6a9b79
Improve wording for Concepts for configuring thread pools in docs
Closes #26402

Signed-off-by: Thomas Darimont <thomas.darimont@googlemail.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-23 12:56:55 +00:00
Alexander Schwartz
e6cd9a2987
Remove product specific content about Linux only (#26222)
Closes #26220

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-22 10:38:07 +01:00
Pedro Ruivo
70b4c6bf52
Encrypt network communication in JGroups
Closes #25702 

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-18 17:24:27 +00:00
Ryan Emerson
ba76682590
Use the http-max-queued-requests option for load shedding in HA docs
Resolves #26223

Signed-off-by: Ryan Emerson <remerson@redhat.com>
2024-01-17 15:44:08 +01:00
Alexander Schwartz
0f48027ffb Reduce internal unsupported options in the Keycloak HA documentation
Closes #26068

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-10 17:38:15 +01:00
Steven Hawkins
41dd1d2161
doc: adding notes about header priority (#25959)
closes: keycloak#23023

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2024-01-10 09:21:49 +01:00
andymunro
70e15bdaa4
Clarify note about containers
Closes #26006

Signed-off-by: AndyMunro <amunro@redhat.com>
2024-01-09 15:20:18 +01:00
Ryan Emerson
60f80ce0c8
Update Route53 HA guide to be compatible with ROSA and OpenShift 4.14.x (#25900)
Closes #25733

Signed-off-by: Ryan Emerson <remerson@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-04 17:45:32 +00:00
Pedro Ruivo
2c70b45205
High Availability Docs: use unbounded token for cross-site connection
Expirable tokens are more secure but it requires manual intervention to
create and share them when they expire.

I have updated the documentation to use non-expirable tokens.

Closes #25909

Signed-off-by: Pedro Ruivo <pruivo@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2024-01-04 17:12:17 +00:00
Steven Hawkins
667ce4be9e
enhance: supporting versioned features (#24811)
also adding a common PropertyMapper validation method

closes #24668

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
2024-01-03 17:56:31 +01:00
Václav Muzikář
e4c348e99e
Add new --proxy-headers option (#25178)
* Add new `--proxy-headers` option

Closes #23431

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>

Co-authored-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>

* Address review comments vol. 03

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>

* Address review comments vol. 04

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>

---------

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-12-13 10:48:12 -03:00
Ryan Emerson
fc2120c881
Add docs for automating Infinispan CLI commands
Add docs for automating Infinispan CLI commands, Move Batch CR to its own concept

Signed-off-by: Ryan Emerson <remerson@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-12-11 17:48:28 +01:00
Steven Hawkins
4db4982e9d
enhance: adding a start optimized flag (#25216)
closes: #25015



Update docs/guides/operator/customizing-keycloak.adoc
Update docs/documentation/release_notes/topics/24_0_0.adoc
Update operator/src/main/java/org/keycloak/operator/crds/v2alpha1/deployment/KeycloakSpec.java

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2023-12-11 16:15:16 +00:00
Steven Hawkins
a04613e7ea
doc: adding a note about config expressions
Closes: #19831

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2023-12-06 19:29:47 +00:00
Alexander Schwartz
a08f112f79
Add links to guides and GitHub discussions (#25271)
This should increase the likelihood for feedback

Closes #25270

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2023-12-05 08:57:52 +01:00
Michal Hajas
d387f13525
Add tests for lb-check endpoint
Added documentation why the check retries and updated outdated docs

Closes #25113

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-12-04 08:53:37 +01:00
Michal Hajas
cafc238ff2
Add documentation for lb-check
Closes #25077

Signed-off-by: Michal Hajas <mhajas@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-11-30 12:47:06 +00:00
Steven Hawkins
8c3df19722
feature: add option for creating a global truststore (#24473)
closes #24148

Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
Co-authored-by: Martin Bartoš <mabartos@redhat.com>
2023-11-30 08:57:17 +01:00
Alexander Schwartz
dd5b9b1c36
Fix cross-links in guides and remove unprocessed content in include (#25126)
Closes #25090

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2023-11-30 08:17:23 +01:00
Alexander Schwartz
68b33be655 Adress keycloak high-availability guide follow-up items
Closes #24975

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2023-11-23 17:12:46 +01:00
Alexander Schwartz
834ef79509
Adding a Keycloak High Availability section to Keycloak's docs
The content was moved over from the Keycloak Benchmark subproject.

Closes #24844

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Pedro Ruivo <pruivo@redhat.com>
Co-authored-by: Michal Hajas <mhajas@redhat.com>
Co-authored-by: Kamesh Akella <kakella@redhat.com>
Co-authored-by: Ryan Emerson <remerson@redhat.com>
Co-authored-by: Anna Manukyan <amanukya@redhat.com>
Co-authored-by: Thomas Darimont <thomas.darimont@googlemail.com>
Co-authored-by: Stian Thorgersen <stian@redhat.com>
Co-authored-by: Thomas Darimont <thomas.darimont@googlemail.com>
Co-authored-by: AndyMunro <amunro@redhat.com>
2023-11-23 12:27:47 +00:00
Václav Muzikář
15a83985b1 Implement load shedding
Closes #23340

Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
2023-11-21 13:43:09 +01:00
Steven Hawkins
4968c35536
fix: correcting the realmrepresentation link (#24869)
closes #22194

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
2023-11-21 09:09:00 +01:00
andymunro
7d62f6308d
Create an attribute for Getting Started (#24825)
* Create an attribute for Getting Started

Closes #24824

Signed-off-by: AndyMunro <amunro@redhat.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-11-20 13:16:35 +01:00
Alexander Schwartz
2bb31b1bfc Fix DocsBuildDebugUtil signatures, and ensure it can be called from an IDE
Closes #24817

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

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
2023-11-20 09:14:57 -03:00
Stian Thorgersen
565bc7d664
Add attributes.adoc for guides to share common attributes (#24519) 2023-11-08 15:09:04 +01:00
AndyMunro
a4b5d66aa0 Minor fixes for FIPS and Operator Guide
Closes #24513
2023-11-03 11:00:55 +01:00
AndyMunro
9ef9c944d0 Minor changes to documentation
Closes #24456
2023-11-01 22:14:11 +01:00
Kohei Tamura
e96d6b38a8
Correct the value of option --cache-stack (#24338) 2023-11-01 12:57:06 +01:00
Stephen Morris
17389e6e29
Fixed some typographical and language usage issues in fips.adoc (#24056)
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2023-10-20 10:02:47 +02:00
AndyMunro
7dda393120 Make minor changes to Getting Started
Closes #23951
2023-10-16 17:47:55 +02:00
Václav Muzikář
b3be89de9b Remove mentions of Crunchy Operator from docs
Closes #24007
2023-10-16 17:36:02 +02:00
Kohei Tamura
2df2aed044
Fix incorrect description of offline session (#23964) 2023-10-13 11:08:57 +02:00
Václav Muzikář
db7ca7fb66 Update Operator product documentation
Closes #23862
2023-10-11 18:23:31 +02:00
Alexander Schwartz
e672ea4f8e
Simplify the docs referencing the container registry (#23874)
Closes #23873
2023-10-11 08:53:28 +02:00
Alexander Schwartz
521db012f3 Fixing missing import for guide
Closes #23800
2023-10-10 15:44:55 -03:00
AndyMunro
c64a3fe7bb Add disclaimer about Kubernetes
Closes #23800
2023-10-10 18:58:12 +02:00
andymunro
469c306cd5
Remove recommendation to file a GitHub issue (#23712)
#Close 23711
2023-10-05 07:42:37 +02:00
Alex Szczuczko
fbae2251e1
Add setup erase command to example for adding more RPMs to the server container (#23639)
Closes #23637
2023-10-03 09:06:55 +02:00
Anil-Shanker
b031aba429
Update configuration.adoc (#23461)
Fix minor typo in "Configuring Keycloak" docs page

Closes #23460
2023-09-22 06:26:44 +00:00
Steven Hawkins
7d1e9a783f
adds a default domain on openshift if one is not specified (#23324)
Closes #21741
2023-09-21 14:43:29 +02:00
mposolda
d4a793be64 Update FIPS 140-2 documentation to clarify default keystore format
closes #23053
2023-09-20 16:15:32 -03:00
Rohan gupta
efe1adc0b1
Windows Command - need to use the backward Slash (#23196) 2023-09-13 09:50:42 +02:00
Alexander Schwartz
2eb37dbe4f Remove MS SQL JDBC driver from the Keycloak product
Closes #22983
2023-09-07 15:30:34 +02:00
Martin Bartoš
6ca78b7554 Return Oracle JDBC driver to the upstream
Closes #22999
2023-09-06 19:11:29 +02:00
andymunro
166e2e4c91
Use screenshot showing fast (#22873)
Closes #22871
2023-09-01 08:54:00 +02:00
Steven Hawkins
5fc4dd03ad
removes direct operator installation for the product (#22828)
Closes #22829
2023-08-30 18:21:38 +02:00
Martin Bartoš
7c013e8d48
Add a Maven profile to remove GELF support (#22615)
Closes #22515

Co-authored-by: Václav Muzikář <vmuzikar@redhat.com>
2023-08-29 17:03:08 +00:00
Martin Bartoš
430c883eda Provide support for determining community/product guides
Closes #22762
2023-08-29 13:13:03 +02:00
Steve Mokris
b776746455
Update health.adoc to link to the Quarkus SmallRye Health docs (#22324) 2023-08-25 16:48:52 +00:00
Erick G. Hagstrom
afaa8c2db9
Fix ambiguity about custom providers in containers.adoc (#22162)
Amplified the explanation of how to include custom providers in a Dockerfile.

Added code to provide context.

Closes #22161

Co-authored-by: Erick G. Hagstrom <erick.hagstrom@innovationhub-act.org>
2023-08-23 09:19:22 +02:00
Martin Bartoš
fcf65389ea
Remove Oracle Database JDBC driver from the Keycloak distribution (#22577)
* Remove Oracle Database JDBC driver from the Keycloak distribution

Closes #22452

* Remove profile for proprietary Oracle JDBC driver

---------

Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-08-21 15:13:49 +00:00
Alexander Schwartz
b99eb52cee Fix mis-alignment of table and enforce checks on AsciiDoc during build
Closes #22518
2023-08-17 13:35:57 -03:00
AndyMunro
bbeac9d533 Address Getting Started review
Closes #22500
2023-08-17 15:06:15 +02:00
Alexander Schwartz
bcfadfc430 Use Freemarker links between different guide pages
Closes #22345
2023-08-16 16:32:08 +02:00
Alexander Schwartz
8652adfe63 Fix layout of tables in the new guides
Closes #22405
2023-08-14 17:16:04 +02:00
Peter Zaoral
8ad6bc49a3
Hostname guide improvements (#21846)
* changed hostname.adoc

Closes #20931

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
Co-authored-by: Steven Hawkins <shawkins@redhat.com>, Václav Muzikář <vaclav@muzikari.cz>
2023-07-28 17:38:07 +02:00
Alexander Schwartz
8bdfb8e1b6 Updating performance information on export/import
Closes: #20703
2023-07-07 09:43:59 -03:00
Alexander Schwartz
3f1553c6cb Referencing information in pom.xml for the list of tested databases
Closes: #21349
2023-07-06 11:39:11 -03:00
Martin Bartoš
ee205c8fbc
Enable IPv6 dualstack support by default (#21340)
Closes #15003
2023-07-03 13:35:33 +00:00
Miquel Simon
83d043e7a8
Upgrade supported and tested version of Postgresql to 15 in order to match supported configuration for Keycloak 22. (#21333)
Closes #21338
2023-06-30 11:29:06 +00:00
Boris Kheyfets
e80107757f Update getting-started-zip.adoc
https://www.keycloak.org/docs/21.0.1/release_notes/index.html#java-11-support-for-keycloak-server-deprecated
2023-06-28 15:49:10 +02:00
Hynek Mlnařík
6b1f08ce26 Update docs/guides/server/keycloak-truststore.adoc
Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2023-06-20 07:47:10 +02:00
Hynek Mlnarik
25e73827f3 Documentation on LDAP secure connection
Closes: #12018
2023-06-20 07:47:10 +02:00
Peter Zaoral
f4cc6d7b76 Update the docs
* updated the release notes
* updated the FIPS guide

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
2023-06-07 09:23:12 -03:00
Steven Hawkins
d045156ba4
Adding the ability to set ingressClassName (#20796)
Closes #20723
2023-06-05 21:10:39 +00:00
Pedro Igor
9ad295a3bc Add back examples for Kubernetes and Openshift to the quickstarts
Closes #20635
2023-05-30 15:32:08 +02:00
Peter Zaoral
34e5884415
SmallRye Keystore (#20375)
* added integration with SmallRye Keystore (keycloak#19281)

Closes #11089

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
2023-05-25 17:36:20 +02:00
Doctor-love
6598bb043b
Update example custom cache configuration for v>21 (#17289)
Co-authored-by: Bruno Oliveira da Silva <bruno@abstractj.com>

Closes #20550
2023-05-24 20:26:25 -03:00
Peter Zaoral
72b238fb48
Keystore vault (#19644)
* KeystoreVault SPI

* added KeystoreVault - a Vault SPI implementation (#19281)

Closes #17252

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
2023-05-24 16:20:30 +00:00
Václav Muzikář
c30b234bbb Reorder chapters in server guide
Closes #20354
2023-05-17 15:31:52 -03:00
Martin Bartoš
812a6c0b99
Improve readability of Operator guides (#20093)
Co-authored-by: Alexander Schwartz <aschwart@redhat.com>
2023-05-17 17:34:32 +02:00
Alexander Schwartz
8cfe8b1411
Update the docs on passthrough proxy (#20072)
Closes #20070
2023-05-15 15:44:47 +00:00
Alexander Schwartz
8573c667a4
Replace guide with a placeholder for downstream docs (#20149)
Closes #20148
2023-05-04 11:04:44 +02:00
mposolda
85d2c41a62 Switch FIPS automated test to ubi8 instead of ubi9
closes #19977
2023-04-27 12:06:21 +02:00
Alexander Schwartz
4f8d67c9fc All commands now auto-reaugment except show-config
Closes #15782
Closes #15898
Closes #17498
2023-04-21 15:06:51 +02:00
ikhomyn
84a7b57059
fix db for openshift 2023-04-21 12:36:41 +00:00
Andre Nascimento
a7153af7b0 Port of the custom extension 'Hostname Debug Tool' to Keycloak.
Co-authored-by: stianst <stian@redhat.com>

Closes #15910
2023-04-21 13:53:33 +02:00
AndyMunro
687c3868c1 Refining Configuring Keycloak guide
Closes #17495
2023-04-19 17:53:46 +02:00
Alexander Schwartz
76ee1be76c
Introducing attribute 'section' to support different naming upstream/downstream (#19547)
Closes #19546
2023-04-17 08:44:34 +02:00
mposolda
863d28e232 Promote FIPS 140-2 to supported in Keycloak 22
closes #17234
2023-04-12 15:29:54 +02:00
Pedro Igor
d857ea8ec2 Removing custom classloader and allow loading drivers at runtime
Closes #13205

Co-authored-by: Brett Lounsbury <brett.lounsbury@nasdaq.com>
2023-03-31 18:05:55 +02:00
Pedro Hos
a96ff792d8 Typo in Outgoing HTTP requests documentation
closes #17242
2023-03-28 10:04:10 +02:00
Václav Muzikář
6ad3005717 Fix container docs for adding a custom provider 2023-03-09 16:27:36 +01:00
Jon Koops
972ebb9650
Use a valid SemVer format for the SNAPSHOT version (#17334)
* Use a valid SemVer format for the SNAPSHOT version

* Update pom.xml

* Update pom.xml

---------

Co-authored-by: Stian Thorgersen <stianst@gmail.com>
Co-authored-by: Stian Thorgersen <stian@redhat.com>
2023-03-03 11:11:44 +01:00
Alexander Schwartz
af0bdd71d3
Move guides to /docs/guides so they are simpler to find and maintain (#17378)
CIAM-5057
2023-03-03 10:08:05 +00:00
Alexander Schwartz
d32b443a27
Write AsciiDoc output as UTF-8 independent of system file encoding. (#17419)
This preserves the UTF-8 encoding of the AsciiDoc input files.

Closes #17417
2023-03-03 09:45:10 +01:00
Sebastian Schuster
2ad5677e3d 17376 added quotes to features documentation 2023-03-02 16:44:32 +01:00
Sebastian Schuster
edcbf73b27 16188 added quotes do logging documentation to also work under Windows 2023-03-01 17:52:00 +01:00
Alex Szczuczko
0b78cf9b29 Update the server guide for the RPM-minimized container
Closes #17273
2023-03-01 16:37:00 +01:00
andymunro
22d090927e
Applying documentation style to the Operator Guide (#17205)
Closes #17177
2023-03-01 16:24:36 +01:00
YO!CHI KIKUCHI
2429d18d78 Update containers.adoc #17301 2023-02-28 09:50:07 +01:00
andymunro
48519be52b
Eliminate guide from cross-references (#17065)
Closes #17055
2023-02-27 14:57:43 +01:00
Alexander Schwartz
8abe984844
Change the list features to the format of a description list (#17237)
CIAM-5050
2023-02-27 08:36:29 +01:00
Pedro Igor
2b98fcdecb Support for standard Forwarded header
Closes #11580
2023-02-22 19:28:04 +01:00
Marek Posolda
b9ab942ef8
FIPS related docs (#17196)
* FIPS related docs
Closes #16444 #12432 #12429

Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
2023-02-22 12:47:15 +01:00
Alexander Schwartz
9ebbf9ceef
Avoid nested table for downstream docs (#17145)
* Avoid nested table for downstream docs

CIAM-5051

* WIP

* Next iteration: making the options and their values monospaced. Merge the default column into the values column

---------

Co-authored-by: Stian Thorgersen <stianst@gmail.com>
2023-02-21 13:44:39 +00:00
andymunro
b8e01596f6
Apply to Keycloak documentation style to the Getting Started guides (#17173)
Closes #17133
2023-02-20 13:58:57 +01:00
Alexander Schwartz
d4604984d0
Compatibility with Maven4 and parallel builds (#16312)
Closes #16308
2023-02-14 11:44:53 +01:00
Alexander Schwartz
e03105e685
Align docs with AsciiDoc best practices for downstream processing (#16996)
CIAM-5054
2023-02-13 08:40:02 +01:00
Stian Thorgersen
6e1a58adc6
Move getting started and migration guides to main repo (#16675)
* Move getting started and migration guides to main repo

Closes #16575

* Fix copy images

* Remove images for Vue getting started that remains on website for now
2023-02-09 10:29:41 +01:00
Alexander Schwartz
9ecd589690
Update docs to enable downstream processing (#16595)
Relates to: #16475
2023-02-08 15:33:43 +01:00
Pedro Igor
75824920aa Update proxy guide with information about session stickness
Closes #16892
2023-02-07 16:42:38 -03:00
Pedro Igor
b5fb528508 Do not enable caching metrics by default and provide a guide
Closes #16751
2023-02-01 18:55:43 +01:00
m2minthemeadow
447364076a
Update containers.adoc (#15729)
You have to set also variable KC_DB after building image, otherwise Keycloak will default to H2 database
2023-01-20 09:14:32 +01:00
yvesgab
234267556d
Update logging.adoc (#16179)
Incorrect reference to "log-format" configuration instead of "log-console-format"
2023-01-20 09:11:04 +01:00
Seenox
ac6b9ed421
docs: add missing backslash to realm startup command (#16381) 2023-01-20 09:10:31 +01:00
Pedro Igor
522bf1c0b0 Keep consistency when importing realms at startup when they are exported via the export command
Closes #16281

Co-authored-by: Martin Bartoš <mabartos@redhat.com>
2023-01-06 18:53:01 +01:00
Martin Bartoš
af3ba49393 Clarify using of --optimized flag with DBs
Closes #16220
2023-01-04 02:47:22 -08:00
Pedro Igor
1ed81fa377 Updating production guide about how to change network stack setting
Closes #15925
2022-12-12 09:29:14 -08:00
Gerrit Sedlaczek
bf458c5715
fixed grammar in health.adoc (#15511) 2022-11-17 08:21:31 +01:00
Stefan Guilhen
4763cfb961 Add missing JDBC driver configuration for MS SQL Server
Closes #15060
2022-11-11 19:44:20 +01:00
Václav Muzikář
71d9b16717 Update Operator docs to reflect Keycloak CR changes 2022-10-24 16:05:00 +02:00
Pedro Igor
1fe3ce79eb Change the title of the Keycloak Truststore guide to make the intent more clear
Closes #14960

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2022-10-21 16:31:41 -03:00
Pedro Igor
dfb2bd144b Fixing commands in the database guide
Closes #14940
2022-10-21 16:08:37 -03:00
Andre Nascimento RH
d12aef0b43
Rename free-form field from 'serverConfiguration' to 'additionalOptions' in Keycloak CR. 2022-10-21 14:41:02 +02:00
Peter Zaoral
4dfbb42680 Refine Ingress settings in Keycloak CR
Closes Keycloak#14407

Signed-off-by: Peter Zaoral <pzaoral@redhat.com>
2022-10-18 17:44:50 +02:00
Muhammad Ummar Iqbal
91a58ed1b9
Documentation updated: Hosting from a sub path section added (#14505)
* Hosting from a sub path section added

* Update as per PR comments

* updates # 2 as per suggestions

* details link removed

* includedOptions section updated
2022-10-05 19:52:05 +02:00
Paweł Walczak
b739878916
Fixed typo in --proxy example (#14539) 2022-09-23 07:43:03 +02:00
Youssef El Houti
7f58c1c570 KEYCLOAK-19138 nginx x509 client trusted certificate lookup 2022-09-01 15:02:56 -03:00
eabykov
6ad71557de Fixed Elasticsearch version
- update Mongo https://docs.graylog.org/docs/upgrade
- update Graylog https://www.graylog.org/post/announcing-graylog-v4-3-3
2022-08-30 15:50:10 -03:00
Pedro Igor
c968925298
Fix the provider id in the database migration example (#14038)
Closes #14037
2022-08-26 14:23:39 +02:00
psytester
ae54fa8dd2
JPA spi example added (#11110)
* JPA spi example added

Added: how to configure JPA migration

* Update db.adoc

* Update configuration-provider.adoc

moved JPA config to db.adoc

* Update docs/guides/src/main/server/configuration-provider.adoc

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2022-08-26 10:38:41 +02:00
Welton Rodrigo Torres Nascimento
ac6ee54455
Document --hostname-strict under reverse proxy (#12881) 2022-08-26 10:11:18 +02:00
Marc Wrobel
827e6c0b20
Fix minor typos in documentations (#13154)
Co-authored-by: Stian Thorgersen <stianst@gmail.com>
2022-08-26 08:07:59 +02:00
Pedro Igor
52aad0bbdc Allow setting a URL to configure frontend and admin URLs
Closes #13524

Co-authored-by: Stian Thorgersen <stianst@gmail.com>
2022-08-25 23:03:09 -03:00
Eric Ashley
21243dafc6
Update reverseproxy.adoc (#12570)
On line 44, "more be" should read "be more"
2022-08-25 13:28:24 +02:00
Deven Phillips
55954b2be7 Improve docs for importing a realm in a container 2022-08-10 11:16:04 -03:00
AndyMunro
a275e239f1 Applying edits to logging guide
Updates to Gelf section

Closes #10363
2022-08-10 09:02:50 -03:00
Martin Kanis
2aadc07703 Improve database topic
Improve clarity, readability, and consistency of the database topic

Closes: #10012
2022-08-09 13:14:52 +02:00
Pedro Igor
cf249fc6ae Updating production guide with information about switching from ipv4 to ipv6
Closes #11979
2022-08-05 11:55:09 -03:00
Pedro Igor
2b2287d1ee More information to the container guide
Closes #13569
2022-08-05 09:45:37 -03:00
Dominik Guhr
f0b7cc66f6 remove ambiguity in caching docs
Closes #13553
2022-08-04 14:49:37 -03:00
Pedro Igor
a5dd9e985c Improving clustering guide and more information about cache-stack and custom stacks
Closes #12862
2022-08-04 11:31:57 -03:00
Dominik Guhr
bef3427add Update docs/guides/src/main/server/logging.adoc
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2022-08-01 12:28:47 -03:00
Dominik Guhr
43afcf11ac add gelf log level option
also aligns writing in logging.adoc to always use GELF instead of gelf/Gelf in plain text.

Closes #13397
2022-08-01 12:28:47 -03:00
manojreddy
7356e1a379
Update configuration.adoc (#13400)
Updated command to run the application from build to start.
2022-07-29 12:24:34 +02:00
Dominik Guhr
22e1c4854d
changed config guide (#13137)
Closes #13135
2022-07-27 09:33:54 +02:00
Dominik Guhr
9bb1299d89 change optimised to optimized
also: fix kc.bat to not use autobuild in devmode anymore, fix containers.adoc to not use auto_build naming, fix build command cli help as it is not required anymore to run it beforehand.
2022-07-22 10:29:07 -03:00
Pedro Igor
e14bd51656 Properly enable/disable metrics and health endpoints
Closes #11506

Co-authored-by: Dominik Guhr <dguhr@redhat.com>
2022-07-22 09:41:29 -03:00
Pedro Igor
89028613d8 Introducing --optimise option
Closes #10737
2022-07-15 15:12:17 -03:00
TheGeekInTheShell
27bed258db
Typo in the configuration provider documentation
It would seem that it was written slashes instead of dashes

Resolves #13085
2022-07-13 10:58:48 -03:00
Dominik Guhr
1d6dde02e5 Add support and docs for centralized logging using gelf.
* 99% 1:1 wrapper of the underlying quarkus gelf extension.
* excluded `filter-stack-trace` and `stack-trace-throwable-reference` options for now, as they are either undocumented on the quarkus side or not important imo.
* added docs and examples for Graylog and ELK stack
* NOT added an automated test, as this is really a 1:1 wrapper around the extension, Test setup would be cumbersome, test would take too much time and tests are done in quarkus itself.

Closes #12125
2022-06-30 16:16:19 -03:00
Pedro Igor
c95ecd9e88 More information in the proxy guide about exposing the administration console
Closes #12450
2022-06-23 10:36:19 -03:00
Pedro Igor
b34f46155c Allow setting the admin hostname
Closes #12190
2022-06-08 16:41:43 -03:00
Pedro Igor
5f349195bb Provide a separate guide for configuring the server truststore
Closes #12260
2022-06-07 10:57:37 -03:00
Pedro Igor
c0fd3b89ea Fixing docs to state that substitution only works when importing at startup
Closes #12069
2022-05-30 08:09:00 -03:00
Dominik Guhr
2e0d2ecbfb Fix link to rest api in import export guide for operator
Has to be merged together with the PR for keycloak/keycloak-web#316 to work correctly

Also fixes a few typos in the guide

Closes #11930
2022-05-17 11:48:46 -03:00
Pedro Igor
b5a5d68dbc Imposing certain constraints to files when importing at start-up
Closes #11861
2022-05-16 16:49:42 +02:00
Kai SHEN
3feed3827c
Add logging format symbols description (#10877)
Resolves #11998
2022-05-16 09:28:04 -03:00
Dominik Guhr
b484bc1268 Update docs/guides/src/main/server/hostname.adoc
Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com>
2022-05-16 12:44:38 +02:00
Dominik Guhr
7a8d38eae3 Adjust docs to reflect what was discussed in #11856
Closes #11579
2022-05-16 12:44:38 +02:00
Paul Wright
599a348b27 update operator watch sentence 2022-05-12 10:05:55 -03:00
Alexey Razinkov
d2d68c25fd docs: fixed logging doc typo
Fixes #11941.
2022-05-11 11:53:20 -03:00
andreaTP
8e1f67b0c4 Fix incorrectly rendered arrows in the docs 2022-05-06 14:50:47 -03:00
Andrea Peruffo
c554a72b18 Update docs/guides/src/main/server/containers.adoc
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2022-05-05 14:41:10 -03:00
andreaTP
9e9da7cb39 Remove the sub-command in the container guide 2022-05-05 14:41:10 -03:00
Kai Josef Schauerte
016c28e7a5 Added a hint to the --cache-config-file config option that you not need to specify the configuration folder
Closes #11302
2022-05-03 09:48:22 -03:00
andreaTP
1f47cb2795 Fix disableDefaultIngress CR field of the operator 2022-04-29 10:48:36 -03:00
Salih Candir
37134ec8b0
Fix wrong reverse proxy link (#11687)
Closes: #11626
2022-04-27 11:41:19 +02:00
Andrea Peruffo
6da5710381
Review pinned guides (#11311) 2022-04-20 10:24:40 +02:00
Andrea Peruffo
8e4512822a Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
376dc4035f Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
5fbcc56080 Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
95ba35e825 Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
1d938fe4ff Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
c8c1a4adc1 Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
41d9aec4c7 Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
6f7a4035b4 Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
d5b68e420e Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
Andrea Peruffo
cbcd8cdfd6 Update docs/guides/src/main/operator/installation.adoc
Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-19 09:41:08 -03:00
andreaTP
73f8909bd8 Operator installation guide 2022-04-19 09:41:08 -03:00
Pedro Igor
9eca6b4e75
Add environment variable expansion to keycloak.conf (#11285)
Closes #11283

Co-authored-by: Dominik Guhr <dguhr@redhat.com>

Co-authored-by: Dominik Guhr <dguhr@redhat.com>
2022-04-19 09:11:29 +02:00
Pedro Igor
52d205ca91
Allow exposing some initial provider config options via web site (#10572)
* Allow exposing some initial provider config options via web site

Co-authored-by: Stian Thorgersen <stian@redhat.com>

Closes #10571

* Include type to provider options, and hide build-icon column as it's not relevant

Co-authored-by: stianst <stianst@gmail.com>
2022-04-19 08:01:42 +02:00
Dominik Guhr
52150cacfc adjust rp docs to clarify exposing js path
Closes #11041
2022-04-13 08:08:48 -03:00
Václav Muzikář
66b1c2b167 Change the CRD API group in the operator 2022-04-12 09:38:40 -03:00
Andrea Peruffo
a521bcfe92
Advanced Keycloak CR configuration (#11065)
* Advanced Keycloak CR configuration

* Update docs/guides/src/main/operator/advanced-configuration.adoc

Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>

Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-04-08 11:57:22 +02:00
Andrea Peruffo
854b75e132
Add how to install extensions to the container docs (#11025) 2022-04-08 11:56:47 +02:00
Andrea Peruffo
57f2b744a0
Add RealmImport CR docs (#11037) 2022-04-08 11:56:03 +02:00
Dominik Guhr
9cb38087b4 Add section about hostname syntax to hostname guide
Superseeds PR #11139, as validation needs more investigation to work for everyone

Closes #11134
2022-04-07 15:14:43 -03:00
McLaynV
5d271c1634 Add a missing = in conf/keycloak.conf example
Add a missing `=` in `conf/keycloak.conf` example
2022-04-07 09:57:04 -03:00