Requirements

Check these before you begin Installation. For what actually gets deployed, see Architecture.

​

Hardware

1. At least 2GB of memory
2. At least 30GB of disk space for container images and application data

​

Software

1. Any operating system that can run Docker. We have tested on Ubuntu 22.04LTS
2. Docker
   • Install the latest versions of Docker engine and docker-compose. Installation instructions are at https://docs.docker.com/desktop/setup/install/linux/
   • Docker compose is also required. By default it comes with Docker desktop. If it is not installed check the documentation at https://docs.docker.com/compose/install.
   • We have tested our deployment with versions 27.4.0 and onwards

​

Prerequisites

1. The tarball containing the Cymph installation script
2. TLS certificates. The installation hosts Cymph on a secure (HTTPS) website, so the certificate and key must be available on the host machine before you install — see TLS certificates.
3. A license file, provided by the Cymph team. The license is uploaded after installation — see Licensing.
4. Network access for any integrations you plan to use — see Networking.