| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
- Docker -
Status colour Red title required
New server using dockerized images that allows Apliqo UX to be deployed across any platform, simplifying deployment and network management.
Follow the installation instructions for your system:
Windows | Linux | Mac
- MongoCompass -
Status colour Green title NICE TO HAVE
While not required, this GUI tool can be useful for querying and managing MongoDB data visually.
https://www.mongodb.com/docs/compass/master/install/
...
Once the containers are running, navigate to the following URL in your browser:
http://your-ip-address
By default, the interface will be accessible from port 80.
...
Environment Variables
| Info |
|---|
The example file contains all the required variables. Please do not remove them, only update if necessary. |
Variable | Description | Default Value | Required | Notes | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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. | ||||||||||||||||||
| 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 | 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. | ||||||||||||||||||
| MongoDB server's domain name or IP address. |
| 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. | ||||||||||||||||||
| Username of a root user from which account would be created a connection to the MongoDB. | None | Yes | |||||||||||||||||||
| 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 | ||||||||||||||||||
| Description: MongoDB uses a connection variant.
|
| Yes | If you don't have your dedicated MongoDB server - use the default value. | ||||||||||||||||||
| Hostname for the Redis database, used for caching and queues. |
| 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. | ||||||||||||||||||
| Port on the machine where docker is running to access the MongoDB. | None | No | |||||||||||||||||||
| Apliqo Content Store database name in MongoDB server. |
| No | |||||||||||||||||||
| MongoDB server's port. |
| No | |||||||||||||||||||
| Database inside MongoDB server which stores users and their permission in MongoDB. |
| No | |||||||||||||||||||
| Port on which the backend server runs inside the Docker container. |
| No | |||||||||||||||||||
| Port on which the backend server is accessible from machine IP. Docker bridges |
| No | |||||||||||||||||||
| Variable to control the SSL verification for all TM1 API requests. Available values: 0 or 1 |
| No | |||||||||||||||||||
| Variable which is used to create a redirect link for CAMPassport authentication. Please make sure that the link doesn’t have slash ('/') and the end
https://apliqo-frontend-domain.com - Valid
| None | No |
...
Authentication
You may want to enable multiple authentication Apliqo supports flexible authentication configurations, allowing multiple options to work together. Below, we break down how to enable and configure various authentication methods step by step.Apliqo allows authentication only when
| Info |
|---|
Refer to the Synchronization article for a detailed setup demonstration. |
» Authentication Overview
Authentication Sources:
Apliqo authenticates users through designated TM1 instances. Authentication is successful if at least one
...
configured TM1 instance validates the credentials.
...
Multiple Authentication Instances:
You can configure multiple TM1 instances with
...
different authentication methods. For example
...
:
A specific instance
...
may handle authentication for Apliqo
...
.
Other instances may function purely as data models
...
.
Limitations:
If a report relies on a TM1 instance
...
not
...
set up as an authentication source, you
...
won’t have an active
...
session for that instance after logging in.
In such cases, the
...
‘Login to
...
Instance’ dialog will appear,
...
letting you
...
log in
...
manually. Both sessions will remain cached
...
,
...
CAMPassport
To enable CAMPassport authentication you need:
- Add instance
even if you close the browser tab.
...
» Enabling CAMPassport Authentication
To set up CAMPassport Authentication, follow these steps:
Add an Instance with CAMPassport authentication enabled.
Turn on the auth source Authentication Source switch button for this instance.
Open instance “Edit Dialog”the instance’s Edit Dialog.
Go to the CAMPassport tab on a the right side.
Check the link to your CAM Server Link:
By default, Apliqo retrieves this link
from the
WWW-Authenticateheader. Adjust as necessary.
Configure the Environment:
Add
APLQIO_HOSTNAME
to the
.envfile
as specified in the guide
.envuse
docker compose up -d.
Apply the changes by running the following command:
| Code Block |
|---|
docker compose up -d --force-recreate apliqo-api |
...
Go to login page and “Login via SSO“ but should appear the Login Page and verify that the Login via SSO button appears.
...
» CAMNamespace
To enable CAMNamespace authentication you needset up CAMNamespace Authentication, follow these steps:
Add instance an Instance with CAMNamespace authentication enabled.
Open instance “Edit Dialog”the instance’s Edit Dialog.
Go to the CAMNamespace tab on a the right side.
Add your supported namespaces into text field “Client CAMNamespaces“
Use coma separation to the Client CAMNamespaces field:Use comma-separated values for multiple namespaces.
Turn on the auth source Authentication Source switch button for this instance.
Go to login page, namespaces select dropdown should appear
...
the Login Page and verify that the namespace selection dropdown appears.
| Info |
|---|
Combining CAMNamespace and Basic Authentication:
|
...
Troubleshooting
» MacOS with M1 chip peculiarities
...
| Code Block |
|---|
platform: linux/amd64 |
...