INSTALL

changeset 221
33d7833ca54c
child 254
55ca6cafc3dd
equal deleted inserted replaced
220:1f7e76a213dd 221:33d7833ca54c
1 Installing LightPIT
2 -------------------
3
4 1. Install a supported database server
5
6 Currently this is only Postgresql. See the Postgresql manual for installing a
7 database instance. On most systems it is sufficient to install the server via
8 the system package manager.
9
10 2. Execute the SQL scripts for creating the database
11
12 In the setup directory you find three SQL scripts to install the database.
13
14 * Modify psql_create_database.sql and choose appropriate usernames and
15 passwords. Then execute the script as database administrator.
16 * Log into the new database with the lightpit_dbo user and execute
17 psql_create_tables.sql and psql_default_data.sql.
18
19 3. Configure a data source in your application servlet or servlet container
20
21 You may use absolutely anything: Tomcat, TomEE, Glassfish, Payara, you name it.
22 Just make sure to configure a data source with the name jdbc/lightpit/app.
23 If you want another name, you can configure the JNDI resource in the
24 WEB-INF/web.xml and META-INF/context.xml files. It is highly recommended to use
25 the lightpit_app user which has less privileges to create the data source and
26 leave the lightpit_dbo user for the database operator.
27
28 4. Make sure JDBC driver and JSTL libraries are available
29
30 This step may be optional depending on the container you are using. Most
31 application servers already have JSTL libraries installed. More basic servlet
32 containers like Tomcat don't. In that case you have to put the libraries of the
33 javax.servlet:jstl:1.2 artifact manually into the library dir of your servlet
34 container (jstl-1.2.jar and jstl-impl-1.2.jar).
35
36 In most cases you also have to put the postgresql JDBC driver into the library
37 directory of your server (e.g. postgres-42.x.x.jar).
38
39 5. Deploy the WAR file of lightpit
40
41 This is the most straight forward step. Just deploy the WAR file as you usually
42 do in your application server.
43
44 6. Configuring a web server and authentication
45
46 LightPIT can optionally detect the authenticated user. You may freely decide
47 whether to enable authentication in your application server or put a web server
48 in front. The latter is recommended, but keep in might that forwarding the
49 authentication information may only work with AJP for certain servlet
50 containers. Consult the respective manuals of the software you are using.
51
52 When the remote user is picked up successfully by LightPIT, comments under
53 issues e.g. are personalized. For this to work the authenticated username must
54 match one of the configured usernames in LightPIT.
55
56 Have fun!

mercurial