Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status

RSS

sanity (38) Versions 4.3.0

Standardize configuration of various machines (VM, cloud, bare metal, etc.) with a common set of packages and settings

Policyfile
Berkshelf
Knife
cookbook 'sanity', '= 4.3.0', :supermarket
cookbook 'sanity', '= 4.3.0'
knife supermarket install sanity
knife supermarket download sanity
README
Dependencies
Changelog
Quality 33%

Sanity Cookbook

Funding
Cookbook
Build Status

chef-sanity brings back your sanity as a sysadmin.

This cookbook helps you standardize configuration on various machines.
It applies a common set of packages and settings to any machine (VM, cloud, bare metal, etc.) so you have a solid base to build on.

Here are some highlights of what it does:

  • sets up a basic firewall with nftables to block incoming connections (IPv4 and IPv6)
  • sets up NTP and set timezone to UTC
  • sets up a reliable DNS resolver
  • sets up automatic package updates
  • hardens sshd config with public key authentication and strong ciphers
  • sets up a local Mail Transfer Agent using Postfix to send emails to sysadmin
  • sets up Monit to alert sysadmin when CPU, memory, disk, etc. is overused
  • sets up SMART to monitor hard drive failures
  • installs a few useful packages like tmux, btop, curl, etc.
  • hardens various OS settings for better security

Recipes

sanity::default is a curated list of recipes that should fit most setups.

You can include extra recipes as you see fit.

Customizing Postfix

sanity::postfix configures Postfix with the postfix 'default' resource from the postfix cookbook.
To customize it, edit that resource from a wrapper recipe after including sanity, e.g. to send emails through a relayhost with SASL authentication:

include_recipe 'sanity'

edit_resource!(:postfix, 'default') do
  main_settings(
    main_settings.merge(
      'relayhost' => '[email-smtp.us-west-2.amazonaws.com]:587',
      'smtp_sasl_auth_enable' => 'yes', # also configures SASL using the credentials below
    ),
  )
  sasl('[email-smtp.us-west-2.amazonaws.com]:587' => { 'username' => 'AKIA...', 'password' => 'secret' })
end

License

MIT

Dependent cookbooks

apt ~> 7.7
os-hardening ~> 4.2
postfix ~> 7.0
resolver ~> 4.2
ssh-hardening ~> 2.9

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Unreleased (changes)

  • TBD

v4.3.0, 2026-11-05 (changes)

  • 60c5db8 - Only run CI on push for master
  • 49f56dd - Configure Monit without the monit-ng cookbook
  • 140bfb7 - Add a ci job to require in branch protection

UPGRADE NOTES:
- no longer depends on the monit-ng cookbook: node['monit'] attributes have no effect anymore, set node['sanity']['monit']['start_delay'] instead of node['monit']['config']['start_delay']
- Monit uses Debian's /etc/monit/monitrc, which is restored where monit-ng had replaced it, and sanity's settings are in /etc/monit/conf.d/sanity.conf: Monit gets a new id and starts with a fresh state once, since its id file, state file and event queue move to Debian's paths under /var/lib/monit

v4.2.0, 2026-11-05 (changes)

  • 029c5fe - Drop support for Ubuntu
  • c86904c - Use Supermarket versions of os-hardening and ssh-hardening
  • b649a1a - Create /etc/sysctl.conf for Chef < 19.4.20 instead of in tests

UPGRADE NOTES:
- dropped support for Ubuntu, Debian 13 is the only supported platform

v4.1.0, 2026-11-05 (changes)

  • 74acb32 - Update Postfix TLS settings to TLSRef guideline v6.0
  • a7e5561 - Make Postfix use IPv4 only when IPv6 is disabled
  • 789339a - Fix "postfix check" warnings
  • bf4e4f2 - Don't chroot Postfix retry service, like upstream's master.cf
  • e3c0f09 - Migrate to postfix cookbook 7.0 custom resources

UPGRADE NOTES:
- requires the postfix cookbook 7.0, which replaced its recipes and attributes with custom resources: wrappers should edit the postfix 'default' resource with edit_resource! (see README) instead of setting node['postfix'] attributes, which the resource properties set by sanity take precedence over
- SASL is configured when smtp_sasl_auth_enable is yes on the postfix 'default' resource instead of when node['postfix']['sasl'] is set
- Postfix uses IPv4 only when node['sanity']['ipv6'] is false: set node['sanity']['postfix']['inet_protocols'] (instead of node['postfix']['main']['inet_protocols']) to override it
- outbound SMTP requires TLS 1.2 or later (TLS 1.0 and 1.1 were allowed)
- Postfix uses compatibility_level = 3.6: mynetworks only covers the host itself instead of its subnets, so other hosts on the local network can no longer relay through it, and relay_domains is empty

