Andrea Docs
Product docs

Everything you need to run, extend, and ship Andrea Helpdesk.

Installation paths, API reference, schema detail, PWA push notifications, internal chat WebSockets, product screenshots, release notes, and update mechanics. This site is built from the app repository docs and wrapped in a navigation structure that is easier to browse than raw markdown.

Read the guide Jump to the API

Coverage

10 core docs

Guide, install, API, schema, PWA, chat, screenshots, versioning, and changelog.

Source of truth

Synced from the Andrea app repo

Update the app docs, then rebuild this site. No second docs fork to babysit.

Understands technical terms like reset-admin-password, file paths, and CLI commands.

Overview 10

Getting Started

Product overview, installation paths, requirements, and high-level feature reference.

Open document
Overview 15

Installation

Command-line install, FTP/shared-hosting install, and the browser installer flow with generated mockups.

Open document
Reference 20

API Specification

Full REST API reference including auth, tickets, replies, attachments, portal routes, and update endpoints.

Open document
Reference 30

Database Schema

Table-by-table schema notes, keys, indexes, relationships, and operational behavior.

Open document
Product Tour 40

Screenshots

Annotated screenshots of the agent UI, portal, reports, and admin settings.

Open document
Operations 45

PWA And Push Notifications

Installable app behavior, Web Push setup, VAPID diagnostics, notification preferences, and mobile install notes.

Open document
Operations 50

Versioning And Updates

Release metadata, update flow, preflight checks, and deployment/update mechanics.

Open document
Operations 55

Chat WebSocket Service

Production systemd service setup for the internal chat WebSocket daemon.

Open document
Operations 56

Chat WebSocket Reverse Proxy

Apache and Nginx proxy configuration for the browser-facing /ws/chat endpoint.

Open document
Operations 60

Changelog

Release history and notable changes across features, fixes, security, and docs.

Open document

Sections

OverviewReferenceProduct TourOperations

Good entry points

Getting Started Requirements, install paths, and product overview. Screenshots See the actual UI before reading code or schema notes. PWA And Push Install prompts, VAPID setup, Web Push diagnostics, and mobile behavior. Chat WebSocket Service Run the internal chat daemon under systemd and proxy /ws/chat correctly. Versioning And Updates Understand update checks, updater behavior, and release flow.