You are here

README.txt in Demonstration site (Sandbox / Snapshot) 8

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
  3. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Usage
 * Maintainers


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

Demo Site is a simple module that allows you to take a snapshot of a Drupal
demonstration site. It turns a Drupal installation into a sandbox that you can
use for testing modules or publicly demonstrating a module / extension / theme
(you name it). In short: With cron enabled, the Drupal site will be reset to
the dumped state in a definable interval. Of course you can reset the site
manually, too.
Demonstration site module help to create snapshots of your drupal site. This
will save the current version of your site and you can restore to this version
later.

Two Options of taking snapshots :-
(1) Database Snapshots</b> Takes the snapshot of the whole database.All files
will get stored in the private directory. On resetting, All the configuration
settings and nodes will get restore.
(2) Configuration Snapshots</b> Takes the snapshot only of the configuration
settings of your drupal site. All files will get stored in the private directory.
On resetting the drupal site, this will only configuration setting will be
restored. Nodes will remain as it is.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/demo

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


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

This module doesn't require any module outside of Drupal core.


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

 * Check if settings.php have the setting enabled ->
   $settings['file_private_path'] = 'sites/default/files/private';

 * Copy the Demo module to your modules directory and enable it on the Modules
   page (admin/modules).

 * Optionally configure who is allowed to administer Demo module, create dumps
   and reset the site on the Permissions page (admin/people/permissions).


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

 * Create private directory for demo module if it doesn't exist in
   'sites/default/files/private/demo/'

 * Configure the path where dumps will be stored at the Dump settings
   (admin/structure/snapshots).

To configure automatic reset:

 * Go to Manage snapshots (admin/structure/snapshots/demo) and select a snapshot
   for cron.

 * Enable atomatic reset from Dump settings
   (admin/structure/snapshots/demo/settings). Make sure you have cron configured
   to run at least once within the entered time interval.


USAGE
-----

 * Go to Create snapshot (admin/structure/snapshots/demo) and create your first
   snapshot.

 * After a while, reset your site (admin/structure/snapshots/demo/reset).


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

 * Gaurav Kapoor (gaurav.kapoor) - https://www.drupal.org/u/gauravkapoor

Supporting organizations:

 * OpenSense Labs - https://www.drupal.org/opensense-labs

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Usage
  8. * Maintainers
  9. INTRODUCTION
  10. ------------
  11. Demo Site is a simple module that allows you to take a snapshot of a Drupal
  12. demonstration site. It turns a Drupal installation into a sandbox that you can
  13. use for testing modules or publicly demonstrating a module / extension / theme
  14. (you name it). In short: With cron enabled, the Drupal site will be reset to
  15. the dumped state in a definable interval. Of course you can reset the site
  16. manually, too.
  17. Demonstration site module help to create snapshots of your drupal site. This
  18. will save the current version of your site and you can restore to this version
  19. later.
  20. Two Options of taking snapshots :-
  21. (1) Database Snapshots Takes the snapshot of the whole database.All files
  22. will get stored in the private directory. On resetting, All the configuration
  23. settings and nodes will get restore.
  24. (2) Configuration Snapshots Takes the snapshot only of the configuration
  25. settings of your drupal site. All files will get stored in the private directory.
  26. On resetting the drupal site, this will only configuration setting will be
  27. restored. Nodes will remain as it is.
  28. * For a full description of the module, visit the project page:
  29. https://www.drupal.org/project/demo
  30. * To submit bug reports and feature suggestions, or to track changes:
  31. https://www.drupal.org/project/issues/demo
  32. REQUIREMENTS
  33. ------------
  34. This module doesn't require any module outside of Drupal core.
  35. INSTALLATION
  36. ------------
  37. * Check if settings.php have the setting enabled ->
  38. $settings['file_private_path'] = 'sites/default/files/private';
  39. * Copy the Demo module to your modules directory and enable it on the Modules
  40. page (admin/modules).
  41. * Optionally configure who is allowed to administer Demo module, create dumps
  42. and reset the site on the Permissions page (admin/people/permissions).
  43. CONFIGURATION
  44. -------------
  45. * Create private directory for demo module if it doesn't exist in
  46. 'sites/default/files/private/demo/'
  47. * Configure the path where dumps will be stored at the Dump settings
  48. (admin/structure/snapshots).
  49. To configure automatic reset:
  50. * Go to Manage snapshots (admin/structure/snapshots/demo) and select a snapshot
  51. for cron.
  52. * Enable atomatic reset from Dump settings
  53. (admin/structure/snapshots/demo/settings). Make sure you have cron configured
  54. to run at least once within the entered time interval.
  55. USAGE
  56. -----
  57. * Go to Create snapshot (admin/structure/snapshots/demo) and create your first
  58. snapshot.
  59. * After a while, reset your site (admin/structure/snapshots/demo/reset).
  60. MAINTAINERS
  61. -----------
  62. * Gaurav Kapoor (gaurav.kapoor) - https://www.drupal.org/u/gauravkapoor
  63. Supporting organizations:
  64. * OpenSense Labs - https://www.drupal.org/opensense-labs