Skip to main content

Stack Parameters

Parameter Overview#

For most users, we recommend c5.xlarge as the instance type for all instances as the best balance of cost and performance, with adequate network throughput to support all workloads. Using smaller instances is not recommended, and is not officially supported. Using smaller instance types, you may also see additional instances temporarily spin up during stack launch, as provisioning may cause instances to autoscale after exceeding the default CPU threshold.

You'll need to provide the following parameters to the stack at launch:

  • KeyName - An existing EC2 Key Pair for SSH access.
  • InstanceTypeControl - Instance type to use for the Control instance.
  • InstanceTypeHAProxy - Instance type to use for HAProxy instances.
  • InstanceTypeMeet - Instance type to use for Meet instances.
  • InstanceTypeJVB - Instance type to use for JVB instances.
  • InstanceTypeTURN - Instance type to use for the TURN instance, if enabled.
  • LoggingBucketName - Name for a new S3 bucket to store logs.
  • FQDN - Domain name that will host the app. Strongly recommended to host on a subdomain, e.g meet.example.com
  • TURNDomain - Domain name for use with the TURN server, e.g. turn.example.com. You must be able to set DNS records for this domain.
  • SSLCertificate - Arn of an existing SSL certificate in Amazon Certificate Manager matching the domain name.
  • SSHCIDR - An IPv4 CIDR block for SSH access to the control instance. Should be 0.0.0.0/0 if you want to access it from everywhere.
  • JitsiCIDR - An IPv4 CIDR block for access to Jitsi itself. Should be 0.0.0.0/0 if you want it accessible to everyone.
  • EnableTokens - Whether to enable JWT Token Authorization. No meetings will be accessible without providing the token, which you will need to generate from your own frontend. Incompatible with using a Prosody secure domain.
  • EnableSecureDomain - Whether to enable a Prosody secure domain for user authentication. No meetings will be accessible without manually configuring usernames and passwords in Prosody, which you will need to do yourself. Incompatible with using JWT tokens.
  • EnableTURN - Whether to enable the coturn TURN server. Only necessary if you have users on restrictive networks requiring NAT traversal.
  • SlackChannel - (optional) Name of channel in Slack to send Grafana notifications to.
  • SlackToken - (optional) A Slack bot token with permission to post to the Slack channel for Grafana notifications.
  • UseLatest - Whether to use the latest package versions on install. Not recommended for production, as it may be unstable.
  • MeetPostInstall - Public URL to a bash script to run post-install on Meet servers.
  • JVBPostInstall - Public URL to a bash script to run post-install on JVB servers.
  • HaproxyPostInstall - Public URL to a bash script to run post-install on Haproxy servers.
  • ControlPostInstall - Public URL to a bash script to run post-install on Control server.
  • TURNPostInstall - Public URL to a bash script to run post-install on TURN server.

Launching from the command line#

While you can launch the stack from the AWS CloudFormation web interface, for ease of reproducible deployment it's usually easier to launch the stack using the AWS command line tools and a JSON file with your parameters.

You'll need the URL of the latest CloudFormation template file. From the AWS marketplace page for the stack, click "View CloudFormation Template." Find the link for "Download CloudFormation Template", then right-click and copy the URL of the latest version of the template.

To launch the stack, use the latest template URL like:

aws cloudformation create-stack --region us-east-1 --stack-name jitsi --template-url https://awsmp-fulfillment-cf-templates-prod.s3-external-1.amazonaws.com/4552b5d7-197b-4047-abfe-d9eadfbd79a5/c13a23cdc7e348b39e22adeb2c982128.template --parameters file://parameters.json --capabilities CAPABILITY_NAMED_IAM`

The parameters.json file should look like this:

[    { "ParameterKey": "KeyName", "ParameterValue": "jitsi" },    { "ParameterKey": "InstanceTypeControl", "ParameterValue": "c5.xlarge" },    { "ParameterKey": "InstanceTypeHAProxy", "ParameterValue": "c5.xlarge" },    { "ParameterKey": "InstanceTypeMeet", "ParameterValue": "c5.xlarge" },    { "ParameterKey": "InstanceTypeJVB", "ParameterValue": "c5.xlarge" },    { "ParameterKey": "InstanceTypeTURN", "ParameterValue": "c5.xlarge" },    { "ParameterKey": "LoggingBucketName", "ParameterValue": "example-jitsi-test-logs" },    { "ParameterKey": "FQDN", "ParameterValue": "jitsi.example.com" },    { "ParameterKey": "TURNDomain", "ParameterValue": "turn.example.com" },    { "ParameterKey": "SSLCertificate", "ParameterValue": "arn:aws:acm:us-east-1:xxxxxxxxxxxx:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" },    { "ParameterKey": "SSHCIDR", "ParameterValue": "0.0.0.0/0" },    { "ParameterKey": "JitsiCIDR", "ParameterValue": "0.0.0.0/0" },    { "ParameterKey": "EnableTokens", "ParameterValue": "false" },    { "ParameterKey": "EnableSecureDomain", "ParameterValue": "false" },    { "ParameterKey": "EnableTURN", "ParameterValue": "false" },    { "ParameterKey": "SlackChannel", "ParameterValue": "updates" },    { "ParameterKey": "SlackToken", "ParameterValue": "xoxb-xxxx-xxxx-xxxx-xxxx" },    { "ParameterKey": "UseLatest", "ParameterValue": "false" },    { "ParameterKey": "MeetPostInstall", "ParameterValue": "" },    { "ParameterKey": "JVBPostInstall", "ParameterValue": "" },    { "ParameterKey": "HaproxyPostInstall", "ParameterValue": "" },    { "ParameterKey": "ControlPostInstall", "ParameterValue": "" },    { "ParameterKey": "TURNPostInstall", "ParameterValue": "" }]