Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 2.34 KB

README.md

File metadata and controls

46 lines (37 loc) · 2.34 KB

Documentation Index

The codestream-server mono-repo contains all of the individual compoenents for the server-side codestream services. While the mono-repo is used for development, the CI/CD pipelines build, manage & deploy the components independently. The mono-repo is never built or installed anywhere outside of local development.

Much of the in-repo documentation can be found within the individual components' docs directories (links below). Further, some of the docs reference sites on the codestream development network. These links will not work outside of that context.

Mono-Repo Supplemental Documentation

Server Components

  • API - By far the largest component containing all of the business logic, data models and access layer to the database. Supplemental API docs can be found here.

  • Broadcaster - For On-Prem deployments, the broadcaster handles instant messaging communications between clients and the server utilizing the socketcluster.io library. Supplemental broadcaster docs can be found here.

  • Outbound Email - The API is responsible for determining what email should be sent and queuing up requests accordingly. It uses AWS SQS for CodeStream Cloud and RabbitMQ for CodeStream On-Prem. The Outbound Email service de-queues the requests and processes them. For CodeStream Cloud, we use the SendGrid.com service. On-Prem installations can use SendGrid or any standard SMTP relay (via NodeMailer). Supplemental outbound email docs can be found here.

  • Inbound Email - Inbound email servers running postfix receive inbound SMTP connections and write the messages to queues (files on the filesystem) which the inbound email service processes. The inbound email service verifies the messages and injects into CodeStream by way of making API calls. Supplemental inbound email docs can be found here.