Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = Installation =
6
7 You have 2 options:
8
9 * Install PostgreSQL on your machine manually
10 * Use the official PostgreSQL docker image
11
12 == Manual Installation ==
13
14 Follow these instructions:
15
16 * Download and install [[PostgreSQL>>http://www.postgresql.org/]] (see [[Database support strategy>>dev:Community.DatabaseSupportStrategy]] for the supported versions).
17 * Download the appropriate [[Postgres JDBC 4.2 driver>>http://jdbc.postgresql.org/download.html]] and copy the JAR into your container's common lib directory or in the XWiki webapp (in ##WEB-INF/lib##)
18 * Start PostgreSQL
19 ** On Mac you could issue the following shell commands to start/stop PostgreSQL 9.1 (adapt to your version and to your setup):(((
20 {{code}}
21 sudo -u postgres /Library/PostgreSQL/9.1/bin/pg_ctl start -D /Library/PostgreSQL/9.1/data
22 sudo -u postgres /Library/PostgreSQL/9.1/bin/pg_ctl stop -D /Library/PostgreSQL/9.1/data
23 {{/code}}
24 )))
25 * Create the ##xwiki## user and the ##xwiki## database:(((
26 * Using the ##psql## tool:(((
27 In a shell, start the PostgreSQL interactive terminal: {{code}}psql -U <replace_with_your_admin_user_eg_postgres>{{/code}}
28
29 Create the ##xwiki## database:
30
31 {{code language="none"}}
32 CREATE DATABASE xwiki
33 WITH OWNER = <replace_with_your_admin_user_eg_postgres>
34 ENCODING = 'UNICODE'
35 TABLESPACE = pg_default;
36 {{/code}}
37
38 Verify that the ##xwiki## database is listed in the available databases: {{code}}\l{{/code}}
39
40 Connect to the ##xwiki## database: {{code}}\connect xwiki{{/code}}
41
42 Create a ##xwiki## user: {{code language="none"}}CREATE USER xwiki PASSWORD 'xwiki' VALID UNTIL 'infinity';{{/code}}
43
44 Verify that the ##xwiki## user is listed in the available users: {{code language="none"}}\du{{/code}}
45
46 Give all the permissions to the ##xwiki## user: {{code}}GRANT ALL ON SCHEMA public TO xwiki;{{/code}}
47 )))
48 * Using the ##createuser## and ##createdb## programs:(((
49 {{info}}
50 Make sure that the ##createuser## and ##createdb## programs are in your ##$PATH##. The example below also assumes that the ##postgres## user exists in your setup (this is the default on Linux).
51 {{/info}}
52
53 Create the ##xwiki## user: {{code}}createuser xwiki -S -D -R -P -Upostgres{{/code}}
54
55 Create the ##xwiki## database: {{code}}createdb xwiki -Eunicode -Oxwiki -Upostgres{{/code}}
56
57 Note that if you need to remove this DB at some point you can issue:{{code}}dropdb -Upostgres xwiki{{/code}}
58 )))
59 )))
60 * Tell XWiki to use this database. To do this, edit the ##WEB-INF/hibernate.cfg.xml## file where you have expanded the XWiki WAR file and uncomment the PostgreSQL part. Make sure to review the ##connection.url## property. For example a typical value would be:{{code}}<property name="connection.url">jdbc:postgresql://localhost:5432/xwiki</property>{{/code}}
61
62 == Using Docker ==
63
64 * Install Docker
65 * Run the following command (update to your needs):(((
66 {{code language="bash"}}
67 docker run --name pgtest -e POSTGRES_PASSWORD=xwiki -e POSTGRES_ROOT_PASSWORD=xwiki -e POSTGRES_USER=xwiki -e POSTGRES_DB=xwiki -e POSTGRES_INITDB_ARGS="--encoding=UTF8" -v postgres-data:/var/lib/postgresql/data -p 5432:5432 postgres:9.5
68 {{/code}}
69 )))
70 * Download the appropriate [[Postgres JDBC 4.2 driver>>http://jdbc.postgresql.org/download.html]]. You can also download it directly from the [[Maven Central Repository>>http://repo1.maven.org/maven2/postgresql/postgresql/]] and copy the JAR into your container's common lib directory or in the XWiki webapp (in ##WEB-INF/lib##)
71 * Tell XWiki to use this database. To do this, edit the ##WEB-INF/hibernate.cfg.xml## file where you have expanded the XWiki WAR file and uncomment the PostgreSQL part. Make sure to review the ##connection.url## property. For example a typical value would be:{{code}}<property name="connection.url">jdbc:postgresql://localhost:5432/xwiki</property>{{/code}}
72
73 = Multiwiki Status =
74
75 Prior to XWiki 4.5M1, multiwiki mode was not fully working on PostgreSQL. Since XWiki 4.5M1, we've made it work in ##schema## mode (i.e. a subwiki is represented as a Schema in the database). However it's not working in ##database## mode for the moment (i.e. a subwiki is represented as a Catalog in the database) because the PostGreSQL JDBC Driver doesn't support yet the ##setCatalog## method.
76
77 The mode used is controlled by a property in ##hibernate.cfg.xml##:
78
79 {{code}}
80 <property name="xwiki.virtual_mode">schema|database</property>
81 {{/code}}
82
83 = Performance Tuning =
84
85 In several cases, for example when rolling back a document to a previous version, your postgres log will show something similar:
86
87 {{code}}
88 2013-04-03 18:44:36 EEST LOG: checkpoints are occurring too frequently (22 seconds apart)
89 2013-04-03 18:44:36 EEST HINT: Consider increasing the configuration parameter "checkpoint_segments".
90 2013-04-03 18:46:05 EEST LOG: checkpoints are occurring too frequently (6 seconds apart)
91 2013-04-03 18:46:05 EEST HINT: Consider increasing the configuration parameter "checkpoint_segments".
92
93 {{/code}}
94
95 This can result in slow DB performance. If using a production environment, you must set the "checkpoint_segments" parameter from your PostgreSQL configuration.
96 More links related to this:
97
98 * http://wiki.postgresql.org/wiki/Tuning_Your_PostgreSQL_Server
99 * http://www.postgresql.org/docs/current/static/runtime-config-wal.html#RUNTIME-CONFIG-WAL-CHECKPOINTS
100
101 = Troubleshooting =
102
103 == Method org.postgresql.jdbc4.Jdbc4Connection.isValid(int) is not yet implemented ==
104
105 Versions of the Postgres JDBC driver older than 9.2 do not support that method. Try to update the ##postgresql-*.jar##
106
107 * if installed from debian package, try to update at least to the version from jessy
108 ** for example download from https://packages.debian.org/jessie/all/libpostgresql-jdbc-java/download
109 ** then use ##dpkg ~-~-install libpostgresql-jdbc-java_9.2-1002-1_all.deb## to install\\
110 * alternatively if you use tomcat8, try downgrading to tomcat7
111 * otherwise find the ##postgresql-*.jar## in your webapp and replace it by a newer version downloaded from https://jdbc.postgresql.org/download.html
112
113 Restart the server to apply the changes.
114
115 == Relation "hibernate_sequence" already exists ==
116
117 If you see this error in your postgres logs, you should know that it's normal and expected. Because of a [[bug in Hibernate>>https://github.com/xwiki/xwiki-platform/blob/1d8e1172757a75cda44398820505dacf384e0a56/xwiki-platform-core/xwiki-platform-oldcore/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java#L576-L576]] we need to create this sequence if it doesn't exist and it's [[hard to check that in a DB-independent way>>https://jira.xwiki.org/browse/XWIKI-14055]]. Thus we simply create the sequence and if it already exists you get this error at startup in your logs.

Get Connected