aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man/gitolfs3-authenticate.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/gitolfs3-authenticate.1')
-rw-r--r--docs/man/gitolfs3-authenticate.133
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/man/gitolfs3-authenticate.1 b/docs/man/gitolfs3-authenticate.1
new file mode 100644
index 0000000..67151e1
--- /dev/null
+++ b/docs/man/gitolfs3-authenticate.1
@@ -0,0 +1,33 @@
1.TH GITOLFS3-AUTHENTICATE 1 2024-04-29 Gitolfs3 "Gitolfs3 Manual"
2.SH NAME
3git-lfs-authenticate \- Git LFS authentication agent for Gitolfs3
4.SH SYNOPSIS
5.B git-lfs-authenticate
6<repository>
7upload/download
8.SH DESCRIPTION
9.B git-lfs-authenticate
10is a Git LFS authentication agent for Gitolfs3.
11When accessible from the Git shell,
12.B git-lfs-authenticate
13can authorize users to access the Gitolfs3 Git LFS server.
14
15Although
16.B git-lfs-authenticate
17does assume that the user can be trusted, as they have access to the server,
18it is a good idea to restrict the shell for the \fIgit\fR user.
19For example, the user should not be able to modify environment variables, nor
20should the user be able to execute any arbitrary command.
21The Git shell provided by Gitolfs3 may be a good option. (See
22.BR gitolfs3-shell (1).)
23.SH ENVIRONMENT VARIABLES
24.TP
25.B GITOLFS3_HREF_BASE
26.B Required.
27The base URL at which the Gitolfs3 server is available.
28Must end with a slash.
29.TP
30.B GITOLFS3_KEY_PATH
31.B Required.
32The path to the key which is used to authorize the request to the Gitolfs3
33server.