picinch

Logo

PicInch Gallery provides a simple way for a group of members, such as a photography club, to display their photographs.

Home

Installation and Setup

Docker Repository

View the Project on GitHub inchworks/picinch

configuration.yml

Configuration parameters may be specified in this file, or as environment variables. Settings here will be overridden by environment variables in docker-compose.yml. This an example configuration file with just the essential settings.

# Example configuration for PicInch Gallery server.
#  - Edit and rename to configuration.yml
#  - Take care to keep indentation unchanged when editing. Do not use tabs.

db-password: <server password>

# The following is needed for certificate registration with Let's Encrypt domains:
  - our-domain.com
  - www.our-domain.com

# Address to be notified of problems with certificates
certificate-email: you@example.com

# A random 32 character key used to encrypt users session data
# For example, start with this one and change a lot of the individual characters.
session-secret: Hk4TEiDgq8JaCNR?WaPeWBf4QQYNUjMR

# Administrator, to be added to the database
admin-name: admin@example.com
admin-password: <your-password>

Set the following items as needed. Default values are as shown.

Database

A database connection is requested with DSN db-user:db-password@db-source?parseTime=true . A MariaDB or MySQL database is required.

db-source tcp(picinch_db:3306)/picinch

db-user server

db-password <server-password>

Domains

domains List of domains for which Let’s Encrypt certificates will be requested on first access.

This is intended for testing and is not recommended for production.

certificate-email Address given to Let’s Encrypt, for notification of problems with certificates.

Session

session-secret A random 32 character key used to encrypt users session data.

Administrator

Specifies the username and password for an PicInch administrator if the username does not exist in the database. These items may be removed after setup if desired.

admin-name E.g. me@mydomain.com.

admin-password <your-password>

Maximum image sizes

Photos uploaded are resized to fit these dimensions.

image-width 1600 stored image width

image-height 1200 stored image height

thumbnail-width 278 thumbnail width

thumbnail-height 208 thumbnail height

max-upload 32 maximum image or video upload, in megabytes

Total limits

highlights-page 12 highlights shown on home page, and on user’s page

highlights-topic 32 total slides highlights slideshow

parent-highlights 16 highlights available for parent website

slideshows-page 16 slideshows shown on home page

Per-user limits

highlights-user 2 highlights shown on home page

slides-show 50 slides shown in a slideshow

slideshows-club 2 club slideshows on home page

slideshows-public 1 public slideshows on home page

Operational settings

allowed-queries fbclid ignored query names in URL. Other queries trigger an IP ban.

ban-bad-files false apply IP ban to requests for missing files.

geo-block ` ` blocked countries, specified by ISO 3166-1 alpha-2 codes. For example, KP, RU.

max-upload-age 8h time limit to save a slideshow update, after uploading images. Units m(inutes) or h(ours).

thumbnail-refresh 1h refresh interval for topic thumbnails. Units m(inutes) or h(ours).

usage-anon 1 anonymisation of user IDs: 0 = daily, 1 = immediate.

Website variants

Options to change the operation of the website. home-switch switches the home page to a specified template, for example, disabled to show disabled.page.tmpl when the website is offline.

misc-name misc path in URL for miscellaneous files, as in example.com/misc/file

video-snapshot 3s time within video for snapshot thumbnail. Units s(econds), -ve for no snapshots.

video-types ` ` acceptable video file types, such as .mp4, .mov.

For testing

http-addr :8000 site HTTP address

https-addr :4000 site HTTPS address