{"id":14701023,"url":"https://github.com/antedebaas/Viesti-Reports","last_synced_at":"2025-09-10T08:31:06.077Z","repository":{"id":231398688,"uuid":"681318254","full_name":"antedebaas/Viesti-Reports","owner":"antedebaas","description":"DMARC \u0026 SMTP-TLS Reports processor and visualizer and BIMI file hoster","archived":false,"fork":false,"pushed_at":"2024-12-01T23:02:31.000Z","size":6959,"stargazers_count":85,"open_issues_count":9,"forks_count":15,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-12-31T22:57:11.108Z","etag":null,"topics":["bimi","dmarc","dmarc-aggregate-reports","dmarc-analyzer","dmarc-assistant","dmarc-parser","dmarc-record","dmarc-reports","mta-sts","php","php8","smtp-tls","sts","tlsrpt","tlsrptv1","viesti"],"latest_commit_sha":null,"homepage":"https://docs.viestireports.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/antedebaas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","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":["antedebaas"]}},"created_at":"2023-08-21T18:47:03.000Z","updated_at":"2024-12-28T12:03:54.000Z","dependencies_parsed_at":"2024-05-22T10:29:09.866Z","dependency_job_id":"6611e68d-386b-4602-8ebc-748dd819176a","html_url":"https://github.com/antedebaas/Viesti-Reports","commit_stats":null,"previous_names":["antedebaas/dmarc-smtptls-reports","antedebaas/viesti-reports"],"tags_count":71,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antedebaas%2FViesti-Reports","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antedebaas%2FViesti-Reports/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antedebaas%2FViesti-Reports/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/antedebaas%2FViesti-Reports/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/antedebaas","download_url":"https://codeload.github.com/antedebaas/Viesti-Reports/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232517611,"owners_count":18535833,"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":["bimi","dmarc","dmarc-aggregate-reports","dmarc-analyzer","dmarc-assistant","dmarc-parser","dmarc-record","dmarc-reports","mta-sts","php","php8","smtp-tls","sts","tlsrpt","tlsrptv1","viesti"],"created_at":"2024-09-13T11:01:33.058Z","updated_at":"2025-01-04T20:30:56.267Z","avatar_url":"https://github.com/antedebaas.png","language":"PHP","funding_links":["https://github.com/sponsors/antedebaas"],"categories":["Security"],"sub_categories":["DMARC"],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Docker][docker-shield]][docker-url]\n[![Docker][docker-shield-old]][docker-url-old]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n![Dashboard][screenshot-dashboard]\n![DMARC-Reports][screenshot-dmarc]\n![SMTP-TLS-Reports][screenshot-smtptls]\n\nI needed a quick and easy way to view my DMARC and SMTP-TLS reports.\nIt also provides hosting for BIMI files and Outlook autodiscover.\nThis is a simple symfony project that can read the inbox for new reports and process them.\nI you use it you should use it with a special sole-purpose email address.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n## License\n\nThis project is licenced under the AGPLv3 with some additional terms.\u003cbr\u003e\nThe additional terms are there to prevent rebranding and then pretending someone else made it.\n\u003cbr\u003e\nSee `LICENSE.txt` for both the license and the additional terms below.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Prerequisites\n\n* composer\n* mariadb (10.5+)/postgresql (13+)/sqlite\n* php (8.2+)\n* php-ctype\n* php-curl\n* php-dom\n* php-fileinfo\n* php-fpm\n* php-iconv\n* php-imap\n* php-mbstring\n* php-pdo\n* php-pdo-mysql\n* php-pdo-pgsql\n* php-pdo-sqlite\n* php-phar\n* php-session\n* php-simplexml\n* php-tokenizer\n* php-xml\n* php-xmlwriter\n* php-zip\n* php-zlib (*)\n\n\\* php-zlib is enabled on redhat based systems by default and not availible as a package\n\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/antedebaas/Viesti-Reports.git\n   ```\n2. run update.sh to update project, clear its cache, this prevents symfony caching issues\n   ```sh\n   bash [root path of this project]/update.sh\n   ```\n3. point the webserver root to the public/ directory\n4. point your webbrowser to http(s)://[yourhost]/setup and follow instructions\n5. run installservice.sh to install the systemd service and timer for automated mail checking\n   ```sh\n   bash [root path of this project]/installservice.sh\n   ```\n6. if you put it on https://mta-sts.yourmdomain.ext it will provide an mta-sts policy file (https://mta-sts.yourmdomain.ext/.well-known/mta-sts.txt)\n   you can edit the policy on the domain edit page.\n   It will also host https://autoconfig.yourmdomain.ext and https://autodiscover.yourmdomain.ext outlook autoconfiguration files\n   And it supports BIMI file hosting on https://bimi.yourmdomain.ext\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Usage notes\n\nSometimes the check mail process gets locked and it will say so in the logs.\nto unlock it run `php bin/console app:removemaillock`\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Docker\n\n1. see the docker-compose.yml file for all variables and an example stack.\n2. `MAILCHECK_SCHEDULE` can be adjusted to check the mailbox more or less frequent using a cron syntax.\n   you can also use one of the following keywords: monthly, weekly, daily, hourly, 15min\n3. run `docker compose up`\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- TRANSLATING --\u003e\n## Translating\n\n![Lokalise][logo-lokalise]\u003cbr\u003e\n\u003ca href=\"http://www.lokalise.com/\"\u003eLokalise.com\u003c/a\u003e has provided us with an opensource licence for translations.\n\nIf you want to contribute you can join the project there using the following link:\u003cbr\u003e\nhttps://app.lokalise.com/public/943233106735f8aa5bd752.59947412/\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/antedebaas/Viesti-Reports.svg?style=for-the-badge\n[contributors-url]: https://github.com/antedebaas/Viesti-Reports/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/antedebaas/Viesti-Reports.svg?style=for-the-badge\n[forks-url]: https://github.com/antedebaas/Viesti-Reports/network/members\n[stars-shield]: https://img.shields.io/github/stars/antedebaas/Viesti-Reports.svg?style=for-the-badge\n[stars-url]: https://github.com/antedebaas/Viesti-Reports/stargazers\n[issues-shield]: https://img.shields.io/github/issues/antedebaas/Viesti-Reports.svg?style=for-the-badge\n[issues-url]: https://github.com/antedebaas/Viesti-Reports/issues\n[license-shield]: https://img.shields.io/github/license/antedebaas/Viesti-Reports.svg?style=for-the-badge\n[license-url]: https://github.com/antedebaas/Viesti-Reports/blob/master/LICENSE.txt\n[docker-shield]: https://img.shields.io/docker/pulls/antedebaas/viesti-reports.svg?style=for-the-badge\n[docker-url]: https://hub.docker.com/repository/docker/antedebaas/viesti-reports/general\n[docker-shield-old]: https://img.shields.io/docker/pulls/antedebaas/dmarc-reports.svg?style=for-the-badge\n[docker-url-old]: https://hub.docker.com/repository/docker/antedebaas/dmarc-reports/general\n\n[screenshot-dashboard]: screenshot-dashboard.png\n[screenshot-dmarc]: screenshot-dmarc.png\n[screenshot-smtptls]: screenshot-smtptls.png\n\n[logo-lokalise]: logo-lokalise.svg","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantedebaas%2FViesti-Reports","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fantedebaas%2FViesti-Reports","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fantedebaas%2FViesti-Reports/lists"}