Running Apidog on Docker

If you're trying to upgrade your Apidog version on Docker, check out these Upgrading instuctions.

Requirements

Hardware and software requirements for Apidog.

Hardware

OS: Preferred unix-based operating system (Ubuntu, Debian, etc). Windows might works too, with Docker Desktop on Windows

RAM: Preferred 8GB, at least 4GB.

CPU: Preferred 4 cores, at least 2 cores.

Recommended Configuration	Quantity	Target Deployment component
4 cores, 8 GB RAM, 100 GB disk space	1	Apidog Server
4 cores, 8 GB RAM, 100 GB disk space	1	MySQL database (>= 8.0.17), Redis database (>= 6.0.5)

Software Requirements

Docker: Verify your installed Docker version using the command docker --version. The minimum supported version is 20.10.0 (released in 2020), while using a newer version like 26.1.4 is recommended. For installation instructions, refer to the official Docker documentation: https://docs.docker.com/engine/install/

Preparing for deployment

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:

Log in to Docker Hub:

docker login --username=apidog docker.io

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.

Preparing the application database configurations

See Configuring the application database.

Preparing the application storage service configurations

See Configuring the application storage service.

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.

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.

Runing 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: https://self-hosting.apidog.io/running-apidog-on-docker-405306m0#verify-successful-startup

Additional Docker maintenance and configuration

See Environment variables in the Configuration guide.

See Troubleshooting guide.

Requirements#

Hardware#

Software Requirements#

Preparing for deployment#

Preparing the Docker image#

Preparing the application database configurations#

Preparing the application storage service configurations#

Running Apidog#

Verify successful startup#

Run the application#

For web access:#

For desktop application access:#

Runing Apidog using Docker Compose (Alternative)#

Install Docker Compose (If Necessary):#

Configure and Launch#

Restart commands:#

Verify successful startup#

Additional Docker maintenance and configuration#

Requirements

Hardware

Software Requirements

Preparing for deployment

Preparing the Docker image

Preparing the application database configurations

Preparing the application storage service configurations

Running Apidog

Verify successful startup

Run the application

For web access:

For desktop application access:

Runing Apidog using Docker Compose (Alternative)

Install Docker Compose (If Necessary):

Configure and Launch

Restart commands:

Verify successful startup

Additional Docker maintenance and configuration