Self-hosting Apidog
  1. Introduction
Self-hosting Apidog
  • Overview
  • Introduction
    • Obtaining Apidog On-Premises License
    • System Requirements
    • Data Privacy & Compliance
  • Deployment
    • Running Apidog on Docker
    • Running Apidog on Kubernetes
    • Running Apidog Multi-Container Deployment without Kubernetes
  • Post Deployment
    • Accessing Apidog Admin Panel
    • Accessing Apidog Web Interface
    • Installing Apidog On-Premises Client
  • Configurations
    • Environment Variables
    • Database Configuration
    • Storage Services Configuration
    • Git Connection Configuration
    • Authentication Providers
      • Using LDAP for Authentication
      • Using OKTA for Authentication
      • Using OAuth2.0 for Authentication
  • Maintenance & Upgrades
    • Updating Apidog
    • Backing up Apidog
    • License Renewal
    • System Design Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Introduction

System Requirements

To ensure optimal performance and smooth operations, please review the following hardware and software requirements for deploying Apidog. These guidelines will help prepare the necessary infrastructure for a seamless experience.
The system requirements are as follows:

Hardware Requirements#

HardwareRecommendedMinimum
Operating SystemUnix-based systems (such as Ubuntu, Debian, etc). Window may also work with Docker desktop installed
RAM8GB4GB
CPU4 cores2 cores
Storage100GB30GB
ComponentRecommended ConfigurationQuantityTarget Deployment
Apidog4 cores, 8GB RAM, 100GB disk1Core application server
Database & Cache4 cores, 8GB RAM, 100GB disk1MySQL >= 8.0.17, Redis >= 6.0.5

Software Requirements#

The software requirements vary depending on your deployment method. Please follow respective instructions for your deployment.

For Docker Deployment#

Docker:
Minimum supported version: 20.10.0
Recommended version:newer version highly recommended
Version verification:docker --version
Installation instructions: Official Docker documentation

For Kubernetes Deployment#

Kubernetes:
Minimum supported version:1.19
Recommended version:newer version highly recommended
Version verification:kubectl version
Helm:
Minimium supported version:3.0.0
Recommended version:newer version highly recommended
Version verification:helm version

Database Requirements#

Database: MySQL version 8.0.17 or higher is required.

Cache Requirements#

Redis: Redis version 6.0.5 or higher is required.
Database and Caching Services
MySQL and Redis can either be deployed as self-hosted instances or as a managed cloud services. Supported managed cloud services includes, but not limited to:
MySQL
Azure Database for MySQL
AWS RDS for MySQL
Google Cloud SQL for MySQL
Redis
Azure Cache for Redis
AWS ElasticCache for Redis
Google Cloud Memorystore
Modified at 2025-12-08 05:03:55
Previous
Obtaining Apidog On-Premises License
Next
Data Privacy & Compliance
Built with