Welcome to Server Generator, a multi-platform Go application designed to help you collect essential system metrics and automate report sending. This tool is perfect for system administrators and anyone looking to keep tabs on their servers with ease.
- Introduction
- Features
- Installation
- Usage
- Configuration
- Health Check
- Contributing
- License
- Contact
- Releases
Server Generator is created by Bocaletto Luca. This application gathers key system metrics such as:
- IP Address
- Operating System
- CPU Usage
- Memory Usage
- Active Users
It compiles this data into a templated report and sends it via email on a schedule you define. With a simple setup, you can monitor your servers without hassle.
- Cross-Platform: Works on both Linux and Windows.
- Scheduled Reports: Set a schedule for automatic report sending.
- Health Check Endpoint: Access a simple
/healthzendpoint for quick health checks. - Email Notifications: Receive system metrics directly in your inbox.
- Open Source: Contribute and improve the project.
To get started, download the latest release from the Releases section. Once downloaded, follow the steps below to install the application:
- Extract the downloaded archive.
- Move the executable to a directory in your system PATH.
- Ensure you have Go installed if you want to build from source.
- Go version 1.15 or higher
- Access to a mail server for sending reports
After installation, you can run the application using the following command:
server-genThis will start the application and begin collecting metrics. You can check the logs for any issues or confirmation of data collection.
You can customize the behavior of Server Generator using command-line options:
-config: Specify a custom configuration file.-schedule: Set the schedule for report generation.
The configuration file is crucial for setting up your application. Below is a sample configuration:
email:
to: "admin@example.com"
from: "server@example.com"
smtp_server: "smtp.example.com"
smtp_port: 587
username: "user"
password: "pass"
schedule: "0 8 * * *" # Sends report every day at 8 AM- Email Settings: Define the email addresses and SMTP server details.
- Schedule: Use cron syntax to define when reports are sent.
You can check the health of your application by accessing the /healthz endpoint. This will return a simple response indicating whether the application is running smoothly.
curl http://localhost:8080/healthzA successful response will look like this:
{"status": "healthy"}
We welcome contributions to Server Generator! If you want to help improve the project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push to your branch and open a pull request.
Server Generator is licensed under the MIT License. See the LICENSE file for more information.
For questions or suggestions, feel free to reach out:
- Bocaletto Luca: bocaletto@example.com
For the latest version of Server Generator, please visit the Releases section. Download the appropriate file for your platform and execute it to get started.
Thank you for checking out Server Generator! Your feedback and contributions are greatly appreciated. Happy monitoring!