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/repo.go +15

@@ -28,6 +28,18 @@ const (
	28	28
	29	29	var nameRE = regexp.MustCompile(`^[a-z0-9][a-z0-9._-]{0,62}$`)
	30	30
		31	// reservedNames are the root paths the forge itself must keep. A repository owns
		32	// the root of the URL space otherwise (/<name> is its page and /<name>.git its
		33	// transport), so these are the only names it cannot take. The forge's own pages
		34	// are all below /-/ and cannot collide with a name at all: a repository may be
		35	// called "admin" or "u".
		36	var reservedNames = map[string]string{
		37	"static": "the asset route /-/static/ serves from the root",
		38	"robots.txt": "crawlers only look for /robots.txt at the root",
		39	"sitemap.xml": "crawlers only look for /sitemap.xml at the root",
		40	"sitemap-pages.xml": "crawlers only look for /sitemap-pages.xml at the root",
		41	}
		42
	31	43	// ValidateName enforces a repo naming scheme that is safe as a directory name
	32	44	// and as a URL path segment.
	33	45	func ValidateName(name string) error {
@@ -40,6 +52,9 @@ func ValidateName(name string) error {
	40	52	if strings.Contains(name, "..") {
	41	53	return fmt.Errorf("invalid repo name %q", name)
	42	54	}
		55	if why, ok := reservedNames[name]; ok {
		56	return fmt.Errorf("invalid repo name %q: %s; choose another name", name, why)
		57	}
	43	58	return nil
	44	59	}
	45	60