Server

This guide explains how to start the voraus 3D Visu server.

Installation

To install the voraus 3D Visu client, run the following command:

pip install \
  --index-url https://voraus.jfrog.io/artifactory/api/pypi/pypi/simple \
  --extra-index-url https://pypi.python.org/simple \
  voraus-3d-visu

CARGO_REGISTRIES_VORAUS_INDEX="sparse+https://voraus.jfrog.io/artifactory/api/cargo/default-cargo-public-production-cloud-local/index/" \
  cargo add voraus-3d-visu --registry voraus

Start the Server

As stated before, there exists a visualization server and a Python client to interact with the server. Either run the server using our Docker image by defining a docker-compose.yml file as shown below:

Listing 1 docker-compose.yml
 1services:
 2  codemeter:
 3    hostname: codemeter
 4    image: docker.io/wibusystems/codemeter:9.10
 5    environment:
 6      CM_REMOTE_SERVER: host.docker.internal
 7    extra_hosts:
 8      - host.docker.internal:host-gateway
 9
10  voraus-3d-visu:
11    image: voraus.jfrog.io/docker/voraus-3d-visu:3.1.2 # x-release-please-version
12    hostname: voraus-3d-visu
13    ports:
14      - 8077:80
15    environment:
16      CODEMETER_HOST: codemeter
17    depends_on:
18      codemeter:
19        condition: service_healthy

Then start the server by running:

docker compose up

All the configurations are explained in the Configuration Example section and can be applied to the server using environment variables.

Once the server is running, access the visualization in your web browser at http://localhost:8077.

Note

The port 8077 is defined in the ports section of the docker-compose.yml file shown in Listing 1. Adjust it there if you want to serve the visualization on a different port.

Next Step

Check out the Client on how to add objects to the server.