npx remotion lambda sites create
npx remotion lambda sites create <entry-point>?
You may pass an entry point as the first argument, otherwise the entry point will be determined.
Bundle and upload a Remotion video to an S3 bucket.
The result will be a URL such as https://remotionlambda-12345.s3.eu-central-1.amazonaws.com/sites/abcdef/index.html
.
If you make changes locally, you need to redeploy the site. Use --site-name
to overwrite an existing site.
You can use this "Serve URL" to render a video on Remotion Lambda using:
- The
npx remotion lambda render
andnpx remotion lambda still
commands - The
renderMediaOnLambda()
andrenderStillOnLambda()
functions. - Locally using the
renderMedia()
andrenderStill()
functions. - Locally using the
npx remotion render
andnpx remotion still
commands
If you are rendering on Lambda, you can also pass the site Name (in this case abcdef
) as an abbreviation.
Example output
(1/3) [====================] Bundled video 3975ms
(2/3) [====================] Created bucket 457ms
(3/3) [====================] Uploaded to S3 25118ms
Deployed to S3!
Serve URL: https://remotionlambda-12345.s3.eu-central-1.amazonaws.com/sites/abcdef/index.html
Site Name: abcdef
--region
The AWS region to select. Both project and function should be in this region.
--site-name
Uploads the project to a specific directory and returns a deterministic URL. If a site already existed under this name, it will be overwritten. Can only contain the following characters: 0-9
, a-z
, A-Z
, -
, !
, _
, .
, *
, '
, (
, )
npx remotion lambda sites create src/index.ts --site-name=my-project
--force-bucket-name
v3.3.42
Specify a specific bucket name to be used. This is not recommended, instead let Remotion discover the right bucket automatically.
--privacy
v3.3.97
Either public
(default) or no-acl
if you are not using ACL. Sites must have a public URL to be able to be rendered on Lambda, since the headless browser opens that URL.
--public-dir
v4.0.140
Define the location of the public/ directory
. If not defined, Remotion will assume the location is the `public` folder in your Remotion root.
--enable-folder-expiry
v4.0.32
When deploying sites, enable or disable S3 Lifecycle policies which allow for renders to auto-delete after a certain time. Default is null
, which does not change any lifecycle policies of the S3 bucket. See: Lambda autodelete.
--throw-if-site-exists
v4.0.141
Prevents accidential update of an existing site. If there are any files in the subfolder where the site should be placed, the function will throw.
--disable-git-source
v4.0.182
Disables the Git Source being connected to the Remotion Studio. Clicking on stack traces and certain menu items will be disabled.
--force-path-style
v4.0.202
Passes forcePathStyle
to the AWS S3 client. If you don't know what this is, you probably don't need it.