You are here

INSTALL.txt in Audit Files 7.4

Same filename and directory in other branches
  1. 5 INSTALL.txt
  2. 6.3 INSTALL.txt
  3. 6.2 INSTALL.txt
  4. 7.3 INSTALL.txt
CONTENTS
--------
 * Requirements
 * Recommended modules
 * Installation
 * Permissions
 * Configuration


REQUIREMENTS
------------
 * No additional requirements are necessary.


RECOMMENDED MODULES
-------------------
 * No additional modules are necessary.


INSTALLATION
------------
 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7
   for further information.


PERMISSIONS
-----------
 * Configure user permissions in Administration > People > Permissions > Audit
   Files (admin/people/permissions#module-auditfiles):
   * Access Audit Files' reports: Users with this permission are allowed access
     to the various file audit reports.
   * Administer Audit Files: Users with this permission are allowed to access
     and change the system administrative configuration settings (described
     below) for this module.


CONFIGURATION
-------------
 * Configure the module in Administration > Configuration and modules > System >
   Audit Files menu (admin/config/system/auditfiles).
   * Exclusions: There may be some files, file extensions and/or directories
     that you do not want to taken into consideration when generating the
     various reports. These fields allow the site administrator the ability to
     exclude those items. In each field, enter in the list of respective items
     to exclude. Separate each exclusion with a  semi-colon. These are the three
     fields:
     * Exclude these files: List in here all specific files to be excluded from
       the reports. By default, only .htaccess is excluded.
     * Exclude these extensions: List in here all file extensions to exclude
       from the reports. Any file found with any of these extensions will be
       excluded from the reports. By default, no extensions are excluded.
     * Exclude these paths: List in here all paths to exclude from searching for
       files through. By default, the color, css, ctools, and js paths are
       excluded.
   * Domains
     * Include references to these domains: Here you may enter a list of domains
       that will be considered local to the site in the reports for the purposes
       of creating links.
   * Report options: These are various configuration options for how to format
     certain items in the reports.
     * Date format: This is the date format that is used when displaying file's
       date in the reports. Date types and formats can be modified in the system
       Date and time settings pages, located at Administration > Configuration >
       Regional and language (admin/config/regional/date-time).
     * Number of items per page: This is the number of items to display on each
       page of a report. If there are more than this number on a page, then a
       pager will be used to display the additional items. Set this to 0 to show
       all items on a single page.
     * Maximum records: This is the maximum number of records to return for each
       report. If any of the reports are timing out, set this to some positive
       integer to limit the number of records that are queried in the database.
       See the Limiting Features Explained section in the README.txt file for
       more information. Set this to 0 for no limit.
     * Batch set size: This the number of records to use for displaying data
       in batches. Enter a positive integer here and the batch operations will
       be broken up into sets of this number of records. See the Limiting
       Features Explained section in the README.txt file for more information.
       Set this to 0 for no limit.

File

INSTALL.txt
View source
  1. CONTENTS
  2. --------
  3. * Requirements
  4. * Recommended modules
  5. * Installation
  6. * Permissions
  7. * Configuration
  8. REQUIREMENTS
  9. ------------
  10. * No additional requirements are necessary.
  11. RECOMMENDED MODULES
  12. -------------------
  13. * No additional modules are necessary.
  14. INSTALLATION
  15. ------------
  16. * Install as you would normally install a contributed Drupal module. See:
  17. https://drupal.org/documentation/install/modules-themes/modules-7
  18. for further information.
  19. PERMISSIONS
  20. -----------
  21. * Configure user permissions in Administration > People > Permissions > Audit
  22. Files (admin/people/permissions#module-auditfiles):
  23. * Access Audit Files' reports: Users with this permission are allowed access
  24. to the various file audit reports.
  25. * Administer Audit Files: Users with this permission are allowed to access
  26. and change the system administrative configuration settings (described
  27. below) for this module.
  28. CONFIGURATION
  29. -------------
  30. * Configure the module in Administration > Configuration and modules > System >
  31. Audit Files menu (admin/config/system/auditfiles).
  32. * Exclusions: There may be some files, file extensions and/or directories
  33. that you do not want to taken into consideration when generating the
  34. various reports. These fields allow the site administrator the ability to
  35. exclude those items. In each field, enter in the list of respective items
  36. to exclude. Separate each exclusion with a semi-colon. These are the three
  37. fields:
  38. * Exclude these files: List in here all specific files to be excluded from
  39. the reports. By default, only .htaccess is excluded.
  40. * Exclude these extensions: List in here all file extensions to exclude
  41. from the reports. Any file found with any of these extensions will be
  42. excluded from the reports. By default, no extensions are excluded.
  43. * Exclude these paths: List in here all paths to exclude from searching for
  44. files through. By default, the color, css, ctools, and js paths are
  45. excluded.
  46. * Domains
  47. * Include references to these domains: Here you may enter a list of domains
  48. that will be considered local to the site in the reports for the purposes
  49. of creating links.
  50. * Report options: These are various configuration options for how to format
  51. certain items in the reports.
  52. * Date format: This is the date format that is used when displaying file's
  53. date in the reports. Date types and formats can be modified in the system
  54. Date and time settings pages, located at Administration > Configuration >
  55. Regional and language (admin/config/regional/date-time).
  56. * Number of items per page: This is the number of items to display on each
  57. page of a report. If there are more than this number on a page, then a
  58. pager will be used to display the additional items. Set this to 0 to show
  59. all items on a single page.
  60. * Maximum records: This is the maximum number of records to return for each
  61. report. If any of the reports are timing out, set this to some positive
  62. integer to limit the number of records that are queried in the database.
  63. See the Limiting Features Explained section in the README.txt file for
  64. more information. Set this to 0 for no limit.
  65. * Batch set size: This the number of records to use for displaying data
  66. in batches. Enter a positive integer here and the batch operations will
  67. be broken up into sets of this number of records. See the Limiting
  68. Features Explained section in the README.txt file for more information.
  69. Set this to 0 for no limit.