Mirador Video Annotation POC
What is this repository
This is a Mirador based application that provides video annotation edition features :
- Video rendering in mirador base on the work of Tokyo university
- Annotation persistance using annotot
- Manifest storage and persistance
- [-] Annotation on video (currently only working on images)
- Multi user and per-user workspace
Requirements
This readme assumes that you now a few basic about docker and docker-compose, if you are not familliar with docker-compose we recommand to read the documentation first.
Install
Copy .env.template to .env and change variables to suit your need.
You MUST set at least the ANNOTOT_SECRET_KEY_BASE to a random string, the rest is preconfigured for a local development environment.
The $HTTP_FOLDER (./www by default) directory will be accessible via HTTP at http://localhost:$PORT/data and can be used to store manifests and theirs ressources and see them in Mirador.
Run docker-compose up -d, which will serve a mirador instance at http://localhost:$DEV_PORT (default port is 9000) with live rebuild/reload enabled on each src/ and public/ files modifications.
Production
For production, one also need to setup :
-
COMPOSE_FILEshould be at leastdocker-compose.yml -
ANNOTOT_ENVshould beproduction -
ANNOTOT_HOSTshould be the public hostname of your annotot server
Run docker-compose up -d, which will serve a mirador instance at http://localhost:$PORT (default port is 8080).
If sources files are modified, run docker-compose up -d --build to update Mirador
Traefik
We provide a traefik.yml file to use behind traefik this file does the following assumptions :
- A traefik container exists and is running in an external docker network called
traefik - Traefik has a tls resolver called
myresolver - Traefik has a middleware called
hardening@dockerthat adds the usual security headers