Installation

The extension must be installed into the same Python environment Salt uses on each minion you want OpenRC service support on. Saltexts are not distributed automatically via the fileserver like custom modules.

:::{tab} State

Install saltext-openrc:
  pip.installed:
    - name: saltext-openrc

:::

:::{tab} Onedir installation

salt-pip install saltext-openrc

:::

:::{tab} Regular installation

pip install saltext-openrc

Salt itself is expected to be provided by the environment. If it should be pip-managed as well, request the salt extra:

pip install 'saltext-openrc[salt]'

:::

:::{hint} On many OpenRC-based distributions Salt uses the system Python, so a regular pip install is correct for most setups. If you have installed Salt into a virtual environment, activate it first. :::

Verifying the installation

After installing, confirm that Salt has loaded the module on your minion:

salt <minion-id> sys.doc service.start

This should return documentation pulled from this extension. If it returns nothing or shows a different provider, see :ref:module-provider-override in the Salt documentation.