Skip to content

Local publisher plugin

This publisher plugin uploads reports and attachments to a directory, which may be mounted.

It is disabled by default as it requires you to define a target directory. Please refer to “Instance configuration” for more information on how to enable or disable a plugin.

It exposes no user-facing endpoints.

There is one service-specific configuration file option that must be specified.

Environment variables

You can set the LOCALPUBLISHER_DEBUG_LEVEL (all upper-cased) or DEBUG_LEVEL environment variables to DEBUG to add additional information in the console for the launched service. It defaults to INFO. (Please note that setting DEBUG_LEVEL to DEBUG will produce tons of logs.)

The possible values are NOTSET, DEBUG, INFO, WARNING, ERROR, and FATAL. Those values are from the most verbose, NOTSET, which shows all logs, to the least verbose, FATAL, which only shows fatal errors.

If LOCALPUBLISHER_DEBUG_LEVEL is not defined then the value of DEBUG_LEVEL is used (or INFO if DEBUG_LEVEL is not defined either).

Access logs are only shown at NOTSET and DEBUG levels.

Configuration file

This plugin has a configuration file (localpublisher.yaml by default) that describes the common service configuration options.

If no configuration file is found it will default to the following values:

kind: ServiceConfig
current-context: default
- name: default
    port: 443
    ssl_context: adhoc
      token: invalid-token
    target: /app/data

The configuration included in the ‘allinone’ image is described in “Common settings.” The listening port is 7783 and the bind address is as the service exposes no user-facing endpoints.

There is one service-specific configuration option besides the common ones that must be specified, target.


The target entry in the context specifies a target directory. Attachments will be stored in this directory, under a {workflow_id}/{filename} key.

This directory is typically a mount point, linked to an external volume.


The local publisher plugin subscribes to the following events:

kind apiVersion

The local publisher plugin exposes an /inbox endpoint that is used by the event bus to post relevant events.

Launch command

If you want to manually start the local publisher plugin, use the following command:

python -m opentf.plugins.localpublisher.main [--context context] [--config configfile]

Additional command-line options are available and described in “Command-line options.”