# Maxy Documentation

Public documentation for Maxy — AI for productive people. Source markdown for every page is available at the same URL with a `.md` suffix.

## Getting Started

- [Getting Started](https://docs.getmaxy.com/getting-started.md): What Maxy is and how to start using it in a fresh install.
- [How Maxy Works](https://docs.getmaxy.com/platform.md): The short version of the platform: agents, plugins, graph, and the admin chat surface.
- [Plugins Guide](https://docs.getmaxy.com/plugins-guide.md): What a plugin is, how they get loaded, and how operators turn them on or off.

## Install

- [Install Overview](https://docs.getmaxy.com/install.md): How Maxy installs from one npm one-liner across macOS, Raspberry Pi, and Hetzner Cloud.
- [macOS Install](https://docs.getmaxy.com/install/macos.md): End-to-end install on Apple Silicon macOS — copy-paste commands, no interactive prompts.
- [Raspberry Pi Install](https://docs.getmaxy.com/install/pi.md): End-to-end install on a Raspberry Pi 5 (16GB) running Ubuntu Server 24.04 ARM64.
- [Hetzner Cloud Install](https://docs.getmaxy.com/install/hetzner.md): End-to-end install on a Hetzner CAX31 ARM64 cloud server (~€13/mo) running Ubuntu 24.04.

## Setup

- [Cloudflare Tunnel](https://docs.getmaxy.com/cloudflare.md): Why the Cloudflare dashboard is the source of truth and how the agent never touches your account directly.
- [Access Control](https://docs.getmaxy.com/access-control.md): Who can read and write to your Maxy install: admin auth, public chat scope, and brand isolation.
- [Settings](https://docs.getmaxy.com/settings.md): Operator-facing knobs: output style, model selection, brand configuration, env overrides.

## Guides

- [Contacts](https://docs.getmaxy.com/contacts-guide.md): What a Maxy contact is, how it gets created, and how the agent uses it to ground conversations.
- [Memory](https://docs.getmaxy.com/memory-guide.md): How Maxy remembers things — brain-first lookup, graph-rooted facts, and what the agent will not forget.
- [Projects](https://docs.getmaxy.com/projects-guide.md): How to organise work into projects so the agent can hold context and pick up where you left off.
- [Telegram](https://docs.getmaxy.com/telegram-guide.md): Connecting Telegram so the agent can read, summarise, and act on your message threads.
- [Outlook](https://docs.getmaxy.com/outlook-guide.md): Microsoft 365 / Outlook integration via Graph API — per-account OAuth, encrypted tokens, automatic refresh.
- [LinkedIn Extension](https://docs.getmaxy.com/linkedin-extension.md): A small Chrome extension that captures LinkedIn profiles and DM threads into the graph with one click.
- [Admin Chat Attachments](https://docs.getmaxy.com/attachments.md): What you can drag-and-drop into the admin chat, how each file type is processed, and the size caps.
- [Answer Engine Optimisation](https://docs.getmaxy.com/aeo.md): Shape the site for Claude, ChatGPT, Perplexity, and Google AI Overviews via schema.org, llms.txt, and an audit pass.
- [Session Retrospective](https://docs.getmaxy.com/session-retrospective.md): The extra turn the agent runs when you end a session — what it saves, why, and where it lands in the graph.
- [Visitor Graph](https://docs.getmaxy.com/visitor-graph.md): Behavioural analytics that link anonymous page visits to known Person contacts in your graph.
- [Voice Mirror](https://docs.getmaxy.com/voice-mirror-guide.md): How the voice plugin captures, transcribes, and learns from your speech for callbacks and ambient note-taking.

## Admin UI

- [Admin UI Reference](https://docs.getmaxy.com/admin-ui.md): A compact map of the admin web app: every page, panel, and API mount under /api/admin.
- [Graph View](https://docs.getmaxy.com/graph.md): The force-directed graph view at /graph — navigation, filters, and how to read the layout.

## Reference

- [Neo4j Edge Types](https://docs.getmaxy.com/neo4j.md): Every edge type Maxy writes to the graph: what it means, what nodes it connects, and when it is created.
- [Platform Internals](https://docs.getmaxy.com/internals.md): Retrieval architecture: how information moves from the Neo4j graph into an agent context window.
- [Deployment Guide](https://docs.getmaxy.com/deployment.md): Hardware, supervisor, tunnel, and update mechanics for a production Maxy install.
- [Samba Share](https://docs.getmaxy.com/samba.md): Per-brand SMB network share: provisioned footprint, share path, install-owner + PIN credentials, per-OS mount, peer-brand lifecycle, and LAN-only binding.

## Troubleshooting

- [Troubleshooting](https://docs.getmaxy.com/troubleshooting.md): Common failure modes and how to diagnose them — stream logs, Neo4j connectivity, VNC, Cloudflare, more.