DocsChat
Get started

Admin onboarding

Create an account, sign in, and launch your first documentation chatbot — no programming required.

Sign up

  1. Open /en/signup or /ru/signup (or click Get started on the website).
  2. Enter your name, email, and password (at least 6 characters).
  3. Submit — you get a Free plan with 50 message credits and a default chat agent.
  4. Confirm your email using the link we send you (/en/verify-email?sent=1).

In local development, the confirmation link appears in the server console instead of real email.

Log in

  • Go to /dashboard/login (add ?lang=ru for Russian buttons and menus)
  • After npm run db:seed, test login: admin@example.com / admin123

Forgot / reset password

  1. On the login page, click Forgot password?
  2. Enter your email — we send a reset link (console in dev)
  3. Open the link and choose a new password
  4. Sign in again

Resend verification

On /verify-email, click Resend verification email while signed in.

Workspaces

  • Switch workspaces from the header menu
  • Each workspace has its own plan, credits, agents, and integrations
  • Create another workspace from the switcher or via POST /api/workspaces

First steps checklist

  1. Upload a document — open Documents at /dashboard/documents, add a PDF or text file
  2. Wait until ready — status must show READY (keep the worker running)
  3. Set a welcome message — open Settings at /dashboard/settings, write how the bot should greet visitors
  4. Try the chat — open an agent Playground from /dashboard/agents or your public link /chat/support
  5. Check usage — open Usage at /dashboard/usage to see remaining message credits

Share the public chat link with customers when answers look good.

Advanced setup (optional)

With the dev server running (npm run dev) and Postgres seeded:

npm run test:e2e          # smoke: public routes, embed SDK, API v2 auth
npm run test:integration  # admin login, builder, chat, inbox, API v2, omnichannel mocks
npm run test:all          # both suites

Integration tests upgrade the default workspace to Standard plan and create a test API key automatically. Live LLM tests run only when CURSOR_API_KEY or LLM_API_KEY is set.

Telegram channel

  1. Create a bot via @BotFather and copy the token.
  2. In admin, connect channel: PUT /api/channels with { "type": "TELEGRAM", "configJson": { "botToken": "...", "botId": "<agent-id>" } }.
  3. Set webhook manually or enable TELEGRAM_AUTO_WEBHOOK=true — webhook URL: /api/telegram/webhook?conn=<connectionId>.
  4. Set TELEGRAM_WEBHOOK_SECRET (defaults to connection id).

Website crawl (knowledge source)

When adding a WEBSITE knowledge source, set maxPages (default 10, max 50). The worker crawls same-origin links via BFS and indexes each page separately.

Run crawl unit tests: npm run test:crawl.

See also 152-ФЗ compliance for RU data residency positioning.

WhatsApp (Meta Cloud API)

  1. Create a Meta Business app with WhatsApp product and get phone_number_id, access token.
  2. Set WHATSAPP_VERIFY_TOKEN in .env (used for webhook verification challenge).
  3. Connect channel: PUT /api/channels with { "type": "WHATSAPP", "configJson": { "phoneNumberId": "...", "accessToken": "..." } }.
  4. Point Meta webhook to /api/whatsapp/webhook (GET for verify, POST for messages).

Compliance & voice (RU)

Русская версия

Регистрация и вход

  1. Откройте /ru/signup или нажмите Начать на сайте.
  2. Заполните имя, email и пароль (от 6 символов).
  3. После регистрации проверьте email — ссылка в письме (в dev смотрите логи сервера).
  4. Вход: /dashboard/login?lang=ru. Тестовый аккаунт после seed: admin@example.com / admin123.

Сброс пароля

Забыли пароль? на странице входа → /ru/forgot-password → ссылка в письме → новый пароль.

Workspace

Переключатель workspace в шапке админки. Данные (агенты, документы, billing) привязаны к активному workspace.

Первые шаги: Агенты (/dashboard/agents) → Playground → проверка ответов. Документы: /dashboard/documents.

Automated tests

With the dev server running (npm run dev) and Postgres seeded:

npm run test:e2e          # smoke: public routes, embed SDK, API v2 auth
npm run test:integration  # admin login, builder, chat, inbox, API v2, omnichannel mocks
npm run test:all          # both suites

Integration tests upgrade the default workspace to Standard plan and create a test API key automatically. Live LLM tests (playground, Cursor API) run only when CURSOR_API_KEY or LLM_API_KEY is set.

← Admin guides