Topic Guides

This section of the documentation dives deep into individual parts of Brigade. We’ll look at Brigade’s architecture, explore the three main roles of interaction with Brigade, go over Brigade’s scripting API and much more. This is probably where you’ll want to spend most of your time; if you work your way through these guides you should come out knowing pretty much everything there is to know about Brigade.

If you don’t see a topic guide here and have a reasonable level of knowledge on the subject, why not write one up?

Table of Contents

• Architecture
  • Brigade Design: A high-level explanation of how Brigade is designed.
  • Brigade Roles: The main roles of interaction within Brigade
• Operators
  • Overview: An overview of the Operator role in Brigade
  • Deployment: How to deploy and manage Brigade
  • Securing Brigade: Securing Brigade via TLS, Ingress and Third-Party Auth
  • Storage: Storage options and configuration for Brigade
  • Gateways: Using and developing Brigade gateways
• Administrators
  • Overview: An overview of the Administrator role in Brigade
  • Authentication: Authentication strategies in Brigade
  • Authorization: Authorization setup in Brigade
• Project Developers
  • Overview: An overview of the Project Developer role in Brigade
  • Projects: Creating and managing Brigade Projects
  • Events: Understanding and handling Brigade Events
  • Using Secrets: Using secrets in Brigade Projects
  • Using the Brigade CLI: Using the brig CLI to interact with Brigade
  • Brigterm: Using the Brigterm visualization utility
• Scripting
  • Overview: Scripting in Brigade
  • Scripting Guide: A guide to writing brigade.js/brigade.ts scripts in Brigade
  • Brigadier: Brigadier: the JS/TS library for Brigade scripts
  • Scripting Guide - Advanced: Advanced examples for Brigade scripts.
  • Adding dependencies: How to add local dependencies and NPM packages to your Brigade scripts.
  • Workers: More information regarding the Brigade Worker.
• Contributing to Brigade Development
  • Brigade Developers Guide: A guide for people who want to modify Brigade’s code.
• Examples
  • Example Projects: Example Brigade projects