Skip to content

Kompakkt/Kompressor

Repository files navigation

Kompressor

ElysiaJS based server for pre-processing:

Quick Start

Build the dockerfile, e.g.:

docker buildx build -t kompressor -f Dockerfile .

Run:

docker run -it --rm --name kompressor --publish 7999:7999 -v /path/to/files:/app/uploads kompressor:latest

API

The server has the following endpoints:

/
Healthcheck. Returns { status: 'OK' } if the server is running

/process/:type/:id
Queue processing for files based on type (cloud, model, splat, ifc) and id.
Looks for files in "/app/uploads/:type/:id", processes them, and outputs processed files into "/app/uploads/:type/:id/out".

/progress/:id
Poll progress for id

/queue
Returns all entries that are either queued or processing.

Type is one of 'model', 'cloud', 'splat' or 'ifc'.

Id is the name of the directory containing the files to be processed.

File Structure

The server inside the docker container expects the following file structure:

/app/uploads/model for directories containing OBJ files to be processed.

/app/uploads/cloud for directories containing LAS/LAZ files to be processed.

/app/uploads/splat for directories containing PLY/SPLAT/SPX files to be processed.

/app/uploads/ifc for directories containing IFC files to be processed.

Outputs will be placed into /app/uploads/[type]/[id]/out.

About

A pre-processing server for managing multimedia file optimizations

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages