Installation

This page explains the installation procedure for Prism.

Overview

By default, the following ports will be used:

• Tomcat

  • HTTP: 80

  • HTTPS: 443

  • Shutdown: 8005

On Windows, we will install everything into a base folder (e. g. C:\Prism):

• C:\Prism

  • \home

  • \jdk17

  • \Tomcat9

It is recommended to use the major version in the folder name but leave out any other version part. That will make sure that references do not need to be adjusted on every update.

Prism Installation Package

As first step of the installation, acquire an eMuseum installation package from the Community Portal.

Create a base folder, e. g. C:\Prism, and extract the installation package into it. Rename the resulting installation folder to home.

3rd-party Requirements

Next, install all required 3rd-party requirements.

Install Java

Download Java from adoptium.net. Make sure to pick the correct version and architecture. Then, install it to C:\Prism\jdk17 (adjust the folder name to match the Java version).

Install Tomcat

Download Tomcat from tomcat.apache.org. For an easy installation including a service pick the 32-bit/64-bit Windows Service Installer.

Execute the installer. Un-check all additional option like the documentation and the manager but select all options under the root item (Tomcat Native and service). The first path the installer asks for is not the Tomcat installation folder but the Java directory. Select C:\Prism\jdk17. The second path will be the Tomcat installation folder. Select C:\Prism\Tomcat9 (adjust the folder name match the Tomcat version). Use only “Prism” as name, the installer will add “Apache Tomcat” in front of it. It is recommended to start the service to let Tomcat create some default folders.

After the installation, stop the Tomcat service and increase the memory by executing the Tomcat configuration utility at C:\Prism\Tomcat9\bin\Prismw.exe. Under the tab “Java” set the start memory to “512” and the maximum memory to a minimum of “4096”.

Next, adjust the port of the HTTP connector in C:\Prism\Tomcat9\conf\server.xml from “8080” to “80”:

    <Connector port="80" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443"
               maxParameterCount="1000">

To set up HTTPS, uncomment one of the example connectors, change its port to “443” and adjust the TLS settings.

Install Database Management Engine

If you want to use a standalone database instance, install one of the supported Database Management Systems. Otherwise, use an existing database server.

Prism Application

Create Database

Create a new eMuseum database including user as follows.

SQL Server

If you want to use SQL Server Management Studio, open it, connect to the database server and do the following steps:

• Create a new login with name “prism” and a strong password. Disable all password policies.

• Create a new database named “prism” with the owner set to “prism” and the Recovery Model set to “simple”

Alternatively, run the following SQL script (adjust the login password!):

CREATE DATABASE prism;
ALTER DATABASE [prism] SET RECOVERY SIMPLE;

CREATE LOGIN prism WITH PASSWORD = N'prism', CHECK_POLICY = OFF, CHECK_EXPIRATION = OFF;

USE prism;
CREATE USER prism FROM LOGIN prism;
EXEC sp_addrolemember 'db_owner', 'prism';

MySQL/MariaDB

Either use a management client of your choice or run the following SQL script (adjust the login password!):

CREATE DATABASE prism CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode;
CREATE USER 'prism'@'localhost' IDENTIFIED BY PASSWORD 'prism';
GRANT ALL PRIVILEGES ON prism.* TO 'prism'@'localhost' WITH GRANT OPTION;
FLUSH PRIVILEGES;

If the database server is running on a different host, adjust the host value. Use “%” to allow the user to connect from any host.

Embedded

To use the embedded database no action is required.

Deploy Webapp

Create a context descriptor by copying an example context.xml file from C:\Prism\home\tomcat to C:\Prism\home\tomcat\ROOT.xml which matches the database management system (e. g. context.mssql.xml for SQL Server).

Adjust the following settings:

• prism.home The path to the Prism folder: C:\Prism\home

• emuseum.jdbcurl The database connection URL

• prism.dbuser The database user name

• prism.dbpassword The database user password

Copy the XML file from above to Tomcat’s configuration folder: C:\Prism\Tomcat9\conf\Catalina\localhost\ROOT.xml

To deploy the webapp, copy the war file from C:\Prism\home\tomcat\prism-1.5.war (adjust the version number) to C:\Prism\Tomcat9\webapps\ROOT.war.

It is crucial that the war file and the context description have the same name (except for the file extention) for Tomcat to match the configuration with the application.

Start the Tomcat service.

First Start

Open a web browser and navigate to http://localhost/. Login as admin/admin.

Change Admin Password

Change the admin password to a strong password.

Configure Application

Adjust the following application settings:

• Hostname

• Use HTTPS (if enabled and a domain has been set up)