KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

mailgoose

★ 207 Open GitHub ↗

A web application that allows the users to check whether their SPF, DMARC and DKIM configuration is set up correctly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Mailgoose is a web application that allows the users to check whether their SPF, DMARC and
DKIM configuration is set up correctly. CERT PL uses it to run
<a href="https://bezpiecznapoczta.cert.pl/">bezpiecznapoczta.cert.pl</a>, an online service
that helps Polish institutions to configure their domains to decrease the probability of successful
e-mail spoofing.

Under the hood, Mailgoose uses <a href="https://github.com/domainaware/checkdmarc">checkdmarc</a>
and <a href="https://launchpad.net/dkimpy/">dkimpy</a>, among others.

## [Quick Start 🔨](https://mailgoose.readthedocs.io/en/latest/quick-start.html) | [Docs 📚](https://mailgoose.readthedocs.io/en/latest/)

## Features
For an up-to-date list of features, please refer to [the documentation](https://mailgoose.readthedocs.io/en/latest/features.html).

## Screenshots
![Check results](https://raw.githubusercontent.com/CERT-Polska/mailgoose/main/.github/screenshots/check_results.png)

## Development

### Tests
To run the tests, use:

```
./scripts/test
```

### Code formatting
Mailgoose uses `pre-commit` to run linters and format the code.
`pre-commit` is executed on CI to verify that the code is formatted properly.

To run it locally, use:

```
pre-commit run --all-files
```

To setup `pre-commit` so that it runs before each commit, use:

```
pre-commit install
```

### Building the docs
To build the documentation, use:

```
cd docs
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt
make html
```

## Releasing
Before creating new release for `mailgoose`, you should update files with new version number:

- `scan/setup.py#L12` - `version=""`
- `docs/conf.py#L36` - `release = ""`

Then create new release with given version.

## Contributing
Contributions are welcome! We will appreciate both ideas for improvements (added as
[GitHub issues](https://github.com/CERT-Polska/mailgoose/issues)) as well as pull requests
with new features or code improvements.

However obvious it may seem we kindly remind you that by contributing to mailgoose
you agree that the BSD 3-Clause License shall apply to your input automatically,
without the need for any additional declarations to be made.

mailgoose

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README