Skip to content

Preface

Here you will find a list of all the services Redbrick runs, along with some configs and some important information surrounding them.

Adding More Services

In order to add a new service, you will need to edit the docs repository.

Adding a new service is as easy as creating a new file in docs/services/ with an appropriate name, and the page will be automatically added to the navigation pane.

Try to keep file names short and concise, limited to one word if possible and avoid using spaces.

The style guide for a service file should be as follows:

Markdown
---
title: ServiceName
author:
  - username
tags:
  - relevant
  - tags

---

# ServiceName - `username`

Short description on how the service works and where it is running

## Configuration

Add some possible useful configs here, like a docker-compose file,
certain command you may have had to run, or something that is not very obvious.
Look at other services for hints on this.