commit d0bd8f5c6100f0e30bd68fa4aef590af7654dea7
parent 6c6dfcf9b776db974d7127e07e8dc14fc73a18ae
Author: Robert Russell <robert@rr3.xyz>
Date: Wed, 20 May 2026 16:50:48 -0700
Update README
Diffstat:
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/README b/README
@@ -7,16 +7,18 @@ Thankfully, the `git` tool makes it easy to add new protocols (see
gitremote-helpers(7)). Here are the steps required to start using Gits:
Servers:
- 1. Run `git daemon`, just like you would to serve `git://`. Optionally,
- you may serve it only locally, to prevent access to the insecure
- `git://`.
- 2. Run a TLS tunnel to terminate TLS and exchange unencrypted traffic
- locally with the Git daemon.
+ 1. Run `git daemon`, just like you would to serve the ordinary Git
+ protocol. Optionally, you can serve it only locally, to prevent
+ outside access to the insecure Git protocol.
+ 2. Run a TLS tunnel to terminate TLS and exchange (unencrypted) Git
+ traffic locally with the Git daemon.
- Public side `IP:port`: <whatever you want>:9419
- Private side `IP:port`: localhost:9418
Clients:
1. Install `ncat` (from the `nmap` package) and the `git-remote-gits`
script from this repo (to somewhere on PATH).
- 2. That's it! The `git` tool now defers to `git-remote-gits` for URLs of
- form `gits://host[:port][/path]`.
+ 2. That's it! The `git` tool now defers to `git-remote-gits` for URLs
+ of form `gits://host[:port][/path]`.
+
+Note the convention that the Gits protocol uses TCP port 9419.