README.txt 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Recommended modules
  6. * Installation
  7. * Configuration
  8. * Drush commands
  9. INTRODUCTION
  10. ------------
  11. Account Sentinel perceives changes made to a configurable set of monitored
  12. roles' accounts, even those that are results of direct database modification
  13. (e.g. SQL injection). A set of e-mail addresses can be configured to be notified
  14. when such a change is detected, also a log of changes can be viewed in Drupal
  15. and via Drush for manual review.
  16. * For a full description of the module, visit the project page:
  17. https://www.drupal.org/project/account_sentinel
  18. * To submit bug reports and feature suggestions, or to track changes:
  19. https://www.drupal.org/project/issues/account_sentinel
  20. REQUIREMENTS
  21. ------------
  22. No special requirements.
  23. RECOMMENDED MODULES
  24. -------------------
  25. * Password Strength (https://www.drupal.org/project/password_strength):
  26. When enabled, password change events will also store the strength of the
  27. new password.
  28. INSTALLATION
  29. ------------
  30. * Install as you would normally install a contributed Drupal module. See:
  31. https://drupal.org/documentation/install/modules-themes/modules-7
  32. for further information.
  33. CONFIGURATION
  34. -------------
  35. * Configure user permissions in Administration > People > Permissions:
  36. - Access Account Sentinel logs
  37. Users with this permission are able to access the logs of Account
  38. Sentinel on Administration > Reports > Account Sentinel log.
  39. - Change Account Sentinel's configuration
  40. Users with this permission are able to change the configuration of Account
  41. Sentinel on Administration > Configuration > System > Account Sentinel
  42. settings.
  43. * Configure the module in Administration > Configuration > System > Account
  44. Sentinel settings:
  45. - Monitored roles
  46. Choose which roles' users should be monitored. Typically any administrative
  47. roles should be checked.
  48. - Recipient(s) of notification e-mails
  49. You may provide e-mail addresses to send notifications to. The format
  50. should be (if not empty):
  51. * user@example.com
  52. * user@example.com, anotheruser@example.com
  53. * User <user@example.com>
  54. * User <user@example.com>, Another User <anotheruser@example.com>
  55. - Automatic DB check method
  56. Account Sentinel periodically compares Drupal's data about users with its
  57. own snapshots of monitored users. You can configure with this option what
  58. the trigger for these audits should be.
  59. * [Optional] Set last audit warning threshold
  60. Account Sentinel will show a warning if it's been a while since the last
  61. database audit. By default this warning is shown after 3 days. You can
  62. change this value using Drush:
  63. drush vset --yes account_sentinel_audit_warn_after NEW_VALUE
  64. Where NEW_VALUE is the threshold in seconds.
  65. DRUSH COMMANDS
  66. --------------
  67. * account-sentinel-audit (as-audit)
  68. Runs the Account Sentinel database audit.
  69. * account-sentinel-show (as-show)
  70. Shows an event's details or a list of the most recent events.
  71. Please consult "drush help as-show" for more information.