Skip to content
Snippets Groups Projects
Select Git revision
  • main default
  • publisher
  • online-demo
3 results

dzkimgs_cats2020_local

  • Clone with SSH
  • Clone with HTTPS
    • Name Last commit Last update
    ..
    public
    src
    .dockerignore
    .env.template
    .gitignore
    .gitmodules
    Caddyfile
    Dockerfile
    Dockerfile.devserver
    README.md
    devserver.yml
    docker-compose.yml
    package-lock.json
    package.json
    webpack.config.js
    README.md

    Mirador Video Annotation POC

    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.

    If sources files are modified, run docker-compose up -d --build to update Mirador

    Production

    For production, one also need to setup :

    • COMPOSE_FILE should be at least docker-compose.yml:annotot.yml
    • ANNOTOT_ENV should be production
    • 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).

    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@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.