Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

instant3Dhub on Single Node

Read First

This guide targets those who have neither an existing k8s cluster nor the resources to set up and manage one. While having a k8s cluster to run instant3Dhub is still a requirement, we provide tools to get all the requirements ready for you on a single CentOS 8 machine. For installing on Windows, please follow the instructions here

Prerequisites

The machine where you want to run instant3Dhub should have the following requirements in order to run the system properly:

Resources

These minimal resources are required to run instant3Dhub

  • CPU-only: CPU=4 Cores, Mem=16GB

  • With GPU: CPU=8 Cores, Mem=32GB, GPU=1 NVIDIA GPU

System

  • Snapd is installed and running

  • SELinux is disabled

  • The system has the correct Linux kernel sources from the CentOS repositories

  • If you want to use GPU support, then make sure that the nouveau driver is disabled and that there is no other driver installed on the host system running microk8s.

  • If your system uses firewalld then make sure that masquerade is enabled on the host.

  • You have a running instant3Dhub License Server which can be accessed from the host. For installing instant3Dhub License Server please check the documentation here.

If you are not sure if or how to make your system meets these requirements, then please check and run the prerequisites.sh script which will reconfigure your system to meet the requirements 1-5. Please note that a restart might be required to persist the changes.

Installation

For installing instant3Dhub on a single machine:

Clone the release repository:

git clone https://repo.threedy.io/instant3Dhub/release.git
cd release/reference/singleNode/

The script expects these env variables to be set in the setup file:

  • RELEASE_NAME: Is the name of the release to be used when deploying instant3Dhub. This can be any name of your choice. Example: instant3dhub-test. Default is: i3dhub-singlenode.

  • ENTRYPOINT: The external exposure hosts or proxies. Example: http://host-name.your-domain.com:30000. Default is: http://your-hostname:30042. For more information on how to set up a proxy please see our guide.

  • REGISTRY: Is the container registry where instant3Dhub images can be fetched. Example: hub.docker.com. Default is: images.threedy.io.

  • LICENSE_SERVER: The address of the license server. Example: http://license.threedy.io:8200. Default is empty.

  • ENABLE_GPU: Set to true if your system has a GPU and you want to enable it to be used by instant3Dhub visualization services. Default is false.

Please adjust these variables based on your setup.

Now you can install instant3Dhub:

./install.sh