Chromium flags
import {AngleChangelog} from '../components/AngleChangelog';
We allow you to set the following flags in Chromium and Google Chrome since Remotion 2.6.5:
--disable-web-security
This will most notably disable CORS among other security features.
Remotion will automatically append the --user-data-dir
flag.
Via Node.JS APIs
In getCompositions()
, renderStill()
, renderMedia()
, renderFrames()
, getCompositionsOnLambda()
, renderStillOnLambda()
and renderMediaOnLambda()
, you can pass chromiumOptions.disableWebSecurity
.
Via CLI flag
Pass --disable-web-security
in one of the following commands: remotion render
, remotion compositions
, remotion still
, remotion lambda render
, remotion lambda still
, remotion lambda compositions
.
Via config file
Use setChromiumDisableWebSecurity().
tsx
Config .setChromiumDisableWebSecurity (true);
tsx
Config .setChromiumDisableWebSecurity (true);
Prior to v3.3.39
, the option was called Config.Puppeteer.setChromiumDisableWebSecurity()
.
--ignore-certificate-errors
Results in invalid SSL certificates, such as self-signed ones, being ignored.
Via Node.JS APIs
In getCompositions()
, renderStill()
, renderMedia()
, renderFrames()
, getCompositionsOnLambda()
, renderStillOnLambda()
and renderMediaOnLambda()
, you can pass chromiumOptions.ignoreCertificateErrors
.
Via CLI flag
Pass --ignore-certificate-errors
in one of the following commands: remotion render
, remotion compositions
, remotion still
, remotion lambda render
, remotion lambda still
, remotion lambda compositions
.
Via config file
Use setChromiumIgnoreCertificateErrors().
tsx
Config .setChromiumIgnoreCertificateErrors (true);
tsx
Config .setChromiumIgnoreCertificateErrors (true);
Prior to v3.3.39
, the option was called Config.Puppeteer.setChromiumIgnoreCertificateErrors()
.
--disable-headless
Setting this flag will open an actual Chrome during render where you can see the render happen.
Via Node.JS APIs
In getCompositions()
, renderStill()
, renderMedia()
and renderFrames()
, you can pass chromiumOptions.headless
. You cannot set this option in Lambda.
Via CLI flag
Pass --disable-headless
in one of the following commands: remotion compositions
, remotion render
, remotion still
.
Via config file
Use setChromiumHeadlessMode().
tsx
Config .setChromiumHeadlessMode (false);
tsx
Config .setChromiumHeadlessMode (false);
Prior to v3.3.39
, the option was called Config.Puppeteer.setChromiumHeadlessMode()
.
--gl
Select the OpenGL renderer backend for Chromium. Accepted values:
"angle"
,"egl"
,"swiftshader"
"swangle"
null
- Chromium's default
Default for local rendering: null
.
Default for Lambda rendering: "swangle"
.
Via Node.JS APIs
In getCompositions()
, renderStill()
, renderMedia()
, renderFrames()
, getCompositionsOnLambda()
, renderStillOnLambda()
and renderMediaOnLambda()
, you can pass chromiumOptions.gl
.
Via CLI flag
Pass --gl=swiftshader
in one of the following commands: remotion render
, remotion compositions
, remotion still
, remotion lambda render
, remotion lambda still
, remotion lambda compositions
.
Via config file
tsx
Config .setChromiumOpenGlRenderer ("swiftshader");
tsx
Config .setChromiumOpenGlRenderer ("swiftshader");
Prior to v3.3.39
, the option was called Config.Puppeteer.setChromiumOpenGlRenderer()
.
--user-agent
Via Node.JS APIs
In getCompositions()
, renderStill()
, renderMedia()
, renderFrames()
, getCompositionsOnLambda()
, renderStillOnLambda()
and renderMediaOnLambda()
, you can pass chromiumOptions.userAgent
.
Via CLI flag
Pass --user-agent
in one of the following commands: remotion render
, remotion compositions
, remotion still
, remotion lambda render
, remotion lambda still
, remotion lambda compositions
.
Need more flags?
Open a GitHub issue to request it.