☁️VoltTest Cloud closed beta is now openJoin the waitlist
Skip to main content

Configuration Reference

All settings are in config/volttest.php. Publish with:

php artisan vendor:publish --tag=volttest-config

Test Configuration

KeyEnv VarDefaultDescription
nameVOLTTEST_NAMELaravel Application TestDefault test name
descriptionVOLTTEST_DESCRIPTIONPerformance test for Laravel applicationDefault description

Load Configuration

KeyEnv VarDefaultDescription
virtual_usersVOLTTEST_VIRTUAL_USERS10Number of concurrent virtual users
durationVOLTTEST_DURATIONnullTest duration (e.g., 30s, 2m, 1h)
ramp_upVOLTTEST_RAMP_UPnullRamp-up time for VUs

Stages

'stages' => [
['duration' => '1m', 'target' => 50],
['duration' => '5m', 'target' => 100],
['duration' => '1m', 'target' => 0],
],

When stages are set, virtual_users, duration, and ramp_up are ignored.

Region Distribution

'regions' => [
'us-east-1' => 60,
'eu-west-1' => 40,
],

Weights must sum to 100. Leave empty for single-region default. Requires cloud mode.

Debug

KeyEnv VarDefaultDescription
http_debugVOLTTEST_HTTP_DEBUGfalseEnable HTTP debug output

Paths

KeyDefaultDescription
test_pathsapp_path('VoltTests')Directory for test classes
reports_pathstorage_path('volttest/reports')Directory for saved reports

Reports

KeyEnv VarDefaultDescription
save_reportsVOLTTEST_SAVE_REPORTStrueSave test reports to disk

Base URL

KeyEnv VarDefaultDescription
use_base_urlVOLTTEST_USE_BASE_URLtruePrefix relative paths with base URL
base_urlVOLTTEST_BASE_URLhttp://localhost:8000Base URL for your application

When use_base_url is true, relative paths like /api/users become http://localhost:8000/api/users. Full URLs are used as-is.

CSV Data Source

'csv_data' => [
'path' => storage_path('volttest/data'),
'validate_files' => true,
'default_distribution' => 'unique',
'default_headers' => true,
],
KeyDefaultDescription
csv_data.pathstorage/volttest/dataDefault directory for CSV files
csv_data.validate_filestrueCheck CSV files exist before running
csv_data.default_distributionuniqueDefault distribution mode (unique, random, sequential)
csv_data.default_headerstrueWhether CSV files have a header row

Cloud

KeyEnv VarDefaultDescription
cloud.enabledVOLTTEST_CLOUD_ENABLEDfalseEnable cloud execution by default
cloud.api_keyVOLTTEST_API_KEYnullVoltTest API key (starts with vt_)

Minimal .env Example

VOLTTEST_VIRTUAL_USERS=20
VOLTTEST_DURATION=1m
VOLTTEST_BASE_URL=http://localhost:8000
VOLTTEST_SAVE_REPORTS=true

Cloud .env Example

VOLTTEST_API_KEY=vt_your_api_key
VOLTTEST_CLOUD_ENABLED=true
VOLTTEST_VIRTUAL_USERS=500
VOLTTEST_DURATION=10m