You are here

README.txt in Hacked! 7.2

Same filename and directory in other branches
  1. 7.3 README.txt
CONTENTS OF THIS FILE
---------------------

* Introduction
* Requirements
* Recommended modules
* Installation
* Configuration
* Drush
* Maintainers


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

The Hacked! module scans the currently installed Drupal contributed modules and
themes, re-downloads them and determines if they have been changed. Changes are
marked clearly and if the Diff module is installed then Hacked! will allow you
to see the exact lines that have changed.

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

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


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

This module does not require any additional modules outside of Drupal core.

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

Diff - https://www.drupal.org/project/diff


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

Option 1:

Install the Hacked! module as you would normally install a contributed Drupal
module, and then enable it.
Visit https://www.drupal.org/docs/7/extend/installing-modules for further
information.

Option 2:

To leave the site untouched, and not install the module, do the following:

1. Outside of the Drupal directory structure, download the Hacked module to your
Drush directory.
    * `drush pm-download hacked`
2. Clear your Drush cache to pick up the new commands.
    * `drush cache-clear drush`


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

1. Navigate to Administration > Reports > Hacked. The "List projects" tab will
provide a list of modules which have changes. Each list item provides a "View
details of changes" link which gives a more detailed list of what exact changes
occurred.
The "Settings" tab allows two options: "Ignore line endings" which is helpful if
the project has been edited on a platform different from the original author's
(E.g. if a file has been opened and saved on Windows) and "Include line endings"
when hashing files differences in line endings will be included.
2. To run a report which includes disabled modules, navigate to Administration
> Reports > Updates > Settings and click the "Check for updates of disabled and
uninstalled modules and themes" checkbox. Save configuration.

The process of fetching and comparing with clean projects can be a
time-consuming one, so give it some time to load on the first run.


DRUSH
-----

Drush commands in hacked:

hacked-details (hd)   Show the Hacked! report about a specific project.
hacked-diff           Output a unified diff of the project specified.
hacked-list-projects  List all projects that can be analysed by Hacked!


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

* Andrei Ivnitskii - https://www.drupal.org/u/itcrowd72
* Colan Schwartz - https://www.drupal.org/u/colan
* Stuart Clark (Deciphered) - https://www.drupal.org/u/deciphered
* Steven Jones - https://www.drupal.org/u/steven-jones

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Recommended modules
  6. * Installation
  7. * Configuration
  8. * Drush
  9. * Maintainers
  10. INTRODUCTION
  11. ------------
  12. The Hacked! module scans the currently installed Drupal contributed modules and
  13. themes, re-downloads them and determines if they have been changed. Changes are
  14. marked clearly and if the Diff module is installed then Hacked! will allow you
  15. to see the exact lines that have changed.
  16. * For a full description of the module visit
  17. https://www.drupal.org/node/667576
  18. * To submit bug reports and feature suggestions, or to track changes visit
  19. https://www.drupal.org/project/issues/hacked
  20. REQUIREMENTS
  21. ------------
  22. This module does not require any additional modules outside of Drupal core.
  23. RECOMMENDED MODULES
  24. -------------------
  25. Diff - https://www.drupal.org/project/diff
  26. INSTALLATION
  27. ------------
  28. Option 1:
  29. Install the Hacked! module as you would normally install a contributed Drupal
  30. module, and then enable it.
  31. Visit https://www.drupal.org/docs/7/extend/installing-modules for further
  32. information.
  33. Option 2:
  34. To leave the site untouched, and not install the module, do the following:
  35. 1. Outside of the Drupal directory structure, download the Hacked module to your
  36. Drush directory.
  37. * `drush pm-download hacked`
  38. 2. Clear your Drush cache to pick up the new commands.
  39. * `drush cache-clear drush`
  40. CONFIGURATION
  41. -------------
  42. 1. Navigate to Administration > Reports > Hacked. The "List projects" tab will
  43. provide a list of modules which have changes. Each list item provides a "View
  44. details of changes" link which gives a more detailed list of what exact changes
  45. occurred.
  46. The "Settings" tab allows two options: "Ignore line endings" which is helpful if
  47. the project has been edited on a platform different from the original author's
  48. (E.g. if a file has been opened and saved on Windows) and "Include line endings"
  49. when hashing files differences in line endings will be included.
  50. 2. To run a report which includes disabled modules, navigate to Administration
  51. > Reports > Updates > Settings and click the "Check for updates of disabled and
  52. uninstalled modules and themes" checkbox. Save configuration.
  53. The process of fetching and comparing with clean projects can be a
  54. time-consuming one, so give it some time to load on the first run.
  55. DRUSH
  56. -----
  57. Drush commands in hacked:
  58. hacked-details (hd) Show the Hacked! report about a specific project.
  59. hacked-diff Output a unified diff of the project specified.
  60. hacked-list-projects List all projects that can be analysed by Hacked!
  61. MAINTAINERS
  62. -----------
  63. * Andrei Ivnitskii - https://www.drupal.org/u/itcrowd72
  64. * Colan Schwartz - https://www.drupal.org/u/colan
  65. * Stuart Clark (Deciphered) - https://www.drupal.org/u/deciphered
  66. * Steven Jones - https://www.drupal.org/u/steven-jones