ungleich-public/cdist-contrib
ungleich-public
/
cdist-contrib
7
2
Fork 3
Code Issues 5 Pull Requests 5 Projects Releases Wiki Activity
Community maintained cdist types.
355 Commits 9 Branches 0 Tags 2.2 MiB
Shell 97.5%
Awk 2%
Makefile 0.4%
Go to file
evilham ecd10de2d3
[__opendkim*] FreeBSD support and minor fixes 
While adding FreeBSD support to the type I noticed various issues:

- We were making sure that the KeyTable and SigningTable were created in
  __opendkim_genkey, but that was being done with the default cdist permissions
  (0400) which could result in issues when reloading the service after privilege
  drop.
  This is addressed by checking that it exists/creating it in __opendkim (just
  once, not once per __opendkim_genkey call) with laxer permissions (0444).
- In __opendkim, the service was being started after the config file was
  installed. This is insufficient as OpenDKIM will refuse to start with the
  generated config if either SigningTable or KeyTable do not exist yet.
- __opendkim_genkey had the implicit assumption that the --directory parameter
  always ended in a slash. This was not documented and error-prone; we are now
  a bit laxer and add the trailing slash if it is missing.
- __opendkim_genkey was not changing permissions for the resulting .txt file.
  This was not critical for it to function, but it was inconsistent.
- As documented in #17, __opendkim allows for a --userid parameter that might
  cause issues with keys generated by __opendkim_genkey.
  This issue has not been addressed yet, but I recommend deprecating the
  --userid parameter.
 		2022-03-10 20:08:51 +01:00
docs/src Generate documentation homepage from README 2021-01-11 11:34:54 +01:00
scripts Fix run-shellcheck.sh following 'conflict resolution' from gitlab web ui 2021-01-12 07:14:24 +01:00
type [__opendkim*] FreeBSD support and minor fixes 2022-03-10 20:08:51 +01:00
.gitignore Add basic CI configuration 2020-05-07 09:37:30 +02:00
.gitlab-ci.yml ci: do not run docs job in forks 2021-02-16 13:47:09 +01:00
LICENSE Initial project structure, README 2020-04-21 08:02:51 +02:00
Makefile Import html/man doc generation logic from upstream cdist 2021-01-04 11:08:55 +01:00
README.md Update cdist-recycledcloud URL in README 2021-02-16 13:36:29 +01:00

README.md

cdist-contrib

This project extends the cdist 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.

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.

An example of this would be:

# 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 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 cdist community

Join us on #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 (you can make an account on account.ungleich.ch.

Every type in cdist-contrib must:

  • Have a man.rst documentation page.
  • Pass shellcheck without errors.

Other resources

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