libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Merge pull request #4 from aasingh/master

Browse source 
Replaced Keycloak with {{book.project.name}}- with correction
This commit is contained in:
Bill Burke 2016-05-31 00:05:35 -04:00
commit 625d73731d
5 changed files with 27 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
topics/mongo.adoc
View file

@ -69,7 +69,7 @@ And at the end of the file add the snippet like this where you can configure det
All configuration options are optional.
Default values for host and port are localhost and 27017.
Default name of database is `keycloak` . You can also specify properties `user` and `password` if you want authenticate against your MongoDB.
If user and password are not specified, Keycloak will connect unauthenticated to your MongoDB.
If user and password are not specified, {{book.project.name}} will connect unauthenticated to your MongoDB.
Finally there is set of optional configuration options, which can be used to specify connection-pooling capabilities of Mongo client.
Supported int options are: `connectionsPerHost`, `threadsAllowedToBlockForConnectionMultiplier`, `maxWaitTime`, `connectTimeout` `socketTimeout`.
@ -80,7 +80,7 @@ See http://api.mongodb.org/java/2.11.4/com/mongodb/MongoClientOptions.html[Mongo
Alternatively, you can configure MongoDB using a MongoDB http://docs.mongodb.org/manual/reference/connection-string/[connection URI].
In this case, you define all information concerning the connection and authentication within the URI, as described in the MongoDB documentation.
Please note that the database specified within the URI is only used for authentication.
To change the database used by keycloak you have to set `db` property as before.
To change the database used by {{book.project.name}} you have to set `db` property as before.
Therefore, a configuration like the following
[source]
@ -93,8 +93,8 @@ Therefore, a configuration like the following
}
}
----
will authenticate the user against the authentication database, but store all keycloak related data in the keycloak database.
will authenticate the user against the authentication database, but store all {{book.project.name}} related data in the keycloak database.
=== MongoDB Replica Sets
In order to use a mongo replica set for Keycloak, one has to use URI based configuration, which supports the definition of replica sets out of the box: `mongodb://host1:27017,host2:27017,host3:27017/`.
In order to use a mongo replica set for {{book.project.name}}, one has to use URI based configuration, which supports the definition of replica sets out of the box: `mongodb://host1:27017,host2:27017,host3:27017/`.

2
topics/network/https.adoc
View file

@ -32,7 +32,7 @@ for the {{book.project.name}} server. This involves
===== Creating the Certificate and Java Keystore
In order to allow HTTPS connections, you need to obtain a self signed or third-party signed certificate and import it into a Java keystore before you can enable HTTPS in the web container you are deploying the Keycloak Server to.
In order to allow HTTPS connections, you need to obtain a self signed or third-party signed certificate and import it into a Java keystore before you can enable HTTPS in the web container you are deploying the {{book.project.name}} Server to.
====== Self Signed Certificate

26
topics/openshift.adoc
View file

