You are here

README.txt in Album Photos 8.4

Same filename in this branch
  1. 8.4 README.txt
  2. 8.4 photos_access/README.txt
Same filename and directory in other branches
  1. 8.5 README.txt
  2. 6.2 README.txt
  3. 7.3 README.txt
  4. 6.0.x README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Features
 * Requirements
 * Recommended Modules
 * Installation
 * Configuration
 * Maintainers


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

The Album Photos module provides a solution for creating photo albums and
uploading multiple images. The module automatically creates the photos content
type which creates a node that contains all the photos (saved as managed files).

The Album Photos module comes with the Photo Access sub-module that provides
settings for each album including open, locked, designated users, or password
required.

 * For a full description of the module visit:
   https://www.drupal.org/project/photos or
   https://www.drupal.org/node/2896620

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

FEATURES
--------

 * Create photo galleries.
 * Upload and manage images.
 * Upload multiple images with Plupload.
 * Comment on images (@todo).
 * Vote on images (@todo).
 * Integrates with core image styles.
 * Support for Drupal core private file system.


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

This module requires no modules outside of Drupal core.


RECOMMENDED MODULES
-------------------

For the best experience install and enable the following modules:
 * Crop API - https://www.drupal.org/project/crop
 * Image Widget Crop - https://www.drupal.org/project/image_widget_crop
 * Image Effects - https://www.drupal.org/project/image_effects
 * Colorbox - https://www.drupal.org/project/colorbox

For multi image upload:
 * Plupload integration - https://www.drupal.org/project/plupload

For auto fix image orientation:
 * EXIF Orientation - https://www.drupal.org/project/exif_orientation


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

Install the Album Photos module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/1897420 for further
information.


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

    1. Navigate to Administration > Extend and enable the module. Upon enabling,
       the module creates a "Photos" content type.
    2. Navigate to Administration > Configuration > Media > Photos to edit
       global settings: Basic Settings, Image Sizes, Display Settings,
       Statistics, and Exif Settings.
    3. To edit the Privacy settings, the Photos Access submodule must be
       enabled.
    4. Navigate to Administration > People > Permissions to edit user
       permissions.

For plupload integration.
    1. Install plupload module.
    2. Install plupload library.
    3. Enable plupload setting in photos global settings.
    4. Clear cache.

For cropping:
    1. Install Crop API: https://www.drupal.org/project/crop
    2. Install Image Widget Cropper:
       https://www.drupal.org/project/image_widget_crop
    3. Configure Image Widget Cropper and set up image styles to work with
       photos: admin/config/media/photos.
    4. The image crop widget will appear on the image edit form:
       photos/image/{file}/edit

For watermark:
    1. Install Image Effects https://www.drupal.org/project/image_effects
    2. Update image styles as needed.
    3. Tips: resize or scale image before watermark is added.
       Or use watermark scale option.

For inline editing photo title and description:
    1. TBD (@todo).
    2. Save jquery.jeditable.js AND jquery.jeditable.mini.js
      from http://www.appelsiini.net/projects/jeditable.
    3. Add both files to libraries/jeditable.

For colorbox integration:
    1. Install the Colorbox module (@todo).
    2. On the Colorbox module settings page check "Enable Colorbox load" in
       extra settings and save.

