Commit graph

232 commits

Author SHA1 Message Date
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