Homepage: http://bpatrik.github.io/pigallery2/
This is a directory-first photo gallery website, optimised for running on low resource servers (especially on raspberry pi)
Live Demo @ heroku: https://pigallery2.herokuapp.com/
- the demo page first load might take up 30s: the time while the free webservice boots up
1.1.0 Install NodeJs
Download and extract
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
Full node install on raspberry pi description: https://www.w3schools.com/nodejs/nodejs_raspberrypi.asp
cd ~
wget https://github.com/bpatrik/pigallery2/releases/download/1.5.5/pigallery2.zip
unzip pigallery2.zip
cd pigallery2
npm install
cd ~
wget https://github.com/bpatrik/pigallery2/archive/master.zip
unzip master.zip
cd pigallery2-master # enter the unzipped directory
npm install
Note: if you run npm run build-release
, it creates a clean, minified, production ready version from the app in the release
folder, that is ready to deploy.
npm start
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.
Default user: admin
pass: admin
If you have docker
and don't want to install all the dependencies, use this:
docker run \
-p 80:80 \
-e NODE_ENV=production \
-v <path to your config file folder>/config.json:/pigallery2-release/config.json \
-v <path to your images folder>:/pigallery2-release/demo/images \
-v <path to your temp folder>:/pigallery2-release/demo/TEMP \
bpatrik/pigallery2:1.5.5-stretch
Make sure that a file at <path to your config file folder>/config.json
exists before running it.
After the container is up and running, you go to http://localhost
and log in with user: admin
pass: admin
and set up the page in the settings.
All docker builds: https://hub.docker.com/r/bpatrik/pigallery2/tags/
Note: You dont need to do the installation steps if you are using docker.
You can set up the app the following ways:
- Using the UI
- Manually editing the
config.json
- Through switches
- Like:
node backend/index.js --Server-port=3000 --Client-authenticationRequired=false
- You can check the generated
config.json
for the config hierarchy
- Like:
- Through environmental variable
- like set env. variable
Server-port
to3000
- like set env. variable
It is recommended to use a reverse proxy like nginx before node https://stackoverflow.com/questions/5009324/node-js-nginx-what-now
With cerbot & nginx it is simple to set up secure connection. You have no excuse not doing so. https://certbot.eff.org/
If you get error during module installation, make sure you have everything to build node modules from source
apt-get install build-essential libkrb5-dev gcc g++
- download / clone the repo (the source not the packed release!)
- add your language e.g: fr
it creates a new
npm run add-translation -- --fr
messages.fr.xls
file atfrontend/translate
folder, it will already contain dummy translation with google translate. - 'fix' the dummy translation
- test if it works:
build and start the app
npm install npm start
- create a pull request at github to add your translation to the project.
- Rendering directories as it is
- Listing subdirectories recursively
- Listing photos in a nice grid layout
- supporting most common image formats
- showing tag/keywords, locations, GPS coordinates for photos
- rendering photos on demand (on scroll)
- On the fly thumbnail generation in several sizes
- Custom lightbox for full screen photo and video viewing
- keyboard support for navigation
- showing low-res thumbnail while full image loads
- Information panel for showing Exif info
- Automatic playing
- gesture support (swipe left, right, up)
- shortcut support
- Client side caching (directories and search results)
- Rendering photos with GPS coordinates on open street maps
- Two modes: SQL database and no-database mode
- both modes supports
- user management
- password protection can be disabled/enabled
- database mode supports:
- faster directory listing
- searching
- instant search, auto complete
- sharing
- setting link expiration time
- both modes supports
- internalization / translation support
- currently supported languages: eng, hun
- Nice design
- responsive design (phone, tablet desktop support)
- Setup page
- 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
- video support
- fully supports *.mp4 files and partially (might have errors with safari and IE) supports *.ogg, *.ogv, *.webm files
- uses ffmpeg and ffprobe to generate video thumbnails
- Dockerized
- Markdown based blogging support -
future plan
- you can write some note in the blog.md for every directory
- bug free :) -
In progress
- 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)
- Video support on weak servers (like raspberry pi) with low upload rate
- video playback may use up too much resources and the server might not response for a while. A solution might be to down scale / convert the video files to lower bitrate.
Crossbrowser testing sponsored by Browser Stack