Fixes for product
This commit is contained in:
Stian Thorgersen
parent
0389fc7be7
commit
08c28b05fd
11 changed files with 116 additions and 55 deletions
|
|
@ -1,10 +1,9 @@
|
|||
|
||||
{{book.project.name}} Server Installation and Configuration Guide
|
||||
======================
|
||||
= Server Installation and Configuration Guide
|
||||
|
||||
image:images/keycloak_logo.png[alt="Keycloak"]
|
||||
|
||||
*{{book.project.name}}* _Documentation_ for {{book.project.version}}
|
||||
{{book.project.name}} {{book.project.version}}
|
||||
|
||||
http://www.keycloak.org
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@
|
|||
.. link:topics/clustering/multicast.adoc[Multicast Network Setup]
|
||||
.. link:topics/clustering/serialized.adoc[Serialized Cluster Startup]
|
||||
.. link:topics/clustering/booting.adoc[Booting the Cluster]
|
||||
.. link:topics/clustering/troubleshooting.adoc[Trouble Shooting]
|
||||
.. link:topics/clustering/troubleshooting.adoc[Troubleshooting]
|
||||
. link:topics/cache.adoc[Server Cache Configuration]
|
||||
.. link:topics/cache/eviction.adoc[Eviction Policy and Max Entries]
|
||||
.. link:topics/cache/replication.adoc[Replication and Failover]
|
||||
|
|
|
|||
65
book-product.json
Executable file
65
book-product.json
Executable file
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"gitbook": "2.x.x",
|
||||
"structure": {
|
||||
"readme": "README.adoc"
|
||||
},
|
||||
"plugins": [
|
||||
"toggle-chapters",
|
||||
"ungrey",
|
||||
"splitter"
|
||||
],
|
||||
"variables": {
|
||||
"title": "Server Installation and Configuration Guide",
|
||||
"project": {
|
||||
"name": "Red Hat Single Sign-On",
|
||||
"version": "7.0.0"
|
||||
},
|
||||
"community": false,
|
||||
"product": true,
|
||||
"images": "rhsso-images",
|
||||
"appserver": {
|
||||
"name": "JBoss EAP",
|
||||
"version": "7",
|
||||
"admindoc": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/configuration-guide"
|
||||
},
|
||||
"datasource": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-13-datasource-management"
|
||||
},
|
||||
"network": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-4-network-and-port-configuration"
|
||||
},
|
||||
"socket": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-4-network-and-port-configuration"
|
||||
},
|
||||
"loadbalancer": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-21-configuring-high-availability"
|
||||
},
|
||||
"jgroups": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-21-configuring-high-availability#cluster_communication_jgroups"
|
||||
},
|
||||
"caching": {
|
||||
"name": "JBoss EAP Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/configuration-guide/chapter-21-configuring-high-availability#infinispan"
|
||||
},
|
||||
"jpa": {
|
||||
"name": "JBoss EAP Development Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-jboss-enterprise-application-platform/7.0/development-guide/chapter-13-hibernate"
|
||||
}
|
||||
},
|
||||
"developerguide": {
|
||||
"name": "Server Developer Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.0.0/server-developer-guide/"
|
||||
},
|
||||
"adminguide": {
|
||||
"name": "Server Administration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en/red-hat-single-sign-on/7.0.0/server-administration-guide/"
|
||||
}
|
||||
}
|
||||
}
|
||||
57
book.json
57
book.json
|
|
@ -9,7 +9,11 @@
|
|||
"splitter"
|
||||
],
|
||||
"variables": {
|
||||
"title": "Keycloak Installation and Configuration Guide",
|
||||
"title": "Server Installation and Configuration Guide",
|
||||
"project": {
|
||||
"name": "Keycloak",
|
||||
"version": "1.9.7.Final"
|
||||
},
|
||||
"community": true,
|
||||
"product": false,
|
||||
"images": "keycloak-images",
|
||||
|
|
@ -17,60 +21,45 @@
|
|||
"name": "Wildfly",
|
||||
"version": "10",
|
||||
"admindoc": {
|
||||
"name": "JBoss EAP Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/"
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/Documentation"
|
||||
},
|
||||
"datasource": {
|
||||
"name": "JBoss EAP Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/chap-Datasource_Management.html"
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/DataSource+configuration"
|
||||
},
|
||||
"network": {
|
||||
"name": "JBoss EAP Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/chap-Network_and_Port_Configuration.html#Configure_interfaces"
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/Interfaces+and+ports"
|
||||
},
|
||||
"socket": {
|
||||
"name": "JBoss EAP Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-Socket_Binding_Groups.html"
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/Interfaces+and+ports"
|
||||
},
|
||||
"loadbalancer": {
|
||||
"name": "JBoss EAP Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-Web_HTTP_Connectors_and_HTTP_Clustering.html"
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/High+Availability+Guide"
|
||||
},
|
||||
"jgroups": {
|
||||
"name": "JBoss EAP Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-JGroups.html"
|
||||
}
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/JGroups+Subsystem"
|
||||
},
|
||||
"caching": {
|
||||
"name": "JBoss Data Grid",
|
||||
"version": "???",
|
||||
"admindoc": {
|
||||
"name": "JBoss Data Grid Administration and Configuration Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Data_Grid/6.6/html/Administration_and_Configuration_Guide/index.html",
|
||||
"eviction": "https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Data_Grid/7.0/html/Administration_and_Configuration_Guide/sect-Eviction_Strategies.html"
|
||||
}
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/Infinispan+Subsystem"
|
||||
},
|
||||
"jpa": {
|
||||
"name": "Hibernate",
|
||||
"version": "???",
|
||||
"admindoc": {
|
||||
"name": "JBoss Development Guide",
|
||||
"link": "https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Development_Guide/sect-Java_Persistence_API_JPA.html#sect-Configuration2"
|
||||
"name": "WildFly 10 Documentation",
|
||||
"link": "https://docs.jboss.org/author/display/WFLY10/JPA+Reference+Guide#JPAReferenceGuide-Hibernateproperties"
|
||||
}
|
||||
|
||||
},
|
||||
"developerguide": {
|
||||
"name": "Keycloak Server Developer Guide",
|
||||
"name": "Server Developer Guide",
|
||||
"link": "https://keycloak.gitbooks.io/server-developer-guide/content/"
|
||||
|
||||
},
|
||||
"adminguide": {
|
||||
"name": "Keycloak Adminstration Guide",
|
||||
"name": "Server Administration Guide",
|
||||
"link": "https://keycloak.gitbooks.io/server-adminstration-guide/content/"
|
||||
},
|
||||
"project": {
|
||||
"name": "Keycloak",
|
||||
"version": "1.9.3.Final-SNAPSHOT"
|
||||
}
|
||||
}
|
||||
}
|
||||
7
build.sh
Executable file
7
build.sh
Executable file
|
|
@ -0,0 +1,7 @@
|
|||
#!/bin/bash
|
||||
|
||||
cd $(readlink -f `dirname $0`)
|
||||
|
||||
python gitlab-conversion.py
|
||||
cd target
|
||||
asciidoctor master.adoc
|
||||
|
|
@ -42,6 +42,9 @@ if os.path.isdir('keycloak-images'):
|
|||
if os.path.isdir('rhsso-images'):
|
||||
shutil.copytree('rhsso-images',os.path.join(targetdir, 'rhsso-images'))
|
||||
|
||||
shutil.copyfile('metadata.ini', os.path.join(targetdir, 'metadata.ini'));
|
||||
shutil.copyfile('master-docinfo.xml', os.path.join(targetdir, 'master-docinfo.xml'));
|
||||
|
||||
tmp = os.path.join(targetdir, 'topics')
|
||||
if not os.path.exists(tmp):
|
||||
os.makedirs(tmp)
|
||||
|
|
@ -67,8 +70,8 @@ input = re.sub(r"[ ]*\.+\s*link:(.*)\[(.*)\]", "include::\g<1>[]", input)
|
|||
input = applyTransformation(input)
|
||||
output.write(input)
|
||||
|
||||
# parse book.json file and create document attributes
|
||||
with open('book.json') as data_file:
|
||||
# parse book-product.json file and create document attributes
|
||||
with open('book-product.json') as data_file:
|
||||
data = json.load(data_file)
|
||||
|
||||
variables = data['variables']
|
||||
|
|
|
|||
|
|
@ -14,6 +14,6 @@ but is possibly replicated across the cluster.
|
|||
|
||||
This chapter discusses some configuration options for these caches for both clustered a non-clustered deployments.
|
||||
|
||||
Note: More advanced configuration of these caches can be found in link:{{book.caching.admindoc.link}}[{{book.caching.admindoc.name}}]
|
||||
Note: More advanced configuration of these caches can be found in link:{{book.appserver.caching.link}}[{{book.appserver.caching.name}}]
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -48,6 +48,5 @@ globalStatsInterval::
|
|||
schema::
|
||||
Specify the database schema to use
|
||||
|
||||
NOTE: All these configuration switches and more are described in the link:{{book.jpa.admindoc.link}}[the Hibernate chapter]
|
||||
of {{book.jpa.admindoc.name}}.
|
||||
NOTE: All these configuration switches and more are described in the link:{{book.appserver.jpa.link}}[{{book.appserver.jpa.name}}].
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ and install it into the server.
|
|||
Modules define JARs that are loaded into the {{book.project.name}} classpath and the dependencies those JARs have on
|
||||
other modules. They are pretty simple to set up.
|
||||
|
||||
Within the _.../modules/system/layers/keycloak/_ directory of your
|
||||
Within the _.../modules/_ directory of your
|
||||
{{book.project.name}} distribution, you need to create a directory structure to hold your module definition. The convention is use the Java package name
|
||||
of the JDBC driver for the name of the directory structure. For PostgreSQL, create the directory _org/postgresql/main_. Copy your database
|
||||
driver JAR into this directory and create an empty _module.xml_ file within it too.
|
||||
|
|
|
|||
|
|
@ -17,8 +17,10 @@ _domain/_::
|
|||
_modules/_::
|
||||
These are all the Java libraries used by the server.
|
||||
|
||||
{% if book.community %}
|
||||
_providers/_::
|
||||
If you are writing extensions to keycloak, you can put your extensions here. See the link:{{book.developerguide.link}}[{{book.developerguide.name}}] for more information on this.
|
||||
{% endif %}
|
||||
|
||||
_standalone/_::
|
||||
This contains configuration files and working directory when running {{book.project.name}} in <<fake/../../operating-mode/standalone.adoc#_standalone-mode,standalone mode>>.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,8 @@
|
|||
|
||||
=== Recommended Additional External Documentation
|
||||
|
||||
{{book.project.name}} is built upon a derivative of the {{book.appserver.name}} Application Server and projects embedded
|
||||
within {{book.appserver.name}} like {{book.cache.name}} (for caching) and Hibernate (for persistence). This guide only
|
||||
goes over the basics for infrastructure-level configuration. It is highly recommended that you peruse the documentation
|
||||
for {{book.appserver.name}} and its sub projects. Here are some links to that documentation:
|
||||
{{book.project.name}} is built on top of the {{book.appserver.name}} application server and it's sub-projects like Infinispan (for caching) and Hibernate (for persistence).
|
||||
This guide only covers basics for infrastructure-level configuration. It is highly recommended that you peruse the documentation
|
||||
for {{book.appserver.name}} and its sub projects. Here is the link to the documentation:
|
||||
|
||||
* link:{{book.appserver.admindoc.link}}[{{book.appserver.admindoc.name}}]
|
||||
* link:{{book.caching.admindoc.link}}[{{book.caching.admindoc.name}}]
|
||||
* link:{{book.jpa.admindoc.link}}[Hibernate JPA Configuration]
|
||||
Loading…
Reference in a new issue