# etke.cc-specific components

This directory contains [etke.cc](https://etke.cc)-specific components, unusable for any other purposes and/or configuration.

We at [etke.cc](https://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](https://etke.cc) customers.

Due to the specifics mentioned above, these components are documented here rather than in the [docs](../../../docs/README.md), 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](../../../screenshots/etke.cc/server-status/indicator.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):

* 🟢 (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](https://etke.cc/help/extras/scheduler/#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 icon in sidebar](../../../screenshots/etke.cc/server-status/indicator-sidebar.webp)

The same icon (and link to the [Server Status page](#server-status-page)) is displayed in the sidebar.

### Server Status page

![Server Status Page](../../../screenshots/etke.cc/server-status/page.webp)

When you click on the [Server Status icon](#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

This is [a Monitoring report](https://etke.cc/services/monitoring/)

### Server Notifications icon

![Server Notifications icon](../../../screenshots/etke.cc/server-notifications/badge.webp)

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](../../../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.

### Server Actions Page

![Server Actions Page](../../../screenshots/etke.cc/server-actions/page.webp)

When you click on the `Server Actions` sidebar menu item, you will be redirected to the Server Actions page.
On this page you can do the following:

* [Run a command](#server-commands-panel) on your server immediately
* [Schedule a command](https://etke.cc/help/extras/scheduler/#schedule) to run at a specific date and time
* [Configure a recurring schedule](https://etke.cc/help/extras/scheduler/#recurring) for a command to run at a specific time every week

### Server Commands Panel

![Server Commands Panel](../../../screenshots/etke.cc/server-commands/panel.webp)

When you open [Server Actions 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.
