CONFIGURATION.md

Configuration

Your Configuration File

By default the Serverless Toolkit will look into your current working directory (which you can override using the --cwd flag) for a .twilioserverlessrc file. Alternatively you can specify the location explicitly using the --config flag.

The .twilioserverlessrc file by default uses JSON5 meaning any valid JSON will be valid as well as some additional features.

Alternatively you can name your config file .twilioserverlessrc.js to use JavaScript. Make sure to export your configuration:

module.exports = {
  // your config
}

Lastly you can use YAML by naming your config file .twilioserverlessrc.yml instead.

Content

Basically any CLI flag you can define can be used in the configuration file using camelCase notation.

Additionally you can scope settings based on "environments", "projects" and "commands". Check out the Examples for concrete use cases.

Examples

Functions with Preprocessor like TypeScript or Babel

By default the Serverless Toolkit will be looking for Functions inside a functions/ or src/ directory and for assets for an assets/ or static/ directory.

If you are using a pre-processor such as TypeScript or Babel, your structure might look different. For example maybe you have a structure where src/ contains all TypeScript files and dist/ contains the output.

In which case you'd want a config that looks similar to this:

{
  "functionsFolderName": "dist"
}

Using different .env files for different environments

If you are deploying to different environments you might want different environment variables for your application.

You can specify environment specific configurations inside the config file by using the domain suffix of your environment.

If you are using the --production flag you'll need to use the environment: *.

For example:

{
  "environments": {
    "dev": {
      "env": ".env"
    },
    "stage": {
      "env": ".env.stage"
    },
    "*": {
      "env": ".env.prod"
    }
  }
}

Use a different .env file for deployments and local development

For local development you use the "start" command and for deployments "deploy". By setting the config based on those respective "commands" they'll only be used if that command is used.

{
  "commands": {
    "start": {
      "env": ".env"
    },
    "deploy": {
      "env": ".env.prod"
    }
}

Deploy to specific services on different accounts

There might be a scenario where you want to deploy the same project to different Twilio accounts or projects with different services.

Inside the config you can define which service the project should be deployed to depending on the Twilio Account SID.

{
  "projects": {
    "AC11111111111111111111111111111111": {
      "serviceSid": "ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "AC22222222222222222222222222222222": {
      "serviceSid": "ZSbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
    }
  }
}