You are here

README.txt in Slack 7

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended Modules
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

The Slack module brings all your communication together in one place. It’s
real-time messaging, archiving and search for modern teams, and it has cool
system integrations features.

This module allows you to send messages from a Drupal website to Slack.
It has Rules module integration. Also you can use our module API in your
modules.

 * For a full description of the module visit:
   https://www.drupal.org/project/slack

 * To submit bug reports and feature suggestions, or to track changes visit:
   https://www.drupal.org/project/issues/slack


REQUIREMENTS
------------

This module requires the following outside of Drupal core:

 * Slack account - https://your-team-domain.slack.com

A webhook integration is required.
    1. Navigate to
       https://your-team-domain.slack.com/apps/manage/custom-integrations.
    2. Select "Incoming Webhooks" and "Add Configuration." Choose a channel
       (or create a new one) to integrate and select " Add Incoming Webhooks
       integration."
    3. Upon saving, the user will be redirected to a page with the Webhook URL.

For more information:
 * https://api.slack.com/custom-integrations
 * https://api.slack.com/incoming-webhooks


RECOMMENDED MODULES
-------------------

To enable the Rules-based Slack integration:

 * Rules - https://www.drupal.org/project/rules

Useful links (about the Rules module):

 * https://www.drupal.org/documentation/modules/rules
 * https://fago.gitbooks.io/rules-docs/content/


INSTALLATION
------------

 * Install the Slack module as you would normally install a contributed Drupal
   module. Visit https://www.drupal.org/node/895232 for further information.


CONFIGURATION
-------------

    1. Navigate to Administration > Modules and enable the module.
    2. Navigate to Administration > Configuration > Web Services > Slack >
       Configuration to configure the Slack module.
    3. Enter the Webhook URL that was obtained from
       https://your-team-domain.slack.com/apps/manage/custom-integrations.
    4. Enter the channel name with the # symbol (or @username for a private
       message or a private group name).
    5. Enter the Default user name that you would like to name your Slack bot.
    6. Select the type of image: Emoji, Image, or None (Use default
       integration settings).
    7. Choose if message should be sent with attachment styling.
    8. Save configuration.
    9. To test the messaging system, navigate to Administration > Configuration
       > Web Services > Slack > Send a Message. Enter a message and select "Send
       message." The message should be sent to the selected Slack channel or
       user.
    10.If you want to automatically delete files from slack workspace, you
       should provide token, which you can generate here:
       https://api.slack.com/custom-integrations/legacy-tokens#legacy-info
       Or you can get more secure oauth tokens here:
       - go to https://api.slack.com/apps (sign in into your slack account
         of course)
       - choose app that you will grant permission to file access
       - select OAuth & Permissions in sidebar
       - copy 'OAuth Access Token' into settings of slack module on your
         drupal site
       - scroll to 'Select Permission Scopes' and select files:read and
         files:write:user permissions
       - save changes and reinstall your app
    11.You also can choose file types, which you want delete and expiration
       period.


MAINTAINERS
-----------

 * Serge_Konst - https://www.drupal.org/u/serge_konst
 * Evgeny Leonov (hxdef) - https://www.drupal.org/u/hxdef
 * adci_contributor - https://www.drupal.org/u/adci_contributor

Supporting organization:

 * ADCI Solutions - https://www.drupal.org/adci-solutions

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Recommended Modules
  6. * Installation
  7. * Configuration
  8. * Maintainers
  9. INTRODUCTION
  10. ------------
  11. The Slack module brings all your communication together in one place. It’s
  12. real-time messaging, archiving and search for modern teams, and it has cool
  13. system integrations features.
  14. This module allows you to send messages from a Drupal website to Slack.
  15. It has Rules module integration. Also you can use our module API in your
  16. modules.
  17. * For a full description of the module visit:
  18. https://www.drupal.org/project/slack
  19. * To submit bug reports and feature suggestions, or to track changes visit:
  20. https://www.drupal.org/project/issues/slack
  21. REQUIREMENTS
  22. ------------
  23. This module requires the following outside of Drupal core:
  24. * Slack account - https://your-team-domain.slack.com
  25. A webhook integration is required.
  26. 1. Navigate to
  27. https://your-team-domain.slack.com/apps/manage/custom-integrations.
  28. 2. Select "Incoming Webhooks" and "Add Configuration." Choose a channel
  29. (or create a new one) to integrate and select " Add Incoming Webhooks
  30. integration."
  31. 3. Upon saving, the user will be redirected to a page with the Webhook URL.
  32. For more information:
  33. * https://api.slack.com/custom-integrations
  34. * https://api.slack.com/incoming-webhooks
  35. RECOMMENDED MODULES
  36. -------------------
  37. To enable the Rules-based Slack integration:
  38. * Rules - https://www.drupal.org/project/rules
  39. Useful links (about the Rules module):
  40. * https://www.drupal.org/documentation/modules/rules
  41. * https://fago.gitbooks.io/rules-docs/content/
  42. INSTALLATION
  43. ------------
  44. * Install the Slack module as you would normally install a contributed Drupal
  45. module. Visit https://www.drupal.org/node/895232 for further information.
  46. CONFIGURATION
  47. -------------
  48. 1. Navigate to Administration > Modules and enable the module.
  49. 2. Navigate to Administration > Configuration > Web Services > Slack >
  50. Configuration to configure the Slack module.
  51. 3. Enter the Webhook URL that was obtained from
  52. https://your-team-domain.slack.com/apps/manage/custom-integrations.
  53. 4. Enter the channel name with the # symbol (or @username for a private
  54. message or a private group name).
  55. 5. Enter the Default user name that you would like to name your Slack bot.
  56. 6. Select the type of image: Emoji, Image, or None (Use default
  57. integration settings).
  58. 7. Choose if message should be sent with attachment styling.
  59. 8. Save configuration.
  60. 9. To test the messaging system, navigate to Administration > Configuration
  61. > Web Services > Slack > Send a Message. Enter a message and select "Send
  62. message." The message should be sent to the selected Slack channel or
  63. user.
  64. 10.If you want to automatically delete files from slack workspace, you
  65. should provide token, which you can generate here:
  66. https://api.slack.com/custom-integrations/legacy-tokens#legacy-info
  67. Or you can get more secure oauth tokens here:
  68. - go to https://api.slack.com/apps (sign in into your slack account
  69. of course)
  70. - choose app that you will grant permission to file access
  71. - select OAuth & Permissions in sidebar
  72. - copy 'OAuth Access Token' into settings of slack module on your
  73. drupal site
  74. - scroll to 'Select Permission Scopes' and select files:read and
  75. files:write:user permissions
  76. - save changes and reinstall your app
  77. 11.You also can choose file types, which you want delete and expiration
  78. period.
  79. MAINTAINERS
  80. -----------
  81. * Serge_Konst - https://www.drupal.org/u/serge_konst
  82. * Evgeny Leonov (hxdef) - https://www.drupal.org/u/hxdef
  83. * adci_contributor - https://www.drupal.org/u/adci_contributor
  84. Supporting organization:
  85. * ADCI Solutions - https://www.drupal.org/adci-solutions