v4.0.0, 2026-10-29 (changes)

  • 708d739 - Test against Cinc 19 and make it the default
  • 049f7ec - Update Berksfile.lock for 4.0.0
  • e02f431 - Remove Gemfile workarounds for missing dependencies
  • d5d2e16 - Fix TESTING.md since tests run with Docker, not Vagrant
  • bb06368 - Merge identical control waiver files
  • 1e6329e - Use RSpec expect syntax to fix deprecation warning
  • bbefe05 - Fix Chef warning about only_if block returning a string
  • 3a714b8 - Remove firewall type attribute
  • 87ce987 - Remove UsePrivilegeSeparation setting
  • 00f60f3 - Remove obsolete apt-transport-https package and Debian family checks
  • a811618 - Remove broken workstation recipe
  • e14b1c9 - Use Ruby 4.0
  • e48f74f - Drop support for Debian 12 and Ubuntu 24.04
  • 88894df - Don't commit Gemfile.lock
  • 3d5617d - Update GitLab CI to test against Ubuntu 26.04 LTS
  • b3ed23d - Bump firewall rate limits to prevent false positives
  • aab72d5 - Update dependencies
  • 2cdecd0 - Check NVMe's wear daily and email warning when over 80%
  • 799965d - Test against Ubuntu 26.04 LTS
  • 06179b3 - Update deprecated GitHub Action
  • 5b7f116 - Update dependencies
  • 5a9b1e1 - Update dependencies
  • 361648d - Allow mDNS
  • 0410211 - Bump smartd temperature warning threshold
  • 8de24de - Update dependencies
  • aed8ec2 - Tweak Rubocop config
  • 601749c - Replace /etc/network/interfaces with systemd-networkd
  • a5652d6 - Update dependencies
  • baca577 - Update dependencies
  • a6ccdd5 - Update aws-sdk-s3 and other Gems
  • 31c1923 - Don't use Ruby 4.0 yet

BREAKING CHANGES:
- dropped support for Debian 12, Debian 13 is now the minimum
- dropped support for Ubuntu 24.04, Ubuntu 26.04 is now the minimum
- removed the sanity::workstation recipe (it was broken)
- removed node['sanity']['firewall']['type'] since nftables is the only supported firewall
- replaced /etc/network/interfaces with systemd-networkd (enabled by default, set node['sanity']['network']['interfaces']['manage'] to false to opt out): this requests a reboot, and custom files in /etc/network/interfaces.d make the Chef run fail

v3.14.0, 2025-12-18 (changes)

  • 5b13f30 - Drop support for legacy iptables
  • 9476d92 - Mark loopback IP addresses as not reachable
  • 2e05f9b - Move rate limiting to more appropriate location
  • 2217bed - Prefix all log entries with nftables for easy grep'ing
  • c269fa4 - Refactor ICMP traffic handling
  • 89fc043 - Allow traceroute requests
  • c8d4eb8 - Use per-IP rate limit to prevent blocking legitimate users
  • 26138e6 - Fix GitLab CI
  • e04a243 - Tweak GitHub workflow
  • 2a2de6f - Fix test suite for Debian 13
  • 965d8ce - Update dependencies
  • d1443de - Rotate auditd logs when free disk space is less than 30%
  • 3aad5bf - Make sure package systemd-timesyncd is installed when required
  • d3cc786 - Always set net.ipv6.conf.all.disable_ipv6 value
  • 12a38b9 - Tweak firewall logging
  • f4fa5ca - Schedule GitHub Actions monthly
  • 93e0cab - Define some helpful aliases for the sysadmin
  • e766802 - Replace htop with btop
  • 1d90d25 - Update dependencies
  • 5abf045 - Add support for Debian 13 and drop Debian 11
  • 3007af7 - Use more generic env variable to detect test environment

v3.13.2, 2025-07-15 (changes)

  • 8f31641 - Remove SSH rate limit altogether

v3.13.1, 2025-07-13 (changes)

  • 88866c1 - Loosen up SSH rate limit
  • 6e603d4 - Don't fail when non-free packages are found
  • b22c5d7 - Fix Rubocop violations
  • bc04f7c - Don't add Signed-By attribute for APT repositories
  • 89ad1dc - Update dependencies
  • e4ca551 - Update dependencies
  • f180ce4 - Update dependencies

v3.13.0, 2025-03-08 (changes)

  • 6a1439c - Allow custom forward rules with nftables
  • 4ead418 - Don't run iptables tests when firewall is nftables
  • 51edfe7 - Pin CI to Ruby 3.3 until berkshelf is compatible with 3.4
  • fa30442 - Update dependencies

v3.12.1, 2025-01-07 (changes)

  • a3a624b - Don't purge iptables package when using nftables

