{"id":18289823,"url":"https://github.com/tiredofit/docker-spamassassin","last_synced_at":"2025-04-05T09:31:47.473Z","repository":{"id":88408075,"uuid":"104505605","full_name":"tiredofit/docker-spamassassin","owner":"tiredofit","description":"Dockerized spam filter","archived":false,"fork":false,"pushed_at":"2024-12-08T01:13:34.000Z","size":49,"stargazers_count":32,"open_issues_count":3,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-21T02:22:00.286Z","etag":null,"topics":["alpine","antispam","docker","razor","spamassassin","spamd","zabbix"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tiredofit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["tiredofit"]}},"created_at":"2017-09-22T18:22:57.000Z","updated_at":"2025-01-25T16:22:30.000Z","dependencies_parsed_at":"2023-11-22T18:44:30.825Z","dependency_job_id":"5c9d6b07-71c0-41e1-837f-dd0c8cb09c0b","html_url":"https://github.com/tiredofit/docker-spamassassin","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-spamassassin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-spamassassin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-spamassassin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiredofit%2Fdocker-spamassassin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiredofit","download_url":"https://codeload.github.com/tiredofit/docker-spamassassin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247318271,"owners_count":20919457,"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":["alpine","antispam","docker","razor","spamassassin","spamd","zabbix"],"created_at":"2024-11-05T14:08:24.844Z","updated_at":"2025-04-05T09:31:43.698Z","avatar_url":"https://github.com/tiredofit.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/tiredofit","https://www.paypal.me/tiredofit"],"categories":[],"sub_categories":[],"readme":"# github.com/tiredofit/docker-spamassassin\n\n[![GitHub release](https://img.shields.io/github/v/tag/tiredofit/docker-spamassassin?style=flat-square)](https://github.com/tiredofit/docker-spamassassin/releases/latest)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/tiredofit/docker-spamassassin/main.yml?branch=main\u0026style=flat-square)](https://github.com/tiredofit/docker-spamassassin/actions)\n[![Docker Stars](https://img.shields.io/docker/stars/tiredofit/spamassassin.svg?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/tiredofit/spamassassin/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/tiredofit/spamassassin.svg?style=flat-square\u0026logo=docker)](https://hub.docker.com/r/tiredofit/spamassassin/)\n[![Become a sponsor](https://img.shields.io/badge/sponsor-tiredofit-181717.svg?logo=github\u0026style=flat-square)](https://github.com/sponsors/tiredofit)\n[![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal\u0026style=flat-square)](https://www.paypal.me/tiredofit)\n\n\n## About\n\nThis will build a Docker Image for [Spamassassin](https://spamassassin.apache.org) - A message content scanner for spam.\n## Maintainer\n\n- [Dave Conroy](https://github.com/tiredofit/)\n\n## Table of Contents\n\n- [Introduction](#introduction)\n    - [Changelog](CHANGELOG.md)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Quick Start](#quick-start)\n- [Configuration](#configuration)\n    - [Data Volumes](#data-volumes)\n    - [Environment Variables](#environmentvariables)\n- [Maintenance](#maintenance)\n    - [Shell Access](#shell-access)\n   - [References](#references)\n\n## Prerequisites and Assumptions\n\n- This image doesn't do much on it's own, you must use a complemenary service to pass messages or data to it via port 783.\n\n## Installation\n### Build from Source\nClone this repository and build the image with `docker build -t (imagename) .`\n\n### Prebuilt Images\nBuilds of the image are available on [Docker Hub](https://hub.docker.com/r/tiredofit/spamassassin)\n\n```bash\ndocker pull docker.io/tiredofit/spamassassin:(imagetag)\n```\nBuilds of the image are also available on the [Github Container Registry](https://github.com/tiredofit/docker-spamassassin/pkgs/container/docker-spamassassin) \n \n```\ndocker pull ghcr.io/tiredofit/docker-spamassassin:(imagetag)\n``` \n\nThe following image tags are available along with their tagged release based on what's written in the [Changelog](CHANGELOG.md):\n\n| Container OS | Tag       |\n| ------------ | --------- |\n| Alpine       | `:latest` |\n\n#### Multi Architecture\nImages are built primarily for `amd64` architecture, and may also include builds for `arm/v7`, `arm64` and others. These variants are all unsupported. Consider [sponsoring](https://github.com/sponsors/tiredofit) my work so that I can work with various hardware. To see if this image supports multiple architecures, type `docker manifest (image):(tag)`\n\n## Configuration\n\n### Quick Start\n\n* The quickest way to get started is using [docker-compose](https://docs.docker.com/compose/). See the examples folder for a working [compose.yml](examples/compose.yml) that can be modified for development or production use.\n\n* Set various [environment variables](#environment-variables) to understand the capabilities of this image.\n* Map [persistent storage](#data-volumes) for access to configuration and data files for backup.\n### Persistent Storage\n\nThe following directories are used for configuration and can be mapped for persistent storage.\n\n| Directory  | Description                         |\n| ---------- | ----------------------------------- |\n| `/logs/`   | Spamassassin Logs                   |\n| `/config/` | Configuration                       |\n| `/data/`   | Volatile Data (Downloaded Patterns) |\n\n* * *\n### Environment Variables\n\n#### Base Images used\n\nThis image relies on an [Alpine Linux](https://hub.docker.com/r/tiredofit/alpine) base image that relies on an [init system](https://github.com/just-containers/s6-overlay) for added capabilities. Outgoing SMTP capabilities are handlded via `msmtp`. Individual container performance monitoring is performed by [zabbix-agent](https://zabbix.org). Additional tools include: `bash`,`curl`,`less`,`logrotate`,`nano`,`vim`.\n\nBe sure to view the following repositories to understand all the customizable options:\n\n| Image                                                  | Description                            |\n| ------------------------------------------------------ | -------------------------------------- |\n| [OS Base](https://github.com/tiredofit/docker-alpine/) | Customized Image based on Alpine Linux |\n\n| Parameter               | Description                             | Default                  |\n| ----------------------- | --------------------------------------- | ------------------------ |\n| `CHILD_MAX`             | Max Children                            | `5`                      |\n| `CHILD_MAX_CONNECTIONS` | Max connections per child               | `200`                    |\n| `CHILD_MAX_SPARE`       | Max Spare Children                      | `2`                      |\n| `CHILD_MIN`             | Minimum Child Process                   | `1`                      |\n| `CHILD_MIN_SPARE`       | Minimum Spare Children                  | `1`                      |\n| `CONFIG_PATH`           | Config directory                        | `/config/`               |\n| `DATA_PATH`             | Updates / Rulesets directory            | `/data/`                 |\n| `ENABLE_LEARNING`       | Enable Learning/Reporting               | `TRUE`                   |\n| `ENABLE_ROUND_ROBIN`    | Enable Roundrobin Forking for childs    | `FALSE`                  |\n| `ENABLE_UPDATES`        | Enable Ruleset Updates                  | `TRUE`                   |\n| `LISTEN_PORT`           | TCP Listen Port                         | `783`                    |\n| `LOG_FILE`              | Log File                                | `spamassassin.log`       |\n| `LOG_PATH`              | Log Logcation                           | `/logs/`                 |\n| `PID_FILE`              | PID File                                | `spamassassin.pid`       |\n| `PID_PATH`              | PID Path                                | `/var/run/spamassassin/` |\n| `TIMEOUT_CHILD`         | Child Timeout in Seconds                | `300`                    |\n| `TIMEOUT_IDENT`         | Ident Timeout in Seconds                | `5`                      |\n| `TIMEOUT_TCP`           | TCP Timeout in Seconds                  | `30`                     |\n| `UPDATE_PERIOD`         | Cron Expression when to perform updates | `15 23 * * *`            |\n\n### Networking\n\n| Port  | Description                 |\n| ----- | --------------------------- |\n| `783` | Spamassassin Listening Port |\n\n## Maintenance\n### Shell Access\n\nFor debugging and maintenance purposes you may want access the containers shell.\n\n```bash\ndocker exec -it (whatever your container name is) bash\n```\n\n## Support\n\nThese images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.\n### Usage\n- The [Discussions board](../../discussions) is a great place for working with the community on tips and tricks of using this image.\n- [Sponsor me](https://tiredofit.ca/sponsor) for personalized support\n### Bugfixes\n- Please, submit a [Bug Report](issues/new) if something isn't working as expected. I'll do my best to issue a fix in short order.\n\n### Feature Requests\n- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.\n- [Sponsor me](https://tiredofit.ca/sponsor) regarding development of features.\n\n### Updates\n- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.\n- [Sponsor me](https://tiredofit.ca/sponsor) for up to date releases.\n\n## License\nMIT. See [LICENSE](LICENSE) for more details.\n\n## References\n\n* https://spamassassin.apache.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-spamassassin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiredofit%2Fdocker-spamassassin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiredofit%2Fdocker-spamassassin/lists"}