Update README.md

This commit is contained in:
UltraLion
2023-04-10 15:20:08 +02:00
committed by GitHub
parent 64f9ffe7d0
commit e95f6b7447
+24 -24
View File
@@ -1,38 +1,39 @@
<h1 align=center>Script Bash Statistiques Serveur Linux</h1>
<h1 align=center>Script Bash Statistics Linux Server
<h3 align="center">
<p>Script Bash qui permet de voir les statistiques de votre serveur Linux en les envoyants à un webhook discord.</p>
<p>Bash script that allows to see the statistics of your Linux server by sending them to a webhook discord.</p>
<a href="https://www.buymeacoffee.com/ultralion" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee" " </a>
</h3>
<hr>
<h2>👨‍💻 Technologies utilisées pour ce projet</h2>
<h2>👨‍💻 Technologies used for this project</h2>
![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)
[![!#/bin/bash](https://img.shields.io/badge/-%23!%2Fbin%2Fbash-1f425f.svg?style=for-the-badge&logo=image%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw%2FeHBhY2tldCBiZWdpbj0i77u%2FIiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8%2BIDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTExIDc5LjE1ODMyNSwgMjAxNS8wOS8xMC0wMToxMDoyMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUgKFdpbmRvd3MpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOkE3MDg2QTAyQUZCMzExRTVBMkQxRDMzMkJDMUQ4RDk3IiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOkE3MDg2QTAzQUZCMzExRTVBMkQxRDMzMkJDMUQ4RDk3Ij4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6QTcwODZBMDBBRkIzMTFFNUEyRDFEMzMyQkMxRDhEOTciIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6QTcwODZBMDFBRkIzMTFFNUEyRDFEMzMyQkMxRDhEOTciLz4gPC9yZGY6RGVzY3JpcHRpb24%2BIDwvcmRmOlJERj4gPC94OnhtcG1ldGE%2BIDw%2FeHBhY2tldCBlbmQ9InIiPz6lm45hAAADkklEQVR42qyVa0yTVxzGn7d9Wy03MS2ii8s%2BeokYNQSVhCzOjXZOFNF4jx%2BMRmPUMEUEqVG36jo2thizLSQSMd4N8ZoQ8RKjJtooaCpK6ZoCtRXKpRempbTv5ey83bhkAUphz8fznvP8znn%2B%2F3NeEEJgNBoRRSmz0ub%2FfuxEacBg%2FDmYtiCjgo5NG2mBXq%2BH5I1ogMRk9Zbd%2BQU2e1ML6VPLOyf5tvBQ8yT1lG10imxsABm7SLs898GTpyYynEzP60hO3trHDKvMigUwdeaceacqzp7nOI4n0SSIIjl36ao4Z356OV07fSQAk6xJ3XGg%2BLCr1d1OYlVHp4eUHPnerU79ZA%2F1kuv1JQMAg%2BE4O2P23EumF3VkvHprsZKMzKwbRUXFEyTvSIEmTVbrysp%2BWr8wfQHGK6WChVa3bKUmdWou%2BjpArdGkzZ41c1zG%2Fu5uGH4swzd561F%2BuhIT4%2BLnSuPsv9%2BJKIpjNr9dXYOyk7%2FBZrcjIT4eCnoKgedJP4BEqhG77E3NKP31FO7cfQA5K0dSYuLgz2TwCWJSOBzG6crzKK%2BohNfni%2Bx6OMUMMNe%2Fgf7ocbw0v0acKg6J8Ql0q%2BT%2FAXR5PNi5dz9c71upuQqCKFAD%2BYhrZLEAmpodaHO3Qy6TI3NhBpbrshGtOWKOSMYwYGQM8nJzoFJNxP2HjyIQho4PewK6hBktoDcUwtIln4PjOWzflQ%2Be5yl0yCCYgYikTclGlxadio%2BBQCSiW1UXoVGrKYwH4RgMrjU1HAB4vR6LzWYfFUCKxfS8Ftk5qxHoCUQAUkRJaSEokkV6Y%2F%2BJUOC4hn6A39NVXVBYeNP8piH6HeA4fPbpdBQV5KOx0QaL1YppX3Jgk0TwH2Vg6S3u%2BdB91%2B%2FpuNYPYFl5uP5V7ZqvsrX7jxqMXR6ff3gCQSTzFI0a1TX3wIs8ul%2Bq4HuWAAiM39vhOuR1O1fQ2gT%2F26Z8Z5vrl2OHi9OXZn995nLV9aFfS6UC9JeJPfuK0NBohWpCHMSAAsFe74WWP%2BvT25wtP9Bpob6uGqqyDnOtaeumjRu%2ByFu36VntK%2FPA5umTJeUtPWZSU9BCgud661odVp3DZtkc7AnYR33RRC708PrVi1larW7XwZIjLnd7R6SgSqWSNjU1B3F72pz5TZbXmX5vV81Yb7Lg7XT%2FUXriu8XLVqw6c6XqWnBKiiYU%2BMt3wWF7u7i91XlSEITwSAZ%2FCzAAHsJVbwXYFFEAAAAASUVORK5CYII%3D)](https://www.gnu.org/software/bash/)
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
<h2>📡 Objectif</h2>
<p>Ce projet a pour but d'envoyer les statistiques d'un serveur linux à un webhook discord (voir l'image ci dessous)</p>
<img src="https://user-images.githubusercontent.com/49597041/213926598-3e9301df-8a68-49e4-abd3-72222ed655af.png">
<h2>📡 Objective</h2>
<p>The purpose of this project is to send statistics from a linux server to a webhook discord (see image below)</p>
<img src="https://i.imgur.com/APbUO1W.png">
<h2>📋 Fonctionnalité</h2>
<h2>📋 Functionality</h2>
- [X] Un message est envoyé lorsque le script est démarrer avec la commande ./script.sh
- [X] Message configurable
- [X] A message is sent when the script is started with the command `./script.sh` or `bash script.sh`
- [X] Configurable message
<h2> 🚀 Prise en main</h2>
<h2> 🚀 Getting started</h2>
1. `git clone https://github.com/UltraLionfr/statistiques-discord-webhook-vps.git` & `cd statistiques-discord-webhook-vps`
1. `git clone https://github.com/UltraLionfr/statistics-discord-webhook-vps.git` & `cd statistics-discord-webhook-vps`
2. Pour commencer, vous devez installez jq sur votre serveur, pour ça faite la commande suivante :
```yml
sudo apt install jq -y
2. **To start you need to install the following packages on your server**:
```bash
sudo apt-get update && sudo apt-get install -y ping procps procinfo lscpu curl coreutils lsb-release ifstat -y
```
3. Ensuite, démarrage du script une fois le webhook configuré et l'interface réseau changé :
```yml
sudo ./script.sh
```
4. Configuration de crontabe pour avoir les statistiques toutes les heures
3. **Changing the network interface** :<br>
At the line `network_bandwidth_usage` change `enp6s18` by your network interface.<br>
Do `ifconfig or ip addr` to find your network interface.
4. **Configuration of crontabe to have statistics every hour**:
```yml
sudo crontabe -e
```
@@ -61,12 +62,11 @@ sudo crontabe -e
#
# m h dom mon dow command
```
/!\ Penser à remplacer le chemain d'accès à la ligne `0 * * * * /home/user/script.sh` /!\
⚠️ Remember to replace the access path on the line `0 * * * * /home/user/script.sh` ⚠️
<h2>Credits</h2>
<h2>Crédits</h2>
- Auteur : [UltraLion](https://github.com/UltraLionfr)
- Author : [UltraLion](https://github.com/UltraLionfr)
<hr>
<h6 align=center>Veuillez forker ce projet si vous l'utilisez et mettre une étoile ❤️.</h6>
<h6 align=center>Please fork this project if you use it and put a star ❤️.</h6>