aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man
diff options
context:
space:
mode:
authorLibravatar Rutger Broekhoff2024-04-30 02:20:00 +0200
committerLibravatar Rutger Broekhoff2024-04-30 02:20:00 +0200
commit29c576de63a3de6da6a2f4909f151b3d5d157060 (patch)
treefedab8595a2d55f61824bd25d8c22c6807576015 /docs/man
parent58cda3c6d2135e652c025c6b586cecf014ff2ad6 (diff)
downloadgitolfs3-29c576de63a3de6da6a2f4909f151b3d5d157060.tar.gz
gitolfs3-29c576de63a3de6da6a2f4909f151b3d5d157060.zip
Improve man pages
Added an explanation on the type of key that is expected. Also tried to fix layout of the path structure explanation in gitolfs3-server(1), so that it also looks okay when rendered as a PDF. (On the PDF generated using mandoc it still looks a bit weird, but I don't think I'll try to solve that right now.)
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/gitolfs3-authenticate.110
-rw-r--r--docs/man/gitolfs3-server.132
2 files changed, 31 insertions, 11 deletions
diff --git a/docs/man/gitolfs3-authenticate.1 b/docs/man/gitolfs3-authenticate.1
index 3a9951e..3f44312 100644
--- a/docs/man/gitolfs3-authenticate.1
+++ b/docs/man/gitolfs3-authenticate.1
@@ -31,3 +31,13 @@ Must end with a slash.
31.B Required. 31.B Required.
32The path to the key which is used to authorize the request to the Gitolfs3 32The path to the key which is used to authorize the request to the Gitolfs3
33server. 33server.
34The key must be 128-character hexadecimal string, i.e., a 64-byte number.
35Such a key can, for example, be generated using OpenSSL, with the following
36command:
37
38 openssl rand -hex 64
39
40Note that the Gitolfs3 server must be configured to use exactly the same key
41for
42.B gitolfs3-authenticate
43to function.
diff --git a/docs/man/gitolfs3-server.1 b/docs/man/gitolfs3-server.1
index f141bce..30f8cb5 100644
--- a/docs/man/gitolfs3-server.1
+++ b/docs/man/gitolfs3-server.1
@@ -15,18 +15,22 @@ Otherwise, repositories will not be recognized (and nothing will work).
15 15
16The Gitolfs3 server uses S3-compatible services as backing storage. 16The Gitolfs3 server uses S3-compatible services as backing storage.
17In the configured S3 bucket, a familiar structure is used: 17In the configured S3 bucket, a familiar structure is used:
18.in +2 18.IP
19lfs-test.git/ ................. repository name 19.TS
20.in +2 20tab(%);
21lfs/objects/ ................ namespace 21l l
22.in +2 22l l
234e/ ....................... first byte of the object ID (OID) 23l l
24.in +2 24l l
257b/ ..................... second byte of the OID 25l l.
26.in +2 26lfs-test.git/ % repository name
274e7bfdb[...]11ce013 ... OID (SHA256) 27 lfs/objects/ % namespace
28.in -10 28 4e/ % first byte of the object ID (OID)
29 7b/ % second byte of the OID
30 4e7bfdb[...]11ce013 % OID (SHA256)
31.TE
29 32
33.P
30Public and private repositories are distinguished using the presence of a 34Public and private repositories are distinguished using the presence of a
31\fIgit-daemon-export-ok\fR file in the bare repository. 35\fIgit-daemon-export-ok\fR file in the bare repository.
32Unauthenticated users accessing the service over the public internet are 36Unauthenticated users accessing the service over the public internet are
@@ -80,6 +84,12 @@ itself.
80.B GITOLFS3_KEY_PATH 84.B GITOLFS3_KEY_PATH
81.B Required. 85.B Required.
82Path to the key that is used to generate and verify tags (MACs) for requests. 86Path to the key that is used to generate and verify tags (MACs) for requests.
87The key must be 128-character hexadecimal string, i.e., a 64-byte number.
88Such a key can, for example, be generated using OpenSSL, with the following
89command:
90
91 openssl rand -hex 64
92
83Must correspond with the key used by 93Must correspond with the key used by
84.BR gitolfs3-authenticate (1), 94.BR gitolfs3-authenticate (1),
85if using. 95if using.