...
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 | |||||||
APLIQO_HOSTNAME | 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 | None | No |
...
Authentication
You may want to enable multiple authentication options to work together.
Apliqo allows authentication only when at least one of the TM1 instances designated as an authentication source successfully validates the credentials.
It is possible to configure multiple instances with various authentication methods. For example, if you want a specific instance to handle authentication for Apliqo, while other instances serve only as data models, you need to enable the authentication source setting only for the designated 'authentication' instance.
However, if certain reports rely on a TM1 instance that is not configured as an authentication source, you will not have an active TM1 session for that instance after logging in.
In such cases, the 'Login to Instance' dialog will appear, allowing you to log in to that instance. Even if you close the Apliqo tab in your browser, both sessions will remain cached. When you return, you will be able to access the reports without logging in again.
CAMPassport
To enable CAMPassport authentication you need:
Add instance with CAMPassport authentication enabled
Turn on the auth source switch button for this instance
Open instance “Edit Dialog”
Go to CAMPassport tab on a right side
Check the link to your CAM Server
By default, this link Apliqo take fromWWW-Authenticate
headerAdd
APLQIO_HOSTNAME
into the.env
file follow the guideAfter editting
.env
usedocker compose up -d --force-recreate apliqo-api
This command restart the server with new environment variables changesGo to login page and “Login via SSO“ but should appear
CAMNamespace
To enable CAMNamespace authentication you need:
Add instance with CAMNamespace authentication enabled
Open instance “Edit Dialog”
Go to CAMNamespace tab on a right side
Add your supported namespaces into text field “Client CAMNamespaces“
Use coma separation for multiple namespaces.Turn on the auth source switch button for this instance
Go to login page, namespaces select dropdown should appear
Info |
---|
In case, you want to have Basic and CAMNamespace authentication options available together, leave Namespace select dropdown empty (in this case, Basic authentication will be used by default) |
Troubleshooting
» MacOS with M1 chip peculiarities
...