Thumbnails

  • The admin documentation for this service contains the full service description, configuration, and administration details. The content there is valid for both administrators and developers.

  • Anything that is relevant only for developers is described on this page.

Developer Readme

Here you can find the developer README.md for this service on the master branch. Please note that the README is intended for developers and may differ from the description in the admin documentation. Admin Docs provides information that has had specific, developer-only information removed, but it may contain additional administrative or configuration notes relevant to this service.

Developer Topics

Using libvips for Thumbnail Generation

To improve performance and support a wider range of image formats, the thumbnails service can use the libvips library. Support must be enabled at build time and has the following implications:

  • With libvips support enabled, it is not possible to create a statically linked oCIS binary.

  • The libvips shared libraries must be available at runtime in the same release used to build the oCIS binary.

  • When using the oCIS Docker images, the libvips shared libraries are included in the image.

libvips support is disabled by default. To enable it, install libvips and its build-time dependencies first. On macOS:

brew install vips pkg-config
export PKG_CONFIG_PATH="/usr/local/opt/libffi/lib/pkgconfig"

Then build with the ENABLE_VIPS variable:

make -C ocis build ENABLE_VIPS=1

Or pass the build tag directly:

go build -tags enable_vips -o bin/ocis ./cmd/ocis

When building a Docker image using the Dockerfile in the top-level oCIS directory, libvips support is enabled automatically and the shared libraries are included in the resulting image.