Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/admin-guide/files/index.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Configuration Files
logging.yaml.en
parent.config.en
plugin.config.en
plugin.yaml.en
records.yaml.en
remap.config.en
remap.yaml.en
Expand Down Expand Up @@ -63,6 +64,10 @@ Configuration Files
Control runtime loadable plugins available to |TS|, as well as their
configurations.

:doc:`plugin.yaml.en`
YAML-based alternative to :doc:`plugin.config.en` with support for
disabling plugins, explicit load ordering, and inline configuration.

:doc:`records.yaml.en`
Contains many configuration variables affecting |TS| operation.

Expand Down
26 changes: 26 additions & 0 deletions doc/admin-guide/files/plugin.config.en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,31 @@ plugin.config

.. configfile:: plugin.config

.. warning::

**Use** :file:`plugin.yaml` **instead.** The :file:`plugin.config` format is
maintained for backward compatibility but :file:`plugin.yaml` is the
recommended way to configure global plugins. It supports disabling plugins
without deleting lines, explicit load ordering, and inline configuration.

If :file:`plugin.yaml` exists in the configuration directory, |TS| will load
plugins from it and ignore :file:`plugin.config` entirely.

See :doc:`plugin.yaml.en` for the full reference.

**Migrating:** use ``traffic_ctl`` to convert an existing file automatically:

.. code-block:: bash

# Preview the converted output on stdout
traffic_ctl config convert plugin_config plugin.config -

# Write directly to plugin.yaml
traffic_ctl config convert plugin_config plugin.config plugin.yaml

Commented-out lines in :file:`plugin.config` are converted to
``enabled: false`` entries. Pass ``--skip-disabled`` to drop them instead.

Description
===========

Expand Down Expand Up @@ -71,6 +96,7 @@ Examples
See Also
========

:doc:`plugin.yaml.en`,
:manpage:`TSAPI(3ts)`,
:manpage:`TSPluginInit(3ts)`,
:manpage:`remap.config(5)`
Loading