diff --git a/.env.template b/.env.template index c4b0b2598328c2b78bf1688083a5345386608f15..dea774d3092bfa2afbef908eaad4577b241c4f49 100644 --- a/.env.template +++ b/.env.template @@ -1,4 +1,7 @@ # host port -PORT= +PORT=8080 # container restart policy -RESTART= +RESTART=unless-stopped +# HTTP folder, will be served at http://localhost:$PORT/data +# use absolute path or relative path starting with ./ +HTTP_FOLDER=./www diff --git a/.gitignore b/.gitignore index 512d934a3627d622119f5beb1d27a854507c3aea..342adbe992850ff70bffaaafbdd198138aa5e144 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +www/ .env node_modules/ dist/ diff --git a/README.md b/README.md index d78d52eddba2ef91042c98e7eae0578930c32341..cedf460ce67265e7f12a7ce45483dbdf2802644b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ ## Mirador Video Annotation POC -Run `docker-compose up -d`, which will serve a mirador instance to `http://localhost:8080`. If sources files are modified, run `docker-compose up -d --build` +Copy `.env.template` to `.env` and change variables to suit your need (you can skip the edit step) + +Run `docker-compose up -d`, which will serve a mirador instance at `http://localhost:$PORT` (default port is 8080). + +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 diff --git a/docker-compose.yml b/docker-compose.yml index 019b574ad1ef8770bf8a680f397c372fa722891c..5c7b261988e82552f59d3f620b308ae8ffc49fd9 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,4 +6,5 @@ services: ports: - $PORT:80 volumes: + - $HTTP_FOLDER:/srv/data - ./Caddyfile:/etc/caddy/Caddyfile