2018-12-04 05:38:25 +08:00
# PiGallery2
2020-01-03 05:28:18 +08:00
2020-01-03 05:11:59 +08:00
[](https://lgtm.com/projects/g/bpatrik/pigallery2/context:javascript)
2017-07-04 01:17:49 +08:00
[](https://travis-ci.org/bpatrik/pigallery2)
2020-01-03 05:28:18 +08:00
[](https://coveralls.io/github/bpatrik/pigallery2?branch=master)
2016-05-02 16:07:42 +08:00
[](https://pigallery2.herokuapp.com)
2019-12-24 06:17:05 +08:00
[](https://github.com/bpatrik/pigallery2/actions)
2018-11-30 22:36:42 +08:00
[](https://david-dm.org/bpatrik/pigallery2)
2020-01-03 05:28:18 +08:00
2018-12-06 20:50:55 +08:00
2018-12-04 05:38:25 +08:00
Homepage: http://bpatrik.github.io/pigallery2/
2017-03-23 02:38:39 +08:00
This is a directory-first photo gallery website, optimised for running on low resource servers (especially on raspberry pi)
2016-03-14 20:30:15 +08:00
2017-06-04 21:25:22 +08:00
## Live Demo
2019-01-03 04:22:03 +08:00
Live Demo @ heroku: https://pigallery2.herokuapp.com/
2018-12-03 05:30:49 +08:00
- the demo page **first load** might take up **30s** : the time while the free webservice boots up
2017-03-23 02:38:39 +08:00
2019-12-13 00:22:41 +08:00
2018-05-16 08:01:11 +08:00
## Table of contents
2020-01-02 05:25:45 +08:00
1. [Getting started ](#1-getting-started-also-works-on-raspberry-pi )
2018-12-22 07:29:05 +08:00
2. [Translate the page to your own language ](#2-translate-the-page-to-your-own-language )
3. [Feature list ](#3-feature-list )
2019-02-25 18:50:27 +08:00
4. [Suggest/endorse new features ](#4-suggestendorse-new-features )
2019-02-25 18:41:56 +08:00
5. [Known errors ](#5-known-errors )
6. [Credits ](#6-credits )
2016-03-14 20:30:15 +08:00
2017-03-23 02:38:39 +08:00
2018-05-16 08:01:11 +08:00
2019-12-24 04:07:34 +08:00
## 1. Getting started (also works on Raspberry Pi)
2020-01-02 05:25:45 +08:00
### 1.1 Install and Run with Docker (recommended)
[Docker ](https://www.docker.com/ ) with [docker-compose ](https://docs.docker.com/compose/ ) is the offitial and recommend way of installing and running *Pigallery2* .
It contains all necessary dependencies, auto restarts on reboot, supports https, easy to upgrade to newer versions.
2019-12-24 04:07:34 +08:00
For configuration and docker-compose files read more [here ](docker/README.md ) or check all builds: https://hub.docker.com/r/bpatrik/pigallery2/tags/
2020-01-02 05:25:45 +08:00
### 1.2 Direct Install (if you are familiar with nodejs and building npm packages from source)
2019-12-29 17:45:01 +08:00
As an alternative, you can also directly install nodejs and the app and run it natively.
2019-12-24 04:07:34 +08:00
### 1.2.0 [Install NodeJs](https://nodejs.org/en/download/)
2017-06-04 21:25:22 +08:00
Download and extract
```bash
2019-12-24 04:07:34 +08:00
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
2018-12-03 05:15:39 +08:00
sudo apt-get install -y nodejs
2017-06-04 21:25:22 +08:00
```
2018-12-03 05:15:39 +08:00
2018-12-06 16:52:04 +08:00
Full node install on raspberry pi description: https://www.w3schools.com/nodejs/nodejs_raspberrypi.asp
2017-06-04 21:25:22 +08:00
2019-12-24 04:07:34 +08:00
### 1.2.1 Install PiGallery2
#### 1.2.1-a Install from release
2017-07-13 00:35:23 +08:00
2017-06-04 21:25:22 +08:00
```bash
cd ~
2019-12-31 04:49:50 +08:00
wget https://github.com/bpatrik/pigallery2/releases/download/1.8.0/pigallery2.zip
2019-01-27 04:00:01 +08:00
unzip pigallery2.zip -d pigallery2
2018-05-16 08:01:11 +08:00
cd pigallery2
2017-07-13 00:35:23 +08:00
npm install
```
2019-12-24 04:07:34 +08:00
#### 1.2.1-b Install from source
2020-01-02 04:18:35 +08:00
**Note:** A build requires a machine with around 2GB or memory.
2020-01-02 05:25:45 +08:00
2017-07-13 00:35:23 +08:00
```bash
cd ~
wget https://github.com/bpatrik/pigallery2/archive/master.zip
unzip master.zip
2018-05-16 08:01:11 +08:00
cd pigallery2-master # enter the unzipped directory
2017-06-04 21:25:22 +08:00
npm install
2020-01-02 01:29:44 +08:00
npm run build
2017-06-04 21:25:22 +08:00
```
2020-01-02 05:25:45 +08:00
**Note**: It is recommended to create a release version with `npm run create-release` on a more powerful mashine and deploy that to you server.
**Note**: you can use `npm run create-release -- --languages=fr,ro` to restrict building to the listed languages (english is added by default)
2017-07-13 00:35:23 +08:00
2019-12-24 04:07:34 +08:00
#### 1.2.2 Run PiGallery2
2017-06-04 21:25:22 +08:00
```bash
npm start
```
2018-12-06 04:55:11 +08:00
To configure it, run `PiGallery2` first to create `config.json` file, then edit it and restart.
The app has a nice UI for settings, you may use that too.
2017-07-26 05:39:50 +08:00
Default user: `admin` pass: `admin`
2017-06-04 21:25:22 +08:00
2019-12-29 19:09:08 +08:00
**Note**: First run, you might have file access issues and port 80 issue, see [#115 ](https://github.com/bpatrik/pigallery2/issues/115 ).
2019-12-29 17:45:01 +08:00
Running `npm start -- --Server-port=8080` will start the app on port 8080 that does not require `root`
Adding read/write permissions to all files can solve the file access issue `chmod -R o-w .` , see [#98 ](https://github.com/bpatrik/pigallery2/issues/98 ).
2018-12-06 20:50:55 +08:00
### 1.3 Advanced configuration
You can set up the app the following ways:
* Using the UI
* Manually editing the `config.json`
* Through switches
2019-12-12 18:04:20 +08:00
* Like: `node start -- --Server-port=3000 --Client-authenticationRequired=false`
2018-12-06 20:50:55 +08:00
* You can check the generated `config.json` for the config hierarchy
* Through environmental variable
* like set env. variable `Server-port` to `3000`
2020-02-07 20:59:36 +08:00
Full list of configuration options are available at the [MANPAGE.md ](MANPAGE.md ).
2018-12-06 20:50:55 +08:00
### 1.4 Useful links/tips:
2018-05-16 08:01:11 +08:00
#### using nginx
2018-12-06 20:50:55 +08:00
It is recommended to use a reverse proxy like nginx before node
2017-07-30 05:39:06 +08:00
https://stackoverflow.com/questions/5009324/node-js-nginx-what-now
2017-10-20 00:08:07 +08:00
2018-05-16 08:01:11 +08:00
#### making https
2018-12-06 20:50:55 +08:00
With cerbot & nginx it is simple to set up secure connection. You have no excuse not doing so.
2017-07-30 05:39:06 +08:00
https://certbot.eff.org/
2018-05-16 08:01:11 +08:00
#### node install error:
2017-10-20 00:08:07 +08:00
If you get error during module installation, make sure you have everything to build node modules from source
```bash
apt-get install build-essential libkrb5-dev gcc g++
```
2018-12-06 16:52:04 +08:00
## 2. Translate the page to your own language
2018-12-22 07:29:05 +08:00
1. [Install Pigallery2 ](#111-b-install-from-source ) from source (with the release it won't work)
2018-05-16 08:01:11 +08:00
2. add your language e.g: fr
```bash
npm run add-translation -- --fr
```
2019-12-12 18:04:20 +08:00
it creates a new `messages.fr.xls` file at `src/frontend/translate` folder,
2018-05-16 08:01:11 +08:00
it will already contain dummy translation with google translate.
3. 'fix' the dummy translation
4. test if it works:
build and start the app
```bash
npm install
2020-01-02 05:28:09 +08:00
npm run build
2018-05-16 08:01:11 +08:00
npm start
```
2018-12-22 07:20:03 +08:00
5. (optional) create a pull request at github to add your translation to the project.
2020-01-02 05:28:09 +08:00
**Note**: you can also build your own release with as described in [1.1.1-b Install from source ](#121-b-install-from-source );
2018-05-16 08:01:11 +08:00
2018-12-06 16:52:04 +08:00
## 3. Feature list
2017-06-04 21:25:22 +08:00
2020-01-02 05:25:45 +08:00
* supported formats [full list here ](https://github.com/bpatrik/pigallery2/blob/master/src/common/SupportedFormats.ts ):
2019-01-13 01:08:34 +08:00
* images: **jpg, jpeg, jpe, webp, png, gif, svg**
* videos: **mp4, ogg, ogv, webm**
2020-01-02 05:25:45 +08:00
* with (built-in) transcoding: avi, mkv, mov, wmv, flv, mts, m2ts, mpg, 3gp, m4v, mpeg, vob, divx, xvid, ts
2017-03-23 02:38:39 +08:00
* **Rendering directories as it is**
* Listing subdirectories recursively
* Listing photos in a nice grid layout
* showing **tag/keywords, locations, GPS coordinates** for photos
* rendering photos on demand (on scroll)
2017-03-23 02:41:32 +08:00
* **On the fly thumbnail generation** in several sizes
2017-03-23 02:38:39 +08:00
* prioritizes thumbnail generation (generating thumbnail first for the visible photos)
* saving generated thumbnails to TEMP folder for reuse
2018-12-06 04:55:11 +08:00
* supporting multi-core CPUs
2020-01-02 05:28:09 +08:00
* supporting hardware acceleration ([sharp](https://github.com/lovell/sharp))
2018-12-13 04:03:06 +08:00
* Custom lightbox for full screen photo and video viewing
2017-07-09 18:03:17 +08:00
* keyboard support for navigation
2017-03-23 02:38:39 +08:00
* showing low-res thumbnail while full image loads
2017-07-10 04:00:42 +08:00
* Information panel for showing **Exif info**
2017-07-12 04:23:07 +08:00
* Automatic playing
2017-07-18 00:30:16 +08:00
* gesture support (swipe left, right, up)
2018-12-13 04:03:06 +08:00
* shortcut support
2020-01-02 05:25:45 +08:00
* On the fly photo downscaling for faster load [#50 ](https://github.com/bpatrik/pigallery2/issues/50 )
* on zoom, the original photo loads
2017-03-23 02:41:32 +08:00
* Client side caching (directories and search results)
2018-12-13 04:03:06 +08:00
* Rendering **photos** with GPS coordinates **on open street maps**
* .gpx file support: rendering paths to map
* supports [OSM ](https://www.openstreetmap.org ) and [Mapbox ](https://www.mapbox.com ) by default, but you can add any provider that has a tile url
2017-03-23 02:41:32 +08:00
* **Two modes: SQL database and no-database mode**
* both modes supports
* user management
* password protection can be disabled/enabled
2017-03-23 02:38:39 +08:00
* database mode supports:
* faster directory listing
* searching
* instant search, auto complete
2017-07-09 18:03:17 +08:00
* sharing
2017-03-23 02:38:39 +08:00
* setting link expiration time
2019-07-21 23:00:07 +08:00
* Faces (persons) support
* reads Adobe's XMP Face region metadata. (It is defined by the Metadata Working Group (MWG).)
* shows face bounding box over images
2018-03-30 08:30:23 +08:00
* internalization / translation support
2020-01-02 05:25:45 +08:00
* currently supported languages: eng, hun, ro, ru, fr
2017-07-30 05:39:06 +08:00
* Nice design
2017-03-23 02:38:39 +08:00
* responsive design (phone, tablet desktop support)
2017-07-30 05:39:06 +08:00
* Setup page
2018-11-02 17:51:36 +08:00
* Random photo url
* You can generate an url that returns a random photo from your gallery. You can use this feature to develop 3rd party applications, like: changing desktop background
2020-01-02 05:25:45 +08:00
* duplicate photo detection
2018-11-23 02:12:10 +08:00
* video support
2020-01-02 05:25:45 +08:00
* fully supports `*.mp4` files and partially (might have errors with safari and IE) supports `*.ogg` , `*.ogv` , `*.webm` files
2018-11-25 22:22:07 +08:00
* uses ffmpeg and ffprobe to generate video thumbnails
2020-01-02 05:25:45 +08:00
* can transcode videos to mp4 for better support
* job sceduling support, with the following supported task: [#92 ](https://github.com/bpatrik/pigallery2/issues/92 )
* converting/transcoding videos [#66 ](https://github.com/bpatrik/pigallery2/issues/66 ) [#71 ](https://github.com/bpatrik/pigallery2/issues/71 )
* generating thumbnails
* generating converted photos
* cleaning up temp folder
* indexing db
* folder ignoring [#87 ](https://github.com/bpatrik/pigallery2/issues/87 )
2018-12-06 16:52:04 +08:00
* Dockerized
2017-07-09 18:03:17 +08:00
* **Markdown based blogging support** - `future plan`
2017-03-23 02:41:32 +08:00
* you can write some note in the blog.md for every directory
2017-03-23 02:38:39 +08:00
* bug free :) - `In progress`
2019-02-25 18:41:56 +08:00
2019-02-25 18:49:37 +08:00
## 4. Suggest/endorse new features
You are welcome to suggest new features to the application via [github issues ](https://github.com/bpatrik/pigallery2/issues ).
2019-02-25 18:41:56 +08:00
I cannot garantie any dealine with the development of a new feature. (I usually fix bugs within week/weeks.)
I will give a higher priority to a feature that has more 'likes' (i.e.: `+1` -s or thumbs ups) on it.
2018-03-30 08:30:23 +08:00
2019-02-25 18:41:56 +08:00
## 5. Known errors
2018-11-02 17:51:36 +08:00
* EXIF orientation tag:
* There is no nice way to handle EXIF orientation tag properly.
The page handles these photos, but might cause same error in the user experience (e.g.: the pages loads those photos slower. See issue [#11 ](https://github.com/bpatrik/pigallery2/issues/11 ))
2018-12-03 03:57:16 +08:00
* Video support on weak servers (like raspberry pi) with low upload rate
2020-01-02 05:25:45 +08:00
* video playback may use up too much resources and the server might not response for a while. Enable video transcoding in the app, to transcode the videos to lover bitrate.
2019-02-25 18:41:56 +08:00
## 6. Credits
2018-05-16 08:01:11 +08:00
Crossbrowser testing sponsored by [Browser Stack ](https://www.browserstack.com )
[<img src="https://camo.githubusercontent.com/a7b268f2785656ab3ca7b1cbb1633ee5affceb8f/68747470733a2f2f64677a6f7139623561736a67312e636c6f756466726f6e742e6e65742f70726f64756374696f6e2f696d616765732f6c61796f75742f6c6f676f2d6865616465722e706e67" alt="Browser Stack" height="31px" style="background: cornflowerblue;"> ](https://www.browserstack.com )
2018-03-30 08:30:23 +08:00
