Symphony CLI

Symphony is a framework for making real-time collaborative applications.

Requirements

To use Symphony, you'll need:

• An AWS account
• Use AWS as your DNS Management servers via Hosted Zones
• The AWS CLI tool should be installed and configured.
• Node v19+

Usage

Installation npm install -g symphony-cli

Symphony's CLI tool is used to setup and teardown the necessary AWS infrastructure.

The infrastructure is deployed in the specified region in 2 availability zones, which can be modified for your use case.

The deployment assumes you have an existing hosted zone that holds records for your domain. Essentially it expects you to have AWS for your DNS Management servers.

If you want to use non-AWS servers for DNS resolution, you can remove adding the certificate to the hosted zone in the CDK code. After deployment, create a new record with your DNS provider and use the CNAME of the new certificate.

Commands

There are 4 main commands: type the command followed by the -h flag to display the details and options of each command

• compose: deploys infrastructure
• destroy: destroy infrastructure
• dashboard: deploy local dashboard
• update: update configurtion variables