aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man/gitolfs3-authenticate.1
blob: 3f4431236bdcc4a9c24500b76c473b1b0cf6e1f7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.TH GITOLFS3-AUTHENTICATE 1 2024-04-29 Gitolfs3 "Gitolfs3 Manual"
.SH NAME
gitolfs3-authenticate \- Git LFS authentication agent for Gitolfs3
.SH SYNOPSIS
.B gitolfs3-authenticate
<repository>
upload/download
.SH DESCRIPTION
.B gitolfs3-authenticate
is a Git LFS authentication agent for Gitolfs3.
When accessible from the Git shell as \fIgit-lfs-authenticate\fR,
.B gitolfs3-authenticate
can authorize users to access the Gitolfs3 Git LFS server.

Although
.B gitolfs3-authenticate
does assume that the user can be trusted, as they have access to the server,
it is a good idea to restrict the shell for the \fIgit\fR user.
For example, the user should not be able to modify environment variables, nor
should the user be able to execute any arbitrary command.
The Git shell provided by Gitolfs3 may be a good option. (See
.BR gitolfs3-shell (1).)
.SH ENVIRONMENT VARIABLES
.TP
.B GITOLFS3_HREF_BASE
.B Required.
The base URL at which the Gitolfs3 server is available.
Must end with a slash.
.TP
.B GITOLFS3_KEY_PATH
.B Required.
The path to the key which is used to authorize the request to the Gitolfs3
server.
The key must be 128-character hexadecimal string, i.e., a 64-byte number.
Such a key can, for example, be generated using OpenSSL, with the following
command:

	openssl rand -hex 64

Note that the Gitolfs3 server must be configured to use exactly the same key
for
.B gitolfs3-authenticate
to function.