AiHummer
English▾
Log in
v1.0.x▾
v1.0.xstable
{ }Swagger
Getting started/Quickstart

Quickstart

v1.0.x · updated 2026-07-07

This quickstart walks through the first run of AiHummer — from install to a first agent answering in a channel. Each step has a dedicated page with full detail, linked as you go.

Install AiHummer

Installation starts in your personal account: register at my.aihummer.ru, open the “Installation” screen and get your personal install link. The portal shows a ready-to-run command — run it on the server with sudo (a rootless install is also supported — see Installation):

curl -fsSL "<your personal install link>" | sudo bash

The installer detects your architecture, downloads and verifies the signed bundle, lays out the install root and registers the gateway service under systemd. For the full detail — the personal link, release channels, choosing sidecars, verifying — see Installation.

Point at PostgreSQL

The only hard dependency is PostgreSQL with the pgcrypto extension enabled. The installer wires the database connection automatically. If you set the database manually, use the AIHUMMER_DATABASE_URL configuration option:

AIHUMMER_DATABASE_URL=postgres://user:pass@localhost:5432/aihummer?sslmode=disable
-- once, in the target database
CREATE EXTENSION IF NOT EXISTS pgcrypto;

Database migrations are applied automatically on startup.

Open the admin UI

Once the service is up, open the admin Web UI on the server. It runs on its own private listener (default :8781, AIHUMMER_WEBUI_ADDR), served at the root path / — not on the public gateway port:

http://localhost:8781/

On an empty database the gateway creates the admin login and writes the initial password to ~/.aihummer/etc/initial-admin-password.txt. Read it, sign in, change the password immediately and delete the file — see First login for the details.

Connect your first channel

From the admin UI, add a channel so messages can reach AiHummer:

  • Telegram — the most production-ready connector to start with.
  • Web widget — the quickest way to test everything in a browser.
  • MAX — a Russian messenger, also available.

Create your first agent

In the admin UI, create an agent: give it a persona and, optionally, a per-agent model. Bind it to the channel you just added (the “Bindings” block on the “Channels” page) so the router knows where to send messages. Send a message through the channel and watch the turn run end to end.

Talk to the agent right from the admin UI

A channel is not required for a first check: on the “Sessions” page the “+ New session” button opens a conversation with the agent right in the admin UI. The composer lets you attach files (images and documents — the model receives the extracted text), and two toggles above the thread reveal per-turn cost and tool output — handy for seeing what the agent did on each step.

[!TIP] You can also drive AiHummer directly through its OpenAI-compatible API without any channel:

POST /v1/chat/completions
Content-Type: application/json

{"model": "default", "messages": [{"role": "user", "content": "Hello"}]}

Set "stream": true for SSE streaming.

Mind the mock model

Until you wire a real model, replies come from a deterministic mock — useful for validating channels, routing and agents without any model cost.

[!NOTE] A real model is never required: AiHummer runs on free/local OpenAI-compatible endpoints and a Codex/ChatGPT-subscription transport. To connect your own provider (BYOK), set the AIHUMMER_LLM_* configuration options — this is optional. See Requirements.

Where to next