v3.12.0, 2024-12-07 (changes)

  • afbdbee - Update dependencies
  • 8137901 - Notify when systemd services fail
  • 7a370f9 - Don't include email headers in Telegram message
  • 173f811 - Update dependencies
  • 6bc0ffd - Update dependencies

v3.11.0, 2024-09-02 (changes)

  • 731493b - Update dependencies
  • e8376fe - Allow disabling smartmontools

v3.10.1, 2024-07-08 (changes)

  • c866537 - Drop deprecated LLMNR protocol in favor of mDNS

v3.10.0, 2024-06-12 (changes)

  • 49abbee - Allow package lists to be configured as attributes
  • 74a40e9 - Add GitHub funding file
  • fec2e18 - Update dependencies
  • c3d7c0e - Update dependencies

v3.9.1, 2024-03-10 (changes)

  • 909436b - Update dependencies
  • 92dcafb - Trim overly long emails

v3.9.0, 2024-02-15 (changes)

  • 343cd2e - Only catch emails sent to us to prevent infinite loop in some cases
  • d688a47 - Relax overly secure Postfix security level
  • cc33369 - Fix deprecation warning about Node.js 16
  • 099392d - Update k8s-ruby to support Ruby 3.3
  • ccd26e5 - Revert "Pin Ruby to 3.2 on GitHub Actions"

v3.8.1, 2024-02-12 (changes)

  • bf77882 - Don't process dummy "manage" network interface

v3.8.0, 2024-01-08 (changes)

  • 267f1bc - Pin Ruby to 3.2 on GitHub Actions
  • 13e422e - Update dependencies
  • 95512b0 - Prefer IPv6 DNS over IPv4
  • 6bdfec2 - Limit GitLab CI to Chef 18
  • d306738 - Guard all kernel settings to support containers
  • 27c66ce - Remove flaky test
  • b4e589f - Don't disable kexec when unavailable
  • 71e16d3 - Remove obsolete Nginx attributes

v3.7.0, 2023-11-18 (changes)

  • 1f35fea - Add some more kernel hardening settings
  • e7886bc - Don't allow failures on GitLab CI
  • a49f1dc - Update dependencies
  • 9384e49 - Prevent flaky build on GitLab

v3.6.1, 2023-10-19 (changes)

  • 1ec62a5 - Don't truncate Telegram messages on special characters

v3.6.0, 2023-10-17 (changes)

  • eb808ce - Simplify Postfix email forwarding using virtual aliases
  • 0921d3b - Add support for Postfix to Telegram forwarding
  • a59cf1f - Make sure to forward all emails to root
  • 427bb03 - Update dependencies

v3.5.0, 2023-09-17 (changes)

  • 35f1249 - Make sure systemd-resolved is installed on Debian 12
  • 584f6c3 - Don't set swappiness in containers
  • 266a0a9 - Update dependencies
  • 86a185b - Fix bad build badge in README

v3.4.1, 2023-08-02 (changes)

  • 35ca276 - Accept proper sshd port in nftables firewall

v3.4.0, 2023-08-02 (changes)

  • 3cc8a75 - Add basic rate limiting to nftables
  • 935ff10 - Add custom nftables chain to easily add extra rules

v3.3.0, 2023-07-27 (changes)

  • f65bd46 - Harden sshd config and disable RSA host key
  • ce11ca3 - Set up GitHub workflow to run Test Kitchen
  • 67e4ff1 - Update dependencies
  • 35cae39 - Fix Rubocop violations
  • 551d602 - Add support for nftables

v3.2.1, 2023-06-22 (changes)

  • bac6693 - Fix coredump detection

v3.2.0, 2023-05-26 (changes)

  • 8dd8eb4 - Drop support for Chef 17 and Debian 10
  • 45a48e0 - Update dependencies
  • 5f14ba9 - Log coredumps with systemd and fail run if any are found

v3.1.1, 2023-05-06 (changes)

  • 85b1a6f - Bump SMART warnings to max temperature to avoid false alerts
  • 29dcb7d - Update dependencies

v3.1.0, 2023-04-22 (changes)

  • 94372d7 - Test against multiple Chef versions
  • 401fe68 - Add missing Gems for GitLab CI
  • efeaf00 - Update documentation for release 3.1.0
  • 4549de8 - Move connectivity checks to an InSpec Profile
  • bac767d - Don't install Chef/Cinc tools via Gemfile

