Basic Usage

Run locally

Production setup

To start the Text Repository without building any containers, start it as described in the production example. This docker-compose setup does not build images but downloads the images from docker hub.

Development setup

When you want to start developing or debugging, you can use the ‘dev’ setup, as found in examples/development. When starting, docker-compose will build all Text Repository images from scratch. When stopping, all containers, volumes and network are removed.

See examples/development/ for installation details.

Explore locally

After running the docker-compose setup, you can:

  • Find basic use cases in the integration test results
  • Add some test data: ./scripts/
  • Explore REST-API of Text Repository using swaggger
  • Search in full-text and autocomplete indices



If you run into this Elasticsearch warning:

max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]

you may have to:

sysctl -w vm.max_map_count=262144


If you run into this Elasticsearch error:

max file descriptors [4096] for elasticsearch process is too low, increase to at least [65535]

you may have to increase the ulimits.nofile of elasticsearch in your docker-compose.yml:

        soft: 65535
        hard: 262144