atasidou/multi-client_clusion repository overview

⁠Multi-Client Clusion server

This repository contains the docker image for the Multi-client extension⁠ of the Clusion⁠ open-source searchable encryption library. The library extension is bundled with a web application which demonstrates the functionality.

⁠Instructions

⁠Quick test

The fastest way to get started after pulling the image is by running a container and accessing the web server on the default port:

docker run --rm -p 27080:27080 atasidou/multi-client_clusion

Opening a web browser on localhost:27080⁠ should show the web interface. The image comes with a bundled sample dataset of 10000 documents of parking transaction records which are processed to become available for searching when the server is started.

⁠Advanced options

⁠Ports

To change the port where the web server is accessible, e.g. to port 8080, modify the parameter -p 27080:27080 to -p 8080:27080.

Within the container, the web server always listens on port 27080.

⁠Changing the used dataset

Every time the server starts up, it reads, parses and encrypts the files in the /MC-Clusion/gen-data folder. These files can have any name, but they must be text files. Each line in a document is parsed as a keyword, lines beginning with an exclamation mark ! are excluded.

The default dataset can be replaced by changing the contents of this folder. The easiest way to do this is to mount an external volume on top of the default folder.

As an example, using the command:

docker run --rm -p 27080:27080 -v /absolute-path/my-text-data-dir:/MC-Clusion/gen-data atasidou/multi-client_clusion

the server will read, parse and provide search functionality of the files in the /absolute-path/my-text-data-dir folder.

⁠State

The server maintains no state. Every time it is started, the dataset is re-loaded and processed.