Content Comparison

JWT_SECRET

A secret string for encrypting access tokens. Ensure it is unique and secure.

None

Yes

There is no default value, set the arbitrary string or generate some random string.

SERVICE_USER_PASSWORD

Password for default system user which could be used on first install. After the backend service first starts, you will be able to login into the app via:

username: service-admin
password: SERVICE_USER_PASSWORD

None

Yes

Password for service user stores as a hashed string by bcryptjs. After user creation in Mongodb, you may remove this password from .env.

DB_HOST

MongoDB server's domain name or IP address.

apliqo-mongo

Yes

Inside the docker network, container names could be used as domain names to access the resource. If you are not using Docker for the MongoDB database, set the IP address or domain name as the value for this variable.

DB_USER

Username of a root user from which account would be created a connection to the MongoDB.

None

Yes

DB_PASSWORD

Password of a root user from which account would be created a connection to the MongoDB.

None

Yes

If you are using the default Apliqo UX setup. On first install DB_USER and DB_PASSWORD would be used to create a MongoDB user to access the database. This user would be stored in the admin database by default.

DB_CONNECTION_SCHEME

Description: MongoDB uses a connection variant.
There are 2 options:

mongodb - Standard Connection String Format. The standard format of the MongoDB connection URI is used to connect to a MongoDB deployment: standalone, replica set, or a sharded cluster.

mongodb+srv - DNS Seed List Connection Format. The +srv indicates to the client that the hostname that follows corresponds to a DNS SRV record.

mongodb

Yes

If you don't have your dedicated MongoDB server - use the default value.

REDIS_HOST

Hostname for the Redis database, used for caching and queues.

apliqo-redis

Yes

Inside the docker network, container names could be used as domain names to access the resource. If you are not using Docker for the Redis database, set an IP address or domain name as the value for this variable.

MONGO_DB_PORT_EXPOSE

Port on the machine where docker is running to access the MongoDB.
Set this variable to have the ability to access MongoDB from outside the docker network and to manage the DB by GUI tools (Mongo Compass, Studio 3T)

None

No

DB_NAME

Apliqo Content Store database name in MongoDB server.

apliqo-content-store

No

DB_PORT

MongoDB server's port.

27017

No

DB_AUTHSOURCE

Database inside MongoDB server which stores users and their permission in MongoDB.

admin

No

PORT

Port on which the backend server runs inside the Docker container.

4000

No

PORT_EXPOSE

Port on which the backend server is accessible from machine IP. Docker bridges PORT and PORT_EXPOSE.

4000

No

REDIS_HOST

Hostname for the Redis database, used for caching and queues.

apliqo-redis

No

TM1_VERIFY_SSL

Variable to control the SSL verification for all TM1 API requests. Available values: 0 or 1
Set 1 if you want to enable the TM1 API SSL verification.
Set 0 if you want to disable the TM1 API SSL verification. (Could be used for TM1 with self-signed certificate)

0

No