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
    • Authentication Providers
      • Using LDAP for authentication
      • Using OKTA for authentication
      • Using OAuth2.0 for authentication
  • Maintenance & Upgrades
    • Backing up Apidog
    • License Renewal
    • Updating Apidog
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Introduction

System Requirements

Apidog On-Premises supports several deployment options:
1.
Single-container Docker deployment
2.
Kubernetes deployment
3.
Non-Kubernetes multi-container deployment
For Docker deployment, 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.
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)

Software Requirements#

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.
Previous
Installation Overview
Next
Obtaining Apidog On-premises License
Built with