project is maintained

ddev-apache-tika

Introduction
Getting started
How to debug in Github Actions

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.

Docker guide*

Getting started

In the DDEV project directory:

For DDEV v1.23.5 or above run
```
 ddev add-on get ssmarco/ddev-apache-tika
```
For earlier versions of DDEV run
```
 ddev get ssmarco/ddev-apache-tika
```
Restart the DDEV instance:
```
 ddev restart
```
Get the URL of the Kibana dashboard (e.g. https://your-project-name.ddev.site:5602):
```
 ddev describe
```

Configuring your framework

Silverstripe

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"
```
The Apache Tika endpoint is http://tika:9998
The following modules are tested to work out of the box in your composer.json file:
```
 "silverstripe/silverstripe-textextraction": "^4"
```

Troubleshooting

Make sure all required containers are downloaded
```
 docker pull apache/tika:latest
```
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
```
Restart by ddev restart
Check the status of the project by ddev status
Check the logs
```
 ddev logs -s tika
```
Check job health

You might need to install jq for better legibility of the output.
```
 docker inspect --format "" ddev-your-project-name-tika | jq
```
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

Anyone is welcome to submit a PR to this repo. See README.md at https://github.com/ddev/ddev-addon-template, the parent of this repo.

Maintainer

Contributed and maintained by Marco Hermo.