Installation and Setup

Installation and Initial Setup

Installing the Plugin

1. Download the .lrplugin folder from the GitHub repository
2. Open Lightroom Classic
3. Go to File → Plug-in Manager
4. Click Add
5. Select the .lrplugin folder
6. Ensure the plugin status shows Enabled
7. Select required logging options

Registering the Publish Service

After installation:

1. Open the Library module
2. Locate Publish Services in the left panel
3. Click Add under Publish Services
4. Select Piwigo Publisher
5. Configure the initial connection settings

Initial Connection Setup

Typical first-time configuration includes:

• Piwigo server URL
• Authentication (username/password)
  • if the user has 2FA enabled then authentication currently requires the following workaround:
    • Username: Enter the API key ID (starting with pkid-…)
    • Password: Enter the secret associated with the API key
  • the user must have webmaster permissions for the plugin to operate

Important Once the initial connection has been made then Publish Service must be saved before any further configuratation is performed.

---

Piwigo Publish Service Configuration and Settings

These steps may be performed when configuring a new Publish Service.

1. Import Albums

Info: Creates a local representation of your Piwigo albums without downloading photos.

• Published Collection Sets and Published Collections are created in the Publish Services panel to match albums and sub-albums in Piwigo.
• Can be re-run
• Album descriptions are imported.
• Note: Photos are not downloaded from Piwigo, nor are existing catalog photos automatically added.
• See Managing Albums and Album Sets

2. Check and Link Existing Collections to Piwigo Structure

Important: Ensures local collections match the Piwigo host structure.

• Compares local LrC Published Collections with Piwigo albums.
• Can be re-run
• Creates missing Piwigo albums and corrects incorrect links.
• Useful for collections created with tools like jb Collection Tools.
• ⚠️ Photos in such collections are not linked to existing Piwigo photos. The first time Publishing is run, duplicates of exisiting imaages on Piwigo may be created.
• See Managing Albums and Album Sets

3. Clone Existing Publish Service

Tip: Quickly replicate another service’s structure and images.

• Clones structure and images from another Publish Service into this one.
• Cannot be re-run in the same publish service
• Works differently depending on whether the source service is Piwigo-connected and which host it uses.
• See Clone Publish Service for details.

4. Create Special Collections

• Allows photos to be published to albums containing sub-albums.
• Can be re-run
• See Special Collections Notes

---

🛠 Service Configuration

5. Metadata Settings

• Metadata and keywords exported to Piwigo regardless of EXIF/IPTC content.
• Export methods:
  • Publish
  • Library ▸ Plug-in Extras (metadata-only)
• Fields populated:
  • author ← Creator
  • date_creation ← Capture Date / Original Date / Created Date or file creation date if missing
  • title ← Title (see Tokenised Metadata below)
  • description ← Caption (see Tokenised Metadata below)

---

Tokenised Metadata

• Use {{token}} placeholders in title and description.
• Supports all metadata from photo:getFormattedMetadata and photo:getRawMetadata.
• Full Details

6. Keyword Settings

• Respects Include on Export.
• Options: Include Full Keyword Hierarchy, Include Keyword Synonyms.
• Automatically creates missing keywords in Piwigo.
• Keywords on Lightroom vs Piwigo
  • Piwigo keywords are case-insensitive and accents are ignored.
  • e.g., "This Is A Keyword" = "this is a keyword"
  • and "Hérémence" = "Heremence"

---

7. Other Settings

Synchronise Album Descriptions

• Ticking this option enables the synchronisaton of album descriptions between Lightroom and Piwigo.
• Full details

Synchronise comments as part of a Publish Process

Only include Published Photos

• Full details of the comments synchronisation mechanism can be seen here

Private

Comments

• Comments can be synchronised betwween Piwigo and Lightroom
• Full details

---

⬆ Back to Home