Complete Guide

Welcome to the Complete Guide to Hipcheck! This guide is intended to explain:

What Hipcheck is
How to use Hipcheck effectively
The key concepts underlying Hipcheck's design
How to configure Hipcheck
How to interpret Hipcheck's output
How to debug Hipcheck if you encounter an error

Since we intend this to be a complete guide, if you encounter questions you don't feel are adequately answered by this guide, please let us know by opening an issue on our issue tracker!

Key Concepts

An explanation of the ideas underpinning Hipcheck's design.

Configuration

How to configure Hipcheck and describe your policies to apply.

CLI Reference

Reference for all CLI commands and arguments.

Debugging

How to identify errors during Hipcheck execution.

Plugins

Index of existing plugins for Hipcheck, both for data and analyses.

Making Plugins

A guide for making new Hipcheck plugins.