You are here

README.txt in Nodeaccess 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 5 README.txt
  3. 6.2 README.txt
  4. 6 README.txt
  5. 7 README.txt
INTRODUCTION
------------

This module allows you to manage permissions for nodes by role and user. In 
other words, it implements per node access control for users and groups. With 
this module, you can restrict access to any individual node without having to 
use taxonomy. You can assign permission to view, edit or delete each 
individual node by user or role. Once enabled, a 'grant' tab will appear on 
node pages. You can click this and assign permissions for that node.

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

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

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

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

  * Install as you would normally install a contributed Drupal module. Visit:
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
   for further information.

  * Strongly recommend backing up your database before installing this module.

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

Once you check the enable box and submit the page, no nodes will be accessible
to anyone other than the admin user. You just set permissions on the
nodeaccess settings page (/admin/config/people/nodeaccess) to enable access to 
your site.

The settings page has a section for roles, and then a section for every node 
type you have on your site.

ALLOWED ROLES:

The allowed roles section allows you to choose what roles will appear on the 
node grant tab. Just check each role you want to appear. Note that you can 
still set defaults for all roles as the admin user, these options just hide 
what is available on each node page.

NODE TYPE SETTINGS:

For each node type on your site, you can set default role access permissions 
and choose if the grant tab should be available on that page. If the show 
grant tab option is not checked, the grant tab will not appear on the node 
page regardless of user permissions.

For each node type, you can also choose the default permissions for that type. 
To emulate standard drupal permissions, you would give anonymous user and 
authenticated user view permissions for each node type. Note that once this 
module is first enabled, no permissions are granted, so it is important to set 
defaults.

The default permissions for each node type will apply to any node which does 
not have permissions set, either at the time you submit the settings or when 
any new node is created. For already existing nodes, the defaults will apply 
only to those nodes which have not had custom permissions set on the node 
grants tab. 

TIPS:

If you grant authenticated users edit permission, you cannot revoke that for 
any user who is a member of authenticated users. For example, if you wanted 
all users to be able to edit a node except for one user, you cannot do this by
granted edit permission to authenticated users, then adding the user to the 
node without view permissions. Drupal doesn't let you do that.

File

README.txt
View source
  1. INTRODUCTION
  2. ------------
  3. This module allows you to manage permissions for nodes by role and user. In
  4. other words, it implements per node access control for users and groups. With
  5. this module, you can restrict access to any individual node without having to
  6. use taxonomy. You can assign permission to view, edit or delete each
  7. individual node by user or role. Once enabled, a 'grant' tab will appear on
  8. node pages. You can click this and assign permissions for that node.
  9. * For a full description of the module, visit the project page:
  10. https://www.drupal.org/project/nodeaccess
  11. * To submit bug reports and feature suggestions, or to track changes:
  12. https://www.drupal.org/project/issues/nodeaccess
  13. REQUIREMENTS
  14. ------------
  15. INSTALLATION
  16. ------------
  17. * Install as you would normally install a contributed Drupal module. Visit:
  18. https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
  19. for further information.
  20. * Strongly recommend backing up your database before installing this module.
  21. CONFIGURATION
  22. -------------
  23. Once you check the enable box and submit the page, no nodes will be accessible
  24. to anyone other than the admin user. You just set permissions on the
  25. nodeaccess settings page (/admin/config/people/nodeaccess) to enable access to
  26. your site.
  27. The settings page has a section for roles, and then a section for every node
  28. type you have on your site.
  29. ALLOWED ROLES:
  30. The allowed roles section allows you to choose what roles will appear on the
  31. node grant tab. Just check each role you want to appear. Note that you can
  32. still set defaults for all roles as the admin user, these options just hide
  33. what is available on each node page.
  34. NODE TYPE SETTINGS:
  35. For each node type on your site, you can set default role access permissions
  36. and choose if the grant tab should be available on that page. If the show
  37. grant tab option is not checked, the grant tab will not appear on the node
  38. page regardless of user permissions.
  39. For each node type, you can also choose the default permissions for that type.
  40. To emulate standard drupal permissions, you would give anonymous user and
  41. authenticated user view permissions for each node type. Note that once this
  42. module is first enabled, no permissions are granted, so it is important to set
  43. defaults.
  44. The default permissions for each node type will apply to any node which does
  45. not have permissions set, either at the time you submit the settings or when
  46. any new node is created. For already existing nodes, the defaults will apply
  47. only to those nodes which have not had custom permissions set on the node
  48. grants tab.
  49. TIPS:
  50. If you grant authenticated users edit permission, you cannot revoke that for
  51. any user who is a member of authenticated users. For example, if you wanted
  52. all users to be able to edit a node except for one user, you cannot do this by
  53. granted edit permission to authenticated users, then adding the user to the
  54. node without view permissions. Drupal doesn't let you do that.