cdist-contrib
=============

This project extends the `cdist <https://www.cdi.st/>`__ configuration
management tool with community-maitained types which are either too
specific to fit/be maintained in cdist itself or were not accepted in
code cdist but could still be useful.

This project does not have releases and is continously updated: see git
history for change log. You will find HTML documentation at
`contrib.cdi.st <https://contrib.cdi.st>`__.

Using cdist-contrib
-------------------

We would recommend that you clone this repository next to your regular
cdist config directory, then setup ``conf_dir`` with relative paths in
`cdist
configuration <https://www.cdi.st/manual/latest/cdist-configuration.html>`__.

An example of this would be:

.. code:: ini

   # contents of cdist.cfg next to cdist-contrib
   [GLOBAL]
   # Notice that types defined in last dir win and can override native types.
   # Consider using a prefix for your own types to avoid collisions.
   conf_dir = cdist-contrib:cdist-private

And you would run `cdist <https://www.cdi.st/>`__ from the same
directory as follows:

::

   cdist config -g cdist.cfg
   # Or setup your CDIST_CONFIG_FILE environment variable and run as usual

.. _participating-in-the-cdistcdist-community:

Participating in the `cdist <https://www.cdi.st/>`__ community
--------------------------------------------------------------

Join us on
`#cdist:ungleich.ch <https://matrix.to/#/#cdist:ungleich.ch>`__ on
matrix!

Contributing
------------

The preferred way to submit patches is by opening Merge Requests against
the `cdist-contrib project on
code.ungleich.ch <https://code.ungleich.ch/ungleich-public/cdist-contrib>`__
(you can make an account on
`account.ungleich.ch <https://account.ungleich.ch/>`__.

Every type in cdist-contrib must:

-  Have a ``man.rst`` documentation page.
-  Pass `shellcheck <http://shellcheck.net/>`__ without errors.

Other resources
---------------

Some people/organizations are known to keep some cdist types that might
be of interest to others:

-  `cdist-evilham <https://git.sr.ht/~evilham/cdist-evilham>`__:
   Evilham’s cdist-types
-  `cdist-recycledcloud <https://code.recycled.cloud/RecycledCloud/cdist-recycledcloud>`__:
   e-Durable SA / Recycled Cloud public types
-  `cdist-ungleich <https://code.ungleich.ch/ungleich-public/cdist-ungleich>`__:
   ungleich public types

.. toctree::
   :hidden:

      __bird_bgp <man7/cdist-type__bird_bgp>
      __bird_core <man7/cdist-type__bird_core>
      __bird_filter <man7/cdist-type__bird_filter>
      __bird_function <man7/cdist-type__bird_function>
      __bird_kernel <man7/cdist-type__bird_kernel>
      __bird_ospf <man7/cdist-type__bird_ospf>
      __bird_radv <man7/cdist-type__bird_radv>
      __bird_static <man7/cdist-type__bird_static>
      __borg_repo <man7/cdist-type__borg_repo>
      __coturn <man7/cdist-type__coturn>
      __dma <man7/cdist-type__dma>
      __dma_auth <man7/cdist-type__dma_auth>
      __find_exec <man7/cdist-type__find_exec>
      __jitsi_meet <man7/cdist-type__jitsi_meet>
      __jitsi_meet_domain <man7/cdist-type__jitsi_meet_domain>
      __jitsi_meet_user <man7/cdist-type__jitsi_meet_user>
      __jool <man7/cdist-type__jool>
      __mail_alias <man7/cdist-type__mail_alias>
      __matrix_element <man7/cdist-type__matrix_element>
      __matrix_synapse <man7/cdist-type__matrix_synapse>
      __matrix_synapse_worker <man7/cdist-type__matrix_synapse_worker>
      __matterbridge <man7/cdist-type__matterbridge>
      __netbox <man7/cdist-type__netbox>
      __netbox_gunicorn <man7/cdist-type__netbox_gunicorn>
      __netbox_uwsgi <man7/cdist-type__netbox_uwsgi>
      __networktime <man7/cdist-type__networktime>
      __nextcloud <man7/cdist-type__nextcloud>
      __nextcloud_app <man7/cdist-type__nextcloud_app>
      __nextcloud_user <man7/cdist-type__nextcloud_user>
      __nginx <man7/cdist-type__nginx>
      __nginx_vhost <man7/cdist-type__nginx_vhost>
      __opendkim <man7/cdist-type__opendkim>
      __opendkim_genkey <man7/cdist-type__opendkim_genkey>
      __pass <man7/cdist-type__pass>
      __pass_init <man7/cdist-type__pass_init>
      __runit <man7/cdist-type__runit>
      __runit_service <man7/cdist-type__runit_service>
      __single_binary_service <man7/cdist-type__single_binary_service>
      __systemd_network <man7/cdist-type__systemd_network>
      __systemd_resolved <man7/cdist-type__systemd_resolved>
      __uacme_account <man7/cdist-type__uacme_account>
      __uacme_obtain <man7/cdist-type__uacme_obtain>
      __unbound <man7/cdist-type__unbound>
      __unbound_exporter <man7/cdist-type__unbound_exporter>
      __wikijs <man7/cdist-type__wikijs>
      __wireguard <man7/cdist-type__wireguard>
      __wireguard_peer <man7/cdist-type__wireguard_peer>