Skip to main content
This documentation is for API Self-Hosted Version 2 (Legacy)Version 2 is a legacy deployment model. All new customers must use Version 3, which features a modern multi-container architecture with improved security and performance.👉 Get started with API Self-Hosted v3

​
System requirements

PLEASE NOTE: Draftable API Self-Hosted v3 supports horizontal scaling on AWS EKS (Elastic Kubernetes Service) with S3 storage, which is our documented and tested reference deployment. See the AWS EKS Deployment Guide for details. Other container platforms such as AWS ECS (including Fargate) can also run API Self-Hosted v3 using the same S3 storage plus managed backing services (Amazon RDS, ElastiCache, and Amazon MQ), although they are not covered by a dedicated deployment guide. Azure AKS is not currently supported due to a storage compatibility limitation.
  1. Processor speed is often not a reliable indicator of performance, however any processor manufactured from 2014 on-wards with sufficient cores should meet performance requirements. For development and testing scenarios the processor and memory requirements may be reduced to 2 core and 2GB.
  2. For testing or low use purposes 10 GB of storage should be sufficient, however please perform your own testing to see how much storage space is required for your instance use case.
  3. Storage requirements are primarily dictated by the volume of comparisons to be processed by the appliance. As a general indicator, required storage should be calculated as ~5x the size of the documents submitted for a given comparison. However, the only truly reliable indicator for storage requirements is to submit a representative set of comparisons for your usage scenario.
  4. This configuration is only recommended for testing and development purposes and production environments.
  5. Supported refers to a Linux kernel under active support by the distribution vendor. The kernel must have the requisite support for Docker functionality. In addition, support for cgroups is strongly recommended as the Docker container can take advantage of this functionality for improved application stability and reliability.
  6. Root permissions are required in order for the Self Hosted container to be provisioned correctly, without root permissions the container setup will failover during this provisioning process. We currently do not offer or support a ‘rootless’ design.