Installation

Preparations

Before you install the BPC, you should check System requirements and make the following preparations.

License

You need a license file for your installation. You can obtain this from Support or your sales contact.

System user

It is recommended to create a dedicated user on the system for installation and operation. This is to prevent negative interaction with other applications on the server.

The system user used should have a home directory. If this is not the case, org.ops4j.pax.url.mvn.localRepository, in KARAF/etc/org.ops4j.pax.url.cfg, must be set to a valid path at the end of the installation. Otherwise, errors will occur if additional features are installed in Karaf.

The application should never run under a user with unrestricted administration rights (e.g. root).

Installation procedure

There are various ways to install the BPC. The following describes the options of using a prefabricated bundle (recommended) or assembling all components individually.

Alternatively, there is also the option of installing the BPC as part of an INUBIT installation using its installer. A description of this can be found in the INUBIT documentation.

Installation using a bundle file

Installation using the bundle file is an easy way to install the BPC, as all the required files (except License) are already included in this case.

First download the bundle file suitable for your operating system.
Unzip the bundle file into the INSTALLATIONSVERZEICHNIS.
If you are using Windows as your operating system, you should also create additional links.
```
cd INSTALLATIONSVERZEICHNIS
mklink /J opensearch_config\virtimo\ssl ssl
mklink /J opensearch-2.19.1 opensearch
mklink /J karaf-4.2.X karaf
mklink /J jdk-17.X _jvm
```
Dies ist nicht zwingend nötig, aber es erleichtert den Betrieb, wenn zukünftig Updates eingespielt werden. So bleiben die Pfade der Systemkomponenten stabil.
Place your license file in the INSTALLATIONSVERZEICHNIS/karaf/deploy directory.
If the BPC is to be set up as an operating system service, you can follow the instructions at Services.

Alternatively, you can also start and stop the BPC directly.

At the end, the contents of INSTALLATIONSVERZEICHNIS should look like this.

Installing the individual components

The following describes how the BPC system components can be installed individually.

Provide central configuration files

It is recommended to use Central configuration file. This makes it possible to store important configurations outside of the system components. This simplifies the updating of the individual components, as the configuration is retained.

Download the central configuration files.
Store the files directly at INSTALLATIONSVERZEICHNIS.

Further information can be found at Central configuration file.

Install Java

The two system components OpenSearch and Karaf require a corresponding runtime environment (Java 17). If you already have a suitable runtime environment on the system, you can skip the first two steps.

Unpack the Java runtime environment archive (jdk_*) suitable for your operating system to INSTALLATIONSVERZEICHNIS.
Create a link with the name _jvm, which points to the directory of the runtime environment:
- Unix systems
- Windows systems
ln -s jdk-17.X _jvm
mklink /J jdk-17.X _jvm
You must set the environment variable JAVA_HOME with the path to the runtime environment (e.g. ) for the user executing the BPC.E.g. INSTALLATIONSVERZEICHNIS/_jvm).

To set JAVA_HOME, we recommend Central configuration file

Install OpenSearch

Unpack the OpenSearch archive suitable for your operating system into the INSTALLATIONSVERZEICHNIS.
Create a link with the name opensearch, which points to the new directory:
- Unix systems
- Windows systems
ln -s opensearch-2.19.1/ opensearch
mklink /J opensearch opensearch-2.19.1

As described in the section Configuring OpenSearch, we recommend that you move the configuration directory.

To do this, move the OpenSearch configuration directory to the BPC installation directory, rename this to opensearch_config and reset the symbolic link to the SSL directory.

Unix systems
Windows systems

mv opensearch/config opensearch_config
cd opensearch_config/virtimo/
rm ssl # falls symlink existiert
ln -s ../../ssl ssl

mv opensearch\config opensearch_config
mklink /J opensearch_config\virtimo\ssl ssl

Then activate the following line in the central configuration file:

Unix systems
Windows systems

export OPENSEARCH_PATH_CONF=../opensearch_config

SET OPENSEARCH_PATH_CONF=..\opensearch_config

Install Karaf

Unpack the Karaf archive suitable for your operating system into the INSTALLATIONSVERZEICHNIS.
Create a link with the name karaf, which points to the new directory:
- Unix systems
- Windows systems
ln -s karaf-4.2/ karaf
mklink /J karaf karaf-4.2.X

Install license

Place your license file in the directory INSTALLATIONSVERZEICHNIS/karaf/deploy.

BPC modules

The BPC modules can now be installed.

To do this, download all the required BPC modules and copy them to the INSTALLATIONSVERZEICHNIS/karaf/deploy directory.

A simple installation usually includes the following modules:

Central Java trust and keystores

It is recommended to use central trust/keystores. These are required to set up encrypted network connections. The system components are already equipped with sample stores that enable an encrypted connection. You should nevertheless replace these and adapt them to your needs.

Put together a Java trust store and keystore that contains all the keys and certificates you need.
1. If you do not need your own truststore and keystore, e.g. for simple tests, you can use the example truststores and keystores.
Copy these to the directory INSTALLATIONSVERZEICHNIS/ssl.
Carry out the configuration according to the instructions for using the central trust/keystores.

Start and stop scripts

If you want to start and stop the BPC with a single script, you can set this up as follows.

Download the start and stop scripts suitable for your operating system.
Copy these to the directory INSTALLATIONSVERZEICHNIS/bin.

For more information on using the scripts, see BPC start and stop.

Setting up as an operating system service

If you want to set up the BPC as an operating system service, you can follow the instructions at Services.

Final overview

The INSTALLATIONSVERZEICHNIS should look something like this at the end of the installation:

Initial login

As soon as you have completed the installation and started the BPC, you can log in.

The BPC can be accessed in your browser at http://localhost:8181/ if OpenSearch and Karaf have been started. See also BPC start and stop.

To initially log in to the BPC, Karaf is set as the identity provider by default.
There are two standard users here:

Username Comment

Username	Comment
`bpcadmin`	Admin user with the role bpcadmin.
`virtimo`	Only for access to the Karaf console.

bpcadmin

Admin user with the role bpcadmin.

virtimo

Only for access to the Karaf console.

The passwords for the standard users are assigned randomly and must be set manually (see Karaf as identity provider)!

Other identity providers can also be used for the BPC. You can find out how to configure these in detail at Create, configure and use an identity provider.

Keywords: