You are here

INSTALL.txt in Search Files 7.2

Same filename and directory in other branches
  1. 6.2 INSTALL.txt
- backup your data and database (just in case something goes wrong)
- copy search_files folder into Drupal modules folder
- go to /admin/modules
- enable "Search Files API"
- also enable "Search Files in Attachments" if you want to search files attached to nodes
- also enable "Search Files in Directories" if you want to search files in arbitrary directories
- go to admin/config/search/settings in order to configure general search options
- go to admin/config/search/search_files/helpers in order to configure "Helpers". These are external applications which do the actual plain text extraction
- go to admin/config/search/search_files/attachments/settings in order to configure "Attachments searches" (if used), everything optional
- go to admin/config/search/search_files/directories/settings in order to configure "Directories searches" (if used), must configure at least one directory, everything else optional

- notice the dashboards, they give you some insight of what's going on
- each dashboard offers an "Update index" link which runs the targeted search index build process immediatly

- please note that only "Directories" one attempt is made to build the index
  for directories, then no more activities will be executed until a
  configurable pause of "Directory Rescan Age" is gone. A problem often
  encountered is that the Helpers do not work correctly and after their
  configuration is fixed still nothing happens because of the "Directory Rescan
  Age" timeout. During setup phase you may reduce the timeout to as low as one
  second.

- when searching for attachments the results present two links, one for the
  attachment and another one for the node where the file is attached.

- when searching for files in directories the results present a link to an
  arbitrary URL whose prefix is configurable per directory. You may well scan a
  directory /usr/home/example and setup an FTP server with URL prefix
  ftp://example.com/ which serves exactly this folder. The configuration of the
  server providing the URL is outside the scope of the Drupal module.

- uninstallation of the modules wipes out all dedicated tables, configuration
  settings and every search index data from the Drupal database.

File

INSTALL.txt
View source
  1. - backup your data and database (just in case something goes wrong)
  2. - copy search_files folder into Drupal modules folder
  3. - go to /admin/modules
  4. - enable "Search Files API"
  5. - also enable "Search Files in Attachments" if you want to search files attached to nodes
  6. - also enable "Search Files in Directories" if you want to search files in arbitrary directories
  7. - go to admin/config/search/settings in order to configure general search options
  8. - go to admin/config/search/search_files/helpers in order to configure "Helpers". These are external applications which do the actual plain text extraction
  9. - go to admin/config/search/search_files/attachments/settings in order to configure "Attachments searches" (if used), everything optional
  10. - go to admin/config/search/search_files/directories/settings in order to configure "Directories searches" (if used), must configure at least one directory, everything else optional
  11. - notice the dashboards, they give you some insight of what's going on
  12. - each dashboard offers an "Update index" link which runs the targeted search index build process immediatly
  13. - please note that only "Directories" one attempt is made to build the index
  14. for directories, then no more activities will be executed until a
  15. configurable pause of "Directory Rescan Age" is gone. A problem often
  16. encountered is that the Helpers do not work correctly and after their
  17. configuration is fixed still nothing happens because of the "Directory Rescan
  18. Age" timeout. During setup phase you may reduce the timeout to as low as one
  19. second.
  20. - when searching for attachments the results present two links, one for the
  21. attachment and another one for the node where the file is attached.
  22. - when searching for files in directories the results present a link to an
  23. arbitrary URL whose prefix is configurable per directory. You may well scan a
  24. directory /usr/home/example and setup an FTP server with URL prefix
  25. ftp://example.com/ which serves exactly this folder. The configuration of the
  26. server providing the URL is outside the scope of the Drupal module.
  27. - uninstallation of the modules wipes out all dedicated tables, configuration
  28. settings and every search index data from the Drupal database.