You are here

README.txt in Protected Node 7

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

 * Introduction
 * Requirements
 * Similar modules
 * Installation
 * Configuration
 * Documentation
 * Maintainers


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

With the Protected Node module, users can restrict access to a node with a
password they provide when creating the node (or a site wide password or a per
node type password). On node creation, authorized authors can protect a node by
supplying a password and verifying the strength of the password via JavaScript.

Users that want to view the node or download one of its private attachments are
first redirected to a password query page (/protected-node). Once the user
entered the right password, they are redirected back to the original node.
Authorizations are stored in sessions, so users don't have to enter the
password over and over again once provided (requires cookies).

Email feature: The module is capable of sending the password via unencrypted
emails. This is useful if you create a page to be viewed only by a few people
you know.

Views submodule: The module has a few extensions supporting Views. It includes
filters and output extensions.

Rules submodule: The module includes a Rules extension allowing you to act on a
protected node and test the current state of a node for the current user.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/protected_node
 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/project/issues/130911


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

There is no special requirement for this module.


SIMILAR MODULES
---------------

 * Protected Pages (https://www.drupal.org/project/protected_pages):
   Protected Pages uses the path to protect your page so you can password
   protect Views pages for example. With Protected Node, content creators can
   add the password as they create content, they don't have to go to another
   configuration page.


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

Once enabled, go to the administer permissions page to set the new permissions.

Below is a matrix with permissions you must set depending on your needs.

Needs:
- 1: No access at all to the resource.
- 2: Need to enter the password to see the resource.
- 3: Can view resource without password, need to enter the password to edit the
resource.
- 4: Bypass completely the protection (can edit and view without password).
- 5: Edit node passwords.

Permissions:
- A: Access protected node password form.
- B: View protected content (bypass password).
- C: Edit protected content (bypass password).
- D: Edit content type password.

Permissions\Cases | 1 | 2 | 3 | 4 | 5 |
------------------|---|---|---|---|---|
         A        |   | 1 | 1 |   |   |
------------------|---|---|---|---|---|
         B        |   |   | 1 |   |   |
------------------|---|---|---|---|---|
         C        |   |   |   | 1 |   |
------------------|---|---|---|---|---|
         D        |   |   |   |   | 1 |


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

Global settings: /admin/config/content/protected_node

Per content type: admin/structure/types/manage/%content_type in the fieldset
"Protected node settings".

You can set password on the add/edit node form in the fieldset
"Password protect this %type_name".


DOCUMENTATION
-------------

 * Original:   http://www.m2osw.com/doc-protected-node
 * Drupal.org: https://www.drupal.org/docs/7/modules/protected-node


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

Current maintainers:
 * Ismaeil Abouljamal (izus) - https://www.drupal.org/user/514568
 * Florent Torregrosa (Grimreaper) - https://www.drupal.org/user/2388214

Previous maintainers:
 * Márk Tolmács (mtolmacs) - https://www.drupal.org/user/72361
 * AlexisWilke (AlexisWilke) - https://www.drupal.org/user/356197
 * Adam Thomason (adam_thomason) - https://www.drupal.org/user/2576960
 * zilverdistel (zilverdistel) - https://www.drupal.org/user/276047

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Similar modules
  6. * Installation
  7. * Configuration
  8. * Documentation
  9. * Maintainers
  10. INTRODUCTION
  11. ------------
  12. With the Protected Node module, users can restrict access to a node with a
  13. password they provide when creating the node (or a site wide password or a per
  14. node type password). On node creation, authorized authors can protect a node by
  15. supplying a password and verifying the strength of the password via JavaScript.
  16. Users that want to view the node or download one of its private attachments are
  17. first redirected to a password query page (/protected-node). Once the user
  18. entered the right password, they are redirected back to the original node.
  19. Authorizations are stored in sessions, so users don't have to enter the
  20. password over and over again once provided (requires cookies).
  21. Email feature: The module is capable of sending the password via unencrypted
  22. emails. This is useful if you create a page to be viewed only by a few people
  23. you know.
  24. Views submodule: The module has a few extensions supporting Views. It includes
  25. filters and output extensions.
  26. Rules submodule: The module includes a Rules extension allowing you to act on a
  27. protected node and test the current state of a node for the current user.
  28. * For a full description of the module, visit the project page:
  29. https://www.drupal.org/project/protected_node
  30. * To submit bug reports and feature suggestions, or to track changes:
  31. https://www.drupal.org/project/issues/130911
  32. REQUIREMENTS
  33. ------------
  34. There is no special requirement for this module.
  35. SIMILAR MODULES
  36. ---------------
  37. * Protected Pages (https://www.drupal.org/project/protected_pages):
  38. Protected Pages uses the path to protect your page so you can password
  39. protect Views pages for example. With Protected Node, content creators can
  40. add the password as they create content, they don't have to go to another
  41. configuration page.
  42. INSTALLATION
  43. ------------
  44. Once enabled, go to the administer permissions page to set the new permissions.
  45. Below is a matrix with permissions you must set depending on your needs.
  46. Needs:
  47. - 1: No access at all to the resource.
  48. - 2: Need to enter the password to see the resource.
  49. - 3: Can view resource without password, need to enter the password to edit the
  50. resource.
  51. - 4: Bypass completely the protection (can edit and view without password).
  52. - 5: Edit node passwords.
  53. Permissions:
  54. - A: Access protected node password form.
  55. - B: View protected content (bypass password).
  56. - C: Edit protected content (bypass password).
  57. - D: Edit content type password.
  58. Permissions\Cases | 1 | 2 | 3 | 4 | 5 |
  59. ------------------|---|---|---|---|---|
  60. A | | 1 | 1 | | |
  61. ------------------|---|---|---|---|---|
  62. B | | | 1 | | |
  63. ------------------|---|---|---|---|---|
  64. C | | | | 1 | |
  65. ------------------|---|---|---|---|---|
  66. D | | | | | 1 |
  67. CONFIGURATION
  68. -------------
  69. Global settings: /admin/config/content/protected_node
  70. Per content type: admin/structure/types/manage/%content_type in the fieldset
  71. "Protected node settings".
  72. You can set password on the add/edit node form in the fieldset
  73. "Password protect this %type_name".
  74. DOCUMENTATION
  75. -------------
  76. * Original: http://www.m2osw.com/doc-protected-node
  77. * Drupal.org: https://www.drupal.org/docs/7/modules/protected-node
  78. MAINTAINERS
  79. -----------
  80. Current maintainers:
  81. * Ismaeil Abouljamal (izus) - https://www.drupal.org/user/514568
  82. * Florent Torregrosa (Grimreaper) - https://www.drupal.org/user/2388214
  83. Previous maintainers:
  84. * Márk Tolmács (mtolmacs) - https://www.drupal.org/user/72361
  85. * AlexisWilke (AlexisWilke) - https://www.drupal.org/user/356197
  86. * Adam Thomason (adam_thomason) - https://www.drupal.org/user/2576960
  87. * zilverdistel (zilverdistel) - https://www.drupal.org/user/276047