Skip to content

Latest commit

 

History

History
211 lines (151 loc) · 8.66 KB

README.md

File metadata and controls

211 lines (151 loc) · 8.66 KB
Raw

Gallery+

Build Status Scrutinizer Code Quality Codacy Badge Code Climate SensioLabsInsight

A media gallery for ownCloud which includes previews for all media types supported by your ownCloud installation.

Provides a dedicated view of all images in a grid, adds image viewing capabilities to the files app and adds a gallery view to public links.

This branch brings new features and bug fixes from the master branch of owncloud/gallery to ownCloud 8.0.x

Screenshot

Featuring

  • Support for large selection of media types (depending on ownCloud setup)
  • Large, zoomable previews which can be shown in fullscreen mode
  • Sort images by name or date added
  • Per album description and copyright statement
  • A la carte features (external shares, native svg, etc.)
  • Image download straight from the slideshow or the gallery
  • Seamlessly jump between the gallery and the files view
  • Ignore folders containing a ".nomedia" file
  • Native SVG support (disabled by default)
  • Mobile support

Checkout the full changelog for more.

Maintainers

Current

Alumni

Contributors

Requirements

Browser compatibility

This list is based on the current knowledge of the maintainers and the help they can get. It will evolve if and when people provide patches to fix all known current issues

Fully supported

  • Desktop: Firefox, Chrome
  • Mobile: Safari, Chrome on Android 5+ and iOS 8.x, BlackBerry 10, Firefox

Partially supported

May not look as nice, but should work

  • Desktop: Internet Explorer 9-11, Edge
  • Mobile: Opera, Chrome on Android 4

Not supported

  • Desktop: Internet Explorer prior to 9, Safari, Opera
  • Mobile: Windows Phone

Server requirements

Required

Recommended

  • FreeBSD or Linux server
  • PHP 5.5 with caching enabled
  • EXIF PHP module
  • A recent version ImageMagick with SVG and Raw support
  • MySQL or MariaDB instead of Sqlite
  • A powerful server with lots of RAM

Supporting the development

There are many ways in which you can help make Gallery a better product

  • Report bugs (see below)
  • Provide patches for both owncloud/core and the app
  • Help test new features by checking out new branches on Github
  • Design interface components for new features
  • Develop new features. Please consult with the maintainers before starting your journey
  • Fund a feature, either via BountySource or by directly hiring a maintainer or anybody else who is capable of developing and maintaining it

Bugs

Before reporting bugs

  • Read the section about server and browser requirements
  • Make sure you've disabled the original Pictures app
  • Read the "Known issues" section below
  • Get the latest version of the app from the releases page
  • Check if they have already been reported in Gallery and Gallery+

Known issues

Within deep folders

  • It may take longer to initialise the view as we're parsing every parent folder to look for configuration files

Configurations

  • If you have write access on a share belonging to another ownCloud instance, editing the configuration file in your folder will also modify the original folder

When reporting bugs

  • Enable debug mode by putting this at the bottom of config/config.php
DEFINE('DEBUG', true);
  • Turn on debug level debug by adding loglevel" => 0, to your config/config.php and reproduce the problem
  • Check data/owncloud.log

Please provide the following details so that your problem can be fixed:

  • Owncloud log (data/owncloud.log)
  • Browser log (Hit F12 to gain access)
  • ownCloud version
  • App version
  • Browser version
  • PHP version

Preparation

Here is a list of steps you might want to take before using the app

Supporting more media types

First, make sure you have installed ImageMagick and its PECL extension. Next add a few new entries to your config/config.php configuration file.

  'preview_max_scale_factor' => 1,
  'enabledPreviewProviders' =>
  array (
    0 => 'OC\\Preview\\Image',
    1 => 'OC\\Preview\\Illustrator',
    2 => 'OC\\Preview\\Postscript',
    3 => 'OC\\Preview\\Photoshop',
    4 => 'OC\\Preview\\TIFF',
  ),

If you want support for Raw picture files, you'll need to patch your installation of ownCloud 8.0

$ patch -p1 -l < apps/galleryplus/patches/tmpfile-extension.pull.13654.patch
$ patch -p1 -l < apps/galleryplus/patches/raw-preview.pull.13652.patch

and you'll need to add OC\\Preview\\Raw to the config/config.php configuration file

Look at the sample configuration (config.sample.php) in your config folder if you need more information about how the config file works. That's it. You should be able to see more media types in your slideshows and galleries as soon as you've installed the app.

Improving performance

Assets pipelining

Make sure to enable "asset pipelining", so that all the Javascript and CSS resources can be mixed together. This can greatly reduce the loading time of the app.

Read about it in the Administration Manual

Generating thumbnails

Some of ownCloud's internal operations make the Gallery app very slow

  • Generating thumbnails the first time you open the app
  • Generating a full screen preview

Things are in motion to fix preview caching for ownCloud 8.1, but you can benefit from these improvements right now if you're willing to patch your ownCloud installation.

$ patch -p1 -l < apps/galleryplus/patches/max-preview.pull.13674.patch
$ patch -p1 -l < apps/galleryplus/patches/bitmap-max-preview.pull.13635.patch

It will always be relatively slow to get the first preview as this is when the conversion is taking place, but from the 2nd request, it should only take a few seconds, even for pictures weighing several hundred MBs. The next step will be to be able to generate these previews by clicking on a button per example, so that things are ready when visiting the Gallery app.

Installation

IMPORTANT: Make sure you've disabled the original Pictures app

Installing from archive

  • Go to the the releases page
  • Download the latest release/archive to your server's owncloud/apps/ directory
  • Unpack the app
  • IMPORTANT: Rename it to galleryplus

Installing from Git

In your terminal go into the owncloud/apps/ directory and then run the following command:

$ git clone -b stable8 https://github.com/interfasys/galleryplus.git

Now you can activate it in the apps menu. It's called Gallery

To update the app go inside you owncloud/apps/galleryplus/ directory and type:

$ git pull --rebase origin stable8

List of patches

  1. max-preview.pull.13674.patch : Limits previews to a max size of 2048x2048 by default
  2. bitmap-max-preview.pull.13635.patch : Forces the bitmap converter to respect the max limits of previews
  3. tmpfile-extension.pull.13654.patch : Makes sure temporary files have an extension so that ImageMagick can identify those files properly
  4. raw-preview.pull.13652.patch : Allows ownCloud to visualise Raw files