Self-hosting Apidog
  1. Introduction
Self-hosting Apidog
  • Introduction
    • Installation Overview
    • System Requirements
  • Licensing
    • Obtaining Apidog On-premises License
  • Deployment
    • Running Apidog on Docker
    • Running Apidog on Kubernetes
    • Running Apidog Multi-Container Deployment without Kubernetes
    • Privacy
  • Initial Setup
    • Admin Panel
    • Installing Apidog Client
    • Access Apidog Web
  • Configuration
    • Environment Variables
    • Configuring the application database
    • Configuring the application storage service
    • Configuring the git connection environment
    • 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 Data Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Introduction

System Requirements

Apidog On-Premises supports several deployment options:
1.
Running Apidog on Docker
2.
Running Apidog on Kubernetes
3.
Running Apidog Multi-Container Deployment without Kubernetes
The system requirements are as follows:

Hardware#

OS: A Unix-based operating system is preferred (such as Ubuntu, Debian, etc.), although Windows may also work with Docker Desktop installed.
RAM: Preferably 8GB, with a minimum of 4GB.
CPU: Preferably 4 cores, with a minimum of 2 cores.
Storage: Preferred 100GB, at least 30GB.
Recommended ConfigurationQuantityTarget Deployment Component
4 cores, 8GB RAM, 100GB disk1Apidog Server
4 cores, 8GB RAM, 100GB disk1MySQL database (>= 8.0.17), Redis (>= 6.0.5)
Note: The MySQL database and Redis components can be deployed either as self-hosted instances or as managed cloud services. Supported managed services include:
MySQL: Azure Database for MySQL, AWS RDS for MySQL, Google Cloud SQL for MySQL, and other managed MySQL services
Redis: Azure Cache for Redis, AWS ElastiCache for Redis, Google Cloud Memorystore, and other managed Redis services

Software Requirements#

The software requirements depend on your chosen deployment method:

For Docker Deployment#

Docker: Check your Docker version by running docker --version. The minimum supported version is 20.10.0 (released in 2020), but a newer version (such as 26.1.4) is recommended for best performance and compatibility. Installation instructions can be found in the official Docker documentation.

For Kubernetes Deployment#

Kubernetes: Verify your installed Kubernetes version using the command kubectl version. The minimum supported version is 1.19, while using a newer version is recommended.
Helm: Verify your installed Helm version using the command helm version. The minimum supported version is 3.0.0, while using a newer version like >=3.12.0 is recommended.

Database Requirements#

Database: MySQL version 8.0.17 or higher is required. You can use either:
Self-hosted MySQL instances
Managed MySQL services such as Azure Database for MySQL, AWS RDS for MySQL, or Google Cloud SQL for MySQL

Cache Requirements#

Redis: Redis version 6.0.5 or higher is required. You can use either:
Self-hosted Redis instances (Community Redis)
Managed Redis services such as Azure Cache for Redis, AWS ElastiCache for Redis, or Google Cloud Memorystore
Modified at 2025-11-13 10:14:41
Previous
Installation Overview
Next
Obtaining Apidog On-premises License
Built with