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 c596d38d7a
Add notifications badge and page (#240) 
* WIP on server notifications

* WIP: Add server notifications page and removal of notifications

* improve design

* fix missing notifications case; add tooltop

* Fix api response

* fix tests

* add docs; update readme
2024-12-19 11:24:42 +02:00

2.4 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

Server Notifications icon

Server Notifications icon

In the application bar the new notifications icon is displayed that shows the number of unread (not removed) notifications

Server Notifications page

Server Notifications Page

When you click on a notification from the Server Notifications icon's list in the application bar, you will be redirected to the Server Notifications page. This page contains the full text of all the notifications you have about your server.