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
...
...
@@ -8,22 +24,21 @@ Copy `.env.template` to `.env` and change variables to suit your need.
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_FILE` should be at least `docker-compose.yml`
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](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/) 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.
