GRPC Proxy

This project is a SocketIO proxy for the Termius GRPC API.

Development

The project uses scripts in package.json to manage and run tasks for project development.

npm install  # Install dependencies
npm run lint  # Check codestyle
npm test  # Run tests
npm start  # Run local development server

The project uses Makefile to manage and run tasks for project deployemnt.

make build  # Build docker image
make lint-tf  # Run static analysis for Terraform configurations
make plan-deploy # Setup terraform configuration and plan changes

Prerequisites

• Node
• Docker-compose
• Docker
• AWS CLI v1
• Make
• Terraform
• TFlint
• Checkov

Deployment

The project uses Continuous Deployment. The change from the develop branch are deployed

Deployment from local environment to AWS

make push-development  # Build and push docker image for the development environment
make release-development  # Update the development environment
make push-production  # Build and push docker image for the production environment
make release-production  # Update the production environment

How to test grpc locally:

1. Replace original process.env to current in configuration.ts file:

export const { GRPC_HOST_AND_PORT = 'dev.grpc.termius.com:443' } = process.env
export const { ALLOWED_ORIGINS = 'https://devserver.termius.com:9000' } = process.env

2. Rebuild grpc-proxy

npm run build

3. Run grpc-proxy

npm start

4. Add ws://127.0.0.1:4200 to AM CSP connect-src