create-githat-app 1.8.1 → 1.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/templates/base/README.md.hbs +35 -1
package/package.json
CHANGED
|
@@ -66,9 +66,43 @@ After that, every `git push origin main` triggers a build + rsync + restart. The
|
|
|
66
66
|
{{/if}}{{#if includeOrgManagement}}- `/dashboard/members` — Invite members, manage roles
|
|
67
67
|
{{/if}}
|
|
68
68
|
|
|
69
|
+
## Branded auth emails (recommended)
|
|
70
|
+
|
|
71
|
+
Out of the box, password-reset and verification emails are sent from
|
|
72
|
+
`auth@githat.io` with the **From name** set to your app's brand
|
|
73
|
+
("{{businessName}}"). Most email clients show the brand prominently and
|
|
74
|
+
hide the address — but for the most polished experience, verify your
|
|
75
|
+
own domain so emails come from `auth@{{domain}}` instead:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
# 1. Register your domain in SES via the GitHat API
|
|
79
|
+
curl -X POST https://api.githat.io/apps/$APP_ID/email/domains \
|
|
80
|
+
-H "Authorization: Bearer $ACCESS_TOKEN" \
|
|
81
|
+
-H "Content-Type: application/json" \
|
|
82
|
+
-d '{"hostname": "{{domain}}"}'
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The response includes 3 DKIM CNAMEs. Add them to your DNS registrar
|
|
86
|
+
(Route 53, Cloudflare, Namecheap, etc.). SES auto-verifies within
|
|
87
|
+
~5 minutes, after which every auth email ships from `auth@{{domain}}`
|
|
88
|
+
with your brand throughout — subject, body, and reset link.
|
|
89
|
+
|
|
90
|
+
You can also verify domains via the SDK's `useEmailDomains()` hook:
|
|
91
|
+
|
|
92
|
+
```{{#if typescript}}tsx{{else}}jsx{{/if}}
|
|
93
|
+
import { useEmailDomains } from '@githat/nextjs';
|
|
94
|
+
|
|
95
|
+
const { add, list, status } = useEmailDomains();
|
|
96
|
+
await add('{{domain}}'); // returns { dkimRecords }
|
|
97
|
+
const domains = await list(); // includes verificationStatus
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Once verified, links in emails point to `https://{{domain}}/reset-password?token=…`
|
|
101
|
+
— users never see githat.io.
|
|
102
|
+
|
|
69
103
|
## Learn More
|
|
70
104
|
|
|
71
105
|
- [GitHat Documentation](https://githat.io/docs)
|
|
106
|
+
- [Branded Auth Emails Guide](https://githat.io/docs/email-domains)
|
|
72
107
|
- [SDK Reference](https://www.npmjs.com/package/@githat/nextjs)
|
|
73
108
|
- [API Reference](https://githat.io/docs/api)
|
|
74
|
-
tps://githat.io/docs/api)
|