Homepage: http://bpatrik.github.io/pigallery2/
This is a fast (like faster than your PC fast) directory-first photo gallery website, optimised for running on low resource servers (especially on raspberry pi).
✔️ Strengths:
- ⚡ Fast, like for real.
- ✔️ Simple. Point to your photos folder and to a temp folder and you are good to go.
⛔ Weakness:
- 😥 Its simple. Shows what you have that's it. No gallery changes (photo delete, rotate, enhance, tag, organize, etc), your gallery folder is read-only.
- 📁 Optimized for galleries with <100K photos with <5k photos/folder.
- It will work on bigger galleries, but it will start to slow down.
Live Demo @ render: https://pigallery2.onrender.com/
- the demo page first load might take up 30s: the time while the free webservice boots up
- Getting started
- Translate the page to your own language
- Feature list
- Suggest/endorse new features
- Known errors
- Credits
Docker with docker-compose is the official 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. For configuration and docker-compose files read more here or check all builds here.
As an alternative, you can also directly install Node.js and the app and run it natively.
1.2.0 Install Node.js
Download and extract
curl -sL https://deb.nodesource.com/setup_12.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.9.0/pigallery2-release.zip
unzip pigallery2-release.zip -d pigallery2
cd pigallery2
npm install
Note: A build requires a machine with around 2GB or memory.
cd ~
wget https://github.com/bpatrik/pigallery2/archive/master.zip
unzip master.zip
cd pigallery2-master # enter the unzipped directory
npm install
npm run build
Note: It is recommended to create a release version with npm run create-release
on a more powerful machine 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)
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
. (It is not possible to change the admin password, you need to create another user and delete the default admin
user, see #220)
Note: First run, you might have file access issues and port 80 issue, see #115.
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.
You can run the app up as a service to run it on startup. Read more at #42
You can set up the app any of the following ways:
- Using the UI (recommended)
- Manually editing the
config.json
- Through switches
- Like:
node start -- --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
Full list of configuration options are available at the MANPAGE.md.
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
- Install Pigallery2 from source (with the release it won't work)
- add your language e.g: fr
- copy
src/frontend/translate/messages.en.xls
tosrc/frontend/translate/messages.fr.xls
- add the new translation to the
angular.json
projects->pigallery2->i18n->locales
section
- copy
- translate the file by updating the
<target>
tags - test if it works:
build and start the app
npm install npm run build npm start
- (optional) create a pull request at github to add your translation to the project.
Note: you can also build your own release with as described in 1.1.1-b Install from source;
- supported formats full list here:
- images: jpg, jpeg, jpe, webp, png, gif, svg
- videos: mp4, ogg, ogv, webm
- with (built-in) transcoding: avi, mkv, mov, wmv, flv, mts, m2ts, mpg, 3gp, m4v, mpeg, vob, divx, xvid, ts
- 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)
- On the fly thumbnail generation in several sizes
- prioritizes thumbnail generation (generating thumbnail first for the visible photos)
- saving generated thumbnails to TEMP folder for reuse
- supporting multi-core CPUs
- supporting hardware acceleration (sharp)
- 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 and IPTC info
- Automatic playing
- gesture support (swipe left, right, up)
- shortcut support
- On the fly photo downscaling for faster load #50
- on zoom, the original photo loads
- 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 support
- 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 support
- 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
- internalization / translation support
- currently supported languages: eng, hun, ro, ru, fr, many other
- 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
- duplicate photo detection
- 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
- can transcode videos to mp4 for better support
- fully supports
- job scheduling support, with the following supported task: #92
- folder ignoring #87
.pg2conf
UI modifying files. #177.- List of these files are passed down to the UI modify its behaviour.
- Currently, supported custom, per folder sorting.
- Dockerized
- Markdown based blogging support
- you can write some note in the *.md files for every directory
- bug free :) -
In progress
Unfortunately, lately I only have a limited time for this hobby project of mine.
So, I mostly focus on those features that are align with my needs. Sorry :(.
Although, I try to fix bugs ASAP (that can still take from a few days to months).
I also try to implement some feature requests that have a lots of 'likes' (i.e.: 1
-s or thumbs ups) on it.
If you have a feature that you really would like to happen, I welcome contributions to the app. See CONTRIBUTING.md for more details.
- IOS map issue
- Map on IOS prevents using the buttons in the image preview navigation, see #155
- 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 respond for a while. Enable video transcoding in the app, to transcode the videos to lover bitrate.
I'm making this app for my own entertainment, but I like to share it with others as the contributions and bug reports make the app better and it also does not cost anything to me :)
There is no way to donate to this project at the moment. And I'm also not planning on monetizing it. But it warms my hearth seeing that it is useful for some people.
Crossbrowser testing sponsored by Browser Stack