Self-hosting Apidog
  1. Introduction
Self-hosting Apidog
  • Overview
  • Introduction
    • Obtaining Apidog On-Premises License
    • System Requirements
    • Data Privacy & Compliance
  • Deployment
    • Running Apidog on Docker
    • Running Apidog on Kubernetes
    • Running Apidog Multi-Container Deployment without Kubernetes
  • Post Deployment
    • Accessing Apidog Admin Panel
    • Accessing Apidog Web Interface
    • Installing Apidog On-Premises Client
  • Configurations
    • Environment Variables
    • Database Configuration
    • Storage Services Configuration
    • Git Connection Configuration
    • 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 Design Flow
  • Troubleshooting
    • Troubleshooting
    • FAQ
  • Apidog API (coming soon)
  1. Introduction

Obtaining Apidog On-Premises License

Apidog On-Premises requires a server-side license for deployment, which can be obtained through one of the following methods:
1.
Proof of Concept (PoC): By applying for the Apidog On-Premises Proof of Concept (PoC), you will receive a One-Month Trial License for evaluation. This trial license provides access to the core functionality of Apidog On-Premises for a period of 30 days.
2.
License Purchase: Alternatively, a time-limited license can be purchased for Apidog On-Premises. The duration of the license will correspond to the period for which payment is made, allowing deployment for a predefined timeframe (e.g., annual). This license grants access to the full set of features, with ongoing updates and support throughout the license period.

Application and Licensing Process#

To obtain a valid license for Apidog On-Premises, please follow the steps below:
Contact Our Sales Team
To initiate the licensing process, send an email to sales@apidog.com with the following information:
1.
Company Name: Provide the full legal name of your organization.
2.
Deployment URL: Specify the URL that will be used to access your Apidog On-Premises server. This URL will allow Apidog clients to interact with the server-side APIs after deployment. Examples include:
http://192.168.1.1
https://yourdomain.com
http://192.168.1.1:8080
Ensure the URL includes:
IP address or domain name where Apidog will be deployed.
Protocol: Specify http or https (if using https, the corresponding SSL certificate must be added during deployment to ensure secure communication).
If deploying on a non-standard port (other than the default HTTP port 80 or HTTPS port 443), include the port number in the URL(e.g., http://domain-name.com:8080).
3.
Number of Users: Provide the total number of users who will require access to the Apidog On-Premises application. This helps us determine the appropriate license tier for your deployment.
Important Note:
The three pieces of information provided during the licensing process (Company Name, URL, and Number of Users) will be encoded into the server-side license and cannot be changed once the license is generated.
Apidog On-Premises has a minimum purchase of 20 users. Any additional purchase or renewals will require updating the server-side license to reflect the new number of users.
Upon the successful completion and formal approval of the application, a confirmation email will be dispatched to the designated recipient. This email will include the following:
Docker Registry Access: A secure link to the Docker registry, along with an access token, will be provided for authentication and retrieval of the application image. The Docker image can be pulled via the Docker CLI or integrated into CI/CD pipelines as needed.
License Key: The email will also contain a license key, provided as an attachment in a secure file format. This license key is required for activating the application on the target systems and ensuring compliance with licensing terms.
Desktop Application Installation Links: Direct download links for the desktop application will be provided, with support for multiple operating systems (Windows, macOS, and Linux). These links point to the latest stable release and are tailored for each supported platform to facilitate easy installation.
Modified at 2025-12-08 05:12:16
Previous
Overview
Next
System Requirements
Built with