Skip to content

Commit 723eadd

Browse files
committed
docs: add README.md based on repo root readme.md
Signed-off-by: Xe Iaso <xe@tigrisdata.com>
1 parent ac336f5 commit 723eadd

2 files changed

Lines changed: 53 additions & 1 deletion

File tree

‎docs/.auxesia.yaml‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
title: objgit
2-
subtitle: A git server that stores repositories in Tigris
2+
subtitle: Git backed by object storage
3+
ignore:
4+
- plans/**
5+
- superpowers/**
6+
- reference/**
7+
llms:
8+
header: >-
9+
Objgit is a git server that is backed by [Tigris](https://www.tigrisdata.com), globally distributed object storage.
10+
11+
For questions about Tigris, reference these files:
12+
13+
* https://www.tigrisdata.com/llms.txt
14+
* https://www.tigrisdata.com/docs/llms.txt

‎docs/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: objgit
3+
---
4+
5+
# objgit
6+
7+
![GitHub Issues or Pull Requests by label](https://img.shields.io/github/issues/tigrisdata/objgit)
8+
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/tigrisdata/objgit)
9+
![language count](https://img.shields.io/github/languages/count/tigrisdata/objgit)
10+
![repo size](https://img.shields.io/github/repo-size/tigrisdata/objgit)
11+
12+
A git server backed by [Tigris](https://www.tigrisdata.com/). This handles Git repository and LFS storage. The vision is that objgit is the backbone of a git server that handles storage in the cloud so your repos don't have to live on your own disks.
13+
14+
Notable features:
15+
16+
- ssh, http, and git protocol support.
17+
- [post-receive hooks](/usage/hooks) powered by userspace sandboxed shells and [Kefka](https://xeiaso.net/blog/2026/dancing-mad-sandboxing/).
18+
- SSH sandbox access to the environment hooks run in.
19+
- [Kustomize, Kubernetes, and Tekton commands](/usage/kubernetes-hooks) in hooks, so a push can start a PipelineRun.
20+
- [Git LFS](/usage/lfs) with presigned transfers, so large files move straight between the client and Tigris instead of through the daemon. LFS object bytes are deduplicated across every repository in the bucket.
21+
- EROFS snapshots per tree (including LFS pointer resolution).
22+
- basic prometheus metrics.
23+
- no authentication whatsoever, if this ends up being actually useful then authentication will be implemented.
24+
- [webhooks](/usage/webhooks) on a per-repository basis.
25+
26+
## Roadmap
27+
28+
- Integration with Tekton or other services for CI pipelines.
29+
- Some kind of scraper-resistant web UI using [the Xe Design System](https://design.within.website).
30+
- Deployment to Kubernetes (via Helm).
31+
- HTTPS support with TLS termination.
32+
- A robust authentication scheme for agents and users.
33+
- MCP support.
34+
- Integration with Jev / other decision engines in the hook environment.
35+
36+
## Deployment to production
37+
38+
See
39+
[Kubernetes deployment](./usage/kubernetes) for configuration and
40+
caveats.

0 commit comments

Comments
 (0)