https://github.com/impworks/quickpix
A single-file photo gallery script.
https://github.com/impworks/quickpix
Last synced: over 1 year ago
JSON representation
A single-file photo gallery script.
- Host: GitHub
- URL: https://github.com/impworks/quickpix
- Owner: impworks
- License: mit
- Created: 2013-11-25T08:19:38.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T19:54:05.000Z (almost 8 years ago)
- Last Synced: 2025-02-05T11:17:20.473Z (over 1 year ago)
- Language: PHP
- Size: 23.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quickpix
========
Quickpix is a lightweight photogallery script written in PHP. It is designed to be simple and transparent, relying on the file system rather than a database.
Features:
* 1 single PHP script + htaccess file
* No database required
* Automatic preview and thumbnail generation
* Download entire folders as a single .zip file
* Configurable descriptions
* Hidden folders
### Requirements
* PHP 5.4+ with GD extension
* Apache with mod_rewrite (or IIS with URL Rewrite)
* Write access to directory folder
### Installation
* Copy the `index.php` and `.htaccess` / `web.config` files to the root of your web gallery (depending on your server).
* Make sure the folder has write access! Quickpix caches a lof of stuff.
* Update the `.htaccess` / `web.config` file with your gallery's relative path.
* Update the `index.php` file with your gallery's relative path as well, or set any other options (thoroughly commented).
* Create folders and upload pictures. That's it!
### How to work with it
Quickpix uses the file system as a single source of truth. You can think of it as Apache's `Options +Indexes` page on steroids that automatically creates thumbnails and previews for you.
When Quickpix comes across an unknown folder, it creates a `.info` file in it. It is a JSON file which you can edit in any text editor and specify titles and descriptions for some folders. Therefore, most of the manipulations are performed via the file system: adding or removing folders, files, and editing the `.info` files. If your local PC is a webserver, its even simplier!
If a folder does not update automatically, you can force the update by appending the "?update" to the folder path:
http://example.com/photos/your-folder/?update
To remove all cached thumbnails and the zipped folder, append "?clean":
http://example.com/photos/your-folder/?clean
### Hidden folders
By default, all existing subfolders are listed in the tree at the left side. If you wish to exclude a folder from the tree, add a `.hidden` file to it. The folder itself and its contents will not appear in the tree.
Please note that hidden folders are *available by direct links*. They are just not referenced anywhere in the gallery, but you are free to give direct links to whoever you deem worthy!
### Zip arhives
You can let viewers download entire folders as a single zip file. The `ALLOW_ZIP` setting in the `index.php` file must be set to true (and so it is by default).
Please note that zip files are cached and can take a considerable amount of disk space!