Self Hosted Server Installation Requirements

Server Installation Requirements

Setting up the server is a critical first step in any KYP.ai implementation. Before starting, decide whether to proceed with a cloud-based or on-premise setup:

• Cloud servers are deployed and maintained by KYP.ai or an authorized partner.

• On-premise servers are installed and maintained by your internal IT team.

All system components run in Docker containers on a single machine. The specs below apply to virtualized environments. For physical (bare metal) setups, contact KYP.ai for tailored requirements.

Infrastructure Requirements

💡 Key Notes:

• The setup assumes server virtualization.

• Resource needs to depend on data volume, number of users, and enabled features.

• For environments with 1000+ users, consult the KYP.ai Team.
  

🖥️ Configuration for OPS Monitoring (No Screenshot Processing)

📸 Configuration for Process Discovery / PoC (With Screenshot Processing)

* Fast, attached disk as the additional partition. File system: ext4 or xfs with ftype=1 (d_type support enabled).

** Storage calculated based on: 30 days screenshots retention, 20% usage of screenshot apps and a 12 month contract.

☁️ Public Cloud – Recommended Instance Types

The following tables provide cloud instance recommendations for different user ranges and use cases. Prices may vary depending on region and provider.

🔧 Operations Steering (Excluding Screenshot Processing)

📸 Process Discovery (Including Screenshot Processing)

Network Requirements

🔓 Required Open Ports

• 80 – Redirects to 443

• 443 – Data transfer and frontend access (HTTPS)

• 22 – SSH access for maintenance

🌐 External Access

• Allow traffic to:

  • CentOS repositories

  • Docker Hub (https://download.docker.com)

  • *.kyp.ai for installation & monitoring

• Customer workstations → Server on port 443

• Register DNS entry for the server and workstations

• Generate Valid SSL certificate for the server domain name (FQDN) and provide to KYP.ai

• HTTPS traffic cannot be filtered for specific phrases or conditions

• Minimum bandwidth: 2 Mb/s per 50 users

• OPTIONAL: If Concierge extension is enabled with Open AI LLM, then outbound traffic on port 443 is required for Concierge to work https://api.openai.com/v1

🔄 Optional Network Configurations

• In case of Load Balancer usage:

  • Register DNS entry for the load balancer

  • SSL certificate generated for the load balancer in desired domain added to trusted certificates store

  • Load Balancer traffic on port 443 should be redirected to the server on port 80

• Data collection monitoring outbound communication port to email server on port 587/465

• LDAP/Active Directory communication to LDAP server on port 389/636

• SSO (Azure AD):

  • Access https://login.microsoftonline.com and https://graph.microsoft.com
    

Average daily traffic received for one user

If you want to check the average daily traffic generated by a single user, please refer to this article.

Backup Policy

Valuable data and configurations are encouraged to be backed up regularly of KYP.ai databases. While backups may take up some disk storage space, it will save you from future data loss. Protect your precious assets and ensure peace of mind.

• Application backup is necessary to protect against data loss or corruption caused by hardware failure, software malfunction, cyber-attacks, or human error.

• Losing applications and their data can result in downtime, financial losses, and reputational damage.

• Regular backups allow businesses to recover quickly from disasters and minimize the impact of data loss.

• Application backups help ensure compliance with regulatory requirements and avoid fines and legal penalties.

• KYP.ai offers two methods for application backups: configuring backups in a specific directory or using customer-provided storage solutions like AWS S3.

• Customers must specify the backup frequency and retention period from KYP.ai settings.

• The best practice is to create automatic daily backups of the database and keep them stored for at least 7 days to enable easy restoration of functions in case of issues.
  

Software Requirements

🖥️ OS Compatibility

• Recommended: Ubuntu 20.04.5+

• Optional: RHEL 8.7+

🧰 Required Tools

KYP.ai packages are downloaded during installation from the official repository.

Access Requirements (Optional) - only if support is requested

• HTTPS for KYP.ai Support Team for troubleshooting and support.

• SSH (root) access for KYP.ai DevOps Team for installation and daily maintenance

• HTTPS access for KYP.ai Customer Success Team for configuration and data analysis.

• (Optional) Provision a Windows 11 VM for testing the KYP Connect App