Skip to content
Snippets Groups Projects
Verified Commit 3d67f2c6 authored by David Beniamine's avatar David Beniamine
Browse files

Update documentation

parent 2d45d740
No related branches found
No related tags found
1 merge request!8Customize annotot endpoint and environment
## Mirador Video Annotation POC ## Mirador Video Annotation POC
### What is this repository
This is a [Mirador](https://projectmirador.org/) based application that provides video annotation edition features :
+ [x] Video rendering in mirador base on the work of [Tokyo university](https://github.com/2SC1815J/mirador)
+ [x] Annotation persistance using [annotot](https://github.com/PenguinParadigm/annotot)
+ [x] Manifest storage and persistance
+ [-] Annotation on video (currently only working on images)
+ [ ] Multi user and per-user workspace
### Requirements
+ [docker](https://docs.docker.com/)
+ [docker-compose](https://docs.docker.com/compose/install/)
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](https://docs.docker.com/compose/) first.
### Install ### Install
...@@ -9,18 +25,20 @@ You **MUST** set at least the `ANNOTOT_SECRET_KEY_BASE` to a random string, the ...@@ -9,18 +25,20 @@ You **MUST** set at least the `ANNOTOT_SECRET_KEY_BASE` to a random string, the
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. 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.
If sources files are modified, run `docker-compose up -d --build` to update 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 ### Production
For production, one **also** need to setup : For production, one **also** need to setup :
+ `COMPOSE_FILE` should be at least `docker-compose.yml:annotot.yml` + `COMPOSE_FILE` should be at least `docker-compose.yml`
+ `ANNOTOT_ENV` should be `production` + `ANNOTOT_ENV` should be `production`
+ `ANNOTOT_HOST` should be the public hostname of your annotot server + `ANNOTOT_HOST` should 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). 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 #### Traefik
We provide a `traefik.yml` file to use behind [traefik](https://traefik.io/https://traefik.io/) this file does the following assumptions : We provide a `traefik.yml` file to use behind [traefik](https://traefik.io/https://traefik.io/) this file does the following assumptions :
...@@ -28,12 +46,3 @@ We provide a `traefik.yml` file to use behind [traefik](https://traefik.io/https ...@@ -28,12 +46,3 @@ We provide a `traefik.yml` file to use behind [traefik](https://traefik.io/https
+ A traefik container exists and is running in an external docker network called `traefik` + A traefik container exists and is running in an external docker network called `traefik`
+ Traefik has a tls resolver called `myresolver` + Traefik has a tls resolver called `myresolver`
+ Traefik has a middleware called `hardening@docker` that adds the usual security headers + Traefik has a middleware called `hardening@docker` that adds the usual security headers
#### Developpement
Follow the previous instructions if you want to access ressources from `$HTTP_FOLDER` via HTTP in the devserver.
Edit `.env` (copy it from `.env.template` if needed), set `COMPOSE_FILE=docker-compose.yml:devserver.yml` and adapt `DEV_*` variables to your needs.
Run `docker-compose up -d --build devserver`, 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment