| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
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:
| Code Block | ||
|---|---|---|
| ||
sudo services docker status |
2. Verify Docker Compose
Make sure Docker Compose is installed. Run:
| Code Block | ||
|---|---|---|
| ||
docker compose version |
...
| Code Block | ||
|---|---|---|
| ||
docker network ls |
You should see a result like:
| Code Block | ||
|---|---|---|
| ||
NETWORK ID NAME DRIVER SCOPE 06e4817f8b43 apliqo-core bridge local |
...
| Code Block | ||
|---|---|---|
| ||
docker logs ${docker_container_id} |
9. Access Apliqo UX
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 |
|---|---|---|---|---|
|
...
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 | |
|
...
...
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. |
|
...
| colour | Red |
|---|---|
| title | required |
...
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. |
...
|
...
|
...
Apliqo Content Store database name in MongoDB server. |
...
| No | |
|
...
MongoDB server's domain name or IP address |
...
. |
|
...
No | Inside the docker network, container names could be used as domain names to access the resource. If you are not using Docker for MongoDB database, set IP address or domain name as the value for this variable. |
|
...
MongoDB server's port. |
...
| No | |
|
...
...
Port on the machine where docker is running to access the MongoDB. | None | Yes | |
|
...
| colour | Red |
|---|---|
| title | required |
...
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 default Apliqo UX setup. On first install |
| Description: MongoDB uses a connection variant.
|
...
|
...
No | If you don't have your dedicated MongoDB server - use the default value. |
|
...
Database inside MongoDB server which stores users and their permission in MongoDB. |
...
|
...
No | |
|
...
Hostname for the Redis database |
...
, used for caching and queues. |
...
|
...
No | Inside the docker network, container names could be used as domain names to access the resource. If you are not using Docker for Redis database, set IP address or domain name as value for this variable. |
...
|
...
Variable to control the SSL verification for all TM1 API requests. |
...
Available values: 0 or 1 |
...
certificate) |
...
| No |
...
Troubleshooting
» MacOS with M1 chip peculiarities
The architecture of the M1 chip is not fully compatible with the architecture of containers that are used in docker. In this case, you need to install a couple of things to make everything work correctly for your environment.
Rosetta
First of all, you need to install Rosetta and turn the terminal into rosetta mode. 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 |
It seems to be a good idea to run your entire Terminal in Rosetta2. Enable Rosetta for Terminal:
Go to Finder > Applications and find your > Terminal
Right-Click "Terminal" > Get Info > Enable click ‘Terminal’ and select Get Info
Check the box "Open using Rosetta."
Click to Open the Terminal, type
archto verify it says Terminal and verify it’s running under Rosetta by typing:
| Code Block |
|---|
arch |
It should return
i386orx86_64now.
DockerFor
Ensure Docker Desktop
...
is using
VirtioFSas a Virtualization framework
...
in general settings for improved I/O performance for operations on bind mounts.
For containers
...
that
...
require the AMD architecture, add the following line to
...
the container configuration:
| Code Block |
|---|
platform: linux/amd64 |
...