Fix links

This commit is contained in:
Stian Thorgersen 2017-02-15 08:41:26 +01:00
parent 22f77dc16b
commit d5b07e1498
10 changed files with 19 additions and 62 deletions

View file

@ -1,44 +0,0 @@
{
"gitbook": "2.x.x",
"structure": {
"readme": "README.adoc"
},
"plugins": [
"toggle-chapters",
"ungrey",
"splitter"
],
"variables": {
"title": "Authorization Services Guide",
"community": true,
"product": false,
"images": "keycloak-images",
"appServer": "WildFly 10",
"quickstartRepo": "https://github.com/redhat-developer/redhat-sso-quickstarts",
"project": {
"name": "Keycloak",
"version": "SNAPSHOT",
"module": "Authorization Services",
"doc_base_url": "https://keycloak.gitbooks.io/",
"doc_info_version_url": ""
},
"external_link": {
"keycloakjsadapter": {
"name": "JavaScript OpenID Connect Adapter",
"link": "/securing-client-applications-guide/content/topics/oidc/javascript-adapter.html"
},
"keycloakgettingstarted": {
"name": "Getting Started",
"link": "/getting-started-tutorials/content/"
},
"keycloakinstallingandboot": {
"name": "Installing and Boot",
"link": "/getting-started-tutorials/content/topics/first-boot.html"
},
"keycloakinstallclientadapter": {
"name": "Installing the Client Adapter",
"link": "/getting-started-tutorials/content/topics/secure-jboss-app/install-client-adapter.html"
}
}
}
}

View file

@ -2,7 +2,7 @@
==== JavaScript Integration
The {{book.project.name}} Server comes with a JavaScript library you can use to interact with a resource server protected by a policy enforcer.
This library is based on the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.external_link.keycloakjsadapter.link}}[{{book.project.name}} {{book.external_link.keycloakjsadapter.name}}], which can be integrated to allow your client to obtain permissions from a {{book.project.name}} Server.
This library is based on the {{book.project.name}} JavaScript adapter, which can be integrated to allow your client to obtain permissions from a {{book.project.name}} Server.
You can obtain this library from a running a {{book.project.name}} Server instance by including the following `script` tag in your web page:

View file

@ -2,7 +2,7 @@
== Getting Started
Before you can participate in this tutorial, you need to complete the installation of {{book.project.name}} and create the
initial admin user as shown in the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.external_link.keycloakinstallingandboot.link}}[{{book.external_link.keycloakinstallingandboot.name}}] tutorial.
initial admin user as shown in the link:{{book.gettingstarted.link}}[{{book.gettingstarted.name}}] tutorial.
There is one caveat to this. You have to run a separate {{book.appServer}} instance on the same machine as the
{{book.project.name}} server. This separate instance will run your Java Servlet application. Because of this you will
have to run the {{book.project.name}} under a different port so that there are no port conflicts when running on the
@ -23,7 +23,7 @@ $ ${KEYCLOAK_SERVER_DIR}/bin/standalone.sh -Djboss.socket.binding.port-offset=10
> ${KEYCLOAK_SERVER_DIR}\bin\standalone.bat -Djboss.socket.binding.port-offset=100
----
For more details about how to install and configure a {{book.appServer}}, please follow the steps on the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.external_link.keycloakinstallclientadapter.link}}[{{book.external_link.keycloakinstallclientadapter.name}}] tutorial.
For more details about how to install and configure a {{book.appServer}}, please follow the steps on the link:{{book.adapterguide.link}}[{{book.adapterguide.name}}] tutorial.
After installing and booting both servers you should be able to access {{book.project.name}} Admin Console at http://localhost:8180/auth/admin/ and also the {{book.appServer}} instance at
http://localhost:8080.

View file

