Add initial readme
1 file changed
tree: e66f8928b076be05448cbb20c868c9507c4ea47a
  1. .gitignore
  2. README.md
  3. Vagrantfile
README.md

KorAP-Vagrant

A Vagrantfile for the KorAP Corpus Analysis Platform

Description

A Vagrantfile provides all that is required to run KorAP in a virtual machine.

Setup

As a prerequisite, you will need Vagrant and VirtualBox.

To initially create the KorAP VM run

$ git clone https://github.com/KorAP/KorAP-Vagrant
$ cd KorAP-Vagrant
$ vagrant up

This will eventually download the VM image, start the VM and initialize the provision. Please be patient - the first provision will take quite some time.

Afterwards you will have the KorAP user-interface available at http://localhost:5555 on your machine. The KorAP API will be available at http://localhost:5556. An example corpus as provided by Kustvakt will be available as well.

To update the software, simply run

$ git pull origin master
$ vagrant provision

To stop the service, run

$ vagrant halt

To log into the machine, run

$ vagrant ssh

Development and License

Copyright (c) 2018, IDS Mannheim, Germany

KorAP-Vagrant is developed as part of the KorAP Corpus Analysis Platform at the Institute for German Language (IDS), funded by the Leibniz-Gemeinschaft.

KorAP-Vagrant is published under the BSD-2 License.