User Tools

Site Tools


publisher_full_install_guide

TTG CE3 Publisher Full Install Guide

TTG CE3 Publisher is a two-part publishing system. One part is the web app, which resides online with your site; the other part is the Publish Services plugin, installed to Lightroom.

Server-side Setup

The server-side component of TTG CE3 Publisher typically resides in the root of your website, presumably http://yourdomain.com/publisher/. If using TTG CE3 Pages, this would see the /publisher/ folder seating among your assets from Pages.

Installation is performed as follows:

1.
Unzip the downloaded Publisher package, typically named something like TTG-CE3-Publisher-120.zip.

2.
Set a strong password by editing the file publisher/api/config.php and changing the API_KEY setting from 'ttg8888' to your own. For example, to change to 'apple12' (please don't use this specific password!), the top lines of config.php would look like:

<?php

// Change this to a strong password
define('API_KEY', 'apple12');


NOTE for Mac users: TextEdit for Mac by default converts straight quotes to angled quotes, which breaks the Publisher. This can be solved by either using a different editor, or changing this behaviour in the TextEdit settings:

  1. Click the TextEdit menu item, followed by Preferences
  2. Unselect the 'Smart Quotes' option towards the bottom of the window
  3. Restart TextEdit

3.
Upload the /publisher/ folder from within the unzipped folder to the top-level of your site. (The top-level of your site can often be found within the public_html directory when you FTP into your site, however the exact location is specific to your host and your own setup). For example, within a TTG CE3 Pages installation you may find the following files and folders:

/fragments/
/galleries/
/photos/
/phplugins/
/resources/
/thumbnails/
about.php
contact.php
etc. …

After uploading /publisher/ the list would look like this:

/fragments/
/galleries/
/photos/
/phplugins/
/publisher/
/resources/
/thumbnails/
about.php
contact.php
etc. …

4.
Grant write access to the target folder to which your galleries will be published.

  • If using TTG CE3 Pages, the target folder will typically be the /galleries folder.
  • If using TTG CE3 Auto Index, you may use any auto index folder as your target.
  • If using neither TTG CE3 Pages nor TTG CE3 Auto Index, you may create an empty folder to use as target.

To grant write access, change permissions on the target folder to either 777 or 755, depending upon host. This is required so that Publisher will be able to manage the published albums and photos. For more information, see our guide Creating Writable Server-side Directories.

Lightroom's Publish Services Setup

The downloaded zip file includes a Lightroom Publisher plugin called TTG-CE3-Publisher.lrplugin. This needs to be installed to Lightroom as follows.

1.
Copy the TTG-CE3-Publisher.lrplugin to a location on your computer for safekeeping. This should be someplace that the plugin may remain longterm, as LR will read from this location after installation.

2.
Launch Lightroom. From the File menu, choose Plug-in Manager.

3.
The left-hand side of the Plug-in Manager will display a list of installed plugins. Click Add, navigate to the location of the TTG-CE3-Publisher.lrplugin on your drive, and click Add Plug-in. TTG CE3 Publisher will appear in the list of installed plugins.

4.
Click Done. TTG CE3 Publisher should now be installed, and can be seen in the Library's Publish Services control pane.

Setup a Publisher Instance

With TTG CE3 Publisher installed, you now need to setup an “instance” of the publisher for each location to which you wish to publish galleries, i.e. for each target location. To review from above, a target location may be any of the following:

  • If using TTG CE3 Pages, the target folder will typically be the /galleries folder.
  • If using TTG CE3 Auto Index, you may use any auto index folder as your target.
  • If using neither TTG CE3 Pages nor TTG CE3 Auto Index, you may create an empty folder to use as target.

A single instance of TTG CE3 Publisher can publish only to a single target. You may create additional instances to publish to additional targets. More on this later.

1.
In Publish Services (pictured above), double-click the TTG CE3 Publisher item. This will launch the Lightroom Publishing Manager:

2.
The follow items all need to be set:

  1. API URL: This is the URL to your publisher as uploaded on your server. For example, if you uploaded the publisher to the top level of yourdomain.com, then the API URL would look like http://yourdomain.com/publisher/api/. Please note that this must begin with http:// (or https:// if your site runs on SSL) and end with /publisher/api/.
  2. API Key: This is the key set in publisher/api/config.php.
  3. After setting the above, click Check Authentication to check that Lightroom can locate your server and authenticate. The publisher provides error messages as needed that should help you resolve any issues.

Optional Publisher Settings

1.
Checking Show albums in browser after publishing will launch an album in your web browser after each publish completes.

2.
Specify the target folder by name. The corresponding directory must exist on the server and be granted write access. If this setting is changed after photos have been published then the original galleries folder will need to be renamed on the server to prevent the Lightroom albums from becoming out-of-synch with the server.

Once again, for review, the target folder may be any of the following:

  • If using TTG CE3 Pages, the target folder will typically be the /galleries folder.
  • If using TTG CE3 Auto Index, you may use any auto index folder as your target.
  • If using neither TTG CE3 Pages nor TTG CE3 Auto Index, you may create an empty folder to use as target.

Advanced users may specify a nested directory as the top-level galleries directory. For example, in a site setup such as the following:

/portfolio/galleries
/publisher

The top-level galleries directory can be configured as 'portfolio/galleries'.

3.
Preserve capitalization in album slugs allows slugs with capital letters.

4.
The Push metadata without updating existing albums option allows for much faster updates to galleries for photos that have already been published. The only time that you should need to disable this option is after altering the appearance of a photo (rather than updating metadata) or setting an album to use a new template with rendition sizes different from those of the originally published photos.

5.
The Metadata section controls the metadata that is embedded within photos. Thumbnail images are only ever published with the copyright information and stripped of all other embedded metadata, regardless of how this is set.

6.
Watermarks controls image watermarking for all photos published through this instance of TTG CE3 Publisher. For this to take effect on already-published photos, make sure that Push metadata without updating existing albums is unselected before re-publishing photos that require the new watermark.

publisher_full_install_guide.txt · Last modified: 2014/03/20 07:34 by ben