Home

Welcome to the overview-server wiki!

For user documentation, please see the Overview blog

Running Overview on your own computer

• Installing and Running Overview
• Configuration
• Uploading documents from the command line
• Handling huge document sets

Developing

• Setting up a development environment
• Developing and deploying converters
• Testing
• Writing Plugins
  • Overview API Overview
  • Developing your first Overview Plugin
  • Writing a Plugin
  • Ideal Plugin Development Environment
  • Accessing the main page from a Plugin
  • Overview API reference
  • Plugins on Docker Hub
  • Deploying Plugins on ECS and to overview-local
  • List of Overview Plugin projects
• Adding a document language
• Git Workflow
• Incantations -- command line recipes and SQL queries

Deploying Overview

Most deployments are though the Dockerized overview-local.

• Installing and Running Overview
• How to update overview-local container images after making changes to the source in overview-server.
• Deployment Tagging Policy
• Backup Strategies

Some other useful things you may want to do

• Reindexing documents
• Configuring a reverse proxy server

We also have a legacy AWS deployment system based on a series of scripts. You almost certainly will not use this.

• Deploying and releasing -- everyday commands
• Deploying from scratch to Amazon
• Managing Overview on Amazon
• How we set up continuous integration on Jenkins
• Creating staging instances on Amazon
• Viewing logs

Design documents

• Architecture Overview
• Document Lists and Where They're Stored
• Search Engine Internals
• Ingesting:
  • Ingest Pipeline
  • (old, but not yet deleted) Document Processing Pipelines
• Glossary
• Internationalization (also known as "i18n")
• Plugins
  • Plugin FAQ