Documentation/config/remote.txt

   1 remote.pushDefault::
   2         The remote to push to by default.  Overrides
   3         `branch.<name>.remote` for all branches, and is overridden by
   4         `branch.<name>.pushRemote` for specific branches.
   5
   6 remote.<name>.url::
   7         The URL of a remote repository.  See linkgit:git-fetch[1] or
   8         linkgit:git-push[1]. A configured remote can have multiple URLs;
   9         in this case the first is used for fetching, and all are used
  10         for pushing (assuming no `remote.<name>.pushurl` is defined).
  11         Setting this key to the empty string clears the list of urls,
  12         allowing you to override earlier config.
  13
  14 remote.<name>.pushurl::
  15         The push URL of a remote repository.  See linkgit:git-push[1].
  16         If a `pushurl` option is present in a configured remote, it
  17         is used for pushing instead of `remote.<name>.url`. A configured
  18         remote can have multiple push URLs; in this case a push goes to
  19         all of them. Setting this key to the empty string clears the
  20         list of urls, allowing you to override earlier config.
  21
  22 remote.<name>.proxy::
  23         For remotes that require curl (http, https and ftp), the URL to
  24         the proxy to use for that remote.  Set to the empty string to
  25         disable proxying for that remote.
  26
  27 remote.<name>.proxyAuthMethod::
  28         For remotes that require curl (http, https and ftp), the method to use for
  29         authenticating against the proxy in use (probably set in
  30         `remote.<name>.proxy`). See `http.proxyAuthMethod`.
  31
  32 remote.<name>.fetch::
  33         The default set of "refspec" for linkgit:git-fetch[1]. See
  34         linkgit:git-fetch[1].
  35
  36 remote.<name>.push::
  37         The default set of "refspec" for linkgit:git-push[1]. See
  38         linkgit:git-push[1].
  39
  40 remote.<name>.mirror::
  41         If true, pushing to this remote will automatically behave
  42         as if the `--mirror` option was given on the command line.
  43
  44 remote.<name>.skipDefaultUpdate::
  45         A deprecated synonym to `remote.<name>.skipFetchAll` (if
  46         both are set in the configuration files with different
  47         values, the value of the last occurrence will be used).
  48
  49 remote.<name>.skipFetchAll::
  50         If true, this remote will be skipped when updating
  51         using linkgit:git-fetch[1], the `update` subcommand of
  52         linkgit:git-remote[1], and ignored by the prefetch task
  53         of `git maintenance`.
  54
  55 remote.<name>.receivepack::
  56         The default program to execute on the remote side when pushing.  See
  57         option --receive-pack of linkgit:git-push[1].
  58
  59 remote.<name>.uploadpack::
  60         The default program to execute on the remote side when fetching.  See
  61         option --upload-pack of linkgit:git-fetch-pack[1].
  62
  63 remote.<name>.tagOpt::
  64         Setting this value to --no-tags disables automatic tag following when
  65         fetching from remote <name>. Setting it to --tags will fetch every
  66         tag from remote <name>, even if they are not reachable from remote
  67         branch heads. Passing these flags directly to linkgit:git-fetch[1] can
  68         override this setting. See options --tags and --no-tags of
  69         linkgit:git-fetch[1].
  70
  71 remote.<name>.vcs::
  72         Setting this to a value <vcs> will cause Git to interact with
  73         the remote with the git-remote-<vcs> helper.
  74
  75 remote.<name>.prune::
  76         When set to true, fetching from this remote by default will also
  77         remove any remote-tracking references that no longer exist on the
  78         remote (as if the `--prune` option was given on the command line).
  79         Overrides `fetch.prune` settings, if any.
  80
  81 remote.<name>.pruneTags::
  82         When set to true, fetching from this remote by default will also
  83         remove any local tags that no longer exist on the remote if pruning
  84         is activated in general via `remote.<name>.prune`, `fetch.prune` or
  85         `--prune`. Overrides `fetch.pruneTags` settings, if any.
  86 +
  87 See also `remote.<name>.prune` and the PRUNING section of
  88 linkgit:git-fetch[1].
  89
  90 remote.<name>.promisor::
  91         When set to true, this remote will be used to fetch promisor
  92         objects.
  93
  94 remote.<name>.partialclonefilter::
  95         The filter that will be applied when fetching from this promisor remote.
  96         Changing or clearing this value will only affect fetches for new commits.
  97         To fetch associated objects for commits already present in the local object
  98         database, use the `--refetch` option of linkgit:git-fetch[1].
  99
 100 remote.<name>.serverOption::
 101         The default set of server options used when fetching from this remote.
 102         These server options can be overridden by the `--server-option=` command
 103         line arguments.
 104
 105 remote.<name>.followRemoteHEAD::
 106         How linkgit:git-fetch[1] should handle updates to `remotes/<name>/HEAD`.
 107         The default value is "create", which will create `remotes/<name>/HEAD`
 108         if it exists on the remote, but not locally, but will not touch an
 109         already existing local reference. Setting to "warn" will print
 110         a message if the remote has a different value, than the local one and
 111         in case there is no local reference, it behaves like "create".
 112         A variant on "warn" is "warn-if-not-$branch", which behaves like
 113         "warn", but if `HEAD` on the remote is `$branch` it will be silent.
 114         Setting to "always" will silently update it to the value on the remote.
 115         Finally, setting it to "never" will never change or create the local
 116         reference.
 117 +
 118 This is a multi-valued variable, and an empty value can be used in a higher
 119 priority configuration file (e.g. `.git/config` in a repository) to clear
 120 the values inherited from a lower priority configuration files (e.g.
 121 `$HOME/.gitconfig`).