Locked and Password Protected Galleries
 * Please note that locked and password protected galleries will only protect
   the actual image URL if a private file path is set. In settings.php be sure
   to set the private file path ($settings['file_private_path']).

 * NGINX if you are using NGINX the following needs to be added to your config
   file to allow image styles to be created and accessed on the private file
   system:
   # Private image styles
     location ~ ^/system/files/styles/ {
        try_files $uri @rewrite;
     }
   # Private photos image styles
     location ~ ^/system/files/photos/ {
        try_files $uri @rewrite;
     }


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

 * Nathaniel Burnett (Nathaniel) - https://www.drupal.org/u/nathaniel
 * eastcn - https://www.drupal.org/u/eastcn

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Features
  5. * Requirements
  6. * Recommended Modules
  7. * Installation
  8. * Configuration
  9. * Maintainers
  10. INTRODUCTION
  11. ------------
  12. The Album Photos module provides a solution for creating photo albums and
  13. uploading multiple images. The module automatically creates the photos content
  14. type which creates a node that contains all the photos (saved as managed files).
  15. The Album Photos module comes with the Photo Access sub-module that provides
  16. settings for each album including open, locked, designated users, or password
  17. required.
  18. * For a full description of the module visit:
  19. https://www.drupal.org/project/photos or
  20. https://www.drupal.org/node/2896620
  21. * To submit bug reports and feature suggestions, or to track changes visit:
  22. https://www.drupal.org/project/issues/photos
  23. FEATURES
  24. --------
  25. * Create photo galleries.
  26. * Upload and manage images.
  27. * Upload multiple images with Plupload.
  28. * Comment on images (@todo).
  29. * Vote on images (@todo).
  30. * Integrates with core image styles.
  31. * Support for Drupal core private file system.
  32. REQUIREMENTS
  33. ------------
  34. This module requires no modules outside of Drupal core.
  35. RECOMMENDED MODULES
  36. -------------------
  37. For the best experience install and enable the following modules:
  38. * Crop API - https://www.drupal.org/project/crop
  39. * Image Widget Crop - https://www.drupal.org/project/image_widget_crop
  40. * Image Effects - https://www.drupal.org/project/image_effects
  41. * Colorbox - https://www.drupal.org/project/colorbox
  42. For multi image upload:
  43. * Plupload integration - https://www.drupal.org/project/plupload
  44. For auto fix image orientation:
  45. * EXIF Orientation - https://www.drupal.org/project/exif_orientation
  46. INSTALLATION
  47. ------------
  48. Install the Album Photos module as you would normally install a contributed
  49. Drupal module. Visit https://www.drupal.org/node/1897420 for further
  50. information.
  51. CONFIGURATION
  52. -------------
  53. 1. Navigate to Administration > Extend and enable the module. Upon enabling,
  54. the module creates a "Photos" content type.
  55. 2. Navigate to Administration > Configuration > Media > Photos to edit
  56. global settings: Basic Settings, Image Sizes, Display Settings,
  57. Statistics, and Exif Settings.
  58. 3. To edit the Privacy settings, the Photos Access submodule must be
  59. enabled.
  60. 4. Navigate to Administration > People > Permissions to edit user
  61. permissions.
  62. For plupload integration.
  63. 1. Install plupload module.
  64. 2. Install plupload library.
  65. 3. Enable plupload setting in photos global settings.
  66. 4. Clear cache.
  67. For cropping:
  68. 1. Install Crop API: https://www.drupal.org/project/crop
  69. 2. Install Image Widget Cropper:
  70. https://www.drupal.org/project/image_widget_crop
  71. 3. Configure Image Widget Cropper and set up image styles to work with
  72. photos: admin/config/media/photos.
  73. 4. The image crop widget will appear on the image edit form:
  74. photos/image/{file}/edit
  75. For watermark:
  76. 1. Install Image Effects https://www.drupal.org/project/image_effects
  77. 2. Update image styles as needed.
  78. 3. Tips: resize or scale image before watermark is added.
  79. Or use watermark scale option.
  80. For inline editing photo title and description:
  81. 1. TBD (@todo).
  82. 2. Save jquery.jeditable.js AND jquery.jeditable.mini.js
  83. from http://www.appelsiini.net/projects/jeditable.
  84. 3. Add both files to libraries/jeditable.
  85. For colorbox integration:
  86. 1. Install the Colorbox module (@todo).
  87. 2. On the Colorbox module settings page check "Enable Colorbox load" in
  88. extra settings and save.
  89. Locked and Password Protected Galleries
  90. * Please note that locked and password protected galleries will only protect
  91. the actual image URL if a private file path is set. In settings.php be sure
  92. to set the private file path ($settings['file_private_path']).
  93. * NGINX if you are using NGINX the following needs to be added to your config
  94. file to allow image styles to be created and accessed on the private file
  95. system:
  96. # Private image styles
  97. location ~ ^/system/files/styles/ {
  98. try_files $uri @rewrite;
  99. }
  100. # Private photos image styles
  101. location ~ ^/system/files/photos/ {
  102. try_files $uri @rewrite;
  103. }
  104. MAINTAINERS
  105. -----------
  106. * Nathaniel Burnett (Nathaniel) - https://www.drupal.org/u/nathaniel
  107. * eastcn - https://www.drupal.org/u/eastcn