Envira Gallery Documentation

Documentation, Reference Materials and Tutorials for Envira Gallery

Lightroom Addon

Share This Post!

The Lightroom Addon for Envira Gallery allows you to synchronize your Adobe Lightroom Collections with Envira Galleries.

  1. Requirements
  2. Installation
  3. Setup
  4. Use
  5. FAQs
  6. Configuration Options

Requirements

Installation

This Addon requires two components to be configured, which communicate with one another – an Envira Addon for WordPress, and a Lightroom Plugin

Installing on WordPress
  1. Please follow our instructions on how to install and activate addons. In this instance, you’ll be activating the Envira Lightroom Addon.
  2. You will also need to install and activate the WP REST API 1.2.5 or 2.x Plugin
  3. Please make sure Permalinks are set to Post name OR /%postname%/

pretty-permalinks


Installing on Lightroom

Download from Envira

Visit your Envira Account, and navigate to the Downloads tab.

You’ll see the Lightroom Addon (Adobe) option – click the Download option to get the plugin.

Navigate to your computer’s download folder, where you will see the file enviralrplugin.zip.

lightroom-6

Double click on the downloaded ZIP file to extract it. You should now see the file envira.lrplugin:

lightroom-7

IMPORTANT: We recommend you move the file envira.lrplugin out of the default downloads folder on your computer into the Adobe Lightroom Application’s folder so you don’t accidentally delete the file after installing it.

In the below screenshot you can see I’ve moved the envira.lrplugin file into the Adobe Lightroom directory on my computer:

Move the envira.lrplugin file to a more secure directory before installing to avoid deleting it accidentally.

Once you’ve relocated the plugin file you downloaded, open Lightroom and navigate to File > Plug-in Manager:

Select Plugin Manager... from the Edit menu item in your Lightroom app.

Select the Add button:

Select the Add button to install the Envira Addon.

Navigate to the folder containing the plugin file, select the envira.lrplugin file and then the Add Plug-in button:

Locate the envira.lrplugin file on your computer and select the Add Plugin button to install.

You’ll now see the Envira plug-in in the Plug-in Manager, select the Done button to finish.

Finish the setup by clicking on the Done button.


Install using Adobe Creative Cloud

First, make sure that you have the Adobe Creative Cloud app installed and you’ve enabled File Syncing; if you’re unsure how to enable file syncing please follow the steps provided at https://www.adobeexchange.com/resources/19.

Make sure the Lightroom application is closed.

Open https://creative.adobe.com/addons in your browser and select the Sign In button.

Sign in with your Adobe Creative Cloud username and password. Make sure this is the same account that you’re signed into on your Adobe Creative Cloud desktop app with.

You'll be prompted to login to your Adobe account before you can download the Envira Gallery Lightroom Addon.

Visit https://creative.adobe.com/addons/products/13607 and select the Install button:

Select the Install button for the Envira Lightroom Addon.

After a few moments, the Adobe Creative Cloud app on your computer should notify you that Envira Gallery has been downloaded.

Navigate to your computer’s download folder, where you will see the file enviralrplugin.zip.

lightroom-6

Double click on the downloaded ZIP file to extract it. You should now see the file envira.lrplugin:

lightroom-7

IMPORTANT: We recommend you move the file envira.lrplugin out of the default downloads folder on your computer into the Adobe Lightroom Application’s folder so you don’t accidentally delete the file after installing it.

In the below screenshot you can see I’ve moved the envira.lrplugin file into the Adobe Lightroom directory on my computer:

Move the envira.lrplugin file to a more secure directory before installing to avoid deleting it accidentally.

Once you’ve relocated the plugin file you downloaded, open Lightroom and navigate to File > Plug-in Manager:

Select Plugin Manager... from the Edit menu item in your Lightroom app.

Select the Add button:

Select the Add button to install the Envira Addon.

Navigate to the folder containing the plugin file, select the envira.lrplugin file and then the Add Plug-in button:

Locate the envira.lrplugin file on your computer and select the Add Plugin button to install.

You’ll now see the Envira plug-in in the Plug-in Manager, select the Done button to finish.

Finish the setup by clicking on the Done button.

 


 

Install using Adobe Extension Manager (CS6 – CC 2014)

Visit https://creative.adobe.com/addons/products/13607 and select the Download Envira Gallery button:

You can use Adobe Extension Manager to install the Envira Lightroom Addon.

Install the Add-on with Extension Manager

Once installed the Envira Gallery Lightroom Addon will appear in the Extension Manager.


Setup

