From c8bb8398fd7d98144676cb49822c7e93cc0a3018 Mon Sep 17 00:00:00 2001 From: Janis Steiner <89935073+jakani24@users.noreply.github.com> Date: Wed, 13 Mar 2024 18:27:29 +0000 Subject: [PATCH 1/3] Update README.md --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5452a90..1590fac 100644 --- a/README.md +++ b/README.md @@ -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. From 0e25493b1be5bfec15b97182ad887d855444718b Mon Sep 17 00:00:00 2001 From: Janis Steiner <89935073+jakani24@users.noreply.github.com> Date: Wed, 13 Mar 2024 18:28:18 +0000 Subject: [PATCH 2/3] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1590fac..a56e716 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ Cyberhex is a business-oriented antivirus solution developed as part of my MA pr - **Scalability**: Designed to scale efficiently to handle varying numbers of clients and growing databases. ## Getting Started -To get started with Cyberhex, follow these steps: +To get started with Cyberhex, follow these steps (there will be an instruction sheet later on): 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. +2. **Server Setup**: Set up the central server. +3. **Client Installation**: Install the client daemon on each client system. 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. @@ -24,7 +24,7 @@ To get started with Cyberhex, follow these steps: 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). +This project is licensed under the BSD 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. From 7aeb7407937cf6e1e9b9a18482bab8261382bf5a Mon Sep 17 00:00:00 2001 From: Janis Steiner <89935073+jakani24@users.noreply.github.com> Date: Wed, 13 Mar 2024 18:28:34 +0000 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a56e716..506ab55 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ To get started with Cyberhex, follow these steps (there will be an instruction s 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 BSD License. +This project is licensed under the BSD-3 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.