Self-hosting Apidog
  1. Maintenance & Upgrades
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
    • System Data Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Maintenance & Upgrades

System Data Flow

The authentication process flows from the user through the desktop/web client to the SSO Service (e.g., Microsoft Entra ID). Once authenticated, users are routed through a secured gateway(or Firewall) into backend services, which connect to internal APIs and data stores for business operations and service delivery.

System Components#

1.
Internal Users: Initiate interactions via a Desktop Client or Web Client.
2.
Gateway/Firewall: Requests from clients pass through a Gateway/Firewall, ensuring secure access to backend systems. This is component that depends on the user's specific deployment environment, ensuring secure access to the backend services.
3.
Intranet Service: Acts as the access layer that routes user requests to relevant backend services.
4.
Backend Services: Within an On-Premises Container, these handle core application logic:
API Service: Main application API endpoint specs.
Mock Service: Used for testing or development scenarios with simulated responses.
Docs Site Service: Hosts documentation or related content.
5.
Authentication: Handled via SSO Service (e.g., Microsoft Entra ID), enabling secure single sign-on.
6.
Data Servers: Provide data persistence and caching:
MySQL: For structured relational data.
Redis: For in-memory caching and fast data retrieval.

Regarding Multi-Container distributed deployment#

Apidog On-Premises supports distributed deployment across multiple containers.
In this architecture, containers are stateless, as application state and data are not stored locally. Instead, they are managed and shared through a centralized Redis or database instance.
This approach ensures full compatibility with all kind of load balancing algorithms, such as round-robin and IP hash, allowing for seamless and uninterrupted user access.

Data flow Diagram#

apidog-diagram-20250707-123326.jpeg

Sequence Diagram#

Modified at 2025-07-07 06:06:03
Previous
Updating Apidog
Next
Troubleshooting
Built with