vole

Clone

Read only, no credentials:

https://rodent.software/vole.git

Write over SSH with a registered key:

git clone ssh://git@rodent.software:2222/vole.git

A free and open-source forge that lives in your Git repo.

Serve repositories from the root of the URL space

ed03b3d1fa16ef6b55e2773aaf10e3be13282c3a · Keenan Nemetz · 10h ago · parent d37d301f

Serve repositories from the root of the URL space

A repository is now /<name> and its Git transport /<name>.git, so the URL a
person opens, the URL a clone uses, and the Go module path are the same name.
The forge's own pages moved under /-/ (admin, accounts, the directory, the
feed, sign-in, assets), a prefix no repository name can start with: names are
[a-z0-9...] and cannot begin with "-". That leaves the router with two disjoint
spaces and removes the /r/ and /git/ prefixes, which existed only to keep
repositories away from the forge's own paths.

Routes: repoRoutes lose /r/; global, auth and admin routes gain /-/; assets
move to /-/static/ because a subtree pattern like /static/ cannot coexist with
one-segment-wildcard repo routes — Go's mux reports them as conflicting
neither-more-specific patterns. The catch-all still renders the styled 404.

Transport: githttp.Route parses /<name>.git/<rest> instead of a /git/ prefix,
and forgepaths.go hands such requests to the proxy before the mux, because a
wildcard fills a whole segment and cannot match "<name>.git". LFS stays on the
mux (<name>.git/info/lfs/...), and the Go module discovery probe moves to the
same pre-router so a package path under a public repository is answered even
when its first segments name a page tab.

Names: repo.ValidateName now refuses the four root paths the forge must keep —
static, robots.txt, sitemap.xml, sitemap-pages.xml. Everything else is an
ordinary repository name, including admin, u, and activity.

Docs and the packaged URLs follow the new layout; robots.txt, the sitemaps and
the instance activity feed point at the new paths. No aliases: the old /r/ and
/git/ URLs are gone.

Verified with ./vole workflow check and ./vole workflow run verify.

forge/repo/name_test.go +37

@@ -0,0 +1,37 @@
	1	package repo
	2
	3	import (
	4	"strings"
	5	"testing"
	6	)
	7
	8	// A repository owns the root of the URL space, so only the four names the forge
	9	// must serve at the root are unavailable. A name the forge would otherwise use
	10	// for a page ("admin", "u", "activity") is an ordinary repository.
	11	func TestValidateNameReservesOnlyTheForgeRoot(t *testing.T) {
	12	t.Parallel()
	13	for _, name := range []string{"demo", "admin", "u", "r", "activity", "login", "users", "vole-instance", "git"} {
	14	if err := ValidateName(name); err != nil {
	15	t.Errorf("ValidateName(%q) = %v, want it accepted", name, err)
	16	}
	17	}
	18	for name, want := range map[string]string{
	19	"static": "/static/",
	20	"robots.txt": "/robots.txt",
	21	"sitemap.xml": "/sitemap.xml",
	22	"sitemap-pages.xml": "/sitemap-pages.xml",
	23	"demo.git": ".git",
	24	"Demo": "lowercase",
	25	"-demo": "lowercase letters",
	26	"a..b": "invalid repo name",
	27	} {
	28	err := ValidateName(name)
	29	if err == nil {
	30	t.Errorf("ValidateName(%q) was accepted", name)
	31	continue
	32	}
	33	if !strings.Contains(err.Error(), want) {
	34	t.Errorf("ValidateName(%q) = %q, want it to mention %q", name, err, want)
	35	}
	36	}
	37	}