Skip to main content
tiCrypt 2.17.11

Deploy & Operate

System AdministratorRequires: Shell access to the tiCrypt backend hosts

Deploy & Operate enables you to install the tiCrypt backend, configure the services it is composed of, and keep the deployment healthy. It covers the layer beneath the application: the hosts, the microservices, the mail path, and the TLS termination that everything else depends on.

This is the only part of the documentation that assumes shell access to the servers. Everything a researcher or an administrator does happens through the browser; everything here happens through the operating system.

Deploy & Operate contains the following functionality​

  • Components: every package in the tiCrypt repository, what it does, and how to install it.
  • Architecture: an interactive map of a deployment and how its parts reach each other.
  • Network: the three VLANs, the bridges that carry them across hosts, and the single exit point.
  • Installation: prepare the environment, then deploy the backend with the Ansible-based installer.
  • Backend Services: the architecture of the backend microservices and the full configuration reference for each.
  • Operations: monitor system services, manage API keys, configure external SFTP servers, and run the offline Python package mirror.
  • Inboxes: let outside senders deliver files into a user's Vault, through a browser link or over SFTP.
  • NGINX & TLS: reference configuration and TLS verification for the reverse proxy.

Standing up a new deployment​

StepActionGuide
1Prepare the environment: hardware, operating system, network, DNS, and TLSPre-Installation Checklist
2Install the backend with the Ansible installerInstall Guide
3Configure the services: review every service's settings against the referenceConfiguration
4Terminate TLS: put NGINX in front and verify the certificate chainNGINX & TLS
5Prepare VM images so researchers have something to bootBuilding VM Images
6Configure governance: settings, teams, profiles, and escrowGovernance
7Deploy audit if you need retained evidenceAudit Service

Deep dives​

These articles explore the infrastructure architecture underlying the components you deploy.