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 Multi-Container Deployment without Kubernetes

High Availability Multi-Container Deployment without Kubernetes
Before proceeding, please read the documentation on Running Apidog on Docker.

Environment Setup#

Docker: Ensure Docker is installed. Verify the version using docker --version. The minimum supported version is 20.10.0 (released in 2020). However, using a newer version, such as 26.1.4, is recommended. For installation instructions, refer to the official Docker documentation: https://docs.docker.com/engine/install/
Initial deployments and subsequent upgrades may involve database schema updates or data migration tasks. These migration tasks do not support concurrent execution.
Therefore, consider launching a separate container to perform the upgrade first, and then update the containers handling traffic.

Apidog Node Setup#

1.
Create a script named run-apidog.sh: vi run-apidog.sh. Press i to enter insert mode and paste the following content.
2.
Modify the environment variables to reflect your specific configuration.
3.
Execute the script: sh run-apidog.sh.

Nginx Gateway Setup#

1.
Create an initialization script named init-nginx.sh: vi init-nginx.sh. Press i to enter insert mode and paste the following content. Then, execute the script: sh init-nginx.sh.
2.
Copy the Nginx configuration files to the current directory for initialization:
3.
Create a script named run-nginx.sh: vi run-nginx.sh. Press i to enter insert mode and paste the following content. Do not run this script yet.
4.
Prepare the SSL certificate and Nginx configuration:
a. Create the directory for your domain's certificates: mkdir -p $PWD/appdata/conf.d/certs/
b. Create the certificate PEM file: vi $PWD/appdata/conf.d/certs/pem (Paste the certificate content into this file).
c. Create the certificate key file: vi $PWD/appdata/conf.d/certs/key (Paste the key content into this file).
d. Modify the default.conf file: vi $PWD/appdata/conf.d/default.conf. Press i to enter insert mode and paste the following content, updating the server directives in the backend upstream block and the server_name directives to match your environment.
5.
Finally, execute the run-nginx.sh script: sh run-nginx.sh.

Updating Apidog#

Initial deployments and subsequent upgrades may involve database schema updates or data migration tasks. These migration tasks do not support concurrent execution.
Therefore, consider launching a separate container to perform the upgrade first, and then update the containers handling traffic.
Modified at 2025-03-05 09:24:26
Previous
Running Apidog on Kubernetes
Next
Privacy
Built with