Apicat Docs
  1. References
Apicat Docs
  • What is Apicat?
  • Send requests
    • Create requests
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • Dynamic values
      • HTTP/2
      • SOAP/WebService
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
      • Debug requests
    • Dynamic values Modules
      • Airline
      • Animal
      • Color
      • Commerce
      • Company
      • Database
      • Datatype
      • Date
      • Finance
      • Food
      • Git
      • Hacker
      • Helpers
      • Image
      • Internet
      • Location
      • Lorem
      • Music
      • Number
      • Person
      • Phone
      • Science
      • String
      • System
      • Vehicle
      • Word
  • Environments & variables
    • Overview
    • Using variables
    • Environments & services
  • Pre/Post processors
    • Overview
    • Assertion
    • Extract variable
    • Wait
    • Database operations
      • Overview
      • MySQL
      • MongoDB
      • Redis
      • Oracle Client
    • Using scripts
      • Overview
      • Pre processor scripts
      • Post processor scripts
      • Public scripts
      • Postman scripts reference
      • Calling other programming languages
      • Using JS libraries
      • Visualizing responses
      • Script examples
        • Assertion scripts
        • Using variables in scripts
        • Using scripts to modify request messages
        • Other examples
  • Best practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI/Swagger Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  1. References

Runner deployment environment

Hardware#

Recommended Server ConfigurationDeployment Target
4 cores, 4GB RAM, 30GB disk spaceSelf-hosted Runner
1.
CPU: Since Runner executes scheduled tasks concurrently, the CPU should have at least 2 cores, 4 cores or more are recommended.
2.
Memory: Since Runner loads and generates a large amount of data during scheduled tasks, at least 4GB of memory is required; 8GB or more is needed for larger teams.
3.
Disk Space: To accommodate log storage, a minimum of 30GB of disk space is recommended.

Runtime Parameters#

Parameter NameParameter DescriptionExample Value
TZConfigure the time zone for Runner execution. Scheduled tasks will run according to the set time zone and time. Refer to TZ identifier for configuration.America/Los_Angeles

Network Environment#

Runner needs to communicate with the server. Ensure that the network environment of the server executing the Runner can access the Apidog server and supports the WebSocket protocol.
For scheduled tasks for automated testing, the server's network environment must be able to access all requested URLs to initiate requests normally; after running automated tests, test reports will be uploaded, please ensure that the server network environment can access AWS domain names.
For scheduled tasks that import data, ensure that the server's network environment can access the URL of the data source to be imported.
Modified at 2025-06-25 07:57:16
Previous
Install Java Environment
Built with