Publira
English
GitHub

Deployments

Published Updated

These pages are for the operator who deploys Publira. They describe what an install runs and what it depends on; how those parts are hosted — a Compose file, a Kubernetes cluster, a set of systemd units — is your choice.

In this section

  • Overview: the processes an install runs, the services they depend on, and the processes you can add.
  • Installing: bringing an empty install into service, from the services it depends on to the first sign-in to the tenant console.
  • Docker Compose: running a whole install on one host with the Compose file in the repository.
  • Edge: what the load balancer, proxy, or CDN in front of an install has to do, and what to change on it when a tenant is added.
    • Sample configurations: the sample Traefik, nginx, and Caddy configurations in the repository that do it, and how to adapt one to an install.
  • Kubernetes: running an install on a Kubernetes cluster, from its Secrets, Jobs, and Deployments to the first sign-in.
    • The edge on Kubernetes: a Gateway or an Ingress in front of the Services, with cert-manager issuing the certificates.
    • Operating on Kubernetes: adding a tenant, keeping the consoles' credentials off the tenants' domains, metrics, and upgrading.
  • Amazon ECS on Fargate: running an install as ECS services on Fargate, from its parameters, one-off tasks, and services behind an Application Load Balancer to the first sign-in.
  • Upgrading: bringing a running install to a new release, and what to do when a migration fails.
  • Backup and restore: what an install keeps, backing it up, and bringing it back on empty services.
  • Releases: what a 0.x version number tells you, what a minor and a patch release may change, and which releases receive fixes.

Start from Getting started if you have not read what Publira is.