mt77/synapse-admin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
synapse-admin/src/components/etke.cc/README.md
Borislav Pantaleev 7c21692a1e
Add server status page and a badge in AppBar (#182) 
* WIP: Add server status and running process indicators

* Finish ServerStatusPage and ServerRunningProcess

* fix typos, add running process info to the server status page

* Remove ServerRunningProcess and integrate it into ServerStatusBadge

* remove divider in menu

* display time as started X minutes ago

* add documentation; clearly state what new components are; update readme

* change wording a bit, cross-link with docs/README.md

* use returned HTML

* Finish ServerStatus page and badges

* Fix types

* cleanup

* remove some code

* adjust config load
2024-12-04 00:14:29 +02:00

1.8 KiB
Raw Blame History

etke.cc-specific components

This directory contains etke.cc-specific components, unusable for any other purposes and/or configuration.

We at etke.cc attempting to develop everything open-source, but some things are too specific to be used by anyone else. This directory contains such components - they are only available for etke.cc customers.

Due to the specifics mentioned above, these components are documented here rather than in the docs, plus they are not supported as part of the Synapse Admin open-source project (i.e.: no issues, no PRs, no support, no requests, etc.).

Components

Server Status icon

Server Status icon

In the application bar the new monitoring icon is displayed that shows the current server status, and has the following color dot (and tooltip indicators):

  • 🟢 (green) - the server is up and running, everything is fine, no issues detected
  • 🟡 (yellow) - the server is up and running, but there is a command in progress (likely maintenance), so some temporary issues may occur - that's totally fine
  • 🔴 (red) - there is at least 1 issue with one of the server's components

Server Status page

Server Status Page

When you click on the Server Status icon in the application bar, you will be redirected to the Server Status page. This page contains the following information:

  • Overall server status (up/updating/has issues)
  • Details about the currently running command (if any)
  • Details about the server's components statuses (up/down with error details and suggested actions) by categories