Skip to content

Configuration

adc-locust reads Nitro API credentials and the NetScaler address to test from a .env file:

NITRO_URL=netscaler.example.com
NITRO_USER=nitro-api-user
NITRO_PASS=change-me
NITRO_VERIFY_TLS=false
Variable Required Description
NITRO_URL yes Management (NSIP) address of the appliance to read configuration from and test.
NITRO_USER yes Nitro API username.
NITRO_PASS yes Nitro API password.
NITRO_VERIFY_TLS no Verify the appliance's TLS certificate. Default false (most internal NetScalers use self-signed or internal-CA certs).

By default adc-locust looks for .env in the current working directory. Use --env-file /path/to/.env or set ADC_LOCUST_ENV_FILE to use a different path.

Interactive setup

If .env is missing or incomplete, adc-locust shows a setup screen instead of the vserver list on startup. Fill in the NetScaler address, Nitro username, and password, and it writes .env (permissions 600) before continuing — no need to leave the terminal UI or edit files by hand.

Keep .env out of version control (it's already listed in .gitignore). Copy .env.example if you'd rather edit the file directly:

cp .env.example .env
$EDITOR .env