diff --git a/README.md b/README.md index 10a5c11..4a64b7f 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,15 @@ Once MetaDefender Core has been installed and activated with your license, the f * Archive engine * Frequently cleaning up the scan database using both of the following methods: * Setting all the data retention options to the lowest time value under **Settings > Data Retention** - * Using a scheduled task on your MetaDefender machine, see [here](mdcore_install/install_notes.md) for instructions + * Updating your MetaDefender Core version so that PostgreSQL is the default database ## Service Options -* **api_key**: API Key used to connect to the metadefender API +* **api_key**: API Key used to connect to the MetaDefender API * **base_url**: The URL(s) of the MetaDefender deployment(s) * If you have a **single** MetaDefender Core deployment, set the service variable to **str** type and enter the URL of your MetaDefender Core deployment * If you have **multiple** MetaDefender Core deployments, set the service variable to **list** type and enter the URLs of your MetaDefender Core deployments separated by a comma -* **md_version**: Version of metadefender you're connecting to (3 or 4) +* **md_version**: Version of MetaDefender you're connecting to (3 or 4) * **md_timeout**: Maximum amount of time to wait while connecting to the MetaDefender server * **max_md_scan_time**: Maximum amount of time to wait for scan results before the MetaDefender server is put on a brief timeout (only applicable when multiple MetaDefender deployments are used) @@ -53,4 +53,4 @@ If your MetaDefender Core is deployed in an online environment, you can set the ### Offline Deployment of MetaDefender Core -If your Metadefender Core is deployed in an offline environment, you will need to use the Update Downloader utility to download the antivirus definition updates in an online environment and then transfer the updates manually to the offline environment. See [here](https://onlinehelp.opswat.com/downloader/) for instructions on how to use the Update Downloader utility. Once the definition updates have been downloaded and transferred to the offline deployment, you can have MetaDefender monitor a local directory for any new definition updates added to it. You can set which local folder MetaDefender monitors by going to **Settings > Update Settings** then selecting **FOLDER** as the source for updates and then setting the **Pick up updates from** field to your local updates directory. \ No newline at end of file +If your MetaDefender Core is deployed in an offline environment, you will need to use the Update Downloader utility to download the antivirus definition updates in an online environment and then transfer the updates manually to the offline environment. See [here](https://onlinehelp.opswat.com/downloader/) for instructions on how to use the Update Downloader utility. Once the definition updates have been downloaded and transferred to the offline deployment, you can have MetaDefender monitor a local directory for any new definition updates added to it. You can set which local folder MetaDefender monitors by going to **Settings > Update Settings** then selecting **FOLDER** as the source for updates and then setting the **Pick up updates from** field to your local updates directory. \ No newline at end of file diff --git a/docs/install_notes.md b/docs/install_notes.md deleted file mode 100644 index 044980e..0000000 --- a/docs/install_notes.md +++ /dev/null @@ -1,35 +0,0 @@ -# MetaDefender Core - Database Cleanup - -**NOTE**: The following instructions are for **MetaDefender Core v4** running on a **Windows** machine. - -If your deployment experiences a heavy file load, MetaDefender tends to become slower over time due to the increasing size of its database. In order to overcome this issue, a task can be scheduled to run a PowerShell script ([metacleanup.ps1](metacleanup.ps1)) which will temporarily stop the MetaDefender service, delete the database and then restart the service. Every time the script runs, there is a down time of approximately 30-90 secs during which the MetaDefender service is unreachable. If you have multiple deployments of MetaDefender, you can offset the scheduled task for each deployment to minimize service downtime. - -## Set-up Instructions - -1. Download the [metacleanup.ps1](metacleanup.ps1) script on your machine and place it in a location such as ``C:\scripts\`` -2. Open the **Task Scheduler** program -3. In the **Actions** pane on the right, click **Create Task...** -4. The **Create Task** window will open -5. In the **General** tab: - * Enter a name for the task - * Select the **Run whether user is logged on or not** option - * Select the **Run with highest privileges** option -6. Go to the **Triggers** tab and click **New...** -7. In the **New Trigger** window that opens: - * Choose to begin the task **On a schedule** - * Select the **Daily** option - * Set the start date and time to a value in the future (to ensure the task is triggered) - * Set the task to recur every **1 day** - * Select the option to repeat the task every **15 minutes** for a duration of **1 day** - * Ensure the **Enabled** option is selected to enable to trigger - * Click **OK** when done -8. Go to the **Actions** tab and click **New...** -9. In the **New Action** window that opens: - * Select the action type to **Start a program** - * In the **Program/script** field, enter ``powershell.exe`` - * In the **Add arguments** field, enter ``-ExecutionPolicy Bypass C:\scripts\metacleanup.ps1`` - * Click **OK** when done -10. Go to the **Conditions** tab and ensure that all options are unselected -11. Click **OK** to save the scheduled task - -The MetaDefender database cleanup task has now been scheduled and should run every 15 minutes. \ No newline at end of file diff --git a/docs/metacleanup.ps1 b/docs/metacleanup.ps1 deleted file mode 100644 index 47730c3..0000000 --- a/docs/metacleanup.ps1 +++ /dev/null @@ -1,4 +0,0 @@ -Stop-Service ometascan -del 'C:\Program Files\OPSWAT\Metadefender Core\data\ometascan.db.sqlite' -del 'C:\Windows\Temp\ometascan\nginx.log' -Start-Service ometascan \ No newline at end of file