Use & workflow via Docker

Starting and stopping the server

To start the server and its containers, run:

docker-compose up

In your web browser, navigate to localhost:8080. You should see the ISCAN web page.

To stop the server, press Ctrl+C only once. The terminal should show a Gracefully stopping... message and then exit.

Mounted volumes

This Docker instance is configured so that the contents of certain directories persist between runs of the server, and so that contents are constant between the local directory and the directory in the container. These local directories, located in the root of the repository, are:

  • polyglot_source/ - the directory containing corpora to be loaded.
  • polyglot_data/ - the directory where corpus metadata will be stored
  • iscan/ - the directory where the front-end code is stored
  • iscan_server/ - the directory containing the Django project for the server

Changes you make locally in these folders should persist into the container without needing to re-build the Docker image.

Cleaning

The docker-compose up command usefully regenerates fresh containers each time it is run, but old containers can take up space. To clean up containers on your machine, first stop all of them:

docker stop $(docker ps -a -q)

Then, remove them:

docker rm $(docker ps -a -q)