Installing with Docker

Docker lets you run SpaceBuilder in an environment isolated from the host operating system. Make sure to mount the storage path to a host volume so that your data persists even if the container is recreated.


Before you begin

  • Permission to run Docker commands
  • Docker Desktop on Windows and macOS, Docker Engine on Linux
  • Sufficient disk space to store service data and files you'll upload in the future

Do I need to install separate libraries on the host?

No. When using Docker, the packages required for OCR and document conversion need to be installed inside the container image, not on the host. The host only needs Docker Engine or Docker Desktop.

You do not need to run a long apt-get install command like the following on the Docker host.

sudo apt-get install -y \
  tesseract-ocr poppler-utils mupdf-tools libreoffice pandoc \
  libtesseract-dev libleptonica-dev libvips-tools \
  libheif1 libheif-plugin-libde265 libwebp7 libjpeg8 \
  libpng16-16t64 libopenjp2-7 libtiff6

This list mixes runtime packages with development packages needed for building from source.

CategoryPackagesRequirement
Basic image processinglibvips, libvips-tools, libheif1, libheif-plugin-libde265, libglib2.0-0 runtime familyMust be included in the official image
OCRtesseract-ocr and required language packsRecommended when using local OCR features
PDF processingpoppler-utils, mupdf-toolsRecommended for PDF text extraction and OCR preprocessing
Office document conversionlibreoffice, pandocRecommended for document previews and format conversion
Building from sourcelibtesseract-dev, libleptonica-dev, other *-dev packagesNeeded only when building inside the container yourself

The official image should include the base runtime and recommended feature packages. Adding packages with apt-get after the container starts is not recommended, since recreating the container will discard anything installed manually.

Pulling the Docker image

Pull the SetFN SpaceBuilder Docker image.

docker pull setfn/space-builder:latest

Running the container

Run the SpaceBuilder container with the following command.

docker run -d \
  --name setfn-space-builder \
  -p 8510:8510 \
  -v /path/to/space-home:/space-home \
  setfn/space-builder:latest
OptionDescription
-dRun in the background
--nameSet the container name
-p 8510:8510Map host port 8510 to container port 8510
-v /path/to/space-home:/space-homeMount a host storage path into the container

Change /path/to/space-home to the actual absolute host path where you want to store your data. If you don't mount this path, your service data may be lost when the container is deleted.

If port 8510 is already in use on the host, you can change only the left-hand port. For example, if you run it with -p 8511:8510, the access address is http://localhost:8511.

Once the container is running, open http://localhost:8510 in your browser. When the initial setup screen appears, go to Initial Setup to configure the administrator account and service environment.