Skip to content
Simple Image Presentation Interface
C++ Lua CMake C Python JavaScript Other
Branch: develop
Clone or download

README.md

Build Status

Overview

Sipi is a high-performance media server developed by the Digital Humanities Lab at the University of Basel. It is designed to be used by archives, libraries, and other institutions that need to preserve high-quality images while making them available online.

Sipi implements the International Image Interoperability Framework (IIIF), and efficiently converts between image formats, preserving metadata contained in image files. In particular, if images are stored in JPEG 2000 format, Sipi can convert them on the fly to formats that are commonly used on the Internet. Sipi offers a flexible framework for specifying authentication and authorization logic in Lua scripts, and supports restricted access to images, either by reducing image dimensions or by adding watermarks. It can easily be integrated with Knora.

Sipi is free software, released under the GNU Affero General Public License.

It is written in C++ and runs on Linux (including Debian, Ubuntu, and CentOS) and Mac OS X.

Freely distributable binary releases will be available soon.

Documentation

The manual is online at http://dhlab-basel.github.io/Sipi/.

To build it locally, you will need Sphinx. In the manual subdirectory of the source tree, type:

make html

You will then find the manual under manual/_build/html.

Building from source

All should be run from inside the root of the repository.

Build under macOS

$ (mkdir -p ./build-mac && cd build-mac && cmake .. && make && ctest --verbose)
OR
$ (mkdir -p ./build-mac && cd build-mac && cmake -G Ninja .. && ninja && ctest --verbose)

Build inside Docker using Clang/LLVM

$ docker run -it --rm -v $PWD:/sipi dhlabbasel/sipi-base:18.04 /bin/sh -c "mkdir -p /sipi/build-linux && cd /sipi/build-linux && cmake .. && make && ctest --verbose"
OR
$ docker run -it --rm -v $PWD:/sipi dhlabbasel/sipi-base:18.04 /bin/sh -c "mkdir -p /sipi/build-linux && cd /sipi/build-linux && cmake -G Ninja .. && ninja && ctest --verbose"

Build inside Docker using ccache

$ docker run -v $PWD:/sipi -v ~/ccache:/ccache -e CCACHE_DIR=/ccache dhlabbasel/sipi-base:18.04 /bin/sh -c "cd /sipi/build; cmake .. && make && ctest --verbose"
OR
$ docker run -v $PWD:/sipi -v ~/ccache:/ccache -e CCACHE_DIR=/ccache dhlabbasel/sipi-base:18.04 /bin/sh -c "cd /sipi/build; cmake -G Ninja .. && ninja && ctest --verbose"

Releases

Releases are published on Dockerhub: https://cloud.docker.com/u/dhlabbasel/repository/docker/dhlabbasel/sipi

Contact Information

Lukas Rosenthaler <lukas.rosenthaler@unibas.ch>

You can’t perform that action at this time.