Add a basic README

This commit is contained in:
James Mills 2023-08-20 21:59:34 +10:00
parent 50c0f7db21
commit 20cfad5a26
No known key found for this signature in database
GPG Key ID: AC4C014F1440EBD6

View File

@ -1,3 +1,30 @@
# pages-server
> A prototype [Gitea](https://gitea.io) Pages server ala Github Pages (_or Vercal, Netlify, etc_).
Currently supports the following:
- Proxies *.pages.mills.io
- Option 1: Repo with gitea-pages branch + gitea-pages topic => https://<owner>.pages.mills.io/<repo>/<path>
- Option 2: Repo of the form <subdomain>.pages.mills.io with gitea-pages branch and gitea-pages topic => https://<subdomain>.pages.mills.io
Demo sites:
- https://actions.pages.mills.io/
- https://prologic.pages.mills.io/test/
## Quick Start
TBD
## Features
- Proxies `<owner>.<domain>/<repo>` => `owner/repo`
- Proxies `<subdomain.<domain>` => `owner/subdomain`
- Automatically sets MIME types on served content.
- Ues `gitea-pages` as an "opt-in" topic label on repos.
- Content is served from a `gitea-pages` branch.
## License
TBD