Skip to content

docs: add hint for enforce mode, the admin console and a terraform template #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "/"
}
}
}
```