whitequark.org
+10
-5
README.md
+10
-5
README.md
···
1
1
git-pages
2
2
=========
3
3
4
-
_git-pages_ is a static site server for use with Git forges (i.e. a GitHub Pages replacement). It is written with efficiency in mind, scaling horizontally to any number of deployed sites and concurrent requests and serving sites up to hundreds of megabytes in size, while being equally suitable for single-user deployments.
4
+
_git-pages_ is a static site server for use with Git forges (i.e. a GitHub Pages replacement). It is written with efficiency in mind, scaling horizontally to any number of machines and serving sites up to multiple gigabytes in size, while being equally suitable for small single-user deployments.
5
+
6
+
It is implemented in Go and has no other mandatory dependencies, although it is designed to be used together with the [Caddy server][caddy] for TLS termination. Site data may be stored on the filesystem or in an [Amazon S3](https://aws.amazon.com/s3/) compatible object store.
5
7
6
-
It is implemented in Go and has no other mandatory dependencies, although it is designed to be used together with the [Caddy server][caddy] (for TLS termination) and an [Amazon S3](https://aws.amazon.com/s3/) compatible object store (for horizontal scalability of storage).
8
+
The included Docker container provides everything needed to deploy a Pages service, including zero-configuration on-demand provisioning of TLS certificates from [Let's Encrypt](https://letsencrypt.org/), and runs on any commodity cloud infrastructure.
7
9
8
-
The included Docker container provides everything needed to deploy a Pages service, including zero-configuration on-demand provisioning of TLS certificates from [Let's Encrypt](https://letsencrypt.org/), and runs on any commodity cloud infrastructure. There is also a first-party deployment of _git-pages_ at [grebedoc.dev](https://grebedoc.dev).
10
+
> [!TIP]
11
+
> If you would like to publish a site using _git-pages_ to an existing service like Codeberg Pages or [Grebedoc][grebedoc], consider using the [CLI tool][git-pages-cli] or [Forgejo Action][git-pages-action].
9
12
10
13
[caddy]: https://caddyserver.com/
14
+
[git-pages-cli]: https://codeberg.org/git-pages/git-pages-cli
15
+
[git-pages-action]: https://codeberg.org/git-pages/action
16
+
[codeberg-pages]: https://codeberg.page
17
+
[grebedoc]: https://grebedoc.dev
11
18
12
19
13
20
Quickstart
···
31
38
```
32
39
33
40
The `pages` branch of the repository is now available at http://localhost:3000/!
34
-
35
-
[git-pages-cli]: https://codeberg.org/git-pages/git-pages-cli
36
41
37
42
38
43
Deployment