Operator manual¶

This manual is for people who deploy and run plintz. Deploy one plintz instance per company on a single host with Docker Compose. The Glossary defines the terms used on these pages.

Pages¶

Read these pages in order when you first deploy plintz. Return to a page when you need its instructions.

• Deploying plintz: what you need, the services and volumes of the stack, and its network.
• Configuring plintz: the secrets, the deployment config, Datasources, sign-in, Administrators and the Invalidation service token.
• Starting and stopping: starting the stack, what the backend does at startup, checking it and stopping it.
• Logs: where they are and what plintz logs.
• Indexing: when Stored Signal metadata is copied from a Datasource, and what to do when it fails.
• Cache invalidation: telling plintz that data changed in a Datasource, and the block cache's disk budget.

What this manual doesn't cover¶

plintz defines no procedure for backing up or restoring its data, or for upgrading it, so this manual gives none. Deploying plintz lists what each volume holds.

The Workbench itself is covered by the User Manual.