silverstripe-comments/docs/en/Installing.md
AdamSawoscianik d5b9a2818c
Update Installing.md
Adding information about $CommentsForm tag to help people with this module.
2019-10-03 10:32:22 +02:00

26 lines
766 B
Markdown

# 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).
## Displaying Comments
To display form and comments simply add
```sh
{$CommentsForm}
```
to your `.ss` file.