mirror of
https://codeberg.org/git-pages/git-pages.git
synced 2026-05-14 03:01:48 +00:00
Reorganize, add README and LICENSE.
This commit is contained in:
Catherine
13
LICENSE-0BSD.txt
Normal file
13
LICENSE-0BSD.txt
Normal file
@@ -0,0 +1,13 @@
|
||||
Copyright (C) Catherine 'whitequark'
|
||||
|
||||
Permission to use, copy, modify, and/or distribute this software for
|
||||
any purpose with or without fee is hereby granted.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
|
||||
AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
||||
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
|
||||
74
README.md
Normal file
74
README.md
Normal file
@@ -0,0 +1,74 @@
|
||||
git-pages
|
||||
=========
|
||||
|
||||
This is a simple Go service implemented as a strawman proposal of how https://codeberg.page could work. It lacks any form of authentication and must not be used in production.
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* In response to a `PUT` request, performs a shallow in-memory clone of a git repository, checks out a tree to the filesystem, and atomically updates the version of content being served.
|
||||
* In response to a `GET` request, selects an appropriate tree and serves files from it. Supported URL patterns:
|
||||
- `https://domain.tld/project/` (routed to project-specific tree)
|
||||
- `https://domain.tld/` (routed to domain-specific tree by exclusion)
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
You will need [Go](https://go.dev/) 1.24 or newer. Run:
|
||||
|
||||
```console
|
||||
$ mkdir -p data
|
||||
$ go run . data :3333
|
||||
```
|
||||
|
||||
This starts an HTTP server on `0.0.0.0:3333` whose behavior is fully determined by the `data` directory. It will accept requests to any virtual host, but must first be provisioned. For example:
|
||||
|
||||
```console
|
||||
$ curl -v http://127.0.0.1:3333/ -X PUT -H 'Host: codeberg.page' --data https://codeberg.org/Codeberg/pages-server
|
||||
* Trying 127.0.0.1:3333...
|
||||
* [snip]
|
||||
< HTTP/1.1 201 Created
|
||||
< Content-Location: /
|
||||
< Date: Fri, 05 Sep 2025 07:19:34 GMT
|
||||
< Content-Length: 41
|
||||
< Content-Type: text/plain; charset=utf-8
|
||||
<
|
||||
915c874f8029dcb2056237440116e170de0b9489
|
||||
* Connection #0 to host 127.0.0.1 left intact
|
||||
```
|
||||
|
||||
The server will now respond to requests for this host:
|
||||
|
||||
```console
|
||||
$ curl http://127.0.0.1:3333/ -H 'Host: codeberg.page'
|
||||
<!DOCTYPE html>
|
||||
[snip]
|
||||
```
|
||||
|
||||
|
||||
Architecture
|
||||
------------
|
||||
|
||||
Filesystem is used as the sole mechanism for state storage.
|
||||
|
||||
- The `data/tree/` directory contains working trees organized by commit hash (indiscriminately of the repository they belong to). Repositories themselves are never stored on disk; they are cloned in-memory and discarded immediately after their contents is extracted.
|
||||
- The presence of a working tree directory under the appropriate commit hash is considered an indicator of its completeness. Checkouts are first done into a temporary directory and then atomically moved into place.
|
||||
- Currently a working tree is never removed, but a practical system would need to have a way to discard orphaned ones.
|
||||
- The `data/www/` directory contains symlinks to working trees organized by domain and project name (e.g. `data/www/example.org/myproject`, or `data/www/example.org/.index`).
|
||||
- The presence of a symlink at the appropriate location is considered an indicator of completeness as well. Updating to a new content version is done by creating a new symlink at a temporary location and then atomically moving it into place.
|
||||
- This structure is simple enough that it may be served by e.g. Nginx instead of the Go application.
|
||||
- `openat2(RESOLVE_IN_ROOT)` is used to confine GET requests strictly under the `data/` directory.
|
||||
|
||||
This approach has the benefits of being easy to explore and debug, but places a lot of faith onto the filesystem implementation; partial data loss, write reordering, or incomplete journalling *will* result in confusing and persistent caching issues. This is probably fine, but needs to be understood.
|
||||
|
||||
The specific arrangement used is clearly not optimal; at a minimum it is likely worth it to deduplicate files under `data/tree/` using hardlinks, or perhaps to put objects in a flat, content-addressed store with `data/www/` linking to each individual file. The key practical constraint will likely be the need to attribute excessively large trees to repositories they were built from (and to perform GC), which suggests adding structure and not removing it.
|
||||
|
||||
I lack any interesting insight into authentication mechanisms applicable here. It would be straightforward to verify whether a custom domain contains a TXT record specifying the allowed source repositories.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
[0-clause BSD](LICENSE-0BSD.txt)
|
||||
@@ -62,7 +62,7 @@ func fetch(
|
||||
}
|
||||
defer os.RemoveAll(tempDir)
|
||||
|
||||
repo, err = git.Open(storer, osfs.New(tempDir))
|
||||
repo, err = git.Open(storer, osfs.New(tempDir, osfs.WithBoundOS()))
|
||||
if err != nil {
|
||||
return nil, 0, fmt.Errorf("git open: %s", err)
|
||||
}
|
||||
Reference in New Issue
Block a user