Configuring an attachment indexer

If you wish to index the contents of the attachments for your instance, you can optionally choose to configure an external indexing service such as Apache Tika to do this.

GUI

Navigate to your instances ElasticSearch page and click 'Edit Parameters' on the Connection card. On the next page in the 'URL' field of the Attachment Indexing Connection card, enter the name of the URL of the external indexing service you are using - this will likely be the IP/hostname and port of your Apache Tika service. Clicking 'Save Changes' will then update your instance configuration to use this service for indexing all new attachments. If you also need to index pre-existing attachments, you will need to perform a full reindex of your instance.

CLI

To configure an external attachment indexer on the command line you run the following command:

opc inst -i <instance> config set --es-attachment-indexing-url <external_indexing_service_url>
 copy

Running the command will reconfigure the instance and perform a reindex of all attachments.

Set configuration parameters
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✅  Updated Elasticsearch parameters configuration successfully

Write instance config
✅  Wrote instance config file
    └ Path: /opt/deskpro/data/instances/helpdesk/config.yml

Write Deskpro config
✅  Wrote Deskpro config file
    └ Path: /opt/deskpro/data/instances/helpdesk/services/deskpro/config/deskpro-config.php

Re-indexing instance
✅  Re-indexed instance successfully

Done
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
All tasks have completed.

Name                     | helpdesk
UUID                     | 18dddf97-ce11-4846-a326-27b6e554e9c8
Data Path                | /opt/deskpro/data/instances/helpdesk
DB Host                  | localhost:3306
DB User                  | helpdesk
DB Name                  | helpdesk
Elastic Host             | http://localhost:9200
Elastic TenantID         | dp_helpdesk_tenant
Reserved Container Ports | Web: 35297
 copy

Deploying Apache Tika directly via the OPC

To assist with indexing attachments, the OPC offers a simple method of deploying a containerized version of Apache Tika using the official docker image. To deploy this service, select the 'Addons' from the side menu in the OPC You can then select the 'Deploy' button on the Apache Tika card to deploy the service as a docker container. Once deployment is complete, you will see the service deployed and can click on the item to view it's configuration and make any adjustments you require. By default, the service is deployed into the private docker network used by Deskpro so no external connections are required. The service URL that you can use to configure your instance is provided on the addon service page for convenience.