diff options
author | Rutger Broekhoff | 2024-04-30 02:20:00 +0200 |
---|---|---|
committer | Rutger Broekhoff | 2024-04-30 02:20:00 +0200 |
commit | 29c576de63a3de6da6a2f4909f151b3d5d157060 (patch) | |
tree | fedab8595a2d55f61824bd25d8c22c6807576015 /docs/man/gitolfs3-authenticate.1 | |
parent | 58cda3c6d2135e652c025c6b586cecf014ff2ad6 (diff) | |
download | gitolfs3-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/gitolfs3-authenticate.1')
-rw-r--r-- | docs/man/gitolfs3-authenticate.1 | 10 |
1 files changed, 10 insertions, 0 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. | ||