Introduction
Taqtile uses Docker containers to allow clients flexibility to install on premises or in their own hosting environments. This document explains how to install and configure Manifest Server using Docker.
What is Docker? Docker is a containerization platform that packages application and all its dependencies together in the form of a docker container to ensure that application works seamlessly in any environment.
What is a Container? A Docker Container is a standardized unit which can be created on the fly to deploy a particular application or environment.
Using docker you can install a local server copy of Manifest. It is a very useful tool especially when you don’t have access to the Internet but need to demonstrate Manifest
Prerequisites
Docker set up and installation does require some expertise about docker and how it works. Below are a few articles that can help get you up to speed:
In order to set up Manifest using docker you will need the following information that can be obtained from your Account Manager.
- Docker login password which can be obtained by your Account Manager
- Current docker-compose.yml file (attached below)
- License key loaded with the # of licenses agreed within the Taqtile, Inc. contract. This key can be obtained by your Account Manager and will manage the agreed upon # of licenses.
- Manifest Version 2.5 from the store to your 3D head mounted device
Video Tutorial
Please use this Manifest On Premise Installation for Windows video tutorial to assist in the deployment of Manifest in an on premise environment.
Support
Manifest docker supports x86 based host systems for Windows, Linux or Mac
- Windows: https://docs.docker.com/desktop/windows/
- Mac: https://docs.docker.com/desktop/mac/install/
- Linux: https://docs.docker.com/desktop/linux/
IMPT! We do not have support for Kubernetes.
Please follow along with this video tutorial to assist in deploying Manifest using docker for Windows.
Setting Up Docker
- Download Docker (without registration) or from web (with registration on your computer).
- Install Docker on your computer.
- Click on “Docker for Windows” shortcut and then check that it works in the tray bar:
- Create a folder “manifest” in local disk C on your computer. Download the docker-compose2.6.txt file and rename the file to docker-compose.yml. Once the file is renamed place this file into your “manifest” folder.
IMPORTANT: Once downloaded be sure to append the file extension to .yml versus .txt
5. Create a folder in “manifest” called “uploads”
- Set up environment variables in docker-compose.yml file
API VARIABLES:
| Variable | Variable Type | Variable Description | Example |
|---|---|---|---|
| VOLUMES | </put/path/to/file/storage/here>:/uploads | This variable represents the path on your machine where Manifest will persistently store your application files even after restarting your compose. Based on this variable Manifest will store your application files persistently. | /c/manifest/uploads:/uploads |
| IP_ACCESS | <PUT_VM_IP_ADDRESS> | Based on this variable manifest will create stun/turn configuration with our stun/turn container from compose. | 10.0.0.83 (This information can be obtained by typing ipconfig into your machines terminal) |
| ADMIN_EMAIL | <PUT_ADMIN_EMAIL> | With this variable Manifest will generate admin account that will be used to log into the Manifest platforms (web, HL2, iPad, etc) | username@company.com (Use your company email address) |
| ADMIN_PASSWORD | <PUT_ADMIN_PASSWORD> | With this variable Manifest will generate the login password for the Manifest Admin that will be used to log into the Manifest platforms (web, HL2, iPad, etc.) | P@ssword123 (Create an unique password that will be used to log into the Manifest platforms) |
| LICENSE_KEY | ” “ | The license key obtained by your Account Manager that is used to control the number of licenses allowed within the docker install | Example: DdnkLiSNtn8mJMFNkKQlg0oJSUDkyWX1 (This will be obtained from your Account Manager) |
WEB VARIABLES:
| Variable | Variable Type | Variable Description | Example |
|---|---|---|---|
| VOLUMES | </put/path/to/file/storage/here>:/usr/share/nginx/html/uploads | This variable represents the path on your machine where Manifest will persistently store your application files even after restarting your compose. Based on this variable Manifest will store your application files persistently. | /c/manifest/uploads:/usr/share/nginx/html/uploads |
| SELF-ASSIGNED CERTIFICATES | <put_here_path_to_folder_where_certs_will_store>:/usr/share/nginx/certs | If clients want to use their own certs they can replace certs in this folder and restart the web container and new certs will automatically be applied. IMPT! Certs must be named “nginx-cert.crt” and “nginx-cert.key” in order to work. Without these file names, Manifest will create self assigned certs and will use those instead. | c/manifest/uploads:/usr/share/nginx/certs |
| IP_ACCESS | <PUT_VM_IP_ADDRESS> | Based on this variable manifest will create self-signed ssl certificate. | 10.0.0.83 (This information can be obtained by typing ipconfig into your machines terminal) |
CONVERTER VARIABLES:
| Variable | Variable Type | Variable Description | Example |
|---|---|---|---|
| VOLUMES | </put/path/to/file/storage/here>:/manifest-cs/folder | Based on this variable, Manifest will store your 3D models persistently | /c/manifest/uploads:/manifest-cs/folder |
Example of a docker-compose.yml is included below and gives indication as to where each variable needs to be filled out within the compose file.
7. Save the file with name docker-compose.yml and type “All Files.” Change Encoding to UTF-8
Once the docker-compose.yml is saved you should see a file with YML format:
- Run cmd as Administrator
- Right click mouse button on the start menu and choose “Task Manager”
- Click on File–> Run new task, write “CMD” and check the box to run as Administrator and press [OK]:
- Copy the below command in CMD
docker login taqtile.azurecr.io -u taqtile -p [please inquire for password]
and then press [Enter]. You should get “Login Succeeded”:
10. Change current directory to c:/manifest by typing cd c:/manifest
11. Copy command docker-compose up -d in CMD and the process will started. It may take some time, so please be patient. As a result you will see “…done” as seen in the below screenshot:
12. Check your docker results with the command docker image ls in CMD. This will show the all the docker containers.
13. Open your Chrome Browser and type localhost in your browser. You will be directed to the Manifest login page. Enter in the following credentials to log into the Manifest Client Application.
Email: <Email from docker-compose file> [API Variable: ADMIN_EMAIL]
Password: <Password from docker-compose file> [API Variable: [ADMIN_PASSWORD]
14. To access docker on the HL2 device, in the Command Prompt, type ipconfig to obtain your IPv4 address. This is also the variable entered into your compose file: IP_ACCESS as your Web and API Variable.
On devices Login page enter in the IPv4 address into the domain field and enter in your Email [ADMIN_EMAIL] and Password [ADMIN_PASSWORD] credentials.
15. Congratulations! You’ve created a new client and can start working with it.
