Prerequisites
- An on-prem instance of Manifest already installed
- Updated docker compose file, images, etc.
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.
Clearing Docker and Reinstalling
The instructions below show how to clear all images from a past docker version install and start from scratch.
- Make sure the docker is running.
2. Update your c:manifest folder with the updated docker-compose.yml file. Make sure all the variables have been updated in the docker-compose.yml file
IMPT! If you have a new license key that was provided to you after the original install – you MUST go a pull command to pull in the new license key variables. Those commands are:
- docker-compose down
- docker-compose pull
- docker-compose up -d
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 |
3. Run cmd as Administrator
- Click on File –> Run new task, write “CMD” and check the box to run as Administrator and press [OK]
- Change the current directory to c:manifest by typing cd c:manifest
4. Enter in the following commands:
- docker-compose down
- docker image prune –all
- docker system prune –volumes
5. To check if the docker has been cleared type: docker image ls. If the docker was cleared the commands results will be empty and all cleared.
6. To check if the docker volumes have been cleared type: docker volume ls
7. Once that is completed running to reinstall docker, please enter in the following command:
- docker-compose up -d
8. Check your docker results with the command docker image ls in CMD. This will show the all the docker containers.
9. 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]
10. 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.
11. Congratulations! You’ve updated you docker to the latest version. When logging in you should still see all the content that was previously created from past versions.
