From f4c2619943697c29a27dfe571f0e8bded0f0cecc Mon Sep 17 00:00:00 2001 From: Joscha Feth Date: Mon, 2 Jun 2025 14:52:45 +0100 Subject: [PATCH] docs: add hint for enforce mode, the admin console and a terraform template --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 0a584e7..e59fb14 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,43 @@ For more information about MTA-STS, including details of required DNS record set - Update `.well-known/mta-sts.txt` to set `mx` directives to match the MX DNS records of your domain. - Turn on GitHub Pages (Settings > Pages) for the repository, using the root (`/`) of the main branch as source. - Turn on Enforce HTTPS setting for GitHub Pages. +- If you're using Google Workspace, you can check whether your configuration is working in [the admin console](https://admin.google.com/ac/apps/cs/diagnostic) (this page will also have all the specific information you need to fill in) +- Once you know it's working, change the `mode` from `testing` to `enforce` + +## Terraform template to use this template repository + +```hcl +resource "github_repository" "mta-sts-site" { + name = "mta-sts-site" + description = "MTA-STS site for mta-sts.YOURDOMAIN" + visibility = "public" + has_issues = false + has_projects = false + has_wiki = false + has_downloads = false + allow_auto_merge = true + allow_merge_commit = true + allow_rebase_merge = true + allow_squash_merge = false + allow_update_branch = true + archive_on_destroy = true + archived = false + delete_branch_on_merge = true + + template { + owner = "jimeh" + repository = "mta-sts-on-github-pages" + } + + pages { + # Enable this on the second apply, after the repo has been created + # cname = "mta-sts.YOURDOMAIN" + build_type = "legacy" + + source { + branch = "main" + path = "/" + } + } +} +```