Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs(admin): document the System page and test email

Tinfa1ebd72ae87
diff --git a/apps/docs/core/functional/collaborate-with-team.mdx b/apps/docs/core/functional/collaborate-with-team.mdx
index 94b68863a..d4abcedcf 100644
--- a/apps/docs/core/functional/collaborate-with-team.mdx
+++ b/apps/docs/core/functional/collaborate-with-team.mdx
@@ -76,7 +76,7 @@ Give people the access their work needs. For example, a reviewer may only need t
In **Members**, use the member's menu to remove them and confirm the action. They lose membership in this workspace, but their Kaneo account is not deleted.
-To change the owner, use **Settings → Workspace → General → Transfer ownership**. Transfer ownership before leaving or deleting your account if you are the only owner of a shared workspace. If the owner has already left, an instance administrator can transfer ownership for them. See [Administer users and workspaces](/core/operations/administration#manage-workspaces).
+To change the owner, use **Settings → Workspace → General → Transfer ownership**. Transfer ownership before leaving or deleting your account if you are the only owner of a shared workspace. If the owner has already left, an instance administrator can transfer ownership for them. See [Administer your instance](/core/operations/administration#manage-workspaces).
## Keep the conversation with the work
diff --git a/apps/docs/core/operations/administration.mdx b/apps/docs/core/operations/administration.mdx
index 83be4247f..638e20988 100644
--- a/apps/docs/core/operations/administration.mdx
+++ b/apps/docs/core/operations/administration.mdx
@@ -1,6 +1,6 @@
---
-title: "Administer users and workspaces"
-description: "Manage every account and workspace on your instance and review administrative actions as an instance administrator."
+title: "Administer your instance"
+description: "Manage accounts and workspaces, review administrative actions, and check your instance’s services."
---
Instance administrators manage the whole Kaneo instance, not just the workspaces they belong to. The first account created on a new instance becomes an instance administrator, and an administrator can give the role to others from **User management**.
@@ -78,6 +78,34 @@ Kaneo keeps audit log entries until you remove them; there's no automatic retent
Only instance administrators signed in with a session can read the audit log, in the app or through `GET /api/admin/audit-log`. API keys are rejected.
+## Check system status
+
+Open **Settings → Administration → System** to check this instance and the services it relies on. The page checks again each time you open it or choose **Refresh**.
+
+- **Instance**: the Kaneo version, API uptime, PostgreSQL (version, applied migrations, response time), live updates (open WebSocket connections on this API instance), Redis, and S3-compatible file storage.
+- **Email**: whether SMTP is configured and whether Kaneo can connect and sign in to the mail server. Nothing is sent by this check.
+- **Sign-in**: which sign-in and registration options are on, and whether GitHub, Google, Discord, and your custom OAuth/OIDC provider are configured.
+- **Integrations**: every integration provider, how many projects are connected to it, and whether the GitHub App is set up. Other providers are connected per project and need no instance settings.
+
+Each row shows one of these statuses:
+
+| Status | Meaning |
+| --- | --- |
+| Operational | Working. |
+| Not configured | Optional and switched off. This is fine: a single API instance doesn't need Redis, and Kaneo works without SMTP or file storage. |
+| Warning | Works with a problem, or only some of its settings are present. For example, Redis is down so only people on this API instance get live updates, or a sign-in provider has a client ID but no secret. |
+| Down | Configured but not reachable. The row shows a short error code such as `TIMEOUT`, `ECONNREFUSED`, or `EAUTH`. |
+
+Each check gives up after a few seconds, so one unreachable service doesn't stop the page from loading. The page never shows hosts, passwords, client secrets, or other credentials.
+
+When you run more than one API instance behind a load balancer, the checks and connection counts come from whichever instance answered.
+
+### Send a test email
+
+Choose **Send test email** to send a short test message to your own account's address. Kaneo can't send it to anyone else. If the mail server rejects it, you see the error category (for example `EAUTH 535` for a wrong password), and the API logs the same. You can send 5 test emails every 10 minutes.
+
+The button is disabled until `SMTP_HOST` and `SMTP_FROM` are set. See [SMTP configuration](/core/installation/environment-variables#smtp-configuration) for the settings.
+
## API
The user management actions are also available to instance administrators signed in with a session under `/api/admin/users`, for example `POST /api/admin/users` to create a user. API keys are rejected. See the API reference for every endpoint.