From e05466ac79d7f60540168f397b1ba3b78e1179f4 Mon Sep 17 00:00:00 2001
From: CORDEL Yannick <yannick.cordel@univ-lorraine.fr>
Date: Thu, 15 Apr 2021 14:19:03 +0200
Subject: [PATCH] Add readme.md

---
 readme.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..38feac0
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,28 @@
+# Omeka-S Docker Image
+## What is Omeka?
+
+Omeka provides open-source web publishing platforms for sharing digital collections and creating media-rich online exhibits.
+
+## How to use this image?
+
+This image has no database included.
+
+### Environment variables
+You can adjust the configuration of the Omeka S instane by passing variables on the `docker run` command line.
+
+`OMEKA_DB`
+This variable is mandatory and allows you to specify the name of the database for Omeka.
+
+`OMEKA_USER`, `OMEKA_PWD` 
+These variables are mandatory and specify the user who has the permissions on the database.
+
+`OMEKA_HOST`
+This variable is mandatory and specify the host for the database.
+
+## Docker Compose
+
+There is also an example of docker-compose.yml file which can be used.
+It creates 3 containers :
+- Mariadb database
+- PhpMyAdmin
+- Omeka-s without modules or themes 
-- 
GitLab