|
| 1 | +# Public Site |
| 2 | + |
| 3 | +This directory contains the standalone static site for GitHub Pages. It is separate from the product dashboard in `web/` so the public marketing surface can deploy cleanly without pulling in the application build. |
| 4 | + |
| 5 | +## Files |
| 6 | +- `index.html`: primary landing page |
| 7 | +- `404.html`: lightweight custom not-found page |
| 8 | +- `styles.css`: shared site styles |
| 9 | +- `favicon.svg`: simple site icon |
| 10 | + |
| 11 | +## Local Preview |
| 12 | + |
| 13 | +For a quick visual check, open `site/index.html` directly in a browser. |
| 14 | + |
| 15 | +If you prefer to serve it over HTTP, use any static file server. For example, if Python is installed, run this from the repository root: |
| 16 | + |
| 17 | +```powershell |
| 18 | +python -m http.server 4173 --directory site |
| 19 | +``` |
| 20 | + |
| 21 | +Then open `http://localhost:4173`. |
| 22 | + |
| 23 | +## Deployment |
| 24 | + |
| 25 | +GitHub Pages deploys this directory through `.github/workflows/pages.yml`. The workflow uploads `site/` as the Pages artifact whenever `main` changes in this directory, or when the workflow is run manually. |
| 26 | + |
| 27 | +This Pages deployment is separate from GitHub Releases. Release tags package the product artifacts; the public site publishes from the `main` branch workflow. |
| 28 | + |
| 29 | +The repository's default Pages URL will be: |
| 30 | + |
| 31 | +`https://eblackrps.github.io/viaduct/` |
| 32 | + |
| 33 | +All asset links in this site are relative so the same build works both on the default project Pages URL and on a custom domain. |
| 34 | + |
| 35 | +## Custom Domain |
| 36 | + |
| 37 | +For the current repository owner, make `viaducthq.com` the primary domain and point `www.viaducthq.com` at GitHub Pages. |
| 38 | + |
| 39 | +1. In GitHub, open `Settings -> Pages` for `eblackrps/viaduct`. |
| 40 | +2. Set the publishing source to `GitHub Actions` if it is not already set. |
| 41 | +3. In the `Custom domain` field, enter `viaducthq.com`. |
| 42 | +4. In DNS, configure either: |
| 43 | + |
| 44 | +| Host | Type | Value | |
| 45 | +| --- | --- | --- | |
| 46 | +| `@` | `ALIAS` or `ANAME` | `eblackrps.github.io` | |
| 47 | + |
| 48 | +Or the explicit GitHub Pages apex records: |
| 49 | + |
| 50 | +| Host | Type | Value | |
| 51 | +| --- | --- | --- | |
| 52 | +| `@` | `A` | `185.199.108.153` | |
| 53 | +| `@` | `A` | `185.199.109.153` | |
| 54 | +| `@` | `A` | `185.199.110.153` | |
| 55 | +| `@` | `A` | `185.199.111.153` | |
| 56 | +| `@` | `AAAA` | `2606:50c0:8000::153` | |
| 57 | +| `@` | `AAAA` | `2606:50c0:8001::153` | |
| 58 | +| `@` | `AAAA` | `2606:50c0:8002::153` | |
| 59 | +| `@` | `AAAA` | `2606:50c0:8003::153` | |
| 60 | +| `www` | `CNAME` | `eblackrps.github.io` | |
| 61 | + |
| 62 | +With `viaducthq.com` set as the custom domain in GitHub, GitHub Pages should redirect `www.viaducthq.com` to the apex domain once both record sets resolve correctly. |
| 63 | + |
| 64 | +## Verification And HTTPS |
| 65 | + |
| 66 | +For takeover protection, verify the domain in the account or organization Pages settings and keep the TXT verification record in DNS. After GitHub finishes issuing the certificate, enable `Enforce HTTPS` in the repository Pages settings. |
| 67 | + |
| 68 | +## Notes |
| 69 | + |
| 70 | +- Do not use wildcard DNS records for this site. |
| 71 | +- A `CNAME` file is not required for this workflow because custom domains are configured through GitHub Pages settings when deploying via GitHub Actions. |
0 commit comments