Added docs section about tested databases

This commit is contained in:
mposolda 2014-02-19 16:16:15 +01:00
parent 9c5cd352cc
commit 864362f8a2

View file

@ -187,6 +187,65 @@ keycloak-war-dist-all-1.0-alpha-1/
<literal>.../standalone/deployments/auth-server.war/WEB-INF/classes/META-INF/persistence.xml</literal>.
Please see the <ulink url="http://hibernate.org/orm/documentation/">Hibernate and JPA documentation</ulink> for more information on tweaking the backend datamodel.
</para>
<section>
<title>Tested databases</title>
<para>
Here is list of RDBMS databases and corresponding JDBC drivers, which were tested with Keycloak. Note that Hibernate dialect
is usually set automatically according to your database, but in some cases, you must manually set the proper dialect,
as the default dialect may not work correctly. You can setup dialect either by adding property <literal>hibernate.dialect</literal>
to the <literal>persistence.xml</literal> file mentioned above or simply by adding system property <literal>hibernate.dialect</literal>
with corresponding value. For example, if you are using MS-SQL you can start keycloak with command:
<programlisting><![CDATA[
./standalone.sh -Dhibernate.dialect=org.hibernate.dialect.SQLServer2008Dialect
]]>
</programlisting>
This command will set system property <literal>hibernate.dialect</literal> to value <literal>org.hibernate.dialect.SQLServer2008Dialect</literal>
and this one will take precedence over the value from <literal>persistence.xml</literal> file.
<table frame='all'><title>Tested databases</title>
<tgroup cols='3' align='left' colsep='1' rowsep='1'>
<thead>
<row>
<entry>Database</entry>
<entry>JDBC driver</entry>
<entry>Hibernate Dialect</entry>
</row>
</thead>
<tbody>
<row>
<entry>H2 1.3.161</entry>
<entry>H2 1.3.161</entry>
<entry>auto</entry>
</row>
<row>
<entry>MySQL 5.5</entry>
<entry>MySQL Connector/J 5.1.25</entry>
<entry>auto</entry>
</row>
<row>
<entry>PostgreSQL 9.2</entry>
<entry>JDBC4 Postgresql Driver, Version 9.3-1100</entry>
<entry>auto</entry>
</row>
<row>
<entry>Oracle 11g R1</entry>
<entry>Oracle JDBC Driver v11.1.0.7</entry>
<entry>auto</entry>
</row>
<row>
<entry>Microsoft SQL Server 2012</entry>
<entry>Microsoft SQL Server JDBC Driver 4.0.2206.100</entry>
<entry>org.hibernate.dialect.SQLServer2008Dialect</entry>
</row>
<row>
<entry>Sybase ASE 15.7</entry>
<entry>JDBC(TM)/7.07 ESD #5 (Build 26792)/P/EBF20686</entry>
<entry>auto</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
</section>
<section>
<title>SSL/HTTPS Setup</title>