mt77/synapse-admin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add docs

Browse Source
This commit is contained in:
Aine 2025-03-05 14:14:41 +02:00
parent 9fd7290757
commit 73028da430
No known key found for this signature in database
GPG Key ID: 34969C908CCA2804
4 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -118,6 +118,7 @@ The following list contains such features - they are only available for [etke.cc
* 📊 [Server Status indicator and page](https://github.com/etkecc/synapse-admin/pull/182) * 📊 [Server Status indicator and page](https://github.com/etkecc/synapse-admin/pull/182)
* 📬 [Server Notifications indicator and page](https://github.com/etkecc/synapse-admin/pull/240) * 📬 [Server Notifications indicator and page](https://github.com/etkecc/synapse-admin/pull/240)
* 🛠️ [Server Commands panel](https://github.com/etkecc/synapse-admin/pull/365)
### Development ### Development

BIN
screenshots/etke.cc/server-commands/panel.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 30 KiB

BIN
screenshots/etke.cc/server-status/indicator-sidebar.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.5 KiB

11
src/components/etke.cc/README.md
View File

@ -11,6 +11,7 @@ Due to the specifics mentioned above, these components are documented here rathe
### Server Status icon ### Server Status icon
![Server Status icon](../../../screenshots/etke.cc/server-status/indicator.webp) ![Server Status icon](../../../screenshots/etke.cc/server-status/indicator.webp)
![Server Status icon in sidebar](../../../screenshots/etke.cc/server-status/indicator-sidebar.webp)
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): 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):
@ -29,6 +30,8 @@ Server Status page. This page contains the following information:
* Details about the currently running command (if any) * 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 * Details about the server's components statuses (up/down with error details and suggested actions) by categories
This is [a Monitoring report](https://etke.cc/services/monitoring/)
### Server Notifications icon ### Server Notifications icon
![Server Notifications icon](../../../screenshots/etke.cc/server-notifications/badge.webp) ![Server Notifications icon](../../../screenshots/etke.cc/server-notifications/badge.webp)
@ -40,3 +43,11 @@ In the application bar the new notifications icon is displayed that shows the nu
![Server Notifications Page](../../../screenshots/etke.cc/server-notifications/page.webp) ![Server Notifications Page](../../../screenshots/etke.cc/server-notifications/page.webp)
When you click on a notification from the [Server Notifications icon](#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. When you click on a notification from the [Server Notifications icon](#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.
### Server Commands Panel
![Server Commands Panel](../../../screenshots/etke.cc/server-commands/panel.webp)
When you open [Server Status page](#server-status-page), you will see the Server Commands panel. This panel contains all
[the commands](https://etke.cc/help/extras/scheduler/#commands) you can run on your server in 1 click. Once command is finished, you will get a notification about the
result.