diff --git a/README.md b/README.md index 31b29baae111164fed8415d5b8d15b147d58c683..0b220b2c91c26082d8b8be4a1af985a5158a7df0 100644 --- a/README.md +++ b/README.md @@ -19,16 +19,38 @@ This readme assumes that you now a few basic about `docker` and `docker-compose` ### Install -Clone the current git repository and cd inside. +Clone the current git repository and cd inside. : +``` +git clone gitlab@gitlab.tetras-libre.fr:iiif/POC-mirador.git +``` -Copy `.env.template` to `.env` and change variables to suit your need. +Copy example env file : +``` +cp .env.template .env +``` -You **MUST** set at least the `ANNOTOT_SECRET_KEY_BASE` to a random string, the rest is preconfigured for a local development environment. +Build project : +``` +docker-compose build +``` + +Run project (can be long) +``` +docker-compose up +``` + +Project will be available at `http://localhost:$DEV_PORT` (default port is 9000). -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. +Stop project +``` +docker-compose down +``` -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. +#### Notes for .env file + +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. ### Production