Skip to content

Commit

Permalink
adjust readme
Browse files Browse the repository at this point in the history
  • Loading branch information
unglaublicherdude committed Jul 19, 2024
1 parent adb8977 commit b58bd44
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
1 change: 1 addition & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"request": "launch",
"port": 9080,
"pathMappings": {
"/var/www/html/": "${workspaceFolder}/wordpress",
"/var/www/html/wp-content/plugins/wordpress-gdata-antivirus": "${workspaceFolder}/",
},
"runtimeArgs": [
Expand Down
29 changes: 17 additions & 12 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
# WordPress Antivirus Plugin with G DATA VaaS Integration

## Licensing and Partnerships

This plugin is freely available for individual and small business users, providing a high level of security for your WordPress site. [You can get your credentials via our landing page](https://www.gdata.de/vaas-files/vaas-technical-onboarding.html)

For commercial entities, we offer the opportunity to secure your customers' sites. This partnership not only enhances your security offerings but also demonstrates your commitment to customer safety. Interested organizations are encouraged to [contact us for more details](mailto:[email protected]) on how to leverage this powerful antivirus solution.

## Overview

Welcome to the WordPress Antivirus Plugin (wordpress-gdata-antivirus) with G DATA VaaS integration! This plugin adds an additional layer of security to your WordPress installation by utilizing the powerful antivirus service from G DATA CyberDefense AG, known as VaaS (Verdict as a Service). This integration ensures that your WordPress website remains protected from potential threats and malware.

## Features

- **Real-time Scanning:** The plugin performs real-time scanning of file uploads through WordPress upload forms, preventing malicious content from entering your website.
- **Real-time Scanning:** The plugin performs real-time scanning of file uploads through WordPress upload forms (media, plugin or theme uploads), preventing malicious content from entering your website.

- **Full WordPress Scan:** Conduct a comprehensive scan of your entire WordPress installation to identify and eliminate any existing malware.

- **G DATA VaaS Integration:** The antivirus service powering this plugin is provided by G DATA CyberDefense AG, a leading cybersecurity company known for its advanced threat detection capabilities.

## Installation
- **Post Scans:** Scan blog posts done by your site authors.

1. **Download the Plugin:** Download the plugin zip file from the [GitHub repository](https://github.com/GDATASoftwareAG/wordpress-gdata-antivirus).
- **Comment Scans:** Even the comments of your users can be checked for viruses.

2. **Upload and Activate:** Upload the plugin to your WordPress installation and activate it through the WordPress dashboard.
- **Full WordPress Scan:** Conduct a comprehensive scan of your entire WordPress installation to identify and eliminate any existing malware.

3. **Configure Settings:** Access the plugin settings in the WordPress dashboard to to enter your VaaS Credentials.

4. **Get Credentials:** Please contact [email protected] to obtain your credentials.
- **G DATA VaaS Integration:** The antivirus service powering this plugin is provided by G DATA CyberDefense AG, a leading cybersecurity company known for its advanced threat detection capabilities.

## Usage

Expand All @@ -32,9 +35,13 @@ The plugin seamlessly integrates with WordPress upload (like the media upload in

Perform a full scan of your WordPress installation at any time to thoroughly examine all files and directories. This includes core files, themes, plugins, and any custom uploads, providing a comprehensive security audit.

### Scheduled scan

The scheduled scan feature of the WordPress Antivirus Plugin with G DATA VaaS Integration allows users to automate the process of scanning their entire WordPress installation for potential threats and malware. You can configure it to run every day on a selected time.

## Support and Feedback

For any issues, questions, or feedback, please contact [email protected]. We appreciate your input and are committed to continually improving the plugin to meet your security needs.
For any issues, questions, or feedback we have two channels [our vaas e-mail contact]([email protected]) or leave us an issue on our [gitub-repository](https://github.com/GDATASoftwareAG/wordpress-gdata-antivirus/issues). We appreciate your input and are committed to continually improving the plugin to meet your security needs.

## License

Expand All @@ -48,9 +55,7 @@ Contributions are welcome! To get started with development, please use the provi

The devcontainer is configured to mount the source code into the containers. This allows you to work on the code from your local machine, while running and testing it in an environment that closely matches the deployment environment.

### Caveat

Please note that when running a full scan in WordPress, the scan will be performed twice. This is due to the way the source code is mounted into the containers. While this does not affect the functionality of the scan, it does mean that scans will take approximately twice as long to complete.
Within the devcontainer it starts a wordpress-environment with `docker composer` within that you can even debug the code running directly in wordpress.

## Disclaimer

Expand Down

0 comments on commit b58bd44

Please sign in to comment.