Beer Garden Documentation

Follow the links on this page to learn about Beer Garden or plugin development. You’ll also find tips on how to be troubleshoot Beer Garden and how to write effective, composable plugins with Beer Garden syntax.

Can’t find the information you need? Reach out to project members and users via Gitter

The Basics

Discover Beer Garden and how it can help you.

What is Beer Garden?

A high-level overview of what Beer Garden is exactly and when you should use it

Beer Garden User Manual

The A to Z guide of Beer Garden

API User’s Guide

If you aren’t writing plugins, but rather using them, this guide is for you

Get Started with Beer Garden

Installation Guides

Ready to Install Beer Garden? Pick your favorite guide and get started!

Quickstart

A short 5-minute tutorial for getting Beer Garden and a plugin up and running

Write Plugins with Beer Garden

Plugin Syntax Quick Reference Guide

An overview of the plugin syntax you’ll likely need to write a useful plugins

Plugin Developer’s Guide

A comprehensive tutorial with examples that show you how to write plugins

Beer Garden Architecture

Beer Garden Architecture

Learn how Beer Garden internals works

Contributing to Beer Garden

How do I report a bug?

Did you find a bug somewhere in Beer Garden? Checkout how to tell us.

How do I request a feature?

Do you have the next cool idea for Beer Garden to implement? Tell us about it!

How do I submit code to the project?

If you have code you’d like to contribute, create a pull request!

Reference and Developer Resources