@ -42,6 +42,10 @@
"name": "Securing Applications and Services Guide",
"link": "https://keycloak.gitbooks.io/securing-client-applications-guide/content/"
},
"gettingstarted": {
"name": "Getting Started Tutorial",
"link": "https://keycloak.gitbooks.io/securing-client-applications-guide/content/"
},
"apidocs": {
"name": "API Documentation",
"link": "http://keycloak.org/docs"

View file

@ -17,10 +17,7 @@
"community": true,
"product": false,
"images": "keycloak-images",
"adminguide": {
"name": "Server Administration Guide",
"link": "https://keycloak.gitbooks.io/server-adminstration-guide/content/"
},
"clientguide": {
"name": "Securing Applications and Services Guide",
"link": "https://keycloak.gitbooks.io/securing-client-applications-guide/content/"

View file

@ -3,12 +3,12 @@
{{book.project.name}} comes with a fully functional Admin REST API with all features provided by the Admin Console.
To invoke the API you need to obtain an access token with the appropriate permissions. The required permissions are described in
{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.adminguide.link}}[{{book.adminguide.name}}].
{{book.adminguide.link}}[{{book.adminguide.name}}].
A token can be obtained by enabling authenticating to your application with {{book.project.name}}; see the
{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.clientguide.link}}[{{book.clientguide.name}}]. You can also use direct access grant to obtain an access token.
{{book.adapterguide.link}}[{{book.adapterguide.name}}]. You can also use direct access grant to obtain an access token.
For complete documentation see {{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.apidocs.link}}[{{book.apidocs.name}}].
For complete documentation see {{book.apidocs.link}}[{{book.apidocs.name}}].
=== Example using CURL
@ -60,5 +60,5 @@ Keycloak keycloak = Keycloak.getInstance(
RealmRepresentation realm = keycloak.realm("master").toRepresentation();
----
Complete Javadoc for the admin client is available at {{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.apidocs.link}}[{{book.apidocs.name}}].
Complete Javadoc for the admin client is available at {{book.apidocs.link}}[{{book.apidocs.name}}].
{% endif %}

View file

@ -755,7 +755,7 @@ In other words, add your custom authenticator after the "Send Reset Email" authe
First Broker Login flow is used during first login with some identity provider.
Term `First Login` means that there is not yet existing {{book.project.name}} account linked with the particular authenticated identity provider account.
For more details about this flow see the `Identity Brokering` chapter in link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.adminguide.link}}[{{book.adminguide.name}}] .
For more details about this flow see the `Identity Brokering` chapter in link:{{book.adminguide.link}}[{{book.adminguide.name}}] .
[[_client_authentication]]
=== Authentication of clients
@ -766,7 +766,7 @@ to the {{book.project.name}} server (like the request for exchange code to acces
But the client authentication can be also used directly by you during `Direct Access grants` (represented by OAuth2 `Resource Owner Password Credentials Flow`)
or during `Service account` authentication (represented by OAuth2 `Client Credentials Flow`).
For more details about {{book.project.name}} adapter and OAuth2 flows see link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.clientguide.link}}[{{book.clientguide.name}}].
For more details about {{book.project.name}} adapter and OAuth2 flows see link:{{book.adapterguide.link}}[{{book.adapterguide.name}}].
==== Default implementations

View file

@ -88,7 +88,7 @@ org.acme.provider.MyEventListenerProviderFactory
----
You can configure your provider through `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
See the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}] for more details on
See the link:{{book.installguide.link}}[{{book.installguide.name}}] for more details on
where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file lives.
For example by adding the following to `standalone.xml`:

View file

@ -25,7 +25,7 @@ NOTE: To set the theme for the `master` admin console you need to set the admin
refresh the page.
To change the welcome theme you need to edit `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}].
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.installguide.link}}[{{book.installguide.name}}].
Add `welcomeTheme` to the theme element, for example:
@ -208,7 +208,7 @@ of the realm.
==== Internationalization
{{book.project.name}} supports internationalization. To enable internationalization for a realm see {{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.adminguide.link}}[{{book.adminguide.name}}]. This
{{book.project.name}} supports internationalization. To enable internationalization for a realm see {{book.adminguide.link}}[{{book.adminguide.name}}]. This
section describes how you can add your own language.
To add a new language create the file `<THEME TYPE>/messages/messages_<LOCALE>` in the directory of your theme. Then add it to the `locales` property in
@ -355,7 +355,7 @@ To manually create the module create the directory `modules/org/keycloak/example
----
You also need to register the module with {{book.project.name}}. This is done by editing `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}].
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.installguide.link}}[{{book.installguide.name}}].
Then find the `theme` tag under `keycloak-server` subsystem and add the module to `theme/modules/module`. For example:

View file

@ -248,7 +248,7 @@ We then load the `properties` field with the username and password combinations
The `Config.Scope` parameter is factory configuration that can be set up
within `standalone.xml`, `standalone-ha.xml`, or `domain.xml`.
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.project.doc_base_url}}{{book.project.doc_info_version_url}}{{book.installguide.link}}[{{book.installguide.name}}].
For more information on where the `standalone.xml`, `standalone-ha.xml`, or `domain.xml` file resides see the link:{{book.installguide.link}}[{{book.installguide.name}}].
For example, by adding the following to `standalone.xml`: