Skip to main content

Using a proxy with Remotion Lambda

Available from v4.0.315

Remotion Lambda supports using HTTP/HTTPS proxies for all AWS API calls by accepting a requestHandler option that allows you to pass a custom AWS SDK request handler.

This is useful when your environment requires all external HTTP requests to go through a proxy server.

Setting up a proxy​

1. Install a proxy agent​

First, install an HTTP/HTTPS proxy agent package like https-proxy-agent:

bash
npm install https-proxy-agent

2. Create a request handler with proxy​

Create a request handler that uses your proxy:

tsx
import {HttpsProxyAgent} from 'https-proxy-agent';
 
// Configure your proxy URL
const proxyUrl = 'http://your-proxy-server:8080';
 
// Create a proxy agent
const proxyAgent = new HttpsProxyAgent(proxyUrl);
 
// Create a request handler that uses the proxy
export const proxyRequestHandler = {
  httpsAgent: proxyAgent,
};

3. Use the request handler with Remotion Lambda functions​

Pass the requestHandler option to any Remotion Lambda function:

tsx
import {getFunctions} from '@remotion/lambda/client';
import {proxyRequestHandler} from './proxy-setup';
 
const functions = await getFunctions({
  region: 'us-east-1',
  compatibleOnly: true,
  requestHandler: proxyRequestHandler,
});
 
console.log('Functions:', functions);

Supported functions​

All public AWS-related APIs in the Lambda client accept the requestHandler option.

Example with authentication​

If your proxy requires authentication, you can include credentials in the proxy URL:

tsx
import {HttpsProxyAgent} from 'https-proxy-agent';
 
// Proxy with authentication
const proxyUrl = 'http://username:password@your-proxy-server:8080';
const proxyAgent = new HttpsProxyAgent(proxyUrl);
 
export const authenticatedProxyRequestHandler = {
  httpsAgent: proxyAgent,
};

TypeScript support​

Remotion Lambda exports a RequestHandler type that you can use for type safety:

tsx
import type {RequestHandler} from '@remotion/lambda/client';
import {HttpsProxyAgent} from 'https-proxy-agent';
 
const proxyAgent = new HttpsProxyAgent('http://proxy:8080');
 
const myRequestHandler: RequestHandler = {
  httpsAgent: proxyAgent,
};

Environment-specific configuration​

You can conditionally use a proxy based on your environment:

tsx
import {HttpsProxyAgent} from 'https-proxy-agent';
import type {RequestHandler} from '@remotion/lambda/client';
 
const createRequestHandler = (): RequestHandler | undefined => {
  const proxyUrl = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
 
  if (proxyUrl) {
    return {
      httpsAgent: new HttpsProxyAgent(proxyUrl),
    };
  }
 
  // Return undefined to use default behavior
  return undefined;
};
 
export const requestHandler = createRequestHandler();

Then use it in your Lambda calls:

tsx
import {getFunctions} from '@remotion/lambda/client';
import {requestHandler} from './conditional-proxy';
 
const functions = await getFunctions({
  region: 'us-east-1',
  compatibleOnly: true,
  requestHandler, // This will be undefined if no proxy is configured
});

See also​