]>
Commit | Line | Data |
---|---|---|
85a97d4e BF |
1 | GIT URLS[[URLS]] |
2 | ---------------- | |
3 | ||
5ce4f4e3 RR |
4 | In general, URLs contain information about the transport protocol, the |
5 | address of the remote server, and the path to the repository. | |
6 | Depending on the transport protocol, some of this information may be | |
7 | absent. | |
8 | ||
6347e716 | 9 | Git supports ssh, git, http, and https protocols (in addition, ftp, |
0d0bac67 JK |
10 | and ftps can be used for fetching, but this is inefficient and |
11 | deprecated; do not use it). | |
6347e716 | 12 | |
20618016 FT |
13 | The native transport (i.e. git:// URL) does no authentication and |
14 | should be used with caution on unsecured networks. | |
15 | ||
6347e716 | 16 | The following syntaxes may be used with them: |
85a97d4e | 17 | |
2e776665 | 18 | - ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/ |
5ce4f4e3 RR |
19 | - git://host.xz{startsb}:port{endsb}/path/to/repo.git/ |
20 | - http{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/ | |
21 | - ftp{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/ | |
85a97d4e | 22 | |
5ce4f4e3 | 23 | An alternative scp-like syntax may also be used with the ssh protocol: |
85a97d4e | 24 | |
5ce4f4e3 | 25 | - {startsb}user@{endsb}host.xz:path/to/repo.git/ |
85a97d4e | 26 | |
60003340 NTND |
27 | This syntax is only recognized if there are no slashes before the |
28 | first colon. This helps differentiate a local path that contains a | |
29 | colon. For example the local path `foo:bar` could be specified as an | |
30 | absolute path or `./foo:bar` to avoid being misinterpreted as an ssh | |
31 | url. | |
32 | ||
5ce4f4e3 RR |
33 | The ssh and git protocols additionally support ~username expansion: |
34 | ||
35 | - ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/ | |
36 | - git://host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/ | |
37 | - {startsb}user@{endsb}host.xz:/~{startsb}user{endsb}/path/to/repo.git/ | |
38 | ||
2de9b711 | 39 | For local repositories, also supported by Git natively, the following |
5ce4f4e3 | 40 | syntaxes may be used: |
85a97d4e | 41 | |
3598a308 | 42 | - /path/to/repo.git/ |
4c32e361 | 43 | - \file:///path/to/repo.git/ |
3d5c418f | 44 | |
347989f4 | 45 | ifndef::git-clone[] |
5ce4f4e3 RR |
46 | These two syntaxes are mostly equivalent, except when cloning, when |
47 | the former implies --local option. See linkgit:git-clone[1] for | |
48 | details. | |
347989f4 SO |
49 | endif::git-clone[] |
50 | ||
51 | ifdef::git-clone[] | |
5ce4f4e3 RR |
52 | These two syntaxes are mostly equivalent, except the former implies |
53 | --local option. | |
347989f4 | 54 | endif::git-clone[] |
55029ae4 | 55 | |
2de9b711 | 56 | When Git doesn't know how to handle a certain transport protocol, it |
5ce4f4e3 RR |
57 | attempts to use the 'remote-<transport>' remote helper, if one |
58 | exists. To explicitly request a remote helper, the following syntax | |
59 | may be used: | |
60 | ||
61 | - <transport>::<address> | |
62 | ||
63 | where <address> may be a path, a server and path, or an arbitrary | |
64 | URL-like string recognized by the specific remote helper being | |
439cc746 | 65 | invoked. See linkgit:gitremote-helpers[7] for details. |
55029ae4 DB |
66 | |
67 | If there are a large number of similarly-named remote repositories and | |
68 | you want to use a different format for them (such that the URLs you | |
69 | use will be rewritten into URLs that work), you can create a | |
70 | configuration section of the form: | |
71 | ||
72 | ------------ | |
73 | [url "<actual url base>"] | |
74 | insteadOf = <other url base> | |
75 | ------------ | |
76 | ||
77 | For example, with this: | |
78 | ||
79 | ------------ | |
80 | [url "git://git.host.xz/"] | |
81 | insteadOf = host.xz:/path/to/ | |
82 | insteadOf = work: | |
83 | ------------ | |
84 | ||
85 | a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be | |
86 | rewritten in any context that takes a URL to be "git://git.host.xz/repo.git". | |
87 | ||
1c2eafb8 JT |
88 | If you want to rewrite URLs for push only, you can create a |
89 | configuration section of the form: | |
90 | ||
91 | ------------ | |
92 | [url "<actual url base>"] | |
93 | pushInsteadOf = <other url base> | |
94 | ------------ | |
95 | ||
96 | For example, with this: | |
97 | ||
98 | ------------ | |
99 | [url "ssh://example.org/"] | |
100 | pushInsteadOf = git://example.org/ | |
101 | ------------ | |
102 | ||
103 | a URL like "git://example.org/path/to/repo.git" will be rewritten to | |
104 | "ssh://example.org/path/to/repo.git" for pushes, but pulls will still | |
105 | use the original URL. |