INSTALL

Wed, 18 Aug 2021 15:30:49 +0200

author
Mike Becker <universe@uap-core.de>
date
Wed, 18 Aug 2021 15:30:49 +0200
changeset 227
f0ede8046b59
parent 221
33d7833ca54c
child 254
55ca6cafc3dd
permissions
-rw-r--r--

#162 adds active flag to component

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

mercurial