Installing Apidog Client

The Apidog On-Premises client is different from the Apidog SaaS client and is not available for download from the Apidog website.

After purchasing Apidog On-Premises, our support team will provide the client software and the server container image.

The Apidog On-Premises client supports Windows, macOS, and Linux.

1. Installing the Client

Install the appropriate client package for your operating system and version.

For Windows users, silent installation is supported for deployment through systems like SCCM (System Center Configuration Manager). The silent installation command is: Apidog.exe /S /allusers

2. Running the Client

The Apidog On-Premises client does not require a license key or file. Enter the Server Base URL, which corresponds to the backend container's BASE_URL environment variable. Ensure the Server Base URL does not include a trailing '/'.

After entering the Server Base URL and establishing a connection, you can register or log in to your account.

3. Client Updates

3.1. Update Guidelines

Our support team will provide updated Apidog On-Premises client installation packages quarterly via email. These updates include all changes for that quarter. You can manually download and install the new version after updating the server.

We recommend keeping the client and server versions aligned for the best experience.

In most cases, older client versions will work with newer server versions. Client updates are only mandatory for specific features requiring a newer client version.

If the Server version is 2.6.44-202501211049, client versions 2.6.44 or earlier are compatible.

Client versions later than 2.6.44 are incompatible with Server version 2.6.44-202501211049 and may cause application crashes due to missing server endpoints.

3.2. Check for Updates

The "Check for Updates" feature allows the client to automatically download and install the corresponding update. To enable this feature, the system administrator should download all platform client packages and upload them to your designated storage location. The process depends on your container's storage configuration.

File Storage Mode

Prerequisite: Object Storage Mode is disabled. STORAGE_DRIVER is either not configured or set to the default STORAGE_DRIVER='file'.

Mount a directory to the container's /usr/src/app/app/public/client-packages directory. For example:

Place all client packages (including the YAML file, i.e., the entire extracted contents of client-apps.tar.gz) in this mounted directory (e.g., $PWD/client-packages in the example above).

Object Storage Mode (S3)

Prerequisite: Object Storage is enabled, and the environment variable STORAGE_DRIVER='s3' is set. Refer to the Environment Variables documentation for more information.

The API service will look for files in the {STORAGE_BASE_PATH}/client-packages directory. So Please place all client packages (including the YAML file, i.e., the entire extracted contents of client-apps.tar.gz) in this directory.

For example, with the following environment variables:

export STORAGE_DRIVER='s3'
export STORAGE_BASE_URL='https://api.example.com'
export STORAGE_BASE_PATH='/app'

If a Mac arm64 user initiates a "Check for Updates", the server will check https://api.example.com/app/client-packages/arm64-latest-mac.yml. This file will be used to generate a pre-signed URL for https://api.example.com/app/client-packages/Apidog-ee-macOS-arm64-2.6.44.dmg, allowing the client to automatically download and install the update.

1. Installing the Client#

2. Running the Client#

3. Client Updates#

3.1. Update Guidelines#

3.2. Check for Updates#

File Storage Mode#