Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
1 result
Jaswant Panchumarti (Kitware)'s avatar
Merge branch 'change-base-image' into 'main'
Jaswant Panchumarti (Kitware) authored 
Change base image to emscripten/emsdk

See merge request !12
b86b6f6f
History
Jaswant Panchumarti (Kitware)'s avatar b86b6f6f
History
Name Last commit Last update
.gitlab
.gitignore
.gitlab-ci.yml
LICENSE
NOTICE
README.local-build.md
README.md
README.md

VTK WebAssembly SDK Docker Image

This dockerfile builds a self-contained version of VTK C++ so that CMake projects that link with VTK can target WebAssembly in or outside browsers without requiring one to compile VTK from source.

Usage

Let's work with an existing C++ example from VTK repository.

  1. Download the source code from here

    $ curl -L --output Cone.zip https://gitlab.kitware.com/vtk/vtk/-/archive/master/vtk-master.zip?path=Examples/Emscripten/Cxx/Cone
$ unzip -j Cone.zip -d Cone
## You should now see these files in Cone directory
$ ls Cone
  CMakeLists.txt  Cone.cxx  index.html  README.md

  2. Configure the CMake project

    $ docker run \
  --rm \
  -u $(id -u):$(id -g) \
  -v $(pwd)/Cone:/Cone \
  kitware/vtk-wasm-sdk \
  emcmake cmake -S /Cone -B /Cone/build -DCMAKE_BUILD_TYPE=Release -DVTK_DIR=/VTK-install/Release/lib/cmake/vtk

  3. Build

    $ docker run \
  --rm \
  -u $(id -u):$(id -g) \
  -v $(pwd)/Cone:/Cone \
  kitware/vtk-wasm-sdk \
  cmake --build /Cone/build

  4. Run

    $ python3 -m http.server -d ./Cone/build 8080

    Now, go to http://localhost:8080 in a web browser.

Teardown of configure command:

part description
docker run A standard command to run a command in a container
--rm remove a container after execution
-u $(id -u):$(id -g) Run the container as a non-root user with the same UID and GID as local user. Hence all files produced by this are accessible to non-root users
-v $(pwd)/Cone:/Cone Mounting Cone from the current folder in the host system into mirrored path on the container
TIP: This helps to investigate possible problem as we preserve exactly the same paths like in host. In such case modern editors (like Sublime, Atom, VS Code) let us to CTRL+Click on a problematic file
kitware/vtk-wasm-sdk Get the latest tag of this container
emcmake cmake ... Execute emcmake command with following arguments inside container, effectively configure our CMake project

Building Dockerfile

This image optionally accepts the following build arguments:

arg description
BUILD_DATE Date stamp for container metadata
SCCACHE_REDIS sccache redis url
IMAGE_NAME image name for container metadata
IMAGE_TAG image tag for container metadata
REVISION git revision for container metadata
SOURCE_URL VTK source url for container metadata
VERSION VTK version for container metadata

Building

This step will build Dockerfile as given tag on local machine

# using docker
$ docker build \
  --network host \
  --build-arg=BUILD_DATE=$(date) \
  --build-arg=VERSION=9.3.0 \
  --tag kitware/vtk-wasm-sdk:v9.3.0 \
  .

Tagging

In case of using docker build command directly, given --tag should match version of released VTK.

Pushing

This step will take local image and push to default docker registry. You need to make sure that you logged in docker cli (docker login) and you have rights to push to that registry.

# using docker
$ docker push kitware/vtk-wasm-sdk:v9.3.0

In case of pushing the most recent version, this version should be also tagged as latest and pushed.

# using docker cli
docker tag kitware/vtk-wasm-sdk:v9.3.0 kitware/vtk-wasm-sdk:latest
docker push kitware/vtk-wasm-sdk:latest