diff --git a/docs/configuration/index.md b/docs/configuration/index.md index dab7f6135..48f1350ec 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -25,6 +25,7 @@ Some configuration parameters are primarily controlled via NetBox's admin interf * [`CUSTOM_VALIDATORS`](./data-validation.md#custom_validators) * [`DEFAULT_USER_PREFERENCES`](./default-values.md#default_user_preferences) * [`ENFORCE_GLOBAL_UNIQUE`](./miscellaneous.md#enforce_global_unique) +* [`EVENTS_PIPELINE`](./miscellaneous.md#events_pipeline) * [`GRAPHQL_ENABLED`](./graphql-api.md#graphql_enabled) * [`JOB_RETENTION`](./miscellaneous.md#job_retention) * [`MAINTENANCE_MODE`](./miscellaneous.md#maintenance_mode) diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md index 576eb8739..ddcac06ca 100644 --- a/docs/configuration/miscellaneous.md +++ b/docs/configuration/miscellaneous.md @@ -106,6 +106,16 @@ By default, NetBox will prevent the creation of duplicate prefixes and IP addres --- +## EVENTS_PIPELINE + +!!! tip "Dynamic Configuration Parameter" + +Default: ['extras.events.process_event_queue',] + +NetBox will call functions listed here for events (create, update, delete) on models as well as when custom EventRules are fired. + +--- + ## FILE_UPLOAD_MAX_MEMORY_SIZE Default: `2621440` (2.5 MB) diff --git a/docs/plugins/development/index.md b/docs/plugins/development/index.md index f3f9a3e4f..f7c7af4b2 100644 --- a/docs/plugins/development/index.md +++ b/docs/plugins/development/index.md @@ -114,6 +114,7 @@ NetBox looks for the `config` variable within a plugin's `__init__.py` to load i | `max_version` | Maximum version of NetBox with which the plugin is compatible | | `middleware` | A list of middleware classes to append after NetBox's build-in middleware | | `queues` | A list of custom background task queues to create | +| `events_pipeline` | An optional list of functions to add to the [`EVENTS_PIPELINE`](./miscellaneous.md#events_pipeline) | | `search_extensions` | The dotted path to the list of search index classes (default: `search.indexes`) | | `data_backends` | The dotted path to the list of data source backend classes (default: `data_backends.backends`) | | `template_extensions` | The dotted path to the list of template extension classes (default: `template_content.template_extensions`) |