myks-gallery 0.7

GALLERY_PHOTO_STORAGE

Default: not defined

Dotted Python path to the Django storage class for the original photos. It must be readable by the application server but should not be writable.

While GALLERY_PHOTO_STORAGE behaves like Django’s DEFAULT_FILE_STORAGE setting, you’ll usullay point it to a factory function that initializes and returns a Django storage instance because you won’t want to use globally configured values for settings such as the S3 bucket name.

For compatibility for versions prior to 0.5, if GALLERY_PHOTO_STORAGE isn’t defined but GALLERY_PHOTO_DIR is, the photo storage will be set to FileSystemStorage(location=GALLERY_PHOTO_DIR).

GALLERY_CACHE_STORAGE

Default: not defined

Dotted Python path to the Django storage class for the thumbnails and album archives. It must be readable and writable by the application server.

It behaves like GALLERY_PHOTO_STORAGE.

For compatibility for versions prior to 0.5, if GALLERY_CACHE_STORAGE isn’t defined but GALLERY_CACHE_DIR is, the photo storage will be set to FileSystemStorage(location=GALLERY_CACHE_DIR).

GALLERY_PATTERNS

Default: ()

Tuple of (category name, regular expression) defining how to extract album information — category, date, name — from the paths of photo files.

The regular expressions match paths relative to the root of the photo storage. They contain the following captures:

• a_name: album name (mandatory) — to capture several bits, use a_name1, a_name2, etc.

• a_year, a_month, a_day: album date (mandatory)

• p_year, p_month, p_day, p_hour, p_minute, p_second: photo date and time (optional)

Here’s an example, for photos stored with names such as 2013/01_19_Snow in Paris/2013-01-19_19-12-43.jpg:

GALLERY_PATTERNS = (
    ('Photos',
        r'(?P<a_year>\d{4})/(?P<a_month>\d{2})_(?P<a_day>\d{2})_'
        r'(?P<a_name>[^_/]+)/'
        r'(?P<p_year>\d{4})-(?P<p_month>\d{2})-(?P<p_day>\d{2})_'
        r'(?P<p_hour>\d{2})-(?P<p_minute>\d{2})-(?P<p_second>\d{2})\.jpg'),
)

GALLERY_IGNORES

Default: ()

Tuple of regular expressions matching paths within GALLERY_PHOTO_STORAGE. Files matching one of these expressions will be ignored when scanning photos.

GALLERY_RESIZE_PRESETS

Default: {}

Dictionary mapping thumbnail presets names to (width, height, crop). If crop is True, the photo will be cropped and the thumbnail will have exactly the requested size. If crop is False, the thumbnaill will be smaller than the requested size in one dimension to preserve the photo’s aspect ratio.

The default templates assume the following values:

GALLERY_RESIZE_PRESETS = {
    'thumb': (128, 128, True),
    'standard': (768, 768, False),
}

You may double these sizes for better results on high DPI displays.

GALLERY_RESIZE_OPTIONS

Default: {}

Dictionary mapping image formats names to to dictionaries of options for Pillow’s save method. Options are described for each file format in Pillow’s documentation.

The following a reasonable value for high-quality thumbnails and previews:

GALLERY_RESIZE_OPTIONS = {
    'JPEG': {'quality': 95, 'optimize': True},
}

GALLERY_SENDFILE_HEADER

Default: ''

Name of the HTTP header that triggers sendfile on your web server. Use 'X-Accel-Redirect' for nginx and 'X-SendFile' for Apache.

GALLERY_SENDFILE_ROOT

Default: ''

Part to strip at the beginning of the paths in the sendfile header. The header will contain the absolute path to files, minus this prefix. This is generally useful for nginx and not necessary for Apache.

GALLERY_TITLE

Default: "Gallery"

Title of your photo gallery. This is only used by the default templates of the index and year views.

GALLERY_PREVIEW_COUNT

Default: 5

Number of thumbnails shown in the preview of each album.

GALLERY_ARCHIVE_EXPIRY

Default: None or 60

Duration in days during which album archives are kept in cache. None disables expiration.

When using a remote storage system such as S3, configuring an expiry policy for the export folder directly on the storage system is more efficient.

For compatibility with versions prior to 0.5, if GALLERY_CACHE_DIR is defined, GALLERY_ARCHIVE_EXPIRY defaults to 60.