Panoptes is a multi-tenant dataset browser and search tool. This repository contains the back-end code.

• Introduction
• Quick start
  • Installation
  • Usage
• Documentation
• Support & Roadmap
• Changelog
• Contributing
• Frequently Asked Questions

The Panoptes back-end is an API for searching through Elasticsearch indices and retrieving detailed information about specific records using configurable data sources (so far the only supported option is the Clariah CMDI editor API, but more will be added in the future).

The API is made using FastAPI, dataset configuration is done in a Mongo database.

This software is not released yet. Container images will be available here on GitHub. In order to use the latest version, you can build the container image yourself. There is a Docker Bake configuration file. In order to set the name of the image, crate your own docker-bake.override.hcl file to set two variables:

IMAGE = "some-registry.com/your-image-name"
TAG = "beta-1"

And then build

docker buildx bake

As this is a multi-tenant service, you should configure the domain names belonging to the tenants in the database configuration. Then, it's possible to add multiple datasets per tenant, pointing it to the correct

Database configuration is still a work in progress and subject to change. For the current status and what to configure, see the wiki.

The API is specified in the OpenAPI specification. A compiled version using Redoc will be hosted as well.

If you run into a problem, please report it by creating an issue on this repository.

Changes should be logged in the changelog using the keep a changelog specification. The changelog can be found here.

None yet!