v3.0.0, 2023-04-12 (changes)

  • 35a16e3 - Add preliminary support for Ubuntu LTS
  • 3d299c5 - Fix GitLab CI integration
  • 69d3573 - Update dependencies
  • 3507b17 - Fix Kitchen CI test suite
  • fcf3c4e - Don't remove nfs-common and rpcbind as they are useful in some cases
  • 00eb0af - Update dependencies
  • e6134f6 - Update dependencies
  • d08a99a - Add missing entry for Postfix retry service
  • e5ec977 - Modernize Postfix SSL/TLS config
  • a4cde65 - Fix UTC timezone for Debian 11
  • 09e9d12 - Increase SMART temperature warnings to avoid false positive spam
  • 91e6c6b - Update dependencies
  • 5c970d9 - Increase SMART temperature warnings to avoid false positive spam
  • 2e48b66 - Fix systemctl path for Debian 11
  • a6e1cb0 - Enable automatic SMART checks
  • a4c3988 - Update dependencies
  • 2db3496 - Use systemctl reboot instead of reboot
  • 260b286 - Listen on IPv4 as well when IPv6 is enabled
  • 48cebf6 - Use a more reliable method to check for DNSSEC
  • b66877c - Refactor cookbook for new major version 3

BREAKING CHANGES:
- dropped support for Debian 9
- replaced EULA Chef with Free Software CINC
- renamed node['sanity']['firewall'] to node['sanity']['firewall']['type']
- renamed node['sanity']['iptables']['ssh_authorized_ips_v4'] to node['sanity']['firewall']['ssh_authorized_ips_v4']
- renamed node['sanity']['iptables']['ssh_authorized_ips_v6'] to node['sanity']['firewall']['ssh_authorized_ips_v6']

v2.2.0, 2022-03-07 (changes)

  • cc6b956 Fix the build for new ruby Docker image
  • f62fe38 Extract DNS servers as attributes
  • 7ce7c73 Switch from Vagrant to kitchen-dokken
  • 102b594 Use systemd resolved for DNS
  • ba5784e Drop support for discontinued CentOS
  • a92a0d7 Set up network interfaces automatically
  • a1ea577 Don't log unhandled UDP traffic
  • 62c6685 Update dependencies
  • 8b6f949 Use new Chef resource to set timezone to UTC
  • e9d43b6 Update dependencies
  • a6be455 Make sure ntp package is uninstalled
  • a9f0248 Use ShellOut to comply with http://www.foodcritic.io/#FC048
  • da74ae0 Update Gems
  • ba11518 Check free space on all regular filesystems
  • 17dfb8a Forward all unknown local recipients to root

v2.1.0, 2020-06-23 (changes)

  • ffd9a59 Allow to whitelist non-free packages
  • a7be684 Bump rack from 2.2.2 to 2.2.3
  • 5370c31 Update dependencies
  • 0ff3153 Bump activesupport from 5.2.4.1 to 5.2.4.3
  • 50f5892 Keep old config upon updating package with conflict
  • 26b20d9 Make sure the ping program is installed
  • aa5eb33 Don't run Postfix in backwards-compatible mode
  • 2588893 Set smtpd_relay_restrictions for newer Postfix versions
  • 857feb1 Bump nokogiri from 1.10.7 to 1.10.8
  • f1a0f0e Fix broken NTP detection on Debian 10
  • 643c390 Update dependencies
  • 36272f5 Rename auto_reboot to automatic_reboot
  • e91f8b7 Don't recreate the backports repo on every Chef run
  • 2669d5e Use platform helper to make Cookstyle happy
  • 69e8b40 Bump version to 2.1.0
  • ff6ec90 Use numeric ports for NetBIOS
  • d073819 Enable backports on Debian Buster to get Monit package
  • 4bc1912 Update dependencies
  • e2053d6 Test against Debian 10
  • 5d78c58 Don't log UDP broadcast spam
  • 9d1b48e Update dependencies
  • 6fe120a Make sure apt-transport-https package is installed
  • 3612e01 Update dependencies

v2.0.1, 2019-08-23 (changes)

  • [BUGFIX] Don't email about successful package upgrades
  • [BUGFIX] Update Gems
  • [BUGFIX] Use built-in apt_update resource

v2.0.0, 2019-06-19 (changes)

  • First stable release. Enjoy!

v1.0.0 to v1.3.0, 2018-02-17 to 2019-06-19 (changes)

  • Experimental pre-releases. You should avoid to use these versions.

Collaborator Number Metric
            

4.3.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

4.3.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Cookstyle Metric
            

4.3.0 passed this metric

No Binaries Metric
            

4.3.0 passed this metric

Testing File Metric
            

4.3.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

4.3.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number

Copyright © 2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.

Progress and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries.
See Trademarksfor appropriate markings. All rights in any other trademarks contained herein are reserved by their respective owners and their inclusion does not imply an endorsement, affiliation, or sponsorship as between Progress and the respective owners.

Code of Conduct Terms and Conditions of Use Privacy Policy Cookie Policy Trademark Policy Status