Again, one time setup is required for both your WordPress installation and Lightroom installation.

Setup WordPress

Navigate to Envira Gallery > Settings > Lightroom tab. From this screen, choose the WordPress User that Lightroom will use to create and manage Envira Galleries. IMPORTANT: this User must have the relevant role / capabilities to perform the following:

  • Create Envira Galleries
  • Edit Envira Galleries
  • Delete Envira Galleries
  • Create Media Library Items (Attachments)
  • Edit Media Library Items (Attachments)
  • Delete Media Library Items (Attachments)

Select the Save button to apply the chosen configuration.

Save the changes you've made to the Lightroom settings screen to apply them.

You’ll then see on screen confirmation that the settings were successfully applied.

Envira will display a confirmation message after you save your Lightroom settings.

Next, make a note of the Access Token.  You’ll use this in the Lightroom software to connect to your WordPress web site.

IMPORTANT: Do not share your Access Token with anyone else. The Access Token, when used in the Lightroom Plugin, will allow galleries and images to be created, edited and deleted.

If at any time you are concerned that your Access Token may have been compromised, or that another user knows your Access Token, click the Generate New Access Token button:

You can generate a new access token for Lightroom at any time.

Setup Lightoom

Select Set Up… beside the Envira publish service.  This is displayed on the left hand side of the screen:

Choose the Set Up... link next to the Envira service.

  1. Enter your WordPress web site URL, as displayed at WordPress Administration > Settings > General > WordPress Address (URL)
  2. Enter your Access Token, as displayed at WordPress Administration > Envira Gallery > Settings > Lightroom > Access Token

Add the WordPress URL and Access Token to Authenticate Lightroom with your WordPress site.

Then select the Authenticate button:

Select the Authenticate Button to confirm your WordPress URL and Access Token.

If authentication was successful, an on screen message will be displayed.  If it failed, make a note of the error message and ensure you’ve correctly defined the WordPress URL, Access Token and that you’ve followed all previous steps in this document.

Once you've successfully authenticated Lightroom with your WordPress site you'll see a dialog popup with a success message.

Finally select the Save button:

Select the Save button to finalize the WordPress Authentication with Lightroom.


Use

Lightroom: Collections and Photos – there are two important concepts:

  1. A Lightroom Collection corresponds to an Envira Gallery.
  2. A Lightroom Collection’s Photo corresponds to an Envira Gallery Image, which is stored in the WordPress Media Library

 


 

Lightroom: Create a New Collection

Right click on Publish Services > Envira, and left click Create Published Collection:

Right-click on the Envira service and choose Create Published Collection to begin.

Enter a Name for the Collection, and click Create. Note: This will be the Envira Gallery’s Title.

Give your Published Collection a name, this will also be the name of the Envira Gallery when published.

You can have as many Published Collections as you wish. Each Published Collection will have its own Envira Gallery on your WordPress web site.


 

Lightroom: Add Photos to a Collection

Drag and drop Photos from the Library into the Collection. Click on the Collection to see the Photos assigned to it.

Select the Envira Collection in Lightroom to view the images it contains.


 

Lightroom: Publish a Collection

Whenever you create a new Collection, add Photos to a Collection, or delete Photos from a Collection, the Publish button will be available towards the bottom left of the Lightroom screen:

Select the Publish button to publish a collection as an Envira Gallery on your site.

After selecting the Publish button Lightroom will show a progress bar in the upper-left corner of the Lightroom screen:

A progress bar will appear in Lightroom when you Publish a Collection to show the progress of the changes.

Select the Publish button to perform the following actions automatically:

  • Publish New Collection: If this is a new Collection, an Envira Gallery will be created, with all Photos in the Collection uploaded to WordPress and assigned to the Envira Gallery.
  • Update Images in the Collection: If this is an existing Collection, the existing Envira Gallery will be updated, with all edited Photos in the Collection replacing the existing uploaded Photos in the Envira Gallery.
  • Remove Images from the Collection: If this is an existing Collection, and Photos within the Collection have been deleted, these Photos will be deleted from WordPress and the Envira Gallery.
  • Move Associated Envira Gallery to Trash: If this Collection is deleted, the Envira Gallery will be moved to the Trash in WordPress.

After selecting the Publish button, login to the WordPress Administration and edit / view your Envira Gallery to confirm the changes have taken effect.


 

Lightroom: Delete a Published Collection

Right click on the Collection Name, and click Delete:

Select the Delete option after right-clicking on the Collection name to remove the Collection in Lightroom.

