Skip to content

Latest commit

 

History

History
120 lines (74 loc) · 2.69 KB

README.md

File metadata and controls

120 lines (74 loc) · 2.69 KB

tests project is maintained

ddev-apache-tika

Introduction

ddev-apache-tika is an un-official implementation of Apache Tika service for DDEV based on their Docker guide*.

From your DDEV project, install this by running ddev get ssmarco/ddev-apache-tika followed by ddev restart.

Getting started

  1. In the DDEV project directory launch the command:
ddev get ssmarco/ddev-apache-tika
  1. Restart the DDEV instance:
ddev restart
  1. Get the URL of the Kibana dashboard (e.g. https://your-project-name.ddev.site:5602):
ddev describe

Configuring your framework

Silverstripe

  1. Update your project's .env file. The API keys are found in the Enterprise Search section of Kibana dashboard.
SS_TIKA_ENDPOINT="http://tika:9998"
  1. The Apache Tika endpoint is http://tika:9998

  2. The following modules are tested to work out of the box in your composer.json file:

"silverstripe/silverstripe-textextraction": "^4"

Troubleshooting

  1. Make sure all required containers are downloaded
docker pull apache/tika:latest
  1. Remove container volumes to restart from scratch

List all existing volumes from your system:

docker volume ls

This will show example output below:

DRIVER    VOLUME NAME
local     ddev-your-project-name_tika

Delete the volumes by running:

docker volume rm ddev-your-project-name_tika
  1. Restart by ddev restart

  2. Check the status of the project by ddev status

  3. Check the logs

ddev logs -s tika
  1. Check job health

You might need to install jq for better legibility of the output.

docker inspect --format "{{json .State.Health }}" ddev-your-project-name-tika | jq
  1. Check memory consumptions
docker stats

Warning

This is for local development purposes only. Testing large amount of data depends on the host computer's resources.

If you have a good amount of CPU's and memory, you can increase the value of mem_limit for each container or remove this attribute to assign more resources as needed.

Contribute

Maintainer