Commit graph

370 commits

Author SHA1 Message Date
Wojciech Trocki
96bab33db1
fix: add information about npm packagage (#1189)
I recieved feedback from customer/users that keycloak client side is widely undocumented, which was surprising.
After checking I found out that in fact for users that use npm there is no documentation provided:

https://www.npmjs.com/package/keycloak-js

This is very rare to see in NPM for package that have such large number of downloads. 
Additionally official docs doesn't mention NPM at all and recommend using js package from server (which is not be best advice if you do CDN's etc.).
Additionally some old bower repo is still 3th result in google and since it has some docs people using it:
https://github.com/keycloak/keycloak-js-bower - worth to remove this as well. 
Added simple note in the docs so hopefully google will position this documentation
2021-11-10 09:52:54 +01:00
Paul Podgorsek
e72e9ed1a1
Corrected spelling mistakes (#1224) 2021-11-10 09:48:46 +01:00
M. Mostafa Farzan
3d7bf376c3
Clarify docker registry config docs (#1226)
* Clarify docker registry config docs

The docs where actually clear, but this additional explanation could save users some time, as some new folks may not know the fact that realm public key is different from the actual SSL key used for HTTP connections.

* Update docker-overview.adoc

Co-authored-by: Stian Thorgersen <stian@redhat.com>
2021-11-10 09:47:59 +01:00
dmprocha
a62dfc5b07
Update spring-security-adapter.adoc (#1231)
Add missing word
2021-11-10 09:46:47 +01:00
Luigi Bertaco Cristofolini
6ec35d7dd0
Add example for UPDATE_PASSWORD login action (#1243) 2021-11-10 09:45:56 +01:00
Simon Legner
c6d5af8675
java-adapter-config: fix JSON indentation (#1245)
Co-authored-by: Stian Thorgersen <stianst@gmail.com>
2021-11-10 09:45:32 +01:00
Stu Tomlinson
47045aedcc
Minor JavaScript Adapter Reference wording cleanup (#1154) 2021-11-10 09:41:47 +01:00
Tjeu Kayim
eda1b497c4
Translate German/Dutch "geheim" to "secret" (#1139) 2021-11-10 09:12:12 +01:00
Mikail
836c8afe72
Fix typos (#1119) 2021-11-10 09:03:05 +01:00
Jonathan Vila
b6dba27c1e KEYCLOAK-19144 [PR] fixing broken links 2021-11-08 15:00:24 +01:00
mposolda
57cc4a6353 KEYCLOAK-19438 Invalid link in the docs for the OpenBanking Brasil 2021-10-04 11:53:08 +02:00
AndyMunro
e15ebe8306 admin-reuse -- Found one more Data Grid link to fix based on a separate PR. 2021-09-21 08:58:46 +02:00
Andy Munro
26087f0ece Correcting capitalization 2021-09-21 08:58:46 +02:00
Andy Munro
d11312c618 correction to themes 2021-09-21 08:58:46 +02:00
Peter Skopek
b26a91c7a2 KEYCLOAK-16522 fix test issues (external links and anchor) (#44) 2021-09-21 08:58:46 +02:00
mposolda
7f36ef3272 KEYCLOAK-19233 Inaccurate documentation about Device Grant regarding client type 2021-09-07 11:39:18 +02:00
Yang Xie
080c682769 KEYCLOAK-17693 add config for loading custom IdMapper class 2021-08-03 17:45:04 +02:00
mposolda
34fcfb80a8 KEYCLOAK-18883 KEYCLOAK-18864 FAPI CIBA and OpenBanking Brasil updates 2021-07-29 23:41:06 +02:00
Martin Bartoš
104c85d46b KEYCLOAK-18466 Configure HTTP client timeouts for adapters 2021-07-22 10:54:52 +02:00
Michal Hajas
8436c1866b KEYCLOAK-16455 Update JS adapter init method reference with messageReceiveTimeout 2021-06-23 09:00:34 +02:00
mposolda
d312541cfa KEYCLOAK-18484 Documentation note about FAPI TLS considerations 2021-06-17 17:07:00 +02:00
mposolda
817eb73093 KEYCLOAK-17940 Client policies documentation
Co-authored-by: Václav Muzikář <vaclav@muzikari.cz>
2021-06-09 08:47:47 +02:00
stianst
74abc79c48 Remove link to Undertow.io 2021-06-07 12:31:34 +02:00
Hynek Mlnarik
b572fcff07 KEYCLOAK-18301 Fix broken links 2021-05-31 08:59:58 +02:00
Yoshiyuki Tabata
fde7cdeb70 KEYCLOAK-17491 Move the key settings to the new Keys tab 2021-05-27 15:27:18 +02:00
Björn Schmidtke
76644bb065 KEYCLOAK-16072 add mising Advanced Login Configuration documentation 2021-05-03 13:14:18 -03:00
Takashi Norimatsu
f571e01fd0 revise sentences 2021-04-29 15:59:35 +02:00
Takashi Norimatsu
f62cec55f7 KEYCLOAK-12137 OpenID Connect Client Initiated Backchannel Authentication (CIBA) 2021-04-29 15:59:35 +02:00
Manuel Rauber
c8109152a9 KEYCLOAK-17684: fix definition of createAccountUrl parameter 2021-04-28 09:02:01 +02:00
niko-vulic
af4cda7d9b Update sp_role_mappings_provider_element.adoc
Additional information on spaces in role mappings and unicode replacements
2021-04-28 08:55:05 +02:00
Michito Okai
68dcd06748 KEYCLOAK-7675 Support for Device Authorization Grant 2021-03-15 14:45:05 +01:00
R Kaja Mohideen
cdc50fb328 KEYCLOAK-15906 2021-03-11 16:25:37 +01:00
Andy Munro
e18ea48b26 KEYCLOAK-16929 Adding conscious language preface of the release notes 2021-03-02 09:34:57 +01:00
stianst
35a1faf0a6 Fix links 2021-02-17 10:02:55 +01:00
stianst
6e396a7229 Fix some links 2021-02-17 10:02:55 +01:00
Nurbek
00273fb95d Update nodejs-adapter.adoc
example of response_mode 'permissions' uses token as value
2021-02-17 09:14:13 +01:00
brunomedeirosdedalus
7aea6a2023 Update token-exchange.adoc
Changing the German/Dutch name of "geheim" to "the client secret"
2021-02-17 09:11:52 +01:00
MANAS PATNAIK
308f643377 Update client-registration-cli.adoc
Fixed Spelling issues.
2021-02-17 09:06:08 +01:00
Bruno Oliveira da Silva
6680ace8fb [KEYCLOAK-16550] Remove Gatekeeper from the docs 2021-02-17 09:03:06 +01:00
Bodo Graumann
61ceb5fc0c Minor grammatical fix 2021-02-17 08:58:44 +01:00
Stefan Guilhen
9a21c9cb05 [KEYCLOAK-16788] Fix broken links 2021-01-15 10:47:01 +01:00
Johannes Waigel
f51560fb90 fix typo
remove invalid code
2021-01-13 11:45:58 +01:00
mhajas
5675da5ac3 KEYCLOAK-14103 Document setting of SameSite to None for Wildfly/EAP and Tomcat 2020-12-14 15:00:15 +01:00
mposolda
af454cbd94 KEYCLOAK-9551 Client Credentials Grant should not generate refresh token 2020-11-06 09:16:36 +01:00
Niko Köbler
f9e5d78a56 KEYCLOAK-15158 adjust basic example of Keycloak JS adapter usage
As the JS adapter has evolved, it now tries to add an iframe element to the document body during initialization.
When used like in the basic example as before, there will be an JS error, as the document body is not yet available.
So we've to wait until the document is loaded, thus the initialization is put in a function and the function will be called upon body.onload()
2020-10-29 09:53:55 +01:00
Stian Thorgersen
39ad765fc9 Update javascript-adapter.adoc 2020-09-17 23:10:46 -07:00
Michael Furman
6b9a5f2854 Update spring-security-adapter.adoc 2020-09-09 11:19:57 +02:00
Michael Furman
cdbdac6c36 Fixing KEYCLOAK-14642
Fixing documentation to resolve KEYCLOAK-14642
2020-09-09 11:19:57 +02:00
Alex Szczuczko
106669cd45 KEYCLOAK-15428 Fix two broken links causing test failures
http://browsercookielimits.squawky.net no longer exists, and I can't find an
equivilent of what it did, so I've removed it.

https://wildfly.org needed a slash on the end and a www up front, to prevent a redirect.

That should resolve the test failures currently causing all PRs to be flagged.
2020-09-02 14:25:07 -03:00
Alex Szczuczko
4bd21354cc KEYCLOAK-15079 Resolve two test failures
This PR resolves these test failures, currently on master:

```
Tests run: 5, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 38.833 sec <<< FAILURE!
checkExternalLinks(org.keycloak.documentation.test.SecuringAppsTest)  Time elapsed: 38.723 sec  <<< FAILURE!
* http://undertow.io/ (invalid redirect to https://undertow.io/)

Tests run: 5, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.999 sec <<< FAILURE!
checkVariables(org.keycloak.documentation.test.GettingStartedTest)  Time elapsed: 0.004 sec  <<< FAILURE!
* context

Running org.keycloak.documentation.test.ServerInstallationTest
```

And these product test failures:

```
Running org.keycloak.documentation.test.GettingStartedTest
Tests run: 5, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.79 sec <<< FAILURE!
checkExternalLinks(org.keycloak.documentation.test.GettingStartedTest)  Time elapsed: 0.767 sec  <<< FAILURE!
* http://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.4.1/ (invalid redirect to https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.4.1/)

Running org.keycloak.documentation.test.OpenShiftTest
Tests run: 5, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 8.502 sec <<< FAILURE!
checkExternalLinks(org.keycloak.documentation.test.OpenShiftTest)  Time elapsed: 8.404 sec  <<< FAILURE!
* https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.4.1/html-single/red_hat_single_sign-on_for_openshift_on_openj9/ (invalid status code 404)
```
2020-08-18 10:48:29 -03:00
Alex Szczuczko
c3830b1f64 KEYCLOAK-14862 Fix redirect links previously shadowed by a test bug 2020-08-05 10:57:16 -03:00
MANAS PATNAIK
bcea5ebfbb Update oidc-generic.adoc 2020-07-24 11:36:25 -03:00
Ebram Shehata
482479cc18 Update token-exchange.adoc 2020-07-24 11:35:41 -03:00
JQ Zhu
2423febf03 Update spring-security-adapter.adoc
Fix typo
2020-07-23 10:36:14 -03:00
Evan Shortiss
0950d0d15f add proxy configuration section to node.js adapter docs
- fix: correct express to uppercase
2020-07-02 16:24:17 -03:00
Daniel Munzinger
4ca1fecdaf KEYCLOAK-13289 Added redirect_url to Node.js logout 2020-07-02 16:16:12 -03:00
Jon Koops
1652f55997 KEYCLOAK-14496 Document the ability to pass custom adapters into the JavaScript client 2020-07-01 19:27:02 -03:00
mhajas
8659b670ab KEYCLOAK-14105 Document setting SameSite to None for mod_auth_mellon 2020-07-01 18:52:12 -03:00
erwin314
6c98e97abf include tomcat 9 in heading 2020-07-01 18:47:27 -03:00
vmuzikar
f977559a16 KEYCLOAK-14104 Update documentation about silent check-sso to reflect 3rd party cookie blocking 2020-06-30 17:14:16 -03:00
Jared Jennings
91aaed6370 Update token-exchange.adoc
Token Exchange is no longer a draft, but an accepted RFC. Updated link to RFC.
2020-05-19 13:19:24 +02:00
Yoshiyuki Tabata
d3e18744a8 KEYCLOAK-5325 Provide OAuth token revocation capability 2020-04-28 15:26:37 +02:00
Martin Kanis
ee6c7910c6 KEYCLOAK-13727 Incorrect steps for rpms installation 2020-04-06 16:15:27 +02:00
stianst
ee167f8f81 Fix links 2020-03-26 08:41:55 +01:00
Pedro Igor
047ab96c83 [KEYCLOAK-11272] - Adding information about enabling fine-grained admin permissions when using token exchange 2020-03-24 06:09:43 +01:00
Neon Ngo
16f57eb0d9 Update server version to 4.6.0 in known issue
* per author of KEYCLOAK-8954, Keycloak server 4.6.0 was when problem occurred.
* FYI: Keycloak gatekeeper 2.3.0 does work Keycloak server 8.0.1 without the workaround
2020-03-16 14:45:18 -03:00
Thomas Delrue
aa41426f00 Update multi-tenancy.adoc
small typo
2020-03-16 15:52:33 +01:00
stianst
21d15f9502 KEYCLOAK-13226 Remove mention of Spring starter from docs 2020-03-06 08:33:46 +01:00
Yoshiyuki Tabata
3460119485 Fix the link of Apache Felix HTTP Service 2020-03-05 08:10:05 +01:00
stianst
3a2312f2c9 KEYCLOAK-9346 Docs for removal of JS promiseType 2020-03-04 08:53:31 +01:00
nxadm
1325660fab Fix typo 2020-03-03 10:16:28 +01:00
Stian Thorgersen
10264146df
Update installed-adapter.adoc 2020-02-21 14:09:34 +01:00
Greg. A
a14d34adcc highlighting some values for parameters 2020-02-14 10:02:39 +01:00
Simon Wirtz
296273bc2b Fix a minor typo 2020-02-14 09:36:14 +01:00
Yoshiyuki Tabata
1b6687c41f Fix duplicated words "add to". 2020-02-14 09:35:52 +01:00
mhajas
33d554c149 KEYCLOAK-12125 Update docs regarding SameSite changes 2020-01-31 13:05:28 +01:00
Takashi Norimatsu
678d80cbc8 KEYCLOAK-12615 HS384 and HS512 support for Client Authentication by Client Secret Signed JWT 2020-01-28 14:55:25 +01:00
Stian Thorgersen
051e84719f
Update supported-platforms.adoc (#816) 2020-01-07 14:03:51 +01:00
Stian Thorgersen
c9239cbfb6
Merge pull request #804 from keycloak/stianst-patch-3
Update idp_httpclient_subelement.adoc
2020-01-07 13:49:00 +01:00
Stian Thorgersen
8768ed5568 Update java-adapter-config.adoc 2020-01-07 13:48:53 +01:00
Madhurjya Roy
565afce358 Update docker-overview.adoc
Fix a typo where "public" was written as "pulic" in two places in docker-overview.adoc.
2020-01-07 08:34:19 +01:00
Etienne
39f846aecb Update javascript-adapter.adoc
The `pkceMethod` option has to be configured in the `init` method and not the `constructor` (see https://github.com/keycloak/keycloak/blob/master/adapters/oidc/js/src/main/resources/keycloak.js#L160)
2020-01-07 08:31:51 +01:00
stianst
78c71b782c KEYCLOAK-12582 Fixes for product 2019-12-20 09:44:35 +01:00
Hynek Mlnarik
9194cbe2c4 KEYCLOAK-12535 Fix broken links 2019-12-20 08:09:48 +01:00
John Muczynski
f6cc26ab76 KEYCLOAK-11732 gatekeeper documentation, in example config files clarify the values for listen: 2019-11-06 07:17:02 -03:00
stianst
e301da8c63 Add warning to always-refresh-token option 2019-10-31 15:25:33 +01:00
JannesD
f3b2913ad3 🎨 fixed inconsinstent example code indentations (#749)
Some of the code examples used 2 spaces, and some were wrongly indented. This PR fixes the inconsistent JavaScript indentation to 4 spaces, and ensures that opening and closing brackets/braces are placed on the same indentation
2019-10-31 12:43:43 +01:00
Dirk Heuvels
5fa457b77b Removed unintended external link 2019-10-31 11:47:04 +01:00
Dirk Heuvels
0d3af71d67 Amendment for common Tomcat/SAML pitfall
As already proposed in https://lists.jboss.org/pipermail/keycloak-user/2018-May/013984.html
2019-10-31 11:47:04 +01:00
lrozenblyum
d472efb1b5 KEYCLOAK-10266 2019-10-30 15:48:06 +01:00
k-tamura
c8028638c8 Fix typos in V7.0 document 2019-10-30 15:37:05 +01:00
Jon Koops
cd7309ddaf [KEYCLOAK-11436] Update JavaScript adapter documentation to prefer native promises 2019-10-30 15:36:27 +01:00
Rob Winch
77d4447d18 Improve JS Adapter Documentation Admin Labels
The documentation currently does not use the same wording as the administrative UI. This makes finding the
correct setting more difficult. Additionally, the documentation does not surround the field names in tick
marks as it does in other places. This makes it less obvious what configuration needs to be done.

This commit adjusts the wording to match the administrative UI. It also ensures the field names are enclosed in tick marks.
2019-10-30 15:34:03 +01:00
Philip Colmer
200a606905 Fix reference to protected resource
Documentation said /protected. Apache config said /private. Changed the documentation to match config.
2019-10-30 15:28:46 +01:00
Thomas Küstermann
cef9a6f009 Fix typo and name Spring Initializr
Link to start.spring.io is using official "Spring Initializr" as link text now.
2019-10-24 08:56:01 +02:00
Jon Koops
ac2ee48ff6 [KEYCLOAK-11193] Add new enableLogging option to JS adapter 2019-09-24 10:31:36 -03:00
rmartinc
e255e8cf64 KEYCLOAK-10757: Replaying assertion with signature in SAML adapters 2019-09-18 16:48:49 +02:00
Jon Koops
d4403d3e5e KEYCLOAK-11196 Document the useNonce option for JS adapter 2019-09-18 11:29:19 +02:00
Tyler VanZanten
b56ca905cd Fix typos 2019-09-12 12:08:27 +02:00
Alex Buechele
6c48b98f2c typo correction, loose vs lose 2019-09-12 12:07:20 +02:00