Update README.md

This commit is contained in:
Janis Steiner
2024-03-13 18:27:29 +00:00
committed by GitHub
parent 41e0889a6e
commit c8bb8398fd

View File

@@ -1,6 +1,30 @@
# ma
my MA for KSW
# Cyberhex
Cyberhex aims to be a buisness faced av solution. There is a central server which can controll and maange multiple clients. Each client runs a daemon who does all the scanning and so on.
The server manages databases, logs and so on.
## Development
Cyberhex is currently in heavy development.
## Overview
Cyberhex is a business-oriented antivirus solution developed as part of my MA project for KSW. The project aims to provide robust cybersecurity measures with a focus on central management and control.
## Features
- **Centralized Management**: A central server facilitates the management and monitoring of multiple client systems.
- **Client Daemon**: Each client system runs a daemon responsible for executing scans and other security-related tasks.
- **Database Management**: The server manages databases containing critical information such as virus signatures, logs, and client configurations.
- **Scalability**: Designed to scale efficiently to handle varying numbers of clients and growing databases.
## Getting Started
To get started with Cyberhex, follow these steps:
1. **Clone Repository**: Clone the Cyberhex repository to your local machine.
2. **Server Setup**: Set up the central server by following the instructions in the `server/README.md` file.
3. **Client Installation**: Install the client daemon on each client system using the guidelines provided in the `client/README.md` file.
4. **Configuration**: Customize the configuration files according to your requirements.
5. **Run**: Start the server and client daemons to begin managing and protecting your network.
## Support and Contributions
For any issues or feature requests, please open an issue on GitHub. Contributions are welcome through pull requests.
## License
This project is licensed under the [MIT License](LICENSE).
## Acknowledgements
Cyberhex was developed as part of the MA project for KSW, with contributions from Janis Steiner. I thank Emil Müller for his guidance and support throughout the project.