Documentation/urls.txt

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