Installation

Preparations

Before installing the BPC, you should review the System Requirements and complete 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 that you create a dedicated user on the system for installation and operation. This is intended to prevent negative interactions with other applications on the server.

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

The application should never run under a user with unrestricted administrative privileges (such as root).

Installation Procedure

There are several ways to install the BPC. The following sections describe the options for using a pre-built bundle (recommended) or compiling all components individually.

Alternatively, you can install the BPC as part of an INUBIT installation using its installer. A description of this process can be found in the INUBIT documentation.

Installation Using the Bundle File

Installing via the bundle file is a simple way to install the BPC, since in this case all required files (except for License) are already included.

First, download the bundle file appropriate for your operating system.
Unzip the bundle file into the <BPC-INSTALL-DIR> directory.
If you’re using Windows, you should also create the following links:
```
cd <BPC-INSTALL-DIR>
mklink /J opensearch_config\virtimo\ssl ssl
mklink /J opensearch-3.6.0 opensearch
mklink /J karaf-5.0.X karaf
mklink /J jdk-21.X _jvm
```
This isn’t strictly necessary, but it makes things easier when installing future updates. This ensures that the paths to the system components remain consistent.
Place your license file in the directory <BPC-INSTALL-DIR>/karaf/deploy.
If you want to set up the BPC as an operating system Service, you can follow the instructions at Services.

Alternatively, you can start and stop the BPC directly.

When finished, the contents of <BPC-INSTALL-DIR> should look like this.

Installing the Individual Components

The following describes how to install the BPC system components individually.

Setting Up Central Configuration Files

We recommend using the Central configuration file. This allows you to store important configurations separately from the system components. This simplifies updating the individual components, as the configuration remains intact.

Download the central configuration files.
Place the files directly in the <BPC-INSTALL-DIR> directory.

For more information, see Central configuration file.

Install Java

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

Unzip the Java runtime environment archive appropriate for your operating system (jdk_*) into the <BPC-INSTALL-DIR> directory.
Create a link named _jvm that points to the runtime environment directory:
- Unix systems
- Windows systems
ln -s jdk-21.X _jvm
mklink /J jdk-21.X _jvm
You must set the environment variable JAVA_HOME to the path of the runtime environment (e.g., <BPC-INSTALL-DIR>/_jvm) for the user running the BPC.

To set JAVA_HOME, we recommend using the Central configuration file

Install OpenSearch

Extract the OpenSearch archive appropriate for your operating system into the <BPC-INSTALL-DIR>.
Create a link named opensearch that points to the new directory:
- Unix systems
- Windows systems
ln -s opensearch-3.6.0/ opensearch
mklink /J opensearch opensearch-3.6.0

As described in the section “Configuring OpenSearch,” we recommend that you move the configuration directory to a separate location.

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

Unix systems
Windows systems

mv opensearch/config opensearch_config
cd opensearch_config/virtimo/
rm ssl # if the symlink exists
ln -s ../../ssl ssl

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

Then enable 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

Extract the Karaf archive appropriate for your operating system into the <BPC-INSTALL-DIR> directory.
Create a link named karaf that points to the new directory:
- Unix systems
- Windows systems
ln -s karaf-5.0/ karaf
mklink /J karaf karaf-5.0.X

Install the license

Place your license file in the <BPC-INSTALL-DIR>/karaf/deploy directory.

BPC Modules

Now you can install the BPC modules.

To do this, download all required BPC modules and copy them to the directory <BPC-INSTALL-DIR>/karaf/deploy.

A basic installation typically includes the following modules:

If you plan to use the file storage functionality, which enables storing files with cloud services, you must also install the corresponding modules:

File Storage Module

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 already come with sample stores that enable an encrypted connection. However, you should replace these and adapt them to your needs.

Create a Java truststore and keystore that contains all the necessary keys and certificates.
1. If you do not need your own truststores and keystores—for example, for simple testing—you can use the sample truststores and keystores.
Copy these to the directory <BPC-INSTALL-DIR>/ssl.
Configure them 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 it up as follows.

Download the start and stop scripts appropriate for your operating system.
Copy them to the directory <BPC-INSTALL-DIR>/bin.

For more information on using the scripts, see Starting and Stopping BPC.

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 ` <BPC-INSTALL-DIR> ` file should look something like this at the end of the installation:

Initial Login

Once you have completed the installation and started the BPC, you can log in.

The BPC is accessible in your browser at http://localhost:8181/ once OpenSearch and Karaf have been started. See also Starting and Stopping BPC.

To log in to the BPC for the first time, Karaf is set as the identity provider by default.
There are two default users:

Username Note

Username	Note
`bpcadmin`	Admin user with the bpcadmin role.
`Virtimo`	Only for accessing the Karaf console.

bpcadmin

Admin user with the bpcadmin role.

Virtimo

Only for accessing the Karaf console.

Passwords for standard users are assigned randomly and must be set manually (see Karaf as an Identity Provider)!

Other identity providers can also be used for the BPC. For detailed configuration instructions, see Creating, Configuring, and Using an Identity Provider.

Keywords: