Go Help Desk Docs

Everything you need to deploy, configure, and extend Go Help Desk. Start with Getting Started or jump to the section you need.

Upgrading to 1.2.0

A security release that changes behaviour you may be relying on. Read before upgrading.

  • Credentials made in the 1.1.1 UI stop working
  • Everyone is signed out once
  • Email no longer carries ticket content

Getting Started

Deploy with Docker Compose in minutes. Full configuration reference and first-run checklist.

  • Docker Compose quick start
  • All environment variables
  • First-run setup order
  • Upgrading

Authentication

Local accounts, TOTP MFA, SAML 2.0 SSO with Okta, Azure AD and Google, and API keys.

  • Local accounts & passwords
  • TOTP MFA enrollment
  • SAML 2.0 setup (Okta, Azure, Google)
  • API key management

Admin Guide

Configure categories, manage users and groups, define SLA policies, set up email, webhooks, and plugins.

  • CTI category hierarchy
  • Groups & staff scope
  • SLA policies
  • Email templates & webhooks

Working with Tickets

Creating tickets, the full lifecycle, replies, internal notes, linked tickets, assignment, and attachments.

  • CTI form & required fields
  • Lifecycle & status transitions
  • Linked ticket types
  • Replies vs. internal notes

REST API

Complete endpoint reference with request/response examples, authentication methods, error formats, and pagination.

  • Auth (session, API key, OAuth2)
  • Tickets, replies, links
  • Admin endpoints
  • Errors & pagination

MCP Server

Connect AI assistants to Go Help Desk as native tools. Configure Claude, VS Code, and other MCP clients.

  • Available tools & permissions
  • Connecting Claude
  • Connecting VS Code
  • Generic HTTP client config

Plugin Development

Build WASM plugins that react to ticket events, call external APIs, and add custom UI panels.

  • Plugin manifest & config schema
  • Event hooks & payloads
  • Full host API reference
  • Working Slack example

Contributing

Set up a local dev environment, run integration tests, and follow the schema change workflow.

  • Dev environment setup
  • Running tests
  • Schema change workflow
  • Code conventions