@ -1,26 +1,26 @@
[[_openshift]]
== Running Keycloak Server on OpenShift
== Running {{book.project.name}} Server on OpenShift
Keycloak provides a OpenShift cartridge to make it easy to get it running on OpenShift.
{{book.project.name}} provides a OpenShift cartridge to make it easy to get it running on OpenShift.
If you don't already have an account or don't know how to create applications go to https://www.openshift.com/ first.
You can create the Keycloak instance either with the web tool or the command line tool, both approaches are described below.
You can create the {{book.project.name}} instance either with the web tool or the command line tool, both approaches are described below.
WARNING: It's important that immediately after creating a Keycloak instance you open the `Administration Console` and login to reset the password.
If this is not done anyone can easily gain admin rights to your Keycloak instance.
WARNING: It's important that immediately after creating a {{book.project.name}} instance you open the `Administration Console` and login to reset the password.
If this is not done anyone can easily gain admin rights to your {{book.project.name}} instance.
=== Create Keycloak instance with the web tool
=== Create {{book.project.name}} instance with the web tool
. Open https://openshift.redhat.com/app/console/applications and click on `Add Application`.
. Scroll down to the bottom of the page to find the `Code Anything` section.
. Insert `http://cartreflect-claytondev.rhcloud.com/github/keycloak/openshift-keycloak-cartridge` into the `URL to a cartridge definition` field and click on `Next`.
. Fill in the following form and click on `Create Application`.
. Click on `Continue to the application overview page`.
. Under the list of applications you should find your Keycloak instance and the status should be `Started`.
. Click on it to open the Keycloak servers homepage.
. Under the list of applications you should find your {{book.project.name}} instance and the status should be `Started`.
. Click on it to open the {{book.project.name}} servers homepage.
=== Create Keycloak instance with the command-line tool
=== Create {{book.project.name}} instance with the command-line tool
. Run the following command from a terminal:
@ -29,17 +29,17 @@ If this is not done anyone can easily gain admin rights to your Keycloak instanc
rhc app create <APPLICATION NAME> http://cartreflect-claytondev.rhcloud.com/github/keycloak/openshift-keycloak-cartridge
----
. Replace `<APPLICATION NAME>` with the name you want (for example keycloak).
. Replace `<APPLICATION NAME>` with the name you want (for example {{book.project.name}}).
Once the instance is created the rhc tool outputs details about it.
Open the returned `URL` in a browser to open the Keycloak servers homepage.
Open the returned `URL` in a browser to open the {{book.project.name}} servers homepage.
=== Next steps
The Keycloak servers homepage shows the Keycloak logo and `Welcome to Keycloak`.
The {{book.project.name}} servers homepage shows the {{book.project.name}} logo and `Welcome to {{book.project.name}}`.
There is also a link to the `Administration Console`.
Open that and log in using username `admin` and password `admin`.
On the first login you are required to change the password.
TIP: On OpenShift Keycloak has been configured to only accept requests over https.
TIP: On OpenShift {{book.project.name}} has been configured to only accept requests over https.
If you try to use http you will be redirected to https.

2
topics/overview.adoc
View file

@ -10,6 +10,6 @@ own embedded and local-only database. For
decisions and setup you must do prior to deploying the server.
One thing to particularly note is that {{book.project.name}} is derived from the {{book.appserver.name}} Application Server.
Many aspects of configuring a {{book.project.name}} revolve around {{book.appserver.name}} configuration elements. Often
Many aspects of configuring {{book.project.name}} revolve around {{book.appserver.name}} configuration elements. Often
this guide will direct you to documentation outside of the manual if you want to dive into more detail.

16
topics/proxy.adoc
View file

@ -1,14 +1,14 @@
[[_proxy]]
== Keycloak Security Proxy
== {{book.project.name}} Security Proxy
Keycloak has an HTTP(S) proxy that you can put in front of web applications and services where it is not possible to install the keycloak adapter.
{{book.project.name}} has an HTTP(S) proxy that you can put in front of web applications and services where it is not possible to install the {{book.project.name}} adapter.
You can set up URL filters so that certain URLs are secured either by browser login and/or bearer token authentication.
You can also define role constraints for URL patterns within your applications.
=== Proxy Install and Run
Download the keycloak proxy distribution from the Keycloak download pages and unzip it.
Download the {{book.project.name}} proxy distribution from the {{book.project.name}} download pages and unzip it.
[source]
----
@ -145,7 +145,7 @@ error-page::
adapter-config::
_REQUIRED._.
Same configuration as any other keycloak adapter.
Same configuration as any other {{book.project.name}} adapter.
See <<_adapter_config,Adapter Config>>
==== Constraint Config
@ -185,7 +185,7 @@ authenticate::
==== Header Names Config
Next under the list of applications you can override the defaults for the names of the header fields injected by the proxy (see Keycloak Identity Headers). This mapping is optional.
Next under the list of applications you can override the defaults for the names of the header fields injected by the proxy (see {{book.project.name}} Identity Headers). This mapping is optional.
keycloak-subject::
e.g.
@ -207,13 +207,13 @@ keycloak-access-token::
e.g.
MYAPP_ACCESS_TOKEN
=== Keycloak Identity Headers
=== {{book.project.name}} Identity Headers
When forwarding requests to the proxied server, Keycloak Proxy will set some additional headers with values from the OIDC identity token it received for authentication.
When forwarding requests to the proxied server, {{book.project.name}} Proxy will set some additional headers with values from the OIDC identity token it received for authentication.
KEYCLOAK_SUBJECT::
User id.
Corresponds to JWT `sub` and will be the user id Keycloak uses to store this user.
Corresponds to JWT `sub` and will be the user id {{book.project.name}} uses to store this user.
KEYCLOAK_USERNAME::
Username.