Commit graph

199 commits

Author SHA1 Message Date
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
Pedro Igor
23c5199c0c
Allow overriding the host header using X-Forwarded-Host (#11021)
Closes #10997
2022-04-05 09:17:08 +02:00
thomasbeaujean
c522ce59da
typo on reverseproxy.adoc Keylcoak=>Keycloak (#11034) 2022-04-05 08:22:13 +02:00
andreaTP
46fd33d689 Keycloak custom image with Operator 2022-04-01 10:41:07 -03:00
Andrea Peruffo
3a443118c5 Update docs/guides/src/main/operator/basic-deployment.adoc
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2022-03-31 16:07:55 -03:00
Andrea Peruffo
d69abc23b6 Update docs/guides/src/main/operator/basic-deployment.adoc
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2022-03-31 16:07:55 -03:00
Andrea Peruffo
cbd23afbfb Update docs/guides/src/main/operator/basic-deployment.adoc
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2022-03-31 16:07:55 -03:00
andreaTP
e1bd96ea42 Basic Deployment using the Keycloak Operator
Co-authored-by: Václav Muzikář <vmuzikar@redhat.com>
2022-03-31 16:07:55 -03:00
Dominik Guhr
9e57f836f2 Make quarkus runtime properties also available as runtime properties in keycloak
Changes behaviour to:
- all raw quarkus config properties are handled as runtime config in keycloak, with the exception of raw properties we need for additional datasources, there we check for build- vs runtime
- unknown quarkus buildtime properties require a build first or the usual quarkus warning is shown
- wrapped quarkus properties still get ignored / overwritten by our configuration layer (no change in behaviour here)

Closes #10968
2022-03-30 18:13:09 -03:00
Dominik Guhr
25f1c13e55 update proxy docs
Corresponding PR for the change in keycloak-documentation, recommendation is using a package manager

Closes #10915
2022-03-30 12:57:34 -03:00
andreaTP
fff992aa3b Operator docs structure 2022-03-30 12:54:45 -03:00
Pedro Igor
e177f90299
Allow importing realms during startup (#10754)
Closes #9261
2022-03-24 14:35:09 +01:00
keycloak-bot
c71aa8b711
Set version to 999-SNAPSHOT (#10784) 2022-03-22 09:22:48 +01:00
jcz1
1604fb59e6
Update db.adoc (#10753)
redundant text
2022-03-22 08:46:47 +01:00
Pedro Igor
ffa6df5547
Fixes to hostname (#10820)
Closes #10627
Closes #10331
2022-03-22 08:11:50 +01:00
Dominik Guhr
8454dc5a5d Support for console-JSON and FILE logging
See logging.adoc for details on the usage

Closes #10523, #10607 and #10415
2022-03-08 08:19:03 -03:00
Joaquim Fellmann
f569db2e42 Update kubernetes cache-stack documentation
Closes #10341
2022-03-07 07:32:18 -03:00
Alexander Schwartz
e1318d52d7 Add section on how to add the initial admin user
Closes #10531

Co-authored-by: Dominik Guhr <89905860+DGuhr@users.noreply.github.com>
2022-03-04 13:25:09 -03:00
AndyMunro
ced716c07e Minor changes based on feedback from Dominik
Closes #10075
2022-02-25 09:30:01 +01:00
AndyMunro
7b1180856b Removing double spaces
Closes #10309
2022-02-25 08:54:20 +01:00
Dominik Guhr
45c0baf843 enhance container guide
closes #10458
2022-02-25 08:53:37 +01:00
andreaTP
59d9e3e3ee Enable the heatlh endpoints under a flag 2022-02-24 14:35:42 -03:00
Pedro Igor
9297a5e1b2 Configuring providers guide
Co-authored-by: Stian Thorgersen <stian@redhat.com>

Closes #10400
2022-02-24 13:29:57 +01:00
Dominik Guhr
19a17e79ba Change tx driver handling.
Introduce a non-tx driver for the vendors and map based on new build option transaction-tx-enabled

Closes #10191 and others.

Co-authored-by: Pedro Igor <pigor.craveiro@gmail.com>
2022-02-22 18:00:31 -03:00
Marc Collins
7fdd18ac86
Update enabletls.adoc (#10369)
Correction to command line
2022-02-22 09:10:12 +01:00
Carsten Hoffmann
6c74aeec72 docs: Change references from keycloak-x to keycloak 2022-02-17 11:39:05 -03:00
AndyMunro
19b637e895 Changing back to steps and removing extra space
Closes #10100
2022-02-16 19:48:15 -03:00
Pedro Igor
f750c2e0f7
Updating proxy guide with x509 client certificate lookup (#10220)
Closes #10222
2022-02-16 15:47:04 +01:00
keycloak-bot
d9f1a9b207
Set version to 18.0.0-SNAPSHOT (#10165) 2022-02-11 21:28:06 +01:00
Dominik Guhr
d8097ee7a5
Add paragraph about mTLS configuration (#10084)
Closes #10041
2022-02-09 14:58:31 +01:00
Dominik Guhr
f78b8bf89f
Add note about escaping in CLI (#10083)
Closes #9999
2022-02-09 14:39:53 +01:00
Dominik Guhr
1b77358160 Logging guide v1
Closes #10001
2022-02-08 18:13:05 -03:00
andymunro
aed6e8cd5b
Edits to caching topic (#9988)
Closes #9968
2022-02-07 09:22:11 +01:00
Pedro Igor
f107f0596e Rename h2-file and h2-mem and removing defaults from production databases
Closes #9973
2022-02-04 15:43:51 -03:00
Stian Thorgersen
b2fd379a2a
Unify guide titles and update pinned-guides (#10007) 2022-02-04 16:02:22 +01:00
Dominik Guhr
e7abfef3e7
Production readiness guide V1 (#10000)
* Production readiness guide V1

Closes #9463
2022-02-04 15:19:10 +01:00
AndyMunro
4e2e81df23 Addressing Stian's comments
Changing references to kc.start

Closes 9925
2022-02-04 14:05:48 +01:00
AndyMunro
eedf1ef6cb 9925 Review of the hostname topic 2022-02-04 14:05:48 +01:00
AndyMunro
d8c5f9e2fc Edits to the reverse proxy
Suggested deny and allow instead of black/white listed

Closes #9982
2022-02-04 14:05:00 +01:00
Dominik Guhr
9cb0cc8f8a
Configure Caching Guide V1 (#9903)
* Configure Caching Guide V1

Closes #9459
2022-02-03 13:42:46 +01:00
andymunro
c5e95b1dba
9954 Review vault topic (#9955) 2022-02-03 09:55:07 +01:00
Pedro Igor
5daddea006
Configuration guide (#9478)
* Configuration guide

Closes #9452
2022-02-02 16:05:33 +01:00
Dominik Guhr
b24c7ecaae
Outgoing requests guide v1 (#9866)
* Outgoing requests guide v1

Closes #9773

* Apply suggestions from code review

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

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2022-02-02 13:58:25 +01:00
Pedro Igor
3967c81453
Review Configuring a Database guide (#9559)
Closes #9457

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

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2022-02-02 13:30:53 +01:00
andymunro
0301630480
9904 Editing the enable TLS guide (#9909) 2022-02-02 08:48:04 +01:00
andymunro
bd0fda8643
9921 fixing a typo. thanks, Dominik (#9924) 2022-02-02 08:46:14 +01:00
andymunro
4dd27e43d1
9847 Addressing comments from Dominik (#9883) 2022-02-02 08:43:35 +01:00
Stian Thorgersen
078984ace6
Add support for pinning guides to the top (#9913)
Closes #9912
2022-02-01 13:39:17 +01:00
Dominik Guhr
f70a22f583
Run from Container guide V1 (#9646)
Closes #9465

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

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2022-01-27 14:57:18 +01:00
Dominik Guhr
6395e89cfc
Vault Guide v1 (#9772)
* Vault Guide v1

Containing only Kubernetes / OpenShift  secrets via file based vault for now

Closes #9462

* Apply suggestions from code review

Co-authored-by: Andrea Peruffo <andrea.peruffo1982@gmail.com>

Co-authored-by: Andrea Peruffo <andrea.peruffo1982@gmail.com>
2022-01-27 11:18:50 +01:00
Dominik Guhr
47ad9a29eb
Hostname Guide V1 (#9762)
Closes #9460
2022-01-27 11:17:22 +01:00
Pedro Igor
7c162b42a6
Improve enabling/disabling features in Quarkus distribution (#9801)
Closes #9706
2022-01-27 11:11:46 +01:00
Dominik Guhr
0f082dde5b
fix relevant options for existing guides (#9805)
closes #9804
2022-01-27 10:03:11 +01:00
Dominik Guhr
80072b30cd Features guide
Co-authored-by: stianst <stianst@gmail.com>

Closes #9461
2022-01-26 12:50:41 -03:00
Dominik Guhr
af9d840ec1
Add section about recommended path exposures in reverse proxy (#9752)
Closes #9751
2022-01-26 09:02:25 +01:00
Stian Thorgersen
510c482572
Use tools icon instead of lock for build options on all-config guide (#9717) 2022-01-21 13:31:14 +01:00
Joaquim Fellmann
bdb7cf9b96 Quarkus relational database setup documentation error
Closes #9324
2022-01-20 14:57:55 -03:00
Stian Thorgersen
b8d3c12a08
Update layout for options in guides (#9658) 2022-01-20 14:21:23 +01:00
Stian Thorgersen
86e683bdb9
Remove output of summary in guides (#9615)
Closes #9614
2022-01-18 11:11:41 +01:00
Dominik Guhr
d451ae0ab7
Guide for enabling HTTPS/TLS (#9536)
Initial version of the guide for enabling TLS/HTTPS for Quarkus based Keycloak

Closes #9458
2022-01-18 10:51:43 +01:00
Stian Thorgersen
f80d336276
Add support to linking between guides (#9590)
Closes #9575
2022-01-17 16:41:29 +01:00
Dominik Guhr
99e7208f36
new title, summary and headlines for proxy guide (#9572)
Closes #9570
2022-01-17 12:45:06 +01:00
Stian Thorgersen
ecd5dd248d
Package server guides (#9568)
Closes #9567
2022-01-14 13:39:22 +01:00
Dominik Guhr
1cebd79f1c Solves [#9206] - Initial version for proxy documentation 2022-01-05 13:18:33 -08:00
keycloak-bot
9f3d4a7d42 Set version to 17.0.0-SNAPSHOT 2021-12-20 10:50:39 +01:00
stianst
c7134fd539 Initial toolchain for Quarkus distribution documentation
Closes #9054
2021-12-10 02:34:03 -08:00