Abkus Hub — Manual
Step-by-step per screen, with a topical index (7 topics). Use “Download PDF” to save this page as a PDF (print → Save as PDF). Shipped with your subscription.
Your account
Everyday Hub: who is logged in, what they subscribe to, and personal settings.
Dashboard
What it does: Página inicial após o login. Mostra contagens ao vivo do banco do Hub: usuários registrados, assinaturas ativas e o gasto de LLM registrado nos últimos 30 dias. É um retrato, não um painel de controle.
Open this when: Você quer uma visão rápida de “há uso? estamos gastando com modelos?”.
Not this: Não configura SSO, planos nem a frota de LLMs. O trabalho de superadmin começa em Superadmin, não aqui.
Steps & key controls
- Live count cards (users, subscriptions, AI spend) — A snapshot of Hub usage at a glance — read-only totals from the database, so you see activity without touching any configuration.
- Recent AI spend — Shows what the LLM fleet cost in the last 30 days, surfacing spend trends before they reach the cost monitor.
Contas
What it does: Lista as pessoas que têm identidade no Hub (o mesmo login usado em todo app Abkus). Você vê quem existe e o status geral de assinatura. Reset de senha e 2FA ficam nas configurações de segurança do próprio usuário, não nesta tabela.
Open this when: Você precisa encontrar uma pessoa, confirmar que ela tem conta ou ver quem é assinante.
Not this: Não é o registro de clientes SSO (isso é Clientes SSO) nem o detalhe completo de quem paga qual plano (isso é Assinaturas).
Steps & key controls
- User rows (email, subscription status) — The directory of Hub identities — find a person and see high-level subscription state; full billing detail lives on Subscriptions.
Faturamento (suas assinaturas)
What it does: O checkout dos apps Abkus (SBM, Travel e os demais). Planos e preços vêm do catálogo do Hub. O checkout conversa com o Merchant of Record ativo. Parâmetros `app`, `plan` e `cycle` destacam um plano específico quando um satélite enviou o usuário para cá.
Open this when: Você (ou um cliente) precisa iniciar, alterar ou entender uma assinatura Abkus.
Not this: Não é onde se colam chaves de Paddle/Stripe nem se editam preços de plano. Isso é Faturamento (MoR) e Planos e Produtos no Superadmin.
Steps & key controls
- Tabs: Subscriptions | Receipt method — Separates the two billing levels that must never be confused: Level 1 (Abkus charging you, checkout below) and Level 2 (you charging your own customers, merchant keys).
- Highlighted checkout card + Subscribe buttons — A satellite app can deep-link here with app/plan/cycle to pre-highlight the exact plan the customer chose; Subscribe opens the active Merchant of Record checkout.
- Receipt method panel (Level 2) — Lists your own merchant credentials, lets you paste provider keys per gateway, test the connection, and shows each credential’s webhook URL to paste into the provider dashboard.
- Test subscribe (provisional password) — Fail-safe when no payment processor is configured: subscribing with the canonical password exercises the billing flow without charging anyone.
- Manage Billing ↗ — Opens the processor’s customer portal for subscription changes on Abkus’s side (upgrade, card, invoices).
Your account
What it does: The Hub account page: your photo, name and email, the identity every Abkus app sees. When an app opens it, it renders in that app’s context with a “Back to app” link. Full preferences live in Settings; subscriptions in Billing.
Open this when: You want to change your photo or check the identity every app shows.
Not this: Theme/language and API keys are Settings. Subscriptions and receipts are Billing. Password changes are Security.
Steps & key controls
- Profile photo (upload / remove) — One photo for every Abkus app — changing it here updates the shared identity, synced back to the Hub IdP.
- Subscriptions / Preferences cards — Jump to Billing (plans and receipts) or Settings (theme, language) without hunting the menu.
Configurações
What it does: Preferências pessoais do usuário autenticado: aparência, idioma e opções ligadas à conta. Não muda a marca de outro app nem feature flags.
Open this when: Você quer Claro/Escuro, idioma ou opções da sua própria conta do Hub.
Not this: Toggles de produto para todos os usuários são Feature Flags. Logos de tenant não se configuram aqui.
Steps & key controls
- Appearance (Light / Dark) — Personal visual theme for the signed-in user — does not change app branding or tenant logos.
- Language / locale — Sets the interface language for this account; the Hub chrome and app surfaces follow the chosen locale.
Security
What it does: Account security for the signed-in user: change the current password (confirming the old one) or email a password-reset link. Passwords are hashed with argon2; this screen never shows or stores the old one.
Open this when: You suspect your password leaked, rotate passwords periodically, or lost it on another device.
Not this: This is your Hub identity only — app-level logins do not exist (Hub SSO is the one login). Two-factor authentication is not offered here.
Steps & key controls
- Change Password (current + new + confirm) — Rotates your Hub password in place; confirming the current password proves it is really you before the new one is accepted.
- Forgot Password → Send reset link — Emails a one-time reset link for when you are locked out on another device; the link flow is the same one satellites reuse for lost passwords.
Central de Ajuda
What it does: O catálogo sobre o qual o sistema foi construído. Cada tela do Hub tem um tópico com “o que faz”, “abra quando…”, “isto não é…” e links para as telas com que as pessoas costumam confundi-la. O mesmo texto aparece na própria tela pelo explicador “Para que serve esta tela”.
Open this when: Qualquer tela ou comando parece desconhecida — pesquise no índice em vez de adivinhar.
Not this: Documenta telas do Hub, não telas de apps satélites (cada app tem sua própria ajuda). Não é um player de tutorial.
Steps & key controls
- Group index (by concern) — Groups every cataloged screen so you can scan by area instead of knowing the exact screen name.
- Topic cards — Each card carries the screen’s one-liner and opens the full topic (what it does / open this when / not this / related).
Generated from the same source as the in-app Help Center (/help).