Skip to content

Commit b39927b

Browse files
committed
Update docs on custom domain
1 parent b01fdeb commit b39927b

File tree

3 files changed

+37
-1
lines changed

3 files changed

+37
-1
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [Automatic TLS](guides/features/automatic-tls.md)
1717
- [GitHub Actions Integration](guides/features/github-actions-integration.md)
1818
- [Access Control](guides/features/access-control.md)
19+
- [Custom Domain](guides/features/custom-domain.md)
1920

2021
# References
2122

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Custom Domains
2+
3+
Pageship supports custom domains for serving pages for an app. We assume a
4+
cooperative model for custom domain association, so domain ownership
5+
verification is not required.
6+
7+
To enable custom domain, configure `pageship.toml` and specify the site to serve
8+
from the domain:
9+
10+
```toml
11+
# 2 sites for the app: 'main' & 'dev'
12+
[[app.sites]]
13+
name = "main"
14+
15+
[[app.sites]]
16+
name = "dev"
17+
18+
# For 'main' site, serve it at 'example.com'. Traffic to default domain is
19+
# redirected to the configured domain automatically.
20+
[[app.domains]]
21+
domain="example.com"
22+
site="main"
23+
```
24+
25+
If the domain name is already in-use by other apps, the custom domain would not
26+
be activated automatically when first added to the configuration. It can be
27+
activated/deactivated manually using `pageship domains activate <domain name>`/
28+
`pageship domains deactivate <domain name>` command.
29+
30+
Custom domains of the app can be listed with `pageship domains` command.
31+
Additional setup instruction (e.g. DNS setup) would be shown if provided by
32+
server operator.

docs/references/configuration-file.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ server.
2424
subdomain.
2525
- `app.deployments`: Configuration for preview deployments
2626
- `access`: ACL rules controlling access of preview deployments.
27-
- `ttl`: the lifetime of a preview deployment (default to `24h`)``
27+
- `ttl`: the lifetime of a preview deployment (default to `24h`)
28+
- `app.domains`: Configuration for custom domains
29+
- `domain`: The custom domain to use
30+
- `site`: The site name associated the custom domain
2831

2932
### `site` section
3033

0 commit comments

Comments
 (0)