{"id":15157634,"url":"https://github.com/markt-de/puppet-rspamd","last_synced_at":"2025-12-11T21:44:59.275Z","repository":{"id":54692148,"uuid":"89949666","full_name":"markt-de/puppet-rspamd","owner":"markt-de","description":"Puppet module to manage the Rspamd anti spam system","archived":false,"fork":false,"pushed_at":"2024-04-19T10:04:20.000Z","size":230,"stargazers_count":4,"open_issues_count":5,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-30T04:43:07.912Z","etag":null,"topics":["puppet","rspamd"],"latest_commit_sha":null,"homepage":"https://forge.puppet.com/oxc/rspamd","language":"Puppet","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markt-de.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-01T18:15:21.000Z","updated_at":"2024-05-29T14:21:24.348Z","dependencies_parsed_at":"2024-01-16T22:36:45.886Z","dependency_job_id":"46c78688-7434-4f2a-a2c0-83b9698c067f","html_url":"https://github.com/markt-de/puppet-rspamd","commit_stats":null,"previous_names":["oxc/puppet-rspamd"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markt-de%2Fpuppet-rspamd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markt-de%2Fpuppet-rspamd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markt-de%2Fpuppet-rspamd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markt-de%2Fpuppet-rspamd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markt-de","download_url":"https://codeload.github.com/markt-de/puppet-rspamd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219868597,"owners_count":16555871,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["puppet","rspamd"],"created_at":"2024-09-26T20:01:23.905Z","updated_at":"2025-10-24T14:30:39.410Z","avatar_url":"https://github.com/markt-de.png","language":"Puppet","funding_links":[],"categories":[],"sub_categories":[],"readme":"# puppet-rspamd\n\n[![Build Status](https://github.com/markt-de/puppet-rspamd/actions/workflows/ci.yaml/badge.svg)](https://github.com/markt-de/puppet-rspamd/actions/workflows/ci.yaml)\n[![Puppet Forge](https://img.shields.io/puppetforge/v/markt/rspamd.svg)](https://forge.puppetlabs.com/markt/rspamd)\n[![Puppet Forge](https://img.shields.io/puppetforge/dt/markt/rspamd.svg)](https://forge.puppetlabs.com/markt/rspamd)\n\n#### Table of Contents\n\n1. [Description](#description)\n1. [Setup](#setup)\n    * [What rspamd affects](#what-rspamd-affects)\n    * [Beginning with rspamd](#beginning-with-rspamd)\n1. [Usage](#usage)\n1. [Reference](#reference)\n1. [Development](#development)\n    - [Contributing](#contributing)\n\n## Description\n\nThis module installs and manages the Rspamd spam filter, and provides resources\nand functions to configure the Rspamd system. \nIt does, however, not configure the systems beyond the upstream defaults.\n\nPlease note that while all versions starting from 1.6.3 should still be\nsupported, this module is intended to be run with the latest version of Rspamd,\nand compatibility with older versions will not be tested for new releases.\n\n## Setup\n\n### What rspamd affects\n\nBy default, this module...\n\n* installs the rspamd.com package repository for Debian/Ubuntu and RHEL/CentOS/Fedora\n* installs the rspamd package\n* recursively purges all custom rspamd config (e.g. local.d and override.d directories)\n\n### Beginning with rspamd\n\nThe simplest way to use this module is:\n\n```puppet\ninclude rspamd\n```\n\nThis will setup the rspamd service the upstream default configuration.\n\n## Usage\n\nThe rspamd::config resource can be used to specify custom configuration entries.\nThe easiest way to use it, is to put both the file and the hierachical config\nkey into the resource title:\n\n```puppet\nclass { 'rspamd': }\nrspamd::config {\n  'classifier-bayes:backend': value =\u003e 'redis';\n  'classifier-bayes:servers': value =\u003e '127.0.0.1:6379';\n  'classifier-bayes:statfile[0].symbol': value =\u003e 'BAYES_HAM';\n  'classifier-bayes:statfile[0].spam':   value =\u003e false;\n  'classifier-bayes:statfile[1].symbol': value =\u003e 'BAYES_SPAM';\n  'classifier-bayes:statfile[1].spam':   value =\u003e true;\n}\n```\n\nThis results the following config file `/etc/rspamd/local.d/classifier-bayes.conf`:\n\n```\n# This file is managed by Puppet. DO NOT EDIT.\nbackend = redis;\nservers = \"127.0.0.1:6379\";\nstatfile {\n  spam = false;\n  symbol = 'BAYES_HAM';\n}\nstatfile {\n  spam = true;\n  symbol = 'BAYES_SPAM';\n}\n```\n\nUsing the rspamd `$config` parameter, values for multiple config files can\neasily be provided from hiera:\n\n```yaml\nrspamd::config:\n  classifier-bayes:\n    backend: redis\n    servers: \"127.0.0.1:6379\"\n    statfile:\n      - symbol: BAYES_HAM\n        spam: false\n      - symbol: BAYES_SPAM\n        spam: true\n  milter_headers:\n    use:\n      - authentication-results\n      - x-spam-status\n  'worker-proxy.inc':\n    bind_socket: 'localhost:11332'\n    upstream:\n      local:\n        self_scan: true\n  dkim_signing:\n    sign_local: true\n```\n\nThis uses the provided `rspamd::create_config_resources` and `rspamd::create_config_file_resources`\nfunctions, which can be used in custom profiles for extended use cases:\n\n```puppet\nclass profile::mail::rspamd (\n  Hash $config,\n  Hash $override_config,\n) {\n  class { 'rspamd': }\n\n  rspamd::create_config_file_resources($config)\n  rspamd::create_config_file_resources($override_config, { mode =\u003e 'override' })\n}\n```\n\n\n## Reference\n\nClasses and parameters are documented in [REFERENCE.md](REFERENCE.md).\n\n## Development\n\n### Contributing\n\nPlease use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkt-de%2Fpuppet-rspamd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkt-de%2Fpuppet-rspamd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkt-de%2Fpuppet-rspamd/lists"}