docs

Table Of Contents

(Do NOT edit manually. Generated using generate-toc.sh)

About

• Vision
• Structure

Setup

• Software dependencies
• AWS dependencies
• Configuring setup.sh
• Running setup

Running

• Running locally
• Kahuna
• Accessing logs

Apis

• Authentication
• Collections

Troubleshooting

• NGINX
• SBT
• Authentication
• GRID services and SSL

Migration

• Migration
• How to run a migration

Objects of interest

• Config
• TIFF files

Extending

• Extending the Grid using providers
• Image Processor provider pipelines
• Authentication and authorisation providers
• Usage rights provider
• Extending image metadata

Archives

• DEV Cloudformation Setup
• DEV Setup
• Configuration
• Running services
• Grid API
• Authentication
• Upload Image Directly
• Start Thrall
• Media API
• Logging
• Image reingestion
• Troubleshooting
• Migration to Elasticsearch 6
• Migration to Elasticsearch 7
• Local kinesis

---

META: How to create a new documentation file

Documentation conventions

• Find the correct subdirectory your new documentation file belongs to.
• Every documentation file should be markdown (with .md extension).
• First line of every documentation file should contain its title (used to generated the table of content).
• Store all the images in an /images subfolder in the same directory the document referencing them will be.