Configuration
=============
Files organisation
The files organisation is quite simple:
* in the root directory of your project you need a settings.yaml file that will contains the title and subtitle of your gallery
* for each gallery you'll need a folder that also contains a settings.yaml file that will describe how to display the content on your gallery
* and you put the pictures of the gallery inside the gallery folder
* or other directory, in the gallery became an index (so pictures won't be display, only cover of child gallery)
Root settings.yaml
------------------
The root settings.yaml should contains 2 keys: one for the title of your website and one for the subtitle. It should looks like that::
title: My exploration of the outside world
sub_title: it's a scary place, don't go there
It can also optionally contain a menu and global settings.`
Menu
____
It is possible to add a menu to your homepage that links to static pages. To do so, add a `menu` key to your `settings.yaml`, for example::
menu:
- about: "About"
- first_gallery: "My first gallery"
- http://twitter.com: "Twitter"
For example, this could be the content of `settings.yaml` in `about` folder::
title: "About"
static: true
public: false
sections:
- type: text
text: Some text, HTML is allowed.
You can use the `static` option to get a template closer to the one of the
homepage that is better suited for a static page. You'll need to specify
"public: false" if you don't want to list this page on the homepage. On
case you didn't specified "public: false" you'll **need** to specify a "cover:"
entry like any other gallery.
**NOTE**: expect the "static: " option to disappear quite soon for a more
generic approach to "choose your page style".
Global settings
_______________
Global settings can be set in your root `settings.yaml`, under the `settings` key.
GM
~~
Currently a `gm` settings key allows to customize the default GraphicsMagick's behavior. It looks like ::
settings:
gm:
quality: 75
auto-orient: True
strip: True
resize: 50%
progressive: True
The meaning of the currently supported GraphicsMagick's settings is as follows:
* `quality` allows to customize the compression level of thumbnails (between 0 and 100)
* `auto-orient` change the orientation of pictures so they are upright (based on corresponding EXIF tags if present)
* `strip` removes all profiles and text attributes from the image (good for privacy, slightly reduce file size)
* `resize` can be used to resize the fullsize version of pictures. by default, input image size is preserved
* `progressive` converts classic baseline JPEG files to progressive JPEG, and interlace PNG/GIF files (improve the page loading impression, slightly reduce file size)
Any GraphicsMagick setting can be customized on a per-image basis (either `cover` or `image`, see below).
Video convertor
~~~~~~~~~~~~~~~
Prosopopée can use ffmpeg or libav and if you want you can customize the settings::
settings:
ffmpeg:
binary: "ffmpeg",
loglevel: "error",
format: "webm",
resolution: "1280x720",
vbitrate: "3900k",
abitrate: "100k",
audio: "libvorbis",
video: "libvpx",
other: "-qmin 10 -qmax 42 -maxrate 500k -bufsize 1500k"
The meaning of the currently supported FFMEG or LIBAV's settings is as follows :
* `binary` the binary you will use for convert the video (ffmpeg or avconv)
* `loglevel` Set the logging level used by the library
* `format` Force input or output file format
* `resolution` Set frame size
* `vbitrate` Set video bitrate
* `abitrate` Set audio bitrate
* `audio` Set the audio codec
* `video` Set the video codec
* `other` Set different options if you need more
Light Mode
~~~~~~~~~~
For enabled the light mode::
settings:
light_mode: true
With this option Prospopee make a sub directory with light version of your gallery.
This light gallery use less JS, picture in low size etc..
For access to this light gallery, add /light in the url of the gallery.
If you want only light theme you can see below.
Themes
~~~~~~
Prosopopée has a support for various themes. As for now, only 3 themes are available:
* the default one called "exposure"
* "material" based on materialcss
* light
To specify the theme, add the "theme" key in your "settings" key or your
**root** settings.yaml. For example::
title: My exploration of the outside world
sub_title: it's a scary place, don't go there
settings:
theme: material
Light mode
~~~~~~~~~~
Prosopopée has a support light mode, for all gallery you need add /light on the url.
When this mode is enable Prosopopée build the gallery with light theme (no Js and pics size is 800px)::
settings:
light_mode: true
Licence
~~~~~~~
By default Prosopopée use CC-BY-SA for all the content, if you want use a another licence
you need add key in **root** settings.yaml. For example::
licence:
name: WTFPL
url: "http://www.wtfpl.net/txt/copying/"
Share
~~~~~
If you want enable the share content on social network, add key in **root** settings.yaml. For example:
By defaut you can share on facebook, twitter, pinterest, google+::
share: true
url: "http://prosopopee.com"
RSS
~~~
For activate the RSS you need add this key in **root** settings.yaml::
rss: true
url: "http://prosopopee.com"
Open Graph Meta
~~~~~~~~~~~~~~~
For activate the Open Graph Meta you need add this key in **root** settings.yaml::
og: true
Optionnal: You need use description and lang key in settings gallery.
for more informations about Open Graph http://ogp.me/
Gallery settings.yaml
---------------------
This settings.yaml will describe:
* the title, subtitle and cover picture of your gallery that will be used on the homepage
* the tags is optional
* if your gallery is public (if not, it will still be built but won't appear on the homepage)
* the date of your gallery: this will be used on the homepage since **galleries are sorted anti chronologically** on it
* the list of sections that will contains your gallery. A section will represent either one picture, a group of pictures or text. The different kind of sections will be explained in the next README section.
Example
_______
::
title: Gallery title
sub_title: Gallery sub-title
date: 2016-01-15
cover: my_cover_picture.jpg
description: Some text
lang: en_US
tags:
- #yolo
- #travel
sections:
- type: full-picture
image: big_picture.jpg
text:
title: Big picture title
sub_title: Some text
date: 2016-01-15
- type: pictures-group
images:
-
- image1.jpg
- image2.jpg
- image3.jpg
-
- image4.jpg
- image5.jpg
- type: text
text: Some text, HTML is allowed.
- type: bordered-picture
image: another_picture.jpg
And here is an example of a **private** gallery (notice the ``public`` keyword)::
title: Gallery title
sub_title: Gallery sub-title
date: 2016-01-15
cover: my_cover_picture.jpg
public: false
sections:
- ...
Advanced settings
-----------------
Images handling
_______________
Images go into the `cover` or `image` keys.
Each image individual processing settings can be customized to override the default
GraphicsMagick settings defined (or not) in the root `settings.yaml`.
This is done by putting the image path into a `name` key,
and adding specific processing settings afterwards.
For example, you can replace::
image: image1.jpg
by::
image:
name: image1.jpg
quality: 90
strip: False
auto-orient: False