Gravityscan Help

How to install Gravityscan Accelerator

If you would liked to learn more about what Gravityscan Accelerator is, you can visit this help article.

Installing Gravityscan Accelerator vastly improves the scan speed and effectiveness that Gravityscan can provide. This page explains how to install Gravityscan Accelerator.

It’s actually quite simple

Gravityscan Accelerator is simply a PHP file and it needs to be installed on your website like any other PHP file. To work correctly, it must be placed in your document root and it needs to be accessible from the web.

If you hit the file with your web browser, you’ll see a confirmation that it is working correctly. Gravity will automatically detect its presence and your scans will dramatically improve in speed and accuracy.

The Step by Step Guide to Installing Gravityscan Accelerator

Step 1: Go to My Sites

Start by clicking the “My Sites” link at the top of the Gravityscan web application to view all your sites.

Step 2:

Then click the “Jump to” drop down on the far right of the site where you want to enable Gravityscan Accelerator. Then click the “Manage Site” option.

Step 3: Click Install

On the left of the page around the middle you will see an option to install Gravityscan Accelerator. Click the install button. It looks like this:

Step 4: Follow the Gravityscan Accelerator Instructions

You will then see a modal window that appears explaining how to install Gravityscan Accelerator. It looks like this:

As you can see, the above includes a download link in step 1. Click the download link to download the PHP file. Make sure you don’t change the name of the file because Gravityscan expects to find a file with that name on your website.

Then upload the file to your document root. You will usually do this by FTP’ing the file into the base installation directory of your website. You can use FTP, SFTP or your usual file transfer method.

If you are using Magento, you may need to follow these instructions to get the agent working on your site.

Step 5: Confirm Accelerator is Working and hit “Verify”

In the instructions that appear, you are provided a URL on your own website where Gravityscan expects to find the Accelerator. Click this URL and you should see a diagnostic message. It should look like this:

Once you have confirmed that you are seeing the green message above, you can click the “Verify” button on the Accelerator installation window. Gravityscan will verify it can find the Accelerator and your next scan will be much faster and more accurate.

Tips

If you are using SSH and a shell to install the Accelerator, you can skip the download step above, and simply download the file directly into your document root directory with the following command:

wget –content-disposition [insert URL of accelerator that we provided to you here]

The content-disposition parameter above causes the wget command to use the correct filename when downloading Accelerator. You should also see our troubleshooting section below in case you need to adjust the file permissions once you have downloaded Accelerator.

Troubleshooting

What to do if you see the following when visiting the Accelerator URL:

The above message means that Gravityscan Accelerator has detected that it is not able to update its own file. This happens because the file permissions do not allow your web server to update the file.

Don’t worry, this is quite common if you have uploaded the Accelerator using a shell account. If you have SSH access, you need to change the ownership of the file to the web server user and group. On many systems, the web server user and group is ‘www-data’. You can fix this by running the following command via SSH:

chown www-data.www-data [replace this with the accelerator filename]

Note that on your system, the web server may have a different user and group. One way to find out what that is is to simply look at who owns all the files on your website. You can run the following command in an SSH shell to see who your files are owned by:

ls -l

The output will look something like this:

The owner section has been highlighted with a red square above. In this case you can see the files are owned by ‘www-data’ user and ‘www-data’ group. So to fix the problem with Accelerator, you would run:

chown www-data.www-data [Accelerator filename]

In your case it may be ‘web-user’ or ‘web’ or something similar. Just replace www-data above with your user and group from the ‘ls -l’ output.

Then try to hit the Accelerator URL again and you should find that it comes back green this time.

If you are unable to fix this problem, Gravityscan Accelerator will run just fine. The only down-side is that when we release a new version, your version of Accelerator won’t be automatically upgraded to include new features, performance improvements or bug fixes. You will need to constantly update your site with the newest version, which can be inconvenient.

Path problems when installing Accelerator

As mentioned above, if you are using Magento, you may need to follow our additional instructions when installing Accelerator. In the case of Magento, you can’t simply drop the PHP file for Accelerator in the document root. It needs to be placed in a pub/ directory and you may need to modify your web server to allow access.

Most hosting accounts and website configurations allow you to simply drop Accelerator into the root and it should work just fine. If you have a configuration that uses URL routing that does not simply recognize PHP files as they are uploaded, you may need to add custom rules to allow Accelerator to run.

Providing custom rules for each individual configuration is beyond the scope of this help document. But as a general rule, Gravityscan will need to be able to access the Accelerator directly via the web, the same way you access it in a web browser. You may need to create rewrite rules in your .htaccess file or web server configuration to allow the Accelerator to be accessed.

If you are unsure how to do this, we recommend you start with your hosting provider. Ask them how you can upload the file we provide and access it directly from the web.

If they can’t help, the next stop should be the support forum of your web application or content management system. Often web applications have their own .htaccess configuration files and web server configurations. Ask in their forums how you can allow a PHP file to be accessed directly from the web.

What if I don’t have PHP on my server? 

Currently Gravityscan Accelerator requires PHP. Unfortunately we don’t provide a version in other languages at this time. If you would like us to support your platform, please drop us a note describing what you need by using our contact page.

Report a Bug