Self-hosting Apidog
  1. Deployment
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. Deployment

Running Apidog on Docker

This is for running Apidog on Docker. If you're trying to run Apidog on Kubernetes, check out these Running Apidog on Kubernetes. If you're trying to upgrade your Apidog version on Docker, check out these Upgrading instuctions.

Requirements#

For hardware and software requirements, please refer to the System Requirements documentation.

Preparing for deployment#

Prerequisites:
Access Token for the private Docker Hub repository (obtained via email)
Configured application database and storage service following Configuring the application database and Configuring the application storage service.
Preparing the Docker Image:
Apidog offers an official Docker image, but currently, it's only available for download through a private Docker Hub repository. Access to the image requires a read-only Access Token sent via email upon approval.
Assuming you have received the Access Token:
1.
Log in to Docker Hub:
docker login --username=apidog docker.io
2.
Pull the latest Docker image:
docker pull docker.io/apidog/apidog-ee:<image_tag>
Note: Replace <image_tag> with the specific image tag you want to download.

Running Apidog#

Here's an example Docker command:
The following environment variables are required environments. You can find more environment variables in the Configuration guide.
Configuration Notes:
1.
Database configuration:
The example above uses MySQL. If using PostgreSQL instead, replace the MySQL variables with:
2.
Required values: Replace all placeholder values (e.g., <mysql_host>, <redis_host>, <JWT secret>, <License token>, etc.) with your actual configuration values.
3.
Storage configuration:
The s3 storage configuration is required for Kubernetes deployments and recommended for Docker.
For non-AWS S3-compatible storage (e.g., MinIO), you may need to add additional variables:
See the Configuration guide for more details.
4.
Image tag: Replace <image_tag> with the desired image tag (e.g., 2.7.38).

Verify successful startup#

Execute the following command in the Docker Host:
The application has started successfully if the output includes lines similar to the following:
...
[WARN] This Redis server's `default` user does not require a password, but a password was supplied
connect succeeded! value is  null
Executing (default): SELECT 1+1 AS result
...
Connecting to 127.0.0.1:3000 (127.0.0.1:3000)
remote file exists
Connecting to 127.0.0.1 (127.0.0.1:80)
remote file exists
Connecting to 127.0.0.1 (127.0.0.1:80)
remote file exists
If the output differs, the application has not started successfully or is still starting. The typical time for a graceful startup is 30 seconds, but this may vary depending on the performance of the hardware.

Run the application#

To access the service, follow the instructions below:

For web access:#

Open your web browser and navigate to the URL specified by the BASE_URL environment variable. This URL typically follows the format https://api.example.com/web/ or http://192.168.0.13/web/.

For desktop application access:#

Upon launching the application for the first time, you will be prompted to enter the Server Base URL. Ensure this URL does not include a trailing slash.
See Installing Apidog Client

Running Apidog using Docker Compose (Alternative)#

Running Apidog with Docker Compose is an alternative to using docker run, providing simpler configuration and management. This method requires docker compose to be installed on the host machine.

Install Docker Compose (If Necessary):#

If the docker compose --version command fails, you need to install Docker Compose. Refer to the official Docker Compose installation guide: Docker Compose Installation Documentation.

Configure and Launch#

Save the following configuration as compose.yml. Modify the environment variables as needed.
The following environment variables are required environments. You can find more environment variables in the Configuration guide.
Execute docker compose -f compose.yml up -d to start the application.
Initial deployments and subsequent upgrades may involve database migrations. These migration tasks do not support concurrency. Therefore, if you are using a multi-container deployment, you must first start a single container to perform the upgrade, and then rollout update the containers that are actually handling traffic.

Restart commands:#

Verify successful startup#

Refer to the verification steps outlined here: Verify successful startup

Additional Resources#

Environment variables: Configuration Guide
Troubleshooting: Troubleshooting Guide
Modified at 2025-10-31 08:02:19
Previous
Obtaining Apidog On-premises License
Next
Running Apidog on Kubernetes
Built with