Configuration#
The converter configuration holds settings that apply across all conversions: data access policy, fonts, plugins, worker resources, and default themes and locales. Values such as output format, dimensions, and scale belong to the individual conversion instead. See Conversion Overrides for those.
JSONC Configuration Files#
Python, Rust, the CLI, and the server all read the same configuration format. This example limits worker resources and blocks external data and image loads. Save it as production.vlc.jsonc:
production.vlc.jsonc
{
// Persistent conversion workers
"num_workers": 4,
// Data loading
"base_url": false,
"allowed_base_urls": [],
// Fonts
"auto_google_fonts": false,
"google_fonts": [
{"family": "Inter", "variants": [{"weight": 400, "style": "normal"}]}
],
"missing_fonts": "warn",
// JavaScript resource limits
"max_v8_heap_size_mb": 1024,
"max_v8_execution_time_secs": 10,
// Vega extensions
"vega_plugins": [],
"plugin_import_domains": [],
// Vega-Lite defaults
"default_theme": null,
"default_format_locale": null,
"default_time_format_locale": null
}
Note that JSONC is JSON with support for comments and trailing commas.
Fields omitted from the file use their built-in defaults. This example changes some of those defaults: base_url normally points at the Vega datasets CDN, and allowed_base_urls permits any HTTP or HTTPS URL. Setting base_url to false rejects relative data and image URLs. Setting allowed_base_urls to an empty list rejects every external URL and local file.
allowed_base_urls accepts Content Security Policy-style patterns. Grant only the paths, URL prefixes, or schemes the application needs, and use "*" only when every input is trusted. See Security and Network Access.
Configure a CLI Command#
Pass the file with --vlc-config and use flags to override individual settings. This example lowers the heap limit from 1024 to 512 MB and uses chart.vl.json from Quick Start:
$ vl-convert --vlc-config production.vlc.jsonc \
> --max-v8-heap-size-mb 512 \
> vl2png --input chart.vl.json --output chart.png
The CLI takes each setting from the first source that provides it:
command-line flags
VLC_* environment variables
--vlc-config or the platform-default config file
built-in defaults
Relative configuration paths resolve from the current working directory. When --vlc-config is omitted, the CLI loads the platform-default file if it exists. Print that path with vl-convert config-path, or pass --vlc-config disabled to skip config files entirely.
Global options can appear before or after the conversion command. Run vl-convert --help for the global options and vl-convert vl2png --help for a command’s own options.
Common Environment Variables#
Most global flags have VLC_* equivalents. Repeatable values are separated by semicolons, except font directories, which use the platform path separator.
Variable |
Purpose |
|---|---|
|
JSONC config path or |
|
Base for relative data and image URLs: a URL, a path, |
|
Data and image URL allowlist, or the shortcut |
|
Additional font directories |
|
Google Font requests such as |
|
Whether to download missing first-choice fonts from Google Fonts |
|
|
|
Heap limit for each JavaScript worker |
|
JavaScript execution timeout |
|
Plugin file paths or URLs |
|
Allowed HTTP import domains for startup plugins |
|
Logging settings |
Run vl-convert --help for the complete list.