diff options
Diffstat (limited to 'sigal.conf.py.example')
| -rw-r--r-- | sigal.conf.py.example | 305 |
1 files changed, 305 insertions, 0 deletions
diff --git a/sigal.conf.py.example b/sigal.conf.py.example new file mode 100644 index 0000000..15206be --- /dev/null +++ b/sigal.conf.py.example @@ -0,0 +1,305 @@ +# All configuration values have a default; values that are commented out serve +# to show the default. Default values are specified when modified in this +# example config file + +# Gallery title. Can be set here or as the '--title' option of the `sigal +# build` command, or in the 'index.md' file of the source directory. +# The priority order is: cli option > settings file > index.md file +#title = "Test gallery 3a" + +# --------------------- +# General configuration +# --------------------- + +# Source directory. Can be set here or as the first argument of the `sigal +# build` command +source = '/mnt/public/www/gallery/.2018' + +# Destination directory. Can be set here or as the second argument of the +# `sigal build` command (default: '_build') +destination = '/mnt/public/www/gallery/2018' + +# Theme : +# - colorbox (default), galleria, photoswipe, or the path to a custom theme +# directory +#theme = 'colorbox' +theme = '/mnt/public/Support/Programs/gallery/bgstack15-gallery-theme' + +# Author. Used in the footer of the pages and in the author meta tag. +# author = '' + +# Use originals in gallery (default: False). If True, this will bypass all +# processing steps (resize, auto-orient, recompress, and any plugin-specific +# step). +# Originals will be symlinked if orig_link = True, else they will be copied. +use_orig = True + +# ---------------- +# Image processing (ignored if use_orig = True) +# ---------------- + +# Size of resized image (default: (640, 480)) +img_size = (800, 600) + +# Output format of images (default: None, i.e. use input format) +# img_format = "JPEG" + +# Show a map of the images where possible? +# This option only has an effect on the galleria theme for the while. +# The leaflet_provider setting allow to customize the tile provider (see +# https://github.com/leaflet-extras/leaflet-providers#providers) +# show_map = False +# leaflet_provider = 'OpenStreetMap.Mapnik' + +# File extensions that should be treated as images +# img_extensions = ['.jpg', '.jpeg', '.png', '.gif'] + +# Pilkit processor used to resize the image +# (see http://pilkit.readthedocs.org/en/latest/#processors) +# - ResizeToFit: fit the image within the specified dimensions (default) +# - ResizeToFill: crop THE IMAGE it to the exact specified width and height +# - SmartResize: identical to ResizeToFill, but uses entropy to crop the image +# - None: don't resize +# img_processor = 'ResizeToFit' + +# Autorotate images +# Warning: this setting is not compatible with `copy_exif_data` (see below), +# because Sigal can't save the modified Orientation tag (currently Pillow can't +# write EXIF). +# autorotate_images = True + +# If True, EXIF data from the original image is copied to the resized image +# copy_exif_data = False + +# Python's datetime format string used for the EXIF date formatting +# https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior +# datetime_format = '%c' + +# Jpeg options +# jpg_options = {'quality': 85, +# 'optimize': True, +# 'progressive': True} + +# -------------------- +# Thumbnail generation +# -------------------- + +# Generate thumbnails +# make_thumbs = True + +# Subdirectory of the thumbnails +# thumb_dir = 'thumbnails' + +# Prefix and/or suffix for thumbnail filenames (default: '') +# thumb_prefix = '' +# thumb_suffix = '.tn' + +# Thumbnail size (default: (200, 150)) +# For the galleria theme, use 280 px for the width +# For the colorbox and photoswipe theme, use 200 px for the width +thumb_size = (280, 210) + +# Crop the image to fill the box +# thumb_fit = True + +# When using thumb_fit, specifies what we should crop +# for usage see +# http://pillow.readthedocs.io/en/stable/reference/ImageOps.html#PIL.ImageOps.fit +# thumb_fit_centering = (0.5, 0.5) + +# Delay in seconds to avoid black thumbnails in videos with fade-in +# thumb_video_delay = '0' + +# Keep original image (default: False) +# keep_orig = True + +# Subdirectory for original images +# orig_dir = 'original' + +# Use symbolic links instead of copying the original images +orig_link = True + +# Use symbolic links that are relative to the source directory instead of absolute paths +# rel_link = False + +# Attribute of Album objects which is used to sort medias (eg 'title'). To sort +# on a metadata key, use 'meta.key'. +# albums_sort_attr = 'name' + +# Reverse sort for albums +# albums_sort_reverse = False + +# Attribute of Media objects which is used to sort medias. 'date' can be used +# to sort with EXIF dates, and 'meta.key' to sort on a metadata key (which then +# must exist for all images). +# medias_sort_attr = 'filename' + +# Reverse sort for medias +# medias_sort_reverse = False + +# Filter directories and files. +# The settings take a list of patterns matched with the fnmatch module on the +# path relative to the source directory: +# http://docs.python.org/2/library/fnmatch.html +ignore_directories = [] +ignore_files = [] + +# ------------- +# Video options +# ------------- + +# Video converter binary (can be 'avconv' on certain GNU/Linux distributions) +# video_converter = 'ffmpeg' + +# File extensions that should be treated as video files +# video_extensions = ['.mov', '.avi', '.mp4', '.webm', '.ogv', '.3gp'] + +# Video format +# specify an alternative format, valid are 'webm' (default) and 'mp4' +# video_format = 'webm' + +# Webm options +# Options used in ffmpeg to encode the webm video. You may want to read +# http://ffmpeg.org/trac/ffmpeg/wiki/vpxEncodingGuide +# Be aware of the fact these options need to be passed as strings. If you are +# using avconv (for example with Ubuntu), you will need to adapt the settings. +# webm_options = ['-crf', '10', '-b:v', '1.6M', +# '-qmin', '4', '-qmax', '63'] + +# MP4 options +# Options used to encode the mp4 video. You may want to read +# https://trac.ffmpeg.org/wiki/Encode/H.264 +# mp4_options = ['-crf', '23' ] + +# Size of resized video (default: (480, 360)) +# video_size = (480, 360) + +# ------------- +# Miscellaneous +# ------------- + +# Write HTML files. If False, sigal will only process the images. +# write_html = True + +# Name of the generated HTML files +# output_filename = 'index.html' + +# Add output filename (see above) to the URLs +# index_in_url = False + +# Google Analytics tracking code (UA-xxxx-x) +# google_analytics = '' + +# Google Tag Manager tracking code (GTM-xxxxxx) +# google_tag_manager = '' + +# Piwik tracking +# tracker_url must not contain trailing slash. +# Example : {'tracker_url': 'http://stats.domain.com', 'site_id' : 2} +# piwik = {'tracker_url': '', 'site_id' : 0} + +# Specify a different locale. If set to '', the default locale is used. +# locale = '' + +# Define language used on main <html> tag in templates +# html_language = 'en' + +# List of files to copy from the source directory to the destination. +# A symbolic link is used if ``orig_link`` is set to True (see above). +# files_to_copy = (('extra/robots.txt', 'robots.txt'), +# ('extra/favicon.ico', 'favicon.ico'),) + +# Colorbox theme config +# The column size is given in number of column of the css grid of the Skeleton +# framework which is used for this theme: http://www.getskeleton.com/#grid +# Then the image size must be adapted to fit the column size. +# The default is 3 columns (176px). +colorbox_column_size = 3 + +# Site Logo - Use a logo file in the sidebar +# Only for colorbox currently, it could be adapted for other themes +# You must place the logo file into the theme's static images folder, which +# can be done using 'files_to_copy': +# files_to_copy = (('extra/logo.png', 'static/logo.png')) +# site_logo = 'logo.png' + +# -------- +# Plugins +# -------- + +# List of plugins to use. The values must be a path than can be imported. +# Another option is to import the plugin and put the module in the list, but +# this will break with the multiprocessing feature (the settings dict obtained +# from this file must be serializable). +# plugins = [ +# 'sigal.plugins.adjust', +# 'sigal.plugins.compress_assets', +# 'sigal.plugins.copyright', +# 'sigal.plugins.encrypt', +# 'sigal.plugins.extended_caching', +# 'sigal.plugins.feeds', +# 'sigal.plugins.media_page', +# 'sigal.plugins.nomedia', +# 'sigal.plugins.upload_s3', +# 'sigal.plugins.watermark', +# 'sigal.plugins.zip_gallery', +# ] + +# Adjust the image after resizing it. A default value of 1.0 leaves the images +# untouched. +# adjust_options = {'color': 1.0, +# 'brightness': 1.0, +# 'contrast': 1.0, +# 'sharpness': 1.0} + +# Settings for compressing static assets +# compress_assets_options = { +# 'method': 'gzip' # Or 'zopfli' or 'brotli' +# } + +# Add a copyright text on the image (default: '') +# copyright = "© An example copyright message" + +# Settings for encryption plugin +# encrypt_options = { +# 'password': 'password', +# 'ask_password': False +# } + +# Settings for upload to s3 plugin +# upload_s3_options = { +# 'bucket': 'my-bucket', +# 'policy': 'public-read', +# 'overwrite': False +# } + +# Set zip_gallery to either False or a file name. The file name can +# be formatted python style with an 'album' variable, for example +# '{album.name}.zip'. The final archive will contain all resized or +# original files (depending on `zip_media_format`). +# zip_gallery = False # False or 'archive.zip' +# zip_media_format = 'resized' # 'resized' or 'orig' +# zip_skip_if_exists = False # Skip archive generation if archive is +# already present. Warning: new photos in an album won't be added to archive + +# bgstack15 added +edit_cgi_script = "/cgi-bin/gallery/edit.cgi" # web path to edit.cgi +edit_enabled = True +edit_password = "headphones" +edit_string = '[edit]' # text of link to edit metadata +toggle_enable_string = "Enable editing" +toggle_disable_string = "Disable editing" +toggle_link = "/cgi-bin/gallery/toggle-editing.cgi" # web path to toggle-editing.cgi +toggle_editing = [ + (False, 'Enable editing'), + (True, 'Disable editing') + ] + +gallery_id = "bgstack15_images" + +# A list of links (tuples (title, URL)) +# links = [('Example link', 'http://example.org'), +# ('Another link', 'http://example.org')] +links = [ + ('Regenerate pages', '/cgi-bin/gallery/regen.cgi?id=' + gallery_id) + ] |