mirror of
https://github.com/crocofied/CoreControl.git
synced 2025-12-29 16:14:43 +00:00
cleanup v2
This commit is contained in:
@@ -1,7 +0,0 @@
|
||||
# Discord Notification Setup
|
||||
|
||||
To enable Discord notifications, you will need a **Discord Webhook URL**.
|
||||
This URL allows the system to send messages directly to a specific Discord channel.
|
||||
|
||||
You can create a webhook by following this [official Discord guide](https://support.discord.com/hc/articles/228383668).
|
||||
Once created, simply paste the webhook URL into the designated field in your notification settings.
|
||||
@@ -1,17 +0,0 @@
|
||||
# Echobell Notification Setup
|
||||
|
||||
To enable Echobell notifications, you need the following:
|
||||
|
||||
- **Echobell Webhook URL**
|
||||
The HTTP POST endpoint that Echobell exposes for your channel. You’ll find it in your channel’s **Integrations → Webhooks** section.
|
||||
|
||||
- **Message Field Key**
|
||||
The JSON field name that Echobell expects for the notification text. By default this is `message`, but you can verify or customize it under **Integrations → Webhooks → Payload Settings**.
|
||||
|
||||
## How to get your Webhook URL and field key
|
||||
|
||||
1. **Log in** to your Echobell account.
|
||||
2. **Select the channel** you want to send notifications to.
|
||||
3. Navigate to **Integrations → Webhooks**.
|
||||
- Copy the **Webhook URL** shown there (e.g., `https://api.echobell.one/hooks/abc123`).
|
||||
4. In the same screen, check **Payload Settings** and confirm the **Field Key** for your message (`message`).
|
||||
@@ -1,31 +0,0 @@
|
||||
# Email Notification Setup
|
||||
|
||||
To enable email or SMTP notifications, the following fields must be configured:
|
||||
|
||||
- **SMTP HOST**
|
||||
The address of the SMTP server (e.g., `smtp.gmail.com` or `mail.example.com`).
|
||||
*→ Specifies which server will be used to send emails.*
|
||||
|
||||
- **SMTP PORT**
|
||||
The port used for sending (typically `465` for SSL or `587` for TLS).
|
||||
*→ Defines the communication channel to the SMTP server.*
|
||||
|
||||
- **Secure Connection**
|
||||
Indicates whether a secure connection is used (`SSL` or `TLS`).
|
||||
*→ Important for secure transmission of emails.*
|
||||
|
||||
- **SMTP Username**
|
||||
The username for the email account (often the full email address).
|
||||
*→ Used to authenticate with the SMTP server.*
|
||||
|
||||
- **SMTP Password**
|
||||
The corresponding password or an app-specific password.
|
||||
*→ Also required for authentication. Make sure to store it securely.*
|
||||
|
||||
- **From Address**
|
||||
The sender's email address (e.g., `noreply@example.com`).
|
||||
*→ This address will appear as the sender in the recipient's inbox.*
|
||||
|
||||
- **To Address**
|
||||
The recipient's email address where notifications should be sent.
|
||||
*→ Can be your personal email or a designated support inbox.*
|
||||
@@ -1,6 +0,0 @@
|
||||
# Notifications
|
||||
You can set the notifications for CoreControl in the settings. These notifications include when an application goes online or offline and when a server goes online or offline.
|
||||
|
||||

|
||||
|
||||
You can also customize direct notification texts and improve them with placeholders
|
||||
@@ -1,17 +0,0 @@
|
||||
# Gotify Notification Setup
|
||||
|
||||
To enable Gotify notifications, you need the following information from your Gotify server:
|
||||
|
||||
- **Gotify URL**
|
||||
The base URL of your Gotify server (e.g., `https://gotify.example.com`).
|
||||
|
||||
- **Gotify Token**
|
||||
The application token used to authenticate and send messages.
|
||||
|
||||
## How to get these values:
|
||||
|
||||
1. **Log in to your Gotify server.**
|
||||
2. **Go to the "Applications" section.**
|
||||
3. **Create a new application** (e.g., "System Alerts").
|
||||
4. **Copy the generated token** — this is your Gotify Token.
|
||||
5. **Use your server's URL** as the Gotify URL.
|
||||
@@ -1,41 +0,0 @@
|
||||
# ntfy Notification Setup
|
||||
|
||||
To enable ntfy notifications, you need the following:
|
||||
|
||||
- **ntfy URL**
|
||||
The base URL of your ntfy server including the topic (e.g., `https://ntfy.example.com/alerts`)
|
||||
|
||||
- **ntfy Token**
|
||||
An access token for authentication, generated per user
|
||||
|
||||
## How to get the ntfy URL and Token
|
||||
|
||||
1. **Install and set up your ntfy server** (self-hosted or use `https://ntfy.sh`)
|
||||
2. **Choose a topic name** (e.g. `alerts`) and include it in the URL:
|
||||
`https://<your-ntfy-server>/<your-topic>`
|
||||
|
||||
3. **Create a user (if not already created)**
|
||||
|
||||
4. **Generate a token for the user** using the following command:
|
||||
```bash
|
||||
ntfy token add --expires=30d --label="notifications" <username>
|
||||
```
|
||||
|
||||
5. **List existing tokens** to get the full token string:
|
||||
```bash
|
||||
ntfy token list <username>
|
||||
```
|
||||
|
||||
6. **Use the token** as a bearer token when sending messages, either in the Authorization header or in your tool's configuration.
|
||||
|
||||
## Example Token Management Commands
|
||||
|
||||
```bash
|
||||
ntfy token list # Show all tokens
|
||||
ntfy token list alice # Show tokens for user 'alice'
|
||||
ntfy token add alice # Create token for user 'alice' (never expires)
|
||||
ntfy token add --expires=2d bob # Create token for 'bob', expires in 2 days
|
||||
ntfy token remove alice tk_... # Delete a token
|
||||
```
|
||||
|
||||
More information at [the ntfy docs](https://docs.ntfy.sh/config/#access-tokens)
|
||||
@@ -1,22 +0,0 @@
|
||||
# Pushover Notification Setup
|
||||
|
||||
To enable Pushover notifications, you need the following:
|
||||
|
||||
- **Pushover URL**
|
||||
The API endpoint for sending messages:
|
||||
`https://api.pushover.net/1/messages.json`
|
||||
|
||||
- **Pushover Token**
|
||||
Your application’s API token (generated in your Pushover dashboard)
|
||||
|
||||
- **Pushover User Key**
|
||||
The user key or group key of the recipient (found in your Pushover account)
|
||||
|
||||
## How to get the URL, Token, and User Key
|
||||
|
||||
1. **Sign up or log in** at the Pushover website.
|
||||
2. **Create a new application** under “Your Applications.”
|
||||
- You will receive your **Pushover Token** here.
|
||||
3. **Locate your User Key** on your account’s main page.
|
||||
- If you want to notify a group, create or use an existing **Group Key** instead.
|
||||
4. **Use the API URL** `https://api.pushover.net/1/messages.json`
|
||||
@@ -1,49 +0,0 @@
|
||||
# Telegram Notification Setup
|
||||
|
||||
To enable Telegram notifications, you need the following:
|
||||
|
||||
- **Bot Token**
|
||||
Generated by @BotFather when you create your bot.
|
||||
|
||||
- **Chat ID**
|
||||
A unique identifier for the target chat (user, group, or channel).
|
||||
|
||||
## How to create the bot and get the Bot Token
|
||||
|
||||
1. Open Telegram and start a conversation with **@BotFather**.
|
||||
2. Send the command `/newbot`, then follow the prompts to choose a name and username (must end with “bot”). :contentReference[oaicite:1]{index=1}
|
||||
3. After completion, @BotFather replies with a message containing:
|
||||
```
|
||||
Use this token to access the HTTP API:
|
||||
123456789:ABCdefGhIJKlmNoPQRsTuvWxYZ
|
||||
```
|
||||
Copy this token—this is your **Bot Token**.
|
||||
|
||||
## How to obtain the Chat ID
|
||||
|
||||
1. Start a chat with your new bot (send it any message).
|
||||
2. Open in your browser:
|
||||
```
|
||||
https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates
|
||||
```
|
||||
3. Look for the `"chat":{"id":...}` field in the returned JSON. That number is the **Chat ID**. :contentReference[oaicite:3]{index=3}
|
||||
|
||||
### Example: getUpdates response excerpt
|
||||
```json
|
||||
{
|
||||
"ok": true,
|
||||
"result": [
|
||||
{
|
||||
"update_id": 123456789,
|
||||
"message": {
|
||||
"message_id": 1,
|
||||
"from": { "id": 987654321, "is_bot": false, "first_name": "User" },
|
||||
"chat": { "id": 987654321, "first_name": "User", "type": "private" },
|
||||
"date": 1610000000,
|
||||
"text": "Hello"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
*Here, the Chat ID is `987654321`.*
|
||||
Reference in New Issue
Block a user