README.txt 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Features
  5. * Requirements
  6. * Installation
  7. * Configuration
  8. * Daemon Usage
  9. INTRODUCTION
  10. ------------
  11. This module is meant to provide a simple means of creating a robust
  12. command-line-driven, fully bootstrapped PHP Daemon. It uses the PHP-Daemon
  13. (https://github.com/shaneharter/PHP-Daemon) Library to create the Daemon (via
  14. the Libraries API) in order to not re-invent the wheel ;-).
  15. FEATURES
  16. --------
  17. * Provides a Drush interface to start/stop your Daemon.
  18. * Your daemon starts in the background and is detached from the current
  19. terminal.
  20. * Daemon will run all Tripal Jobs submitted within 20 seconds.
  21. * A log including the number of jobs executed, their identifiers and results.
  22. * Lock Files, Automatic restart (8hrs default) and Built-in Signal Handling &
  23. Event Logging are only a few of the features provided by the Daemon API
  24. making this a fully featured & robust Daemon.
  25. REQUIREMENTS
  26. ------------
  27. * Libraries API (https://www.drupal.org/project/libraries)
  28. * PHP-Daemon Library version 2.0 (https://github.com/shaneharter/PHP-Daemon)
  29. * Drush 5.x (https://github.com/drush-ops/drush)
  30. * Drush Daemon API (https://www.drupal.org/project/drushd)
  31. INSTALLATION
  32. ------------
  33. * Install all required modules as per their instructions.
  34. * Install this module as you would normally install a contributed drupal
  35. module. See:https://drupal.org/documentation/install/modules-themes/modules-7
  36. for further information.
  37. * Download the PHP-Daemon Library and extract it in your sites/all/libraries
  38. directory. The folder must be named "PHP-Daemon".
  39. CONFIGURATION
  40. -------------
  41. The module has no menu or modifiable settings. There is no configuration. When
  42. enabled, the module will provide a number of drush commands for control of the
  43. Tripal Daemon from the command-line.
  44. TRIPAL DAEMON USAGE
  45. -------------------
  46. * Start Daemon
  47. drush trpjob-daemon start
  48. * Stop Daemon
  49. drush trpjob-daemon stop
  50. * Check the Status
  51. drush trpjob-daemon status
  52. * Show the Log
  53. * List the last 10 lines of the log file:
  54. drush trpjob-daemon show-log
  55. * List the last N lines of the log file:
  56. drush trpjob-daemon show-log --num_lines=N