Skip to content

Server Requirements

This document outlines the server specifications, software requirements, and firewall/network settings required for the deployment of our services. Please review these requirements carefully to ensure that your server environment is fully compatible.

Base System Requirements

serenity-docs-repo-structure

Operating System

Must run the latest Linux distribution from the list of supported platforms on the official Docker documentation. https://docs.docker.com/engine/install/#supported-platforms

Recommended: Latest Ubuntu LTS release.

Hardware

  • Memory: Minimum 16GB RAM (32GB recommended).
  • Disk Space: Minimum 200GB of storage.
    • Note: For scenarios involving large-scale processing of PDF, video, or audio files, storage requirements may increase or consider using additional object storage solutions (e.g., AWS S3).
  • CPU: Equivalent to or greater than AWS t3.xlarge (4+ vCPUs).

Software

Docker

Install the latest Docker version. (Ubuntu Installation Reference: https://docs.docker.com/engine/install/ubuntu/ )

A system user must be allocated with permissions to start/stop Docker containers. The setup should be validated by successfully executing: docker run hello-world

Firewall and Network Configuration

Outbound HTTPS Access

Ensure that the server is able to reach the following endpoints/domains over HTTPS:

SerenityGPT Service Endpoints:

infra.serenitygpt.com

    Purpose:

        Access our GPU service for document indexing (data remains encrypted in transit).         Sending telemetry metrics (CPU, RAM, DISK, Number of documents in database, Number of questions, Health checks) via HTTPS (No customer data is sent)

serenitygpt.openai.azure.com

    Purpose: Connect to our GPT-4o deployment hosted on Azure.

(Optional) translate.google.com

    Purpose: Enable when translation of user queries is needed.

Repository and Package Access

To facilitate the installation of libraries, software, and machine learning models, the server must be able to access the following domains:

  • *.docker.com
  • docker.com
  • *.docker.io
  • huggingface.co
  • *.hf.co

(Optional) for research or installation of custom/exotic data sources (Python packages):

  • pypi.org
  • *.pythonhosted.org

Remote access for setup assistance

We offer services to install and configure software within minutes. To achieve this we need a temporary SSH access: please allow SSH access from the IP address we will provide.

Additional Considerations

Security Updates & Patching: Regularly update the operating system and installed packages to ensure the environment remains secure.

Backup and Disaster Recovery:

Consider implementing routine backups and a disaster recovery plan, especially when handling critical data.

Monitoring and Logging:

Implement monitoring tools to track system performance, resource utilization, and security logs.

Please contact our technical team if you have any questions or need further clarifications regarding these requirements.