extern/alertik
1
0
Fork 1
mirror of https://github.com/Theldus/alertik.git synced 2024-11-21 23:43:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Davidson Francis 2024-08-05 21:59:08 -03:00
parent cfea53312b
commit 2e2785a972
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -312,10 +312,7 @@ export FORWARD_PORT=<port>
- **`FORWARD_PORT`**: Define the port number on which the syslog server is listening for incoming messages. - **`FORWARD_PORT`**: Define the port number on which the syslog server is listening for incoming messages.
## Setup in RouterOS ## Setup in RouterOS
Using Alertik is straightforward: simply configure your RouterOS to download the latest Docker image from [theldus/alertik:latest](https://hub.docker.com/repository/docker/theldus/alertik/tags) and set/export three environment variables: Using Alertik is straightforward: simply configure your RouterOS to download the latest Docker image from [theldus/alertik:latest](https://hub.docker.com/repository/docker/theldus/alertik/tags) and set/export the environment variables related to the Notifiers and Environment/Static Events you want to configure.
- `TELEGRAM_BOT_TOKEN`: The token for a pre-configured Telegram bot.
- `TELEGRAM_CHAT_ID`: The chat ID where notifications will be sent.
- `TELEGRAM_NICKNAME`: The nickname you wish to be called.
<details><summary>The general procedure is similar for any Docker image (click to expand):</summary> <details><summary>The general procedure is similar for any Docker image (click to expand):</summary>
@ -325,7 +322,7 @@ Using Alertik is straightforward: simply configure your RouterOS to download the
- Configure the IP for the syslog server. - Configure the IP for the syslog server.
- Select the topics to be sent to the syslog server. - Select the topics to be sent to the syslog server.
- Configure a mount point for the Alertik logs: /tmpfs/log -> /log - Configure a mount point for the Alertik logs: /tmpfs/log -> /log
- Set the environment variables listed above. - Set the environment variables for Notifiers and Environment/Static Events.
- Configure the Docker registry to: `https://registry-1.docker.io` - Configure the Docker registry to: `https://registry-1.docker.io`
- Finally, add the Docker image, pointing to: `theldus/alertik:latest`. - Finally, add the Docker image, pointing to: `theldus/alertik:latest`.
@ -345,11 +342,20 @@ Below is the complete configuration for my environment, for reference:
/system logging action add name=rsyslog remote=<your-container-ip> remote-port=5140 target=remote /system logging action add name=rsyslog remote=<your-container-ip> remote-port=5140 target=remote
# Mountpoint configuration # Mountpoint configuration
/container mounts add dst=/log name=logmount src=/tmpfs/log /container mounts add dst=/log name=logmount src=/tmpfs/log
# Docker environment variables configuration
# Docker environment variables configuration for Telegram/Slack/Discord/Teams and/or Generic events
/container envs /container envs
add key=TELEGRAM_BOT_TOKEN name=alertik value=<my-bot-token> add key=TELEGRAM_BOT_TOKEN name=alertik value=<my-bot-token>
add key=TELEGRAM_CHAT_ID name=alertik value=<my-chat-id>
add key=TELEGRAM_NICKNAME name=alertik value=<my-nickname> add key=TELEGRAM_NICKNAME name=alertik value=<my-nickname>
...
# Add some event, such as identifying login failures via SSH
/container envs
add key=EVENT0_NOTIFIER name=alertik value="Telegram"
add key EVENT0_MATCH_TYPE name=alertik value="substr"
add key EVENT0_MATCH_STR name=alertik value=="login failure for user admin"
add key EVENT0_MASK_MSG name=alertik value="There is a failed login attempt for user admin"
# Docker Hub registry configuration # Docker Hub registry configuration
/container config set registry-url=https://registry-1.docker.io tmpdir=tmpfs /container config set registry-url=https://registry-1.docker.io tmpdir=tmpfs
``` ```