bowerta/xeokit-bim-docker repository overview

⁠xeokit-bim-docker

This is a version of xeokit-bim-viewer which launches from a Docker container.

It is based on the Apache docker image httpd2.

This version of xeikit-bim-viewer is compatible with .xkt files converted from IFC4x2.

Files can be converted from .ifc to .xkt using the xeokit-converter⁠ image

⁠Usage

Example docker-compose file

version: '3.7'
services:
  xeokit-viewer:
    image: bowerta/xeokit-bim-docker
    ports:
      - "8080:80"

xeokit-bim-viewer should be available at http://localhost:8080/app⁠

To navigate to a project the project name must be entered as an argument for projectId, for example http://localhost:8080/app/index.html?projectId=Duplex⁠

⁠Project directory

Project files (.xkt and .json) are stored in the following directory in the container.

/usr/local/apache2/htdocs/app/data/projects

This directory can be copied from the container to the host using the command:

docker cp <container_id>:/usr/local/apache2/htdocs/app/data/projects ./projects

The volume can then be mounted in the compose file:

version: '3.7'
services:
  xeokit-viewer:
    image: bowerta/xeokit-bim-docker
    ports:
      - "8080:80"
    volumes:
      - "./projects:/usr/local/apache2/htdocs/app/data/projects"

When adding a new project, ensure that the directory structure is the same as the example projects:

projects
    index.json
    project_name
        index.json
        models
            design
                geometry.xkt
                metadata.json

Update the index.json file at the top of the projects directory with the filename to enable xeokit-bim-viewer to pick up the url for the new project model(s).

For more complex models with MVDs, models can be split over different domains, see the WestRiversideHospital example project.