cameleer/cameleer-saas
2
0
Fork 0
Code Issues 23 Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: update user manual for current UI and identity model
All checks were successful
CI / build (push) Successful in 1m58s
Details
CI / docker (push) Successful in 21s
Details

Browse Source 
- Sign-in instructions: "Enter your email" (not "email or username")
- Troubleshooting: remove reference to deleted "Sign in with Logto" button
- Sidebar navigation: replace outdated single table with vendor console
  and tenant portal sections reflecting current sidebar structure

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
hsiegeln
2026-04-25 20:53:19 +02:00
parent 8fe18c7f83
commit 1d26ae481e
1 changed files with 21 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/user-manual.md
View File

@@ -30,7 +30,7 @@ Cameleer SaaS uses Logto for single sign-on (SSO). Email is the primary user ide
1. Navigate to the Cameleer SaaS URL in your browser.
2. You will be redirected to the Cameleer sign-in page.
3. Enter your email or username and password.
3. Enter your email and password.
4. After successful authentication, you are redirected to the dashboard.
![Login page](screenshots/login-page.png)
@@ -61,16 +61,28 @@ The dashboard provides an at-a-glance overview of your tenant:
The sidebar provides access to all major sections:
**Vendor console** (visible only to platform admins):
| Section | Description |
|---------|-------------|
| **Dashboard** | Tenant overview and KPI metrics |
| **Environments** | Expandable tree showing all environments and their apps |
| **License** | License tier, features, limits, and token |
| **Platform** | Platform-wide tenant management (visible only to platform admins) |
| **View Dashboard** | Opens the observability dashboard (cameleer-server) in a new tab |
| **Account** | Log out of the current session |
| **Tenants** | List, create, and manage tenants |
| **Audit Log** | Platform-wide audit trail |
| **Certificates** | TLS certificate lifecycle (stage, activate, restore) |
| **Metrics** | Tenant usage metrics |
| **Infrastructure** | PostgreSQL and ClickHouse health |
| **Email Connector** | Configure SMTP for email verification and self-service registration |
| **Logto Console** | Opens the Logto admin console (external link) |
The Environments section in the sidebar renders as a collapsible tree: environments at the top level, with their applications nested underneath. Clicking any item navigates directly to its detail page.
**Tenant portal** (visible to tenant admins):
| Section | Description |
|---------|-------------|
| **Dashboard** | Tenant overview, server health, usage, and quick links |
| **License** | License tier, features, limits, and token |
| **Security** | SSO connector configuration |
| **Team** | Manage team members and reset passwords |
| **Audit Log** | Tenant-scoped audit trail |
| **Settings** | Change own password, reset server admin password |
---
@@ -517,7 +529,7 @@ The Cameleer SaaS application itself does not need any changes -- all identity c
### Login Fails or Redirect Loop
**Symptoms:** Clicking "Sign in with Logto" redirects you in a loop, or you see an error page.
**Symptoms:** The sign-in page redirects in a loop, or you see an error page.
**Possible causes:**