add example compose.yaml for running docker with example data
Change-Id: I8c3b1a8107b24459ea9181df237cd6e373583d07
diff --git a/README.md b/README.md
index e4d348e..a01e453 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
of measurements, dimension reduction procedures, visualizations etc., to track down detailed paradigmatic and syntagmatic relations
between words based on their use in very large corpora such as the German Reference Corpus DeReKo (Kupietz et al. 2010).
-## Installation
+## Installation from source
### Dependencies
@@ -24,7 +24,7 @@
make install
```
-Detailed and a known to work installation procedure can also be found in the [GitLab CI pipeline script](.gitlab-ci.yml).
+A detailed and known to work installation procedure can also be found in the [GitLab CI pipeline script](.gitlab-ci.yml).
Please note the `IDS::DeReKoVecs::Read` is not stable and not recommended to be used, yet.
@@ -34,13 +34,25 @@
## Run
-### Debugging mode
+### From prebuilt docker image
+
+```bash
+docker run -v ./example-models:/example-models:z -e MOJO_CONFIG=/example-models/example-docker.conf -p 3000:3000 idscorpuslinguistics/derekovecs
+```
+
+### From prebuilt docker image with docker compose
+
+```bash
+docker compose up
+```
+
+### From source in debug mode
```bash
MOJO_CONFIG=$(pwd)/example.conf morbo script/derekovecs-server
```
-### Production mode
+### From source in production mode
```bash
MOJO_CONFIG=$(pwd)/example.conf hypnotoad script/derekovecs-server
diff --git a/compose.yaml b/compose.yaml
new file mode 100644
index 0000000..8be99cf
--- /dev/null
+++ b/compose.yaml
@@ -0,0 +1,11 @@
+services:
+ derekovecs-test:
+ image: idscorpuslinguistics/derekovecs
+ container_name: derekovecs-test
+ ports:
+ - "3000:3000" # change first port according to your needs
+ volumes:
+ - ./example-models:/example-models:z
+ environment:
+ - MOJO_CONFIG=/example-models/example-docker.conf
+ restart: unless-stopped
diff --git a/example-models/example-docker.conf b/example-models/example-docker.conf
index eae5168..f26ab0a 100644
--- a/example-models/example-docker.conf
+++ b/example-models/example-docker.conf
@@ -17,8 +17,6 @@
# korap_url => "https://korap.ids-mannheim.de"
},
- downtime_calendar_url => "https://cloud.ids-mannheim.de/remote.php/dav/public-calendars/QfRCG4HriLcZJJRd?export",
-
# Piwik => {
# url => 'https://stats.ids-mannheim.de',
# token_auth => 'ad7609a669179c4ebca7c995342f7e12',