diff options
-rw-r--r-- | docs/man/gitolfs3-authenticate.1 | 10 | ||||
-rw-r--r-- | docs/man/gitolfs3-server.1 | 32 |
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. |
32 | The path to the key which is used to authorize the request to the Gitolfs3 | 32 | The path to the key which is used to authorize the request to the Gitolfs3 |
33 | server. | 33 | server. |
34 | The key must be 128-character hexadecimal string, i.e., a 64-byte number. | ||
35 | Such a key can, for example, be generated using OpenSSL, with the following | ||
36 | command: | ||
37 | |||
38 | openssl rand -hex 64 | ||
39 | |||
40 | Note that the Gitolfs3 server must be configured to use exactly the same key | ||
41 | for | ||
42 | .B gitolfs3-authenticate | ||
43 | to 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 | ||
16 | The Gitolfs3 server uses S3-compatible services as backing storage. | 16 | The Gitolfs3 server uses S3-compatible services as backing storage. |
17 | In the configured S3 bucket, a familiar structure is used: | 17 | In the configured S3 bucket, a familiar structure is used: |
18 | .in +2 | 18 | .IP |
19 | lfs-test.git/ ................. repository name | 19 | .TS |
20 | .in +2 | 20 | tab(%); |
21 | lfs/objects/ ................ namespace | 21 | l l |
22 | .in +2 | 22 | l l |
23 | 4e/ ....................... first byte of the object ID (OID) | 23 | l l |
24 | .in +2 | 24 | l l |
25 | 7b/ ..................... second byte of the OID | 25 | l l. |
26 | .in +2 | 26 | lfs-test.git/ % repository name |
27 | 4e7bfdb[...]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 | ||
30 | Public and private repositories are distinguished using the presence of a | 34 | Public 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. |
32 | Unauthenticated users accessing the service over the public internet are | 36 | Unauthenticated 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. |
82 | Path to the key that is used to generate and verify tags (MACs) for requests. | 86 | Path to the key that is used to generate and verify tags (MACs) for requests. |
87 | The key must be 128-character hexadecimal string, i.e., a 64-byte number. | ||
88 | Such a key can, for example, be generated using OpenSSL, with the following | ||
89 | command: | ||
90 | |||
91 | openssl rand -hex 64 | ||
92 | |||
83 | Must correspond with the key used by | 93 | Must correspond with the key used by |
84 | .BR gitolfs3-authenticate (1), | 94 | .BR gitolfs3-authenticate (1), |
85 | if using. | 95 | if using. |