Skip to content

Commit 4ad93b8

Browse files
committed
update docs to reference git auth
1 parent 7549a40 commit 4ad93b8

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

docs/git-auth.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,24 @@
1-
# Git Authentication
1+
# Supported URL Formats
2+
3+
Envbuilder supports three distinct types of Git URLs:
4+
5+
1) Valid URLs with scheme (e.g. `https://user:password@host.tld:12345/path/to/repo`)
6+
2) SCP-like URLs (e.g. `git@host.tld:path/to/repo.git`)
7+
3) Filesystem URLs (require the `git` executable to be available)
8+
9+
Based on the type of URL, one of two authentication methods will be used:
10+
11+
| Git URL format | GIT_USERNAME | GIT_PASSWORD | Auth Method |
12+
| ------------------------|--------------|--------------|-------------|
13+
| https?://host.tld/repo | Not Set | Not Set | None |
14+
| https?://host.tld/repo | Not Set | Set | HTTP Basic |
15+
| https?://host.tld/repo | Set | Not Set | HTTP Basic |
16+
| https?://host.tld/repo | Set | Set | HTTP Basic |
17+
| file://path/to/repo | - | - | None |
18+
| path/to/repo | - | - | None |
19+
| All other formats | - | - | SSH |
20+
21+
# Authentication Methods
222

323
Two methods of authentication are supported:
424

0 commit comments

Comments
 (0)