Skip to content

Commit

Permalink
Merge pull request #3 from c0nfigurati0n/gh-pages
Browse files Browse the repository at this point in the history
Made some "neat" changes.
  • Loading branch information
jpawlowski authored Aug 7, 2023
2 parents 32f6f87 + 7364f34 commit 28f5b1f
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 17 deletions.
5 changes: 0 additions & 5 deletions .gitattributes

This file was deleted.

9 changes: 3 additions & 6 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,10 @@ representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
julian.pawlowski@gmail.com.
All complaints will be reviewed and investigated promptly and fairly.
Any instances of abuse, harassment, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement [here](https://github.com/jpawlowski/mta-sts.template#author).

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
All complaints will be reviewed and investigated promptly and fairly.

## Enforcement Guidelines

Expand Down
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Julian Pawlowski
Copyright @ 2023 Julian Pawlowski

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In case the sending e-mail server is not able to initiate a secure connection, i

2. Change the file `.well-known/mta-sts.txt` according to your needs.

3. Create a `CNAME` record for `mta-sts.<your_domain.tld>` in your domain's DNS that points to `<user>.github.io` or `<organization>.github.io` and [enable GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).
3. Create a `CNAME` record for `mta-sts.<your_domain.tld>` in your domain's DNS that points to `<you_username>.github.io` or `<your_organization>.github.io` and [enable GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).

4. Open a browser to `https://mta-sts.<your_domain.tld>` and make sure it does not show any certificate warnings.

Expand All @@ -35,9 +35,10 @@ In case the sending e-mail server is not able to initiate a secure connection, i
_mta-sts 3600 TXT "v=STSv1; id=20220317000000Z"
```

Note that you will need to change the `id=` here whenever you make changes to your `mta-sts.txt` policy file.
**Note that you will need to change the `id=` here whenever you make changes to your `mta-sts.txt` policy file.**


6. Validate your setup, for example by using the [MTA-STS validator](https://aykevl.nl/apps/mta-sts/) created by [@aykevl](https://github.com/aykevl/mta-sts).
6. Validate your setup, for example by using the [MTA-STS Lookup by MXToolBox](https://mxtoolbox.com/mta-sts.aspx), or looking into your [Hardenize Public Report](https://www.hardenize.com/).

*Optional (but __highly recommended__):*

Expand All @@ -49,7 +50,7 @@ In case the sending e-mail server is not able to initiate a secure connection, i
_smtp._tls 3600 TXT "v=TLSRPTv1; rua=mailto:tls-rua@mailcheck.<your_domain.tld>"
```

Note that the e-mail recipient mailbox shall be on a different domain _without_ MTA-STS being configured.
Note that the e-mail recipient mailbox shall be on a different domain _without_ MTA-STS being configured. This could be a subdomain like `mailcheck.<your_domain.tld>`.
It is also quite painful to manually deal with the reports other e-mail providers will send to you. For that particular reason, you may want to consider sending these e-mails to a 3rd-party tool like [Report URI](https://report-uri.com/), [URIports](https://www.uriports.com/), or from other commercial providers.

You probably want this to be the same tool you might use for DMARC reports, like [DMARC Analyzer](https://www.dmarcanalyzer.com/) or [Dmarcian](https://dmarcian.com/).
Expand All @@ -62,4 +63,4 @@ In case the sending e-mail server is not able to initiate a secure connection, i

[julian.pawlowski.me](https://julian.pawlowski.me/) &nbsp;&middot;&nbsp;
GitHub [@jpawlowski](https://github.com/jpawlowski/mta-sts.template) &nbsp;&middot;&nbsp;
Twitter [@Loredo](https://twitter.com/Loredo)
Mastodon [@Loredo@chaos.social](https://chaos.social/@Loredo)

0 comments on commit 28f5b1f

Please sign in to comment.