About The Project

I needed a quick and easy way to view my DMARC and SMTP-TLS reports. It also provides hosting for BIMI files and Outlook autodiscover. This is a simple symfony project that can read the inbox for new reports and process them. I you use it you should use it with a special sole-purpose email address.

(back to top)

License

This project is licenced under the AGPLv3 with some additional terms.
The additional terms are there to prevent rebranding and then pretending someone else made it.
See LICENSE.txt for both the license and the additional terms below.

(back to top)

Getting Started

Prerequisites

• composer
• mariadb (10.5+)/postgresql (13+)/sqlite
• php (8.2+)
• php-ctype
• php-curl
• php-dom
• php-fileinfo
• php-fpm
• php-iconv
• php-imap
• php-mbstring
• php-pdo
• php-pdo-mysql
• php-pdo-pgsql
• php-pdo-sqlite
• php-phar
• php-session
• php-simplexml
• php-tokenizer
• php-xml
• php-xmlwriter
• php-zip
• php-zlib (*)

* php-zlib is enabled on redhat based systems by default and not availible as a package

Installation

1. Clone the repo

   git clone https://github.com/antedebaas/Viesti-Reports.git

2. run update.sh to update project, clear its cache, this prevents symfony caching issues

   bash [root path of this project]/update.sh

3. point the webserver root to the public/ directory
4. point your webbrowser to http(s)://[yourhost]/setup and follow instructions
5. run installservice.sh to install the systemd service and timer for automated mail checking

   bash [root path of this project]/installservice.sh

6. 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) you can edit the policy on the domain edit page. It will also host https://autoconfig.yourmdomain.ext and https://autodiscover.yourmdomain.ext outlook autoconfiguration files And it supports BIMI file hosting on https://bimi.yourmdomain.ext

(back to top)

Usage notes

Sometimes the check mail process gets locked and it will say so in the logs. to unlock it run php bin/console app:removemaillock

(back to top)

Docker

1. see the docker-compose.yml file for all variables and an example stack.
2. MAILCHECK_SCHEDULE can be adjusted to check the mailbox more or less frequent using a cron syntax. you can also use one of the following keywords: monthly, weekly, daily, hourly, 15min
3. run docker compose up

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If 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". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Translating

Lokalise.com has provided us with an opensource licence for translations.

If you want to contribute you can join the project there using the following link:
https://app.lokalise.com/public/943233106735f8aa5bd752.59947412/

(back to top)