mirror of
https://github.com/bpatrik/pigallery2.git
synced 2024-12-14 11:23:17 +02:00
100 lines
3.8 KiB
Markdown
100 lines
3.8 KiB
Markdown
# PiGallery2
|
|
[](https://badge.fury.io/js/pigallery2)
|
|
[](https://travis-ci.org/bpatrik/pigallery2)
|
|
[](https://coveralls.io/github/bpatrik/PiGallery2?branch=master)
|
|
[](https://pigallery2.herokuapp.com)
|
|
[](https://codeclimate.com/github/bpatrik/pigallery2)
|
|
[](https://david-dm.org/bpatrik/pigallery2)
|
|
[](https://david-dm.org/bpatrik/pigallery2#info=devDependencies)
|
|
|
|
This is a directory-first photo gallery website, optimised for running on low resource servers (especially on raspberry pi)
|
|
|
|
## Live Demo
|
|
Live Demo @ heroku: https://pigallery2.herokuapp.com/
|
|
|
|
|
|
|
|
## Install (on Raspberry Pi 1)
|
|
### Install NodeJs
|
|
Download and extract
|
|
```bash
|
|
cd ~
|
|
wget https://nodejs.org/dist/v6.10.3/node-v6.10.3-linux-armv6l.tar.gz
|
|
tar -xzf node-v6.10.3-linux-armv6l.tar.gz
|
|
```
|
|
Copy it to /usr/local:
|
|
```bash
|
|
cd node-v6.10.3-linux-armv6l/
|
|
sudo cp -R * /usr/local/
|
|
```
|
|
Add to path. Add the following line to `~/.bashrc`
|
|
```bash
|
|
PATH=$PATH:/usr/local/bin
|
|
```
|
|
Full node install description: https://raspberrypi.stackexchange.com/questions/48303/install-nodejs-for-all-raspberry-pi
|
|
|
|
### Install PiGallery2
|
|
#### Install from release
|
|
|
|
```bash
|
|
cd ~
|
|
wget https://github.com/bpatrik/pigallery2/releases/download/1.0.0-beta.3/pigallery2.zip
|
|
unzip pigallery2
|
|
cd pigallery2
|
|
npm install
|
|
```
|
|
#### Install from source
|
|
```bash
|
|
cd ~
|
|
wget https://github.com/bpatrik/pigallery2/archive/master.zip
|
|
unzip master.zip
|
|
cd pigallery2 # enter the unzipped directory
|
|
npm install
|
|
npm run build #explicitly building the project (releases are prebuilt)
|
|
```
|
|
|
|
### Run PiGallery2
|
|
```bash
|
|
npm start
|
|
```
|
|
To configure it. Run `PiGallery2` first to create `config.json` file, then edit it and restart.
|
|
|
|
|
|
## Feature list
|
|
|
|
* **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
|
|
* prioritizes thumbnail generation (generating thumbnail first for the visible photos)
|
|
* saving generated thumbnails to TEMP folder for reuse
|
|
* supporting several core CPU
|
|
* supporting hardware acceleration ([sharp](https://github.com/lovell/sharp) and [gm](https://github.com/aheckmann/gm) as optional and JS-based [Jimp](https://github.com/oliver-moran/jimp) as fallback)
|
|
* Custom lightbox for full screen photo viewing
|
|
* keyboard support for navigation
|
|
* showing low-res thumbnail while full image loads
|
|
* Information panel for showing **Exif info**
|
|
* Automatic playing
|
|
* Client side caching (directories and search results)
|
|
* Rendering **photos** with GPS coordinates **on google map**
|
|
* .gpx file support - `future plan`
|
|
* **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
|
|
* Nice design - `In progress`
|
|
* responsive design (phone, tablet desktop support)
|
|
* Setup page - `In progress`
|
|
* **Markdown based blogging support** - `future plan`
|
|
* you can write some note in the blog.md for every directory
|
|
* bug free :) - `In progress`
|