Install the Ellogon Annotation Platform
The Ellogon Annotation Platform is written in JavaScript using the Anguar Framework, and the Django Web Framework as its backend.
The code of the annotation tool is available at:
https://github.com/iit-Demokritos/clarin-el-annotation-tool
This installation guide is, also, available at Github.
How to deploy the Annotation tool through docker-compose/podman-compose
The Ellogon Web Annotation Tool can be deployed as a container. A container image is available at Docker Hub . The steps to deploy the container through docker-compose/podman-compose or similar tools, are:
- Clone this repository:
git clone --recurse-submodules https://github.com/iit-Demokritos/clarin-el-annotation-tool.git
- Change directory to clarin-el-annotation-tool/docker:
cd clarin-el-annotation-tool/docker
- Inside the
docker
folder, copy the fileenv-dist
toenv
:
cp env-dist env
- Edit file
env
to your needs, by adding passwords, the SMTP server, secret key, etc. Do not remove any variable definitions from it. - After the
env
file has been edited and saved, run the scriptrestart.sh
:
bash restart.sh
Running this script will perform the following actions:
- Check that the file
env
is available in thedocker
directory. - Read the variables defined in the
env
file in the shell. - Ensure that the variable
EMAIL_URL
has been defined in theenv
file. - Set the correct SELinux context in the folder.
- Generate the file
conf/env
, which will be used by the container. - It will run
podman-compose
/docker-compose
to start the containers. - It will wait for about 3 minutes.
- It will initialise the two databases, MariaDB and Mongo.
Last modified May 15, 2022: Getting started Documentation re-organisation (0fd08e4)