The .joule.yml File

The .joule.yml file resides at the root of your project and defines your Joule and all the information about the endpoints. The following sections give details about each individual component of the file.

Version

required

version: 1.0.0

This defines the version of the Joule engine that your Joule will use. It will be used as we add new features to keep Joules from breaking.

Language

required

language: 'nodejs'

The runtime language that your Joule will use. Joules support nodejs and it is the only valid value for now.

Environment Variables

optional

environment_variables:
  - myVariable1
  - myVariable2

This is an optional list of environmental variables to inject into your Joule. Once these have been added and committed to the repository, you can go to the Joule details page (https://joule.run/{GitHub username}/{Joule name}) and there will be form fields to enter values for these variables. They will be injected into your code during deployment and can be accessed through process.env.{Variable name}.

Example

# .joule.yml
environment_variables:
  - TWILIO_AUTH_TOKEN
# index.js
exports.handler = function(event, context) {
  // ...
  var twilioAuth = process.env.TWILIO_AUTH_TOKEN;
  // ...
};