<commit_before># sysinfobot

## A Telegram bot that provides information about the server where it resides.

This bot is still a work-in-progress, changes will be made, and currently doesn't reply with any useful information (unlike what the description says).

Sooo, see you soon.<commit_msg>configuration informations<commit_after># sysinfobot

## A Telegram bot that provides information about the server where it resides.

This bot is still a work-in-progress, changes will be made, and currently doesn't reply with any useful information (unlike what the description says).

In the meantime, let me introduce you the configuration method.

### Configuration

You need to provide a valid JSON configuration file in `~/.config/sysinfobot.json`, or the bot will not operate.

You can find a sample configuration file in `support/configsample.conf` or at the end of this paragraph.

To secure the information provided, you need to create *your* personal Telegram bot, by following the [official documentation](https://core.telegram.org/bots#botfather).

You can create "bot commands" too, but it's not strictly needed.

The bot will obey to a well-defined set of commands that will be provided once it will be capable of at least work: remember, right now is **work-in-progress**!

``` JSON
{
    "cert_path": "web server certificate",
    "key_path": "web server key",
    "url": "your server url, needs to be https://",
    "endpoint": "an endpoint to let telegram push new messages",
    "bot_token": "<PASSWORD>",
    "port": "http port, telegram only allows 80, 88, 443, 8443",
    "authorized_users": [
        "list",
        "with",
        "autorized",
        "users"
    ]
}
```
{'fraction_non_alphanumeric': 0.08994082840236686, 'fraction_numerical': 0.00650887573964497, 'mean_word_length': 4.002958579881657, 'pattern_counts': {'":': 7, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4242703', 'n_tokens_mistral': 467, 'n_tokens_neox': 448, 'n_words': 222}