# PiGallery2
![GitHub package.json version](https://img.shields.io/github/package-json/v/bpatrik/pigallery2)
[![Coverage Status](https://coveralls.io/repos/github/bpatrik/pigallery2/badge.svg?branch=master)](https://coveralls.io/github/bpatrik/pigallery2?branch=master)
[![Docker build](https://github.com/bpatrik/pigallery2/workflows/docker-buildx/badge.svg)](https://github.com/bpatrik/pigallery2/actions)

PiGallery2 is a **fast** directory-first photo gallery website, optimized for running on low-resource servers (especially on Raspberry Pi).

## 🚀 Key Features
- **⚡ Fast**: Optimized for low-end hardware.
- **✔️ Simple**: Point to your photos and you are ready.
- **📁 Directory-first**: Shows your folder structure as it is.
- **Read-only**: Your photo folder is never modified.

[Full documentation here](http://bpatrik.github.io/pigallery2/).

[Try our live demo!](https://pigallery2.onrender.com/) (First load may take up to 60s while the server boots up)

## 🏁 Getting Started
The official and recommended way to run PiGallery2 is using **Docker**.

### [Install with Docker (Recommended)](https://bpatrik.github.io/pigallery2/setup/docker)


### [Native Installation (Unsupported)](https://bpatrik.github.io/pigallery2/setup/direct-install)
Native installation is possible for users familiar with Node.js but is not officially supported.

## 📖 Documentation
For more detailed information, please see our [Documentation Website](http://bpatrik.github.io/pigallery2) or the `docs/` folder:
- [FAQ (Frequently Asked Questions)](https://bpatrik.github.io/pigallery2/faq)
- [Configuration Guide](https://bpatrik.github.io/pigallery2/user-guide/configuration)
- [User Rights](https://bpatrik.github.io/pigallery2/user-guide/user-rights)
- [Contribution Guide](https://bpatrik.github.io/pigallery2/development/contributing)

## 🤝 Contributing
Contributions are welcome! Please read our [Contribution Guide](https://bpatrik.github.io/pigallery2/development/contributing) to get started.

## ⭐ Star History
[![Star History Chart](https://api.star-history.com/svg?repos=bpatrik/pigallery2&type=date&legend=top-left)](https://www.star-history.com/#bpatrik/pigallery2&type=date&legend=top-left)

## 📜 License
PiGallery2 is licensed under the MIT License.