BWS On-Premises Installation Prerequisites

To install the BioID Web Service (BWS) on a local IT infrastructure (on-premises) you need to consider a few basic requirements:

• You should have an agreement with BioID.
• You need a BioID Connect Account to login to the BioID Container Registry and the BioID BWS Portal.
• A MongoDB database server.
• A CLI-secret to access the BioID Container Registry to fetch the Docker images.

BioID Connect Account

To access the BioID BWS Portal and the BioID Container Registry a BioID Connect Account is required. If you do not have an account, you can register at BioID Connect — it is highly recommended to confirm your email address and it is necessary to enable multifactor login by creating a biometric template and TOTP.

With your BioID Connect Account please login to the BioID BWS Portal and to the BioID Container Registry at least once. Now let your contact person at BioID know your email address (you used with the BioID Connect Account) so that we can create the necessary projects and assign the required permissions to your account.

Minimum Hardware Requirement to run a BWS Container

• Memory: 4GB RAM (8GB recommended)
• CPU: 4 cores 2.2 GHz (8 cores recommended)

Database

To install BWS, an existing MongoDB Database is required. You can use any kind of MongoDB installation (Community, Enterprise, Atlas, ...), whereby we recommend to use at least the latest stable release version or newer.
Depending on your environment, you can install MongoDB by following the instructions on the official mongodb website.

In the following you need to have a connection-string to a MongoDB database available, which not only specifies the MongoDB server host, but also the database name and any required settings to get write access to this database, e.g. something like: mongodb://username:password@mongodb.mydomain.com:27017/bws?ssl=true

Connecting to the BioID Container Registry

For your company a project in the BioID Container Registry should have been created containing the most recent BWS Docker images. Your BioID Connect Account should have been granted the required permissions to access this project.

To use the Docker- or Helm-CLI to access this project, login to the BioID Container Registry, click onto your username, select User Profile and copy your CLI secret. With this secret you should now be able to access bcr.bioid.com via Docker using:

docker login -u {username} -p {CLI-secret} bcr.bioid.com

Optionally you can now already download the needed images for a BWS on-premises installation explicitly:

docker pull bcr.bioid.com/{project}/bwsportal-onprem:{version}
docker pull bcr.bioid.com/{project}/bwsgrpc-onprem:{version}

Note that we typically try to use the same version for all our images, but this is not necessarily always the case.