silverstripe-comments/docs/en/Installing.md

# Installation

Then in the root of your project run:

```sh
composer require silverstripe/comments`
```

Then run a database rebuild by visiting `dev/build`. This will add the required database columns and tables for the module to function, and refresh the configuration manifest.

## Enabling Commenting

Out of the box the module adds commenting support to all pages on your site. This functionality can be turned on and off on a per page basis in the CMS under the `Behaviour` tab for a given page. Once the `Allow Comments` checkbox is ticked, republish and view the webpage.

For more configuration options see [Configuration](Configuration.md).

## Upgrading

### Migrating from version SilverStripe 2 installations

This module replaces the built-in commenting system available in SilverStripe 2. Running the `dev/build` task will automatically perform a migration if any comments from these old versions exist.
FEATURE: added delete comment functionality. MINOR: added documentation 2010-12-11 06:01:19 +01:00			`# Installation`

BUGFIX: Fixed calls to Comment::get() to be compatible with PostGres MINOR: Modified docs with basic composer info, typos, grammar etc ENHANCEMENT: Hid the existing 'BaseClass' textfield making a hidden field. There should be no need to manually change this. 2012-12-17 20:53:16 +01:00			`Then in the root of your project run:`

FIX: update javascript requirements so user JS doesn't error 2018-01-29 01:04:34 +01:00			```sh
			composer require silverstripe/comments`
			```
BUGFIX: Fixed calls to Comment::get() to be compatible with PostGres MINOR: Modified docs with basic composer info, typos, grammar etc ENHANCEMENT: Hid the existing 'BaseClass' textfield making a hidden field. There should be no need to manually change this. 2012-12-17 20:53:16 +01:00
FIX: update javascript requirements so user JS doesn't error 2018-01-29 01:04:34 +01:00			Then run a database rebuild by visiting `dev/build`. This will add the required database columns and tables for the module to function, and refresh the configuration manifest.
FEATURE: added delete comment functionality. MINOR: added documentation 2010-12-11 06:01:19 +01:00
BUGFIX: Fixed calls to Comment::get() to be compatible with PostGres MINOR: Modified docs with basic composer info, typos, grammar etc ENHANCEMENT: Hid the existing 'BaseClass' textfield making a hidden field. There should be no need to manually change this. 2012-12-17 20:53:16 +01:00			`## Enabling Commenting`
MINOR: documentation 2010-12-13 00:48:20 +01:00
Removed deprecated example configuration 2015-11-15 23:56:34 +01:00			Out of the box the module adds commenting support to all pages on your site. This functionality can be turned on and off on a per page basis in the CMS under the `Behaviour` tab for a given page. Once the `Allow Comments` checkbox is ticked, republish and view the webpage.
BUGFIX: Fixed calls to Comment::get() to be compatible with PostGres MINOR: Modified docs with basic composer info, typos, grammar etc ENHANCEMENT: Hid the existing 'BaseClass' textfield making a hidden field. There should be no need to manually change this. 2012-12-17 20:53:16 +01:00
MINOR: documentation 2010-12-13 00:48:20 +01:00			`For more configuration options see [Configuration](Configuration.md).`

			`## Upgrading`

FIX: update javascript requirements so user JS doesn't error 2018-01-29 01:04:34 +01:00			`### Migrating from version SilverStripe 2 installations`
MINOR: documentation 2010-12-13 00:48:20 +01:00
FIX: update javascript requirements so user JS doesn't error 2018-01-29 01:04:34 +01:00			This module replaces the built-in commenting system available in SilverStripe 2. Running the `dev/build` task will automatically perform a migration if any comments from these old versions exist.