---
myst:
  html_meta:
    "description": "How to install contentrules.slack in a Plone project."
    "property=og:description": "How to install contentrules.slack in a Plone project."
    "property=og:title": "Install contentrules.slack"
    "keywords": "Plone, Slack, install, add-on"
---

(how-to-install)=

# Install contentrules.slack

This guide shows you how to add contentrules.slack to a Plone project.

contentrules.slack requires Plone {SUPPORTED_PLONE_VERSIONS} and Python {SUPPORTED_PYTHON_VERSIONS}.

## Add the dependency

Add `contentrules.slack` to the dependencies of your project.

`````{tab-set}

````{tab-item} pyproject.toml
If your project has a `pyproject.toml` file, such as a project generated by Cookieplone, add the package to the `dependencies` list of your backend package.

```toml
[project]
dependencies = [
    "Products.CMFPlone",
    "contentrules.slack",
]
```

Then install your project again, for example with `make install`.
````

````{tab-item} pip
If you manage your installation with pip, install the package into the same Python environment as Plone.

```shell
pip install contentrules.slack
```
````

`````

## Restart Plone

Restart Plone so it loads the new add-on.

Plone loads the add-on automatically.
You do not need to activate it in the {guilabel}`Add-ons` control panel, and it does not appear there.

## Check the installation

1.  Open {menuselection}`Site Setup --> Content Rules`.
2.  Create or edit a content rule.
3.  Open the list of available actions.

{guilabel}`Post a message to Slack` appears in the list.

## Next steps

-   {doc}`classic-ui` or {doc}`volto` shows you how to create your first rule.
-   {doc}`/reference/configuration` lists the environment variables the add-on reads.