Options:
To delete the Envira Gallery corresponding to this Published Collection, click Delete in the dialog box.
To keep the Envira Gallery corresponding to this Published Collection (i.e. only delete the Lightroom collection and not the Envira Gallery) click Leave on Service in the dialog box:

Screen Shot 2015-11-11 at 12.09.08


FAQs

Q: What file types are supported?

A: You can use GIF, JPG, PNG or JPEG.


Q: I can’t publish a collection, why?

A: There can be several reasons, please review this checklist to see if any of these scenarios apply:

  • That you have the WordPress REST API plugin installed (the Lightroom Addon is compatible with both version 1 and version 2 of the REST API but does require at least one of them be installed/activated on your site).
  • That your site is set to use Pretty Permalinks — this means in the WordPress Admin > Settings > Permalinks screen “Post name” should be selected.
  • In the WordPress Admin > Envira Gallery > Settings > Lightroom tab the Envira User assigned has the Administrator user-role assigned, and select the Save button to re-confirm this setting.
  • Please check that WordPress web site URL you have entered in Lightroom authentication settings is without /wp-admin (for example it should look like: http://yoursite.com)
  • If the above fail to resolve the error, please download the Lightroom plugin again directly from your Envira Gallery account and replace the current plugin file on your computer with this to be sure you have the latest version running on your computer.
  • Make sure that you are connecting through a live site and not a local install.

Configuration Options

There are no configuration options for this Addon.


Developers

Filters

FileFilter NameArguments
/includes/global/attachment.php
 envira_lightroom_prepare_gallery_dataapply_filters( 'envira_lightroom_prepare_gallery_data', $image, $gallery_data, $id, $tags )

Actions

FileAction NameArguments
/includes/global/v1/class-wp-json-media.php
 envira_gallery_ajax_remove_imagesdo_action( 'envira_gallery_ajax_remove_images', $image_id, $gallery_id )
/includes/admin/settings.php
 envira_gallery_settings_lightroom_tab_noticedo_action( 'envira_gallery_settings_lightroom_tab_notice' )

Changelog

WordPress Plugin

1.1.0.1 (2016-16-12)

  • Hotfix: Make sure images are set to active

1.1.0 (2016-06-10)

  • Fix: Do not double encode strings that are already UTF-8.

1.0.9 (2016-06-09)

  • Fix: Make sure accented characters display correctly in titles and captions.

1.0.8 (2016-05-31)

  • Fix: Addressing a post trashing issue.

1.0.7 (2016-05-05)

  • Fix: Ensure the correct function is called for the WP REST API v1 initialisation.

1.0.6 (2016-04-28)

  • Added: Copy to clipboard option for access token in Settings
  • Added: Error notice if WP REST API v1 and v2 missing
  • Added: Error notice if both WP REST API v1 and v2 activated at the time time

1.0.5 (2016-04-16)

  • Fix: Prevent success / error notices on Settings screen from jumping

1.0.4 (2016-03-10)

  • Added: WP REST API v2 Support
  • Updated: Spanish Translations

1.0.3 (2016-03-03)

  • Added: Image Title is now stored when supplied by Adobe Lightroom Addon 1.0.1.0+
  • Added: Image Caption is now stored when supplied by Adobe Lightroom Addon 1.0.1.0+
  • Fix: Accented characters supported in titles and captions

1.0.2 (2016-02-25)

  • Added: Populate alt field with image filename if no metadata exists for the alt parameter
  • Added: Spanish Translations
  • Fix: Issue publishing images which were previously published but no longer exist in the WordPress Media Library (resulting in a remotePhotoId error being displayed on screen within Adobe Lightroom)

1.0.1 (2016-02-18)

  • Fix: Display notice if Pretty Permalinks not enabled (required for Lightroom Addon to work)

1.0.0 (2015-10-07)

  • Initial release of the addon.

Lightroom Plugin

1.0.3.1 (2016-05-06)

  • Fix: Internal error message on json.lua:383 (title, keywords and caption are only sent if not empty, preventing the error).

1.0.2.1 (2016-03-31)

  • Fix: Send correct Content-Disposition header for WP REST API v2 integrations

1.0.1.1 (2016-02-18)

  • Added: WP REST API v2 Support
  • Added: Image Title is exported when publishing an image in a collection
  • Added: Image Caption is exported when publishing an image in a collection
  • Added: Image Keywords are exported as Tags when publishing an image in a collection (requires Envira Tags Addon on WordPress site)

1.0.0

  • Initial release of the addon.
Share This Post!