Skip to content

Workflows

Workflows take routine sorting off your hands. They’re rules that run on your server: when something happens, check which photos and videos match, then do something with them. For example: every night, add the photos of the dog from the last 7 days to an album and tag them.

Workflows only act on items in your own library. Open Workflows in the sidebar to see yours, create one, or import one.

  • From scratch: choose New workflow, or Start from a template.
  • From a search: run a search, choose Save search, then Automate this search. Your search’s conditions are copied into a new workflow, and you pick the album or tag actions and when it runs.
  • From an album: choose Automatically add matching photos.

A workflow can carry search conditions, such as people, tags, media type and dates. They’re copied into the workflow when you create it, so changing the original search later doesn’t change the workflow. Choose Edit search conditions to change them.

Fixed dates stay fixed. Choose Use a rolling capture-date period for “within the last days” instead, which is worked out each time the workflow runs.

Choose a Trigger:

Trigger Runs
Photo or video uploaded When an item is uploaded
Metadata extracted Once its metadata has been read
Tags changed When its tags change
After every matching change After each supported change while the item still matches, including when processing such as AI descriptions finishes
Scheduled only Only on its schedule or when you choose Run now

Turn on Run on a schedule to also run it Hourly, Daily or Weekly, at a time you choose. Schedules use your server’s timezone, which is shown next to the time. If the server was off when a run was due, it catches up when it starts again. Advanced cron takes a five-field cron expression (minute, hour, day, month, weekday) for anything else.

Run now runs the saved workflow straight away for every matching item. Large runs work through your library in batches; you can follow them under Batch runs and cancel unfinished work. Anything already done stays done.

A workflow’s own changes never set it off again, so two rules can’t keep triggering each other.

Administrators also see a second group of triggers, Frameleaf events. These start a workflow when something happens in Frameleaf itself, and send a message about it to a web address, for example to Home Assistant or another service you run.

Trigger Sends a message when
Studio export finished A Studio export is ready
Cloud Backup finished A Cloud Backup run completes
Cloud Backup failed A Cloud Backup run fails
Clients gallery approved A client sends their choices from a gallery
Frameleaf Cloud job finished A job on Frameleaf Cloud is done

To set one up:

  1. Choose New workflow and pick a trigger from Frameleaf events.
  2. Add the Trigger Webhook step and enter the web address. It’s the only step these workflows can use, and they have no search conditions or schedule.
  3. Choose Check and preview. Checking sends nothing; it shows a Sample message like the one the address will receive.
  4. Enable the workflow.
  • What the message holds. The event, when it happened, what it’s about and a few counts. It never carries a photo’s ID, a file path, an error message, a client’s name or a password. Locked photos are never named, and an event about a Locked or hidden photo isn’t sent at all.
  • Signed messages. Add a signing secret to the step, and each message carries an X-Frameleaf-Signature header the receiver can check, with an X-Frameleaf-Timestamp and an X-Frameleaf-Delivery ID that stays the same if the message is sent again. The secret is stored on the server and never shown again.
  • Secure addresses only. Messages go to https addresses on the internet. To reach a device at home, turn on Allow automations to call devices on my network in Settings, then Server & updates, then Server name & welcome. The server itself and cloud metadata addresses stay out of reach even then.
  • Only while you’re an administrator. The workflow stops sending if its owner is no longer one.
  • Turn on Keep run history to see each time a message was sent. A failed delivery is tried once more by itself.

The Home Assistant integration sets this up for you.

Add steps in order with Add step. A Filter stops the run for items that don’t pass; an Action does something, such as adding to an album or tagging. The designer offers the filters and actions your server has installed. You can turn a single step off, move it earlier or later, or remove it.

Adding to an album only ever adds. Running a workflow again doesn’t create duplicates, and it never removes photos from albums.

Check and preview checks the workflow and walks through what each step would do, as a dry run. It shows how many items match now. Nothing is changed and no plugins are called. Actions only run once you enable the saved workflow.

  • Enable or Pause a workflow at any time. Pausing cancels runs that haven’t started; a step that’s already running finishes.
  • Turn on Keep run history to see each run under History: completed, stopped by a filter, or failed at a step. A failed step is retried once automatically, starting at that step. After that you can choose Retry run.
  • Locked items and items you can no longer access are skipped, even if they matched when the run started.
  • Deleting a workflow keeps the changes it already made to your photos.

Export complete definition saves a workflow as a JSON file to keep it or move it to another server. Stored passwords and other credentials stay on the server and are never exported.

Import workflow brings one in. Imported workflows arrive paused so you can review them before enabling them. Settings for plugins your server doesn’t have are kept, but the workflow can’t be enabled until a compatible plugin is installed.

The iPhone and Android apps can create, schedule, run, pause and delete workflows with album and tag actions, in Settings under Workflows. On Android you can also start one from a search, a saved search or an album. Workflows with advanced steps from plugins are edited on the web, and the apps keep their settings untouched.