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 - Windows¶

Read First¶

This guide targets those who wants to run instant3Dhub for local testing on a Windows machine. Installing the license server is not part of this guide as it requires Linux machine and we do not support Windows. If this is not possible, you can request a license key from us for testing instead, which will then not require a license server.

Prerequisites¶

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

CPU-only: CPU=4 Cores, Mem=16GB
With GPU: CPU=8 Cores, Mem=32GB, GPU=1 NVIDIA GPU

Installation¶

Install Docker Desktop: Docker Desktop is freely available in a community edition, for Windows and Mac. Start by downloading and installing Docker Desktop: https://hub.docker.com/editions/community/docker-ce-desktop-windows.
Enable Kubernetes
1. Make sure you have Docker Desktop running - in the taskbar in Windows you should see Docker’s whale logo. Click the whale and select Settings.
2. A new screen opens with all of Docker Desktop’s configuration options. Click on Kubernetes and check the Enable Kubernetes checkbox.
3. Docker Desktop will download all the Kubernetes images in the background and get everything started up. When it’s ready you’ll see two green lights in the bottom of the settings screen saying Docker running and Kubernetes running.
4. Verify your Kubernetes cluster by running the following command
```
kubectl get nodes
```
  You should see a single node in the output called docker-desktop. That’s a full Kubernetes node running locally on your machine.
Install Helm: We provide a Helm Chart repository for the deployment of instant3Dhub on Kubernetes. Therefore, helm should be installed first: Please follow the instructions from the official Helm documentation: https://helm.sh/docs/intro/install/

Now, open a command prompt and run the following command to add the instant3Dhub Helm repository:

helm repo add instant3dhub https://repo.threedy.io/api/v4/projects/2/packages/helm/stable \
  && helm repo update

Run helm install to deploy instant3Dhub

helm install -n i3dhub --create-namespace i3dhub-windows instant3dhub/instant3dhub \
  --set licenseServer=http://license.yourdomain.com:8200 \
  --set storage.class=hostpath \
  --set entrypoints={http://localhost:30042} \
  --set registry=images.threedy.io

If you received a license key, also add the following parameter to the command:

--set license.serialKey=YOUR_LICENSE_KEY

Note that the licenseServer parameter is required, even if are using a license key. A dummy value can be used in this case.

The startup and initialization of all containers can take a few minutes, depending on your cluster and registry connection speed. To check the status of the containers run:
```
kubectl get pods -n i3dhub
```
Once all containers are running, you should be able to access the splash page at http://localhost:30042.