You are here

Home » API reference » Private files download permission 3.x

README.txt in Private files download permission 3.x

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
Private files download permission
=================================

DESCRIPTION
----------------------------

Version 7.x-1.x provided "two useful features which Drupal itself is missing: a
simple permission to allow downloading of private files by role, plus the
ability to combine both public and private downloads".

Version 7.x-2.x removed the "global" permission and implements a per-directory
by-user and by-role filter instead, to let the administrator better tweak the
whole website and increment the overall security.

The 8.x port was rewritten from scratch, but many thanks to Paris Liakos and
Andrey Kovtun for their precious help and hints.

The 3.x branch was created for Drupal 9 (although it currently supports Drupal
8.8.3+).

Idea and code (mostly for version 7.x-1.x) were inspired by
http://www.beacon9.ca/labs/drupal-7-private-files-module.
The 7.x-2.x development was partly sponsored by Cooperativa Italiana Artisti
(http://www.cita.coop).

INSTALLATION / CONFIGURATION
----------------------------

Browse to Configuration > Media > Private files download permission (url:
/admin/config/media/private-files-download-permission). Then add or edit each
directory path you want to put under control, associating users and roles which
are allowed to download from that location.
All directory paths are relative to your private file system path, but must
have a leading slash ('/'), as the private file system root itself could be put
under control.

E.g.:
Suppose your private file system path is /opt/private.
You could configure /opt/private (and all of its subdirectories) by adding a
'/' entry, while a '/test' entry would specifically refer to /opt/private/test
(and all of its subdirectories).

Please note that per-user checks may slow your site if there are plenty of
users. You can then bypass this feature by browsing to Configuration > Media >
Private files download permission > Settings (url:
/admin/config/media/private-files-download-permission/settings) and change the
setting accordingly.
Additional settings are available to cache users and/or log activities.

Also configure which users and roles have access to the module configuration
under People > Permissions (url: /admin/people/permissions).

File

README.txt
View source 
  1. Private files download permission

  2. =================================

  3. 

  4. DESCRIPTION

  5. ----------------------------

  6. 

  7. Version 7.x-1.x provided "two useful features which Drupal itself is missing: a

  8. simple permission to allow downloading of private files by role, plus the

  9. ability to combine both public and private downloads".

  10. 

  11. Version 7.x-2.x removed the "global" permission and implements a per-directory

  12. by-user and by-role filter instead, to let the administrator better tweak the

  13. whole website and increment the overall security.

  14. 

  15. The 8.x port was rewritten from scratch, but many thanks to Paris Liakos and

  16. Andrey Kovtun for their precious help and hints.

  17. 

  18. The 3.x branch was created for Drupal 9 (although it currently supports Drupal

  19. 8.8.3+).

  20. 

  21. Idea and code (mostly for version 7.x-1.x) were inspired by

  22. http://www.beacon9.ca/labs/drupal-7-private-files-module.

  23. The 7.x-2.x development was partly sponsored by Cooperativa Italiana Artisti

  24. (http://www.cita.coop).

  25. 

  26. INSTALLATION / CONFIGURATION

  27. ----------------------------

  28. 

  29. Browse to Configuration > Media > Private files download permission (url:

  30. /admin/config/media/private-files-download-permission). Then add or edit each

  31. directory path you want to put under control, associating users and roles which

  32. are allowed to download from that location.

  33. All directory paths are relative to your private file system path, but must

  34. have a leading slash ('/'), as the private file system root itself could be put

  35. under control.

  36. 

  37. E.g.:

  38. Suppose your private file system path is /opt/private.

  39. You could configure /opt/private (and all of its subdirectories) by adding a

  40. '/' entry, while a '/test' entry would specifically refer to /opt/private/test

  41. (and all of its subdirectories).

  42. 

  43. Please note that per-user checks may slow your site if there are plenty of

  44. users. You can then bypass this feature by browsing to Configuration > Media >

  45. Private files download permission > Settings (url:

  46. /admin/config/media/private-files-download-permission/settings) and change the

  47. setting accordingly.

  48. Additional settings are available to cache users and/or log activities.

  49. 

  50. Also configure which users and roles have access to the module configuration

  51. under People > Permissions (url: /admin/people/permissions).