Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Required Tools
- 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/
...
General Installation Instructions
1. Install Docker
For Mac and Windows: Install Docker Desktop and launch it.
For Linux: Ensure the Docker service is running. Verify by using:
...
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
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 | None | No |
...
Authentication
You may want to enable multiple authentication options to work together.
...
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:
...
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
If you're using a Mac with the M1 chip, some additional steps are required to ensure compatibility:
Rosetta
1. Install Rosetta
Code Block |
---|
softwareupdate --install-rosetta --agree-to-license |
...
Code Block |
---|
platform: linux/amd64 |