files_photospheres/README.md

Nextcloud - Files_PhotoSpheres

Nextcloud app for viewing Google PhotoSphere 360° images (panorama-images). This app is based on the photo-sphere-viewer.js library. For 360° videos the library marzipano is used.

This version is tested for Nextcloud 30.

Table of contents

• Nextcloud - Files_PhotoSpheres
  • Table of contents
  • Features
  • Setup
    • Install through the app store
    • Install manually
    • Usage
    • Caching
  • Caveats
  • Report an issue

Features

• Interactive viewer to view PhotoSphere images in your Nextcloud instance
• When clicking on an image it automaticlly detects the presence of XMP-data tags (which are used in photospheres).
• Compatible with the "normal" user-view, single-file share and directory share.
• Seamless integration with other file-viewer apps.
• Supports viewing of 360° videos in "normal" user-view via context menu.

Setup

Install through the app store

The recommended way to install this app, is through the Nextcloud app store.

Open your Nextcloud instance -> Settings -> Apps -> Multimedia -> Photo Sphere Viewer -> Download and Enable.

Install manually

You can manually install this app, by cloning the repository into your nextcloud installation:

cd <your-nextcloud-installation>/apps/
git clone https://github.com/nextcloud/files_photospheres.git
chown www-data:www-data -R ./files_photospheres

Usage

After installing the app you can view your PhotoSphere 360° images by clicking on the file in the Nextcloud file browser. Note that opening PhotoSpheres from the gallery is currently not supported.

Caching

This app uses the caching mechanism of Nextcloud to cache the XMP Metadata of the images. The cache is filled on demand when opening a directory for the first time and it will be valid for 24 hours. To get the full performance it's highly recommended to install a local caching backend like APCu or Redis like described here.

Caveats

• It is not possible to open the photosphere viewer from the Gallery. You must use the file browser.
• WebGL-support must be activated in your browser.
• 360° videos can not be shown in shared views. It is only possible to open them by context menu therefore the files_rightclick app has to be installed (see https://github.com/nextcloud/files_rightclick).

Report an issue

I rely on all kind of feedback so feel free to open an issue if you encounter any problems with this app but please pay attention to the following points:

• If there is a problem with some images which aren't opened in this app but rather in the regular image viewer, please provide them via downloadlink if possible. Otherwise debugging and error-checking becomes quite hard. Please also check if the image you provide has correct XMP-metadata for being detected as photosphere image (like specified here). The image is only detected as photosphere if the XMP-metadata contains the following data:

  • GPano:UsePanoramaViewer is set explicitly to true or
  • GPano:ProjectionType is set to equirectangular or
  • GImage:Mime is set to image/jpeg (this is currently the only reliable way to detect Google VR180 images, see https://github.com/nextcloud/files_photospheres/issues/1)

  You can check these metadata information either with tools like exiftool or manually by opening the image with your favorite texteditor and scrolling throw the first few bytes.

• In the frontend this app is only an integration of different external components like photo-sphere-viewer.js and marzipano. Therefore problems regarding these libraries cannot be fixed in this app.

Thanks for your support 😃