---
title: 'Local Hotfolder'
url: 'https://doc.brix.ch/celum_extensions/local_hotfolder'
markdown: 'https://doc.brix.ch/celum_extensions/local_hotfolder.md'
lang: en
date: '2026-10-26'
description: 'Technical documentation for the Celum Plugin "Local Hotfolder" – Software developed by brix'
taxonomy:
  category:
    - docs
---

[](#) 

  [ Welcome ](https://doc.brix.ch/)     [ CELUM Extensions ](https://doc.brix.ch/celum_extensions)      Local Hotfolder    

# Local Hotfolder

![No UI](https://img.shields.io/static/v1?label=UI&message=none&color=inactive)

Local Hotfolder is a CELUM plugin application that allows to upload all files of a local directory on the CELUM server to a specific node.

> > > Note that this requires the folder (or mount) to be present on the appserver - otherwise consider using the [Remote Hotfolder](https://doc.brix.ch/celum_connectors/remote_hotfolder) (e.g. when you are subject to their "pipeline hosting").

#### Table of Contents

- [Properties](#properties)
    - [Instance Properties](#instance-properties)
- [Example](#example)
- [Compatibility Matrix](#compatibility-matrix)
- [Release Notes](#release-notes)

## Properties

To be configured in {home}/appserver/conf/custom.properties

##### localHotfolder.license

> type: string, **required: yes**, default: -

The license key for the plugin (product: localHotfolder), provided by *brix*.

##### localHotfolder.task.name

> type: string, required: no, default: Local Hotfolder Task

System task name for the local hotfolder task.

##### localHotfolder.task.groupName

> type: string, required: no, default: Local Hotfolder

System task group name for the local hotfolder task.

##### localHotfolder.mailTo

> type: comma-separated list of email adresses, required: no, default: -

Email adresses where error mails are sent to.

### Instance Properties

syntax: localHotfolder.*{1..n}*.*{property}*

e.g. localHotfolder.1.localPath=/home, localHotfolder.2.localPath=/mnt/folder

##### localHotfolder.1.localPath

> type: string, **required: yes**, default: -

Local path of the source folder.

##### localHotfolder.1.targetNodes

> type: comma-separated list of node ids, **required: yes**, default: -

IDs of the Target Nodes.

##### localHotfolder.1.enabled

> type: boolean, required: no, default: false

Enables a hotfolder configuration.

##### localHotfolder.1.taskCron

> type: string, required: no, default: -

Cron expression for the local hotfolder task in which the asset will be uploaded from the local path to the target nodes

##### localHotfolder.1.uploadFolders

> type: boolean, required: no, default: false

Activates the folder upload feature for this job. In this mode, subfolders of `localPath` will be scanned as well, and uploaded with their folder structure in tact.

##### localHotfolder.1.cleanUpTaskCron

> type: string, required: no, default: -

Cron expression for the local hotfolder clean up task in which the already uploaded folders will be deleted, only necessary if `uploadFolders` is true.

##### localHotfolder.1.assetType

> type: long, required: no, default: -

Default asset type for newly uploaded assets.

##### localHotfolder.1.credentials

> type: long, required: no, default: apiUser

User id for the uploading user.

##### localHotfolder.1.preventDuplicates

> type: boolean, required: no, default: false

Search for assets of the same name, upload as version instead.

##### localHotfolder.1.searchGlobally

> type: boolean, required: no, default: false

Search everywhere (credentials can see) instead of just the target node for duplicates.

##### localHotfolder.1.relink

> type: boolean, required: no, default: false

Relink the asset to the target node when found somewhere else with searchGlobally

##### localHotfolder.1.blacklist

> type: Regex, required: no, default: `^[\\.].*|Thumbs.db$`

A blacklist of file names to ignore. Defaults to dot-files and the ungodly Thumbs.db

##### localHotfolder.1.name

> type: string, required: no, default: -

Name of the hotfolder task.

## Example

```ini
# first hotfolder, runs every minute
localHotfolder.1.name=First Hotfolder
localHotfolder.1.enabled=true
localHotfolder.1.taskCron=* * * * * ?
localHotfolder.1.localPath=/mnt/source1
localHotfolder.1.targetNodes=123

# second hotfolder, runs only on sunday night at 4 AM
localHotfolder.2.name=Second Hotfolder
localHotfolder.2.enabled=true
localHotfolder.1.taskCron=0 0 4 ? * SUN
localHotfolder.2.localPath=/mnt/source2
localHotfolder.2.targetNodes=456
```

## Compatibility Matrix

| Local Hotfolder | CELUM (min. version) |
|---|---|
| 1.0.0 | 5.13.4 |
| 1.1.0 | 5.13.4 (tested up to 6.4) |
| 1.5.0 | 6.8+ |
| 1.9.0 | 6.20+ (tested up to 7.1) |

## Release Notes

##### 1.0.0

> Released 2020-04-11

Initial version

##### 1.1.0

> Released 2021-01-08

Deduplication support

##### 1.2.0

> Released 2022-08-15

Filename blacklist feature

##### 1.3.0

> Released 2023-07-23

Mail feedback feature

##### 1.4.0

> Released 2023-07-25

Folder upload feature

##### 1.5.0

> Released 2023-09-15

Search in node & ignore file extension

##### 1.6.0

> Released 2023-11-08

Switch folder uploads to standard "NodeFinder" implementation

##### 1.7.0

> Released 2024-11-06

Wait for files to be written completely, add regex search/replace

##### 1.8.0

> Released 2025-01-10

Ignore assets that are in the trashbin when using `searchGlobally`

##### 1.9.0

> Released 2025-08-14

Compatibility with 6.20

 [ ](https://doc.brix.ch/celum_extensions/login_management) [](https://doc.brix.ch/celum_extensions/configurable-date-sync)

---

## Navigation

- Parent: [CELUM Extensions](https://doc.brix.ch/celum_extensions.md)
- Previous: [Login Management](https://doc.brix.ch/celum_extensions/login_management.md)
- Next: [Configurable Date Sync](https://doc.brix.ch/celum_extensions/configurable-date-sync.md)