1171 lines
33 KiB
HTML
1171 lines
33 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
|
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
|
|
<meta name="generator" content="AsciiDoc 10.2.0" />
|
|
<title>gitcredentials(7)</title>
|
|
<style type="text/css">
|
|
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
|
|
|
|
/* Default font. */
|
|
body {
|
|
font-family: Georgia,serif;
|
|
}
|
|
|
|
/* Title font. */
|
|
h1, h2, h3, h4, h5, h6,
|
|
div.title, caption.title,
|
|
thead, p.table.header,
|
|
#toctitle,
|
|
#author, #revnumber, #revdate, #revremark,
|
|
#footer {
|
|
font-family: Arial,Helvetica,sans-serif;
|
|
}
|
|
|
|
body {
|
|
margin: 1em 5% 1em 5%;
|
|
}
|
|
|
|
a {
|
|
color: blue;
|
|
text-decoration: underline;
|
|
}
|
|
a:visited {
|
|
color: fuchsia;
|
|
}
|
|
|
|
em {
|
|
font-style: italic;
|
|
color: navy;
|
|
}
|
|
|
|
strong {
|
|
font-weight: bold;
|
|
color: #083194;
|
|
}
|
|
|
|
h1, h2, h3, h4, h5, h6 {
|
|
color: #527bbd;
|
|
margin-top: 1.2em;
|
|
margin-bottom: 0.5em;
|
|
line-height: 1.3;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
h2 {
|
|
padding-top: 0.5em;
|
|
}
|
|
h3 {
|
|
float: left;
|
|
}
|
|
h3 + * {
|
|
clear: left;
|
|
}
|
|
h5 {
|
|
font-size: 1.0em;
|
|
}
|
|
|
|
div.sectionbody {
|
|
margin-left: 0;
|
|
}
|
|
|
|
hr {
|
|
border: 1px solid silver;
|
|
}
|
|
|
|
p {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
ul, ol, li > p {
|
|
margin-top: 0;
|
|
}
|
|
ul > li { color: #aaa; }
|
|
ul > li > * { color: black; }
|
|
|
|
.monospaced, code, pre {
|
|
font-family: "Courier New", Courier, monospace;
|
|
font-size: inherit;
|
|
color: navy;
|
|
padding: 0;
|
|
margin: 0;
|
|
}
|
|
pre {
|
|
white-space: pre-wrap;
|
|
}
|
|
|
|
#author {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
font-size: 1.1em;
|
|
}
|
|
#email {
|
|
}
|
|
#revnumber, #revdate, #revremark {
|
|
}
|
|
|
|
#footer {
|
|
font-size: small;
|
|
border-top: 2px solid silver;
|
|
padding-top: 0.5em;
|
|
margin-top: 4.0em;
|
|
}
|
|
#footer-text {
|
|
float: left;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
#footer-badges {
|
|
float: right;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
|
|
#preamble {
|
|
margin-top: 1.5em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.imageblock, div.exampleblock, div.verseblock,
|
|
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
|
div.admonitionblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.admonitionblock {
|
|
margin-top: 2.0em;
|
|
margin-bottom: 2.0em;
|
|
margin-right: 10%;
|
|
color: #606060;
|
|
}
|
|
|
|
div.content { /* Block element content. */
|
|
padding: 0;
|
|
}
|
|
|
|
/* Block element titles. */
|
|
div.title, caption.title {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
text-align: left;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
div.title + * {
|
|
margin-top: 0;
|
|
}
|
|
|
|
td div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content + div.title {
|
|
margin-top: 0.0em;
|
|
}
|
|
|
|
div.sidebarblock > div.content {
|
|
background: #ffffee;
|
|
border: 1px solid #dddddd;
|
|
border-left: 4px solid #f0f0f0;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.listingblock > div.content {
|
|
border: 1px solid #dddddd;
|
|
border-left: 5px solid #f0f0f0;
|
|
background: #f8f8f8;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.quoteblock, div.verseblock {
|
|
padding-left: 1.0em;
|
|
margin-left: 1.0em;
|
|
margin-right: 10%;
|
|
border-left: 5px solid #f0f0f0;
|
|
color: #888;
|
|
}
|
|
|
|
div.quoteblock > div.attribution {
|
|
padding-top: 0.5em;
|
|
text-align: right;
|
|
}
|
|
|
|
div.verseblock > pre.content {
|
|
font-family: inherit;
|
|
font-size: inherit;
|
|
}
|
|
div.verseblock > div.attribution {
|
|
padding-top: 0.75em;
|
|
text-align: left;
|
|
}
|
|
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
|
div.verseblock + div.attribution {
|
|
text-align: left;
|
|
}
|
|
|
|
div.admonitionblock .icon {
|
|
vertical-align: top;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
text-decoration: underline;
|
|
color: #527bbd;
|
|
padding-right: 0.5em;
|
|
}
|
|
div.admonitionblock td.content {
|
|
padding-left: 0.5em;
|
|
border-left: 3px solid #dddddd;
|
|
}
|
|
|
|
div.exampleblock > div.content {
|
|
border-left: 3px solid #dddddd;
|
|
padding-left: 0.5em;
|
|
}
|
|
|
|
div.imageblock div.content { padding-left: 0; }
|
|
span.image img { border-style: none; vertical-align: text-bottom; }
|
|
a.image:visited { color: white; }
|
|
|
|
dl {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
dt {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0;
|
|
font-style: normal;
|
|
color: navy;
|
|
}
|
|
dd > *:first-child {
|
|
margin-top: 0.1em;
|
|
}
|
|
|
|
ul, ol {
|
|
list-style-position: outside;
|
|
}
|
|
ol.arabic {
|
|
list-style-type: decimal;
|
|
}
|
|
ol.loweralpha {
|
|
list-style-type: lower-alpha;
|
|
}
|
|
ol.upperalpha {
|
|
list-style-type: upper-alpha;
|
|
}
|
|
ol.lowerroman {
|
|
list-style-type: lower-roman;
|
|
}
|
|
ol.upperroman {
|
|
list-style-type: upper-roman;
|
|
}
|
|
|
|
div.compact ul, div.compact ol,
|
|
div.compact p, div.compact p,
|
|
div.compact div, div.compact div {
|
|
margin-top: 0.1em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
tfoot {
|
|
font-weight: bold;
|
|
}
|
|
td > div.verse {
|
|
white-space: pre;
|
|
}
|
|
|
|
div.hdlist {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
div.hdlist tr {
|
|
padding-bottom: 15px;
|
|
}
|
|
dt.hdlist1.strong, td.hdlist1.strong {
|
|
font-weight: bold;
|
|
}
|
|
td.hdlist1 {
|
|
vertical-align: top;
|
|
font-style: normal;
|
|
padding-right: 0.8em;
|
|
color: navy;
|
|
}
|
|
td.hdlist2 {
|
|
vertical-align: top;
|
|
}
|
|
div.hdlist.compact tr {
|
|
margin: 0;
|
|
padding-bottom: 0;
|
|
}
|
|
|
|
.comment {
|
|
background: yellow;
|
|
}
|
|
|
|
.footnote, .footnoteref {
|
|
font-size: 0.8em;
|
|
}
|
|
|
|
span.footnote, span.footnoteref {
|
|
vertical-align: super;
|
|
}
|
|
|
|
#footnotes {
|
|
margin: 20px 0 20px 0;
|
|
padding: 7px 0 0 0;
|
|
}
|
|
|
|
#footnotes div.footnote {
|
|
margin: 0 0 5px 0;
|
|
}
|
|
|
|
#footnotes hr {
|
|
border: none;
|
|
border-top: 1px solid silver;
|
|
height: 1px;
|
|
text-align: left;
|
|
margin-left: 0;
|
|
width: 20%;
|
|
min-width: 100px;
|
|
}
|
|
|
|
div.colist td {
|
|
padding-right: 0.5em;
|
|
padding-bottom: 0.3em;
|
|
vertical-align: top;
|
|
}
|
|
div.colist td img {
|
|
margin-top: 0.3em;
|
|
}
|
|
|
|
@media print {
|
|
#footer-badges { display: none; }
|
|
}
|
|
|
|
#toc {
|
|
margin-bottom: 2.5em;
|
|
}
|
|
|
|
#toctitle {
|
|
color: #527bbd;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
}
|
|
div.toclevel2 {
|
|
margin-left: 2em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel3 {
|
|
margin-left: 4em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel4 {
|
|
margin-left: 6em;
|
|
font-size: 0.9em;
|
|
}
|
|
|
|
span.aqua { color: aqua; }
|
|
span.black { color: black; }
|
|
span.blue { color: blue; }
|
|
span.fuchsia { color: fuchsia; }
|
|
span.gray { color: gray; }
|
|
span.green { color: green; }
|
|
span.lime { color: lime; }
|
|
span.maroon { color: maroon; }
|
|
span.navy { color: navy; }
|
|
span.olive { color: olive; }
|
|
span.purple { color: purple; }
|
|
span.red { color: red; }
|
|
span.silver { color: silver; }
|
|
span.teal { color: teal; }
|
|
span.white { color: white; }
|
|
span.yellow { color: yellow; }
|
|
|
|
span.aqua-background { background: aqua; }
|
|
span.black-background { background: black; }
|
|
span.blue-background { background: blue; }
|
|
span.fuchsia-background { background: fuchsia; }
|
|
span.gray-background { background: gray; }
|
|
span.green-background { background: green; }
|
|
span.lime-background { background: lime; }
|
|
span.maroon-background { background: maroon; }
|
|
span.navy-background { background: navy; }
|
|
span.olive-background { background: olive; }
|
|
span.purple-background { background: purple; }
|
|
span.red-background { background: red; }
|
|
span.silver-background { background: silver; }
|
|
span.teal-background { background: teal; }
|
|
span.white-background { background: white; }
|
|
span.yellow-background { background: yellow; }
|
|
|
|
span.big { font-size: 2em; }
|
|
span.small { font-size: 0.6em; }
|
|
|
|
span.underline { text-decoration: underline; }
|
|
span.overline { text-decoration: overline; }
|
|
span.line-through { text-decoration: line-through; }
|
|
|
|
div.unbreakable { page-break-inside: avoid; }
|
|
|
|
|
|
/*
|
|
* xhtml11 specific
|
|
*
|
|
* */
|
|
|
|
div.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.tableblock > table {
|
|
border: 3px solid #527bbd;
|
|
}
|
|
thead, p.table.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.table {
|
|
margin-top: 0;
|
|
}
|
|
/* Because the table frame attribute is overridden by CSS in most browsers. */
|
|
div.tableblock > table[frame="void"] {
|
|
border-style: none;
|
|
}
|
|
div.tableblock > table[frame="hsides"] {
|
|
border-left-style: none;
|
|
border-right-style: none;
|
|
}
|
|
div.tableblock > table[frame="vsides"] {
|
|
border-top-style: none;
|
|
border-bottom-style: none;
|
|
}
|
|
|
|
|
|
/*
|
|
* html5 specific
|
|
*
|
|
* */
|
|
|
|
table.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
thead, p.tableblock.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.tableblock {
|
|
margin-top: 0;
|
|
}
|
|
table.tableblock {
|
|
border-width: 3px;
|
|
border-spacing: 0px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
border-collapse: collapse;
|
|
}
|
|
th.tableblock, td.tableblock {
|
|
border-width: 1px;
|
|
padding: 4px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
}
|
|
|
|
table.tableblock.frame-topbot {
|
|
border-left-style: hidden;
|
|
border-right-style: hidden;
|
|
}
|
|
table.tableblock.frame-sides {
|
|
border-top-style: hidden;
|
|
border-bottom-style: hidden;
|
|
}
|
|
table.tableblock.frame-none {
|
|
border-style: hidden;
|
|
}
|
|
|
|
th.tableblock.halign-left, td.tableblock.halign-left {
|
|
text-align: left;
|
|
}
|
|
th.tableblock.halign-center, td.tableblock.halign-center {
|
|
text-align: center;
|
|
}
|
|
th.tableblock.halign-right, td.tableblock.halign-right {
|
|
text-align: right;
|
|
}
|
|
|
|
th.tableblock.valign-top, td.tableblock.valign-top {
|
|
vertical-align: top;
|
|
}
|
|
th.tableblock.valign-middle, td.tableblock.valign-middle {
|
|
vertical-align: middle;
|
|
}
|
|
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
|
|
vertical-align: bottom;
|
|
}
|
|
|
|
|
|
/*
|
|
* manpage specific
|
|
*
|
|
* */
|
|
|
|
body.manpage h1 {
|
|
padding-top: 0.5em;
|
|
padding-bottom: 0.5em;
|
|
border-top: 2px solid silver;
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
body.manpage h2 {
|
|
border-style: none;
|
|
}
|
|
body.manpage div.sectionbody {
|
|
margin-left: 3em;
|
|
}
|
|
|
|
@media print {
|
|
body.manpage div#toc { display: none; }
|
|
}
|
|
|
|
|
|
</style>
|
|
<script type="text/javascript">
|
|
/*<+'])');
|
|
// Function that scans the DOM tree for header elements (the DOM2
|
|
// nodeIterator API would be a better technique but not supported by all
|
|
// browsers).
|
|
var iterate = function (el) {
|
|
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
|
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
|
var mo = re.exec(i.tagName);
|
|
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
|
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
|
}
|
|
iterate(i);
|
|
}
|
|
}
|
|
}
|
|
iterate(el);
|
|
return result;
|
|
}
|
|
|
|
var toc = document.getElementById("toc");
|
|
if (!toc) {
|
|
return;
|
|
}
|
|
|
|
// Delete existing TOC entries in case we're reloading the TOC.
|
|
var tocEntriesToRemove = [];
|
|
var i;
|
|
for (i = 0; i < toc.childNodes.length; i++) {
|
|
var entry = toc.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div'
|
|
&& entry.getAttribute("class")
|
|
&& entry.getAttribute("class").match(/^toclevel/))
|
|
tocEntriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < tocEntriesToRemove.length; i++) {
|
|
toc.removeChild(tocEntriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild TOC entries.
|
|
var entries = tocEntries(document.getElementById("content"), toclevels);
|
|
for (var i = 0; i < entries.length; ++i) {
|
|
var entry = entries[i];
|
|
if (entry.element.id == "")
|
|
entry.element.id = "_toc_" + i;
|
|
var a = document.createElement("a");
|
|
a.href = "#" + entry.element.id;
|
|
a.appendChild(document.createTextNode(entry.text));
|
|
var div = document.createElement("div");
|
|
div.appendChild(a);
|
|
div.className = "toclevel" + entry.toclevel;
|
|
toc.appendChild(div);
|
|
}
|
|
if (entries.length == 0)
|
|
toc.parentNode.removeChild(toc);
|
|
},
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
// Footnotes generator
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
/* Based on footnote generation code from:
|
|
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
|
*/
|
|
|
|
footnotes: function () {
|
|
// Delete existing footnote entries in case we're reloading the footnodes.
|
|
var i;
|
|
var noteholder = document.getElementById("footnotes");
|
|
if (!noteholder) {
|
|
return;
|
|
}
|
|
var entriesToRemove = [];
|
|
for (i = 0; i < noteholder.childNodes.length; i++) {
|
|
var entry = noteholder.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
|
|
entriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < entriesToRemove.length; i++) {
|
|
noteholder.removeChild(entriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild footnote entries.
|
|
var cont = document.getElementById("content");
|
|
var spans = cont.getElementsByTagName("span");
|
|
var refs = {};
|
|
var n = 0;
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnote") {
|
|
n++;
|
|
var note = spans[i].getAttribute("data-note");
|
|
if (!note) {
|
|
// Use [\s\S] in place of . so multi-line matches work.
|
|
// Because JavaScript has no s (dotall) regex flag.
|
|
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
|
spans[i].innerHTML =
|
|
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
spans[i].setAttribute("data-note", note);
|
|
}
|
|
noteholder.innerHTML +=
|
|
"<div class='footnote' id='_footnote_" + n + "'>" +
|
|
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
|
n + "</a>. " + note + "</div>";
|
|
var id =spans[i].getAttribute("id");
|
|
if (id != null) refs["#"+id] = n;
|
|
}
|
|
}
|
|
if (n == 0)
|
|
noteholder.parentNode.removeChild(noteholder);
|
|
else {
|
|
// Process footnoterefs.
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnoteref") {
|
|
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
|
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
|
n = refs[href];
|
|
spans[i].innerHTML =
|
|
"[<a href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
install: function(toclevels) {
|
|
var timerId;
|
|
|
|
function reinstall() {
|
|
asciidoc.footnotes();
|
|
if (toclevels) {
|
|
asciidoc.toc(toclevels);
|
|
}
|
|
}
|
|
|
|
function reinstallAndRemoveTimer() {
|
|
clearInterval(timerId);
|
|
reinstall();
|
|
}
|
|
|
|
timerId = setInterval(reinstall, 500);
|
|
if (document.addEventListener)
|
|
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
|
|
else
|
|
window.onload = reinstallAndRemoveTimer;
|
|
}
|
|
|
|
}
|
|
asciidoc.install();
|
|
/*]]>*/
|
|
</script>
|
|
</head>
|
|
<body class="manpage">
|
|
<div id="header">
|
|
<h1>
|
|
gitcredentials(7) Manual Page
|
|
</h1>
|
|
<h2>NAME</h2>
|
|
<div class="sectionbody">
|
|
<p>gitcredentials -
|
|
Providing usernames and passwords to Git
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div class="sect1">
|
|
<h2 id="_synopsis">SYNOPSIS</h2>
|
|
<div class="sectionbody">
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>git config credential.https://example.com.username myusername
|
|
git config credential.helper "$helper $options"</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_description">DESCRIPTION</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Git will sometimes need credentials from the user in order to perform
|
|
operations; for example, it may need to ask for a username and password
|
|
in order to access a remote repository over HTTP. Some remotes accept
|
|
a personal access token or OAuth access token as a password. This
|
|
manual describes the mechanisms Git uses to request these credentials,
|
|
as well as some features to avoid inputting these credentials repeatedly.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_requesting_credentials">REQUESTING CREDENTIALS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Without any credential helpers defined, Git will try the following
|
|
strategies to ask the user for usernames and passwords:</p></div>
|
|
<div class="olist arabic"><ol class="arabic">
|
|
<li>
|
|
<p>
|
|
If the <code>GIT_ASKPASS</code> environment variable is set, the program
|
|
specified by the variable is invoked. A suitable prompt is provided
|
|
to the program on the command line, and the user’s input is read
|
|
from its standard output.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Otherwise, if the <code>core.askPass</code> configuration variable is set, its
|
|
value is used as above.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Otherwise, if the <code>SSH_ASKPASS</code> environment variable is set, its
|
|
value is used as above.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Otherwise, the user is prompted on the terminal.
|
|
</p>
|
|
</li>
|
|
</ol></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_avoiding_repetition">AVOIDING REPETITION</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>It can be cumbersome to input the same credentials over and over. Git
|
|
provides two methods to reduce this annoyance:</p></div>
|
|
<div class="olist arabic"><ol class="arabic">
|
|
<li>
|
|
<p>
|
|
Static configuration of usernames for a given authentication context.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Credential helpers to cache or store passwords, or to interact with
|
|
a system password wallet or keychain.
|
|
</p>
|
|
</li>
|
|
</ol></div>
|
|
<div class="paragraph"><p>The first is simple and appropriate if you do not have secure storage available
|
|
for a password. It is generally configured by adding this to your config:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>[credential "https://example.com"]
|
|
username = me</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Credential helpers, on the other hand, are external programs from which Git can
|
|
request both usernames and passwords; they typically interface with secure
|
|
storage provided by the OS or other programs. Alternatively, a
|
|
credential-generating helper might generate credentials for certain servers via
|
|
some API.</p></div>
|
|
<div class="paragraph"><p>To use a helper, you must first select one to use (see below for a list).</p></div>
|
|
<div class="paragraph"><p>You may also have third-party helpers installed; search for
|
|
<code>credential-*</code> in the output of <code>git</code> <code>help</code> <code>-a</code>, and consult the
|
|
documentation of individual helpers. Once you have selected a helper,
|
|
you can tell Git to use it by putting its name into the
|
|
credential.helper variable.</p></div>
|
|
<div class="olist arabic"><ol class="arabic">
|
|
<li>
|
|
<p>
|
|
Find a helper.
|
|
</p>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git help -a | grep credential-
|
|
credential-foo</code></pre>
|
|
</div></div>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Read its description.
|
|
</p>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git help credential-foo</code></pre>
|
|
</div></div>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Tell Git to use it.
|
|
</p>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>$ git config --global credential.helper foo</code></pre>
|
|
</div></div>
|
|
</li>
|
|
</ol></div>
|
|
<div class="sect2">
|
|
<h3 id="_available_helpers">Available helpers</h3>
|
|
<div class="paragraph"><p>Git currently includes the following helpers:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
cache
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Cache credentials in memory for a short period of time. See
|
|
<a href="git-credential-cache.html">git-credential-cache(1)</a> for details.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
store
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Store credentials indefinitely on disk. See
|
|
<a href="git-credential-store.html">git-credential-store(1)</a> for details.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
<div class="paragraph"><p>Popular helpers with secure persistent storage include:</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
git-credential-libsecret (Linux)
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
git-credential-osxkeychain (macOS)
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
git-credential-wincred (Windows)
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a href="https://github.com/git-ecosystem/git-credential-manager">Git Credential Manager</a> (cross platform, included in Git for Windows)
|
|
</p>
|
|
</li>
|
|
</ul></div>
|
|
<div class="paragraph"><p>The community maintains a comprehensive list of Git credential helpers at
|
|
<a href="https://git-scm.com/doc/credential-helpers">https://git-scm.com/doc/credential-helpers</a>.</p></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_oauth">OAuth</h3>
|
|
<div class="paragraph"><p>An alternative to inputting passwords or personal access tokens is to use an
|
|
OAuth credential helper. Initial authentication opens a browser window to the
|
|
host. Subsequent authentication happens in the background. Many popular Git
|
|
hosts support OAuth.</p></div>
|
|
<div class="paragraph"><p>Popular helpers with OAuth support include:</p></div>
|
|
<div class="ulist"><ul>
|
|
<li>
|
|
<p>
|
|
<a href="https://github.com/git-ecosystem/git-credential-manager">Git Credential Manager</a> (cross platform, included in Git for Windows)
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a href="https://github.com/hickford/git-credential-oauth">git-credential-oauth</a> (cross platform, included in many Linux distributions)
|
|
</p>
|
|
</li>
|
|
</ul></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_credential_contexts">CREDENTIAL CONTEXTS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Git considers each credential to have a context defined by a URL. This context
|
|
is used to look up context-specific configuration, and is passed to any
|
|
helpers, which may use it as an index into secure storage.</p></div>
|
|
<div class="paragraph"><p>For instance, imagine we are accessing <code>https://example.com/foo.git</code>. When Git
|
|
looks into a config file to see if a section matches this context, it will
|
|
consider the two a match if the context is a more-specific subset of the
|
|
pattern in the config file. For example, if you have this in your config file:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>[credential "https://example.com"]
|
|
username = foo</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>then we will match: both protocols are the same, both hosts are the same, and
|
|
the "pattern" URL does not care about the path component at all. However, this
|
|
context would not match:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code>[credential "https://kernel.org"]
|
|
username = foo</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>because the hostnames differ. Nor would it match <code>foo.example.com</code>; Git
|
|
compares hostnames exactly, without considering whether two hosts are part of
|
|
the same domain. Likewise, a config entry for <code>http://example.com</code> would not
|
|
match: Git compares the protocols exactly. However, you may use wildcards in
|
|
the domain name and other pattern matching techniques as with the <code>http.</code><em><URL></em><code>.*</code>
|
|
options.</p></div>
|
|
<div class="paragraph"><p>If the "pattern" URL does include a path component, then this too must match
|
|
exactly: the context <code>https://example.com/bar/baz.git</code> will match a config
|
|
entry for <code>https://example.com/bar/baz.git</code> (in addition to matching the config
|
|
entry for <code>https://example.com</code>) but will not match a config entry for
|
|
<code>https://example.com/bar</code>.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_configuration_options">CONFIGURATION OPTIONS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Options for a credential context can be configured either in
|
|
<code>credential.*</code> (which applies to all credentials), or
|
|
<code>credential.</code><em><URL></em><code>.*</code>, where <URL> matches the context as described
|
|
above.</p></div>
|
|
<div class="paragraph"><p>The following options are available in either location:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
helper
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
The name of an external credential helper, and any associated options.
|
|
If the helper name is not an absolute path, then the string <code>git</code>
|
|
<code>credential-</code> is prepended. The resulting string is executed by the
|
|
shell (so, for example, setting this to <code>foo</code> <code>--option=bar</code> will execute
|
|
<code>git</code> <code>credential-foo</code> <code>--option=bar</code> via the shell. See the manual of
|
|
specific helpers for examples of their use.
|
|
</p>
|
|
<div class="paragraph"><p>If there are multiple instances of the <code>credential.helper</code> configuration
|
|
variable, each helper will be tried in turn, and may provide a username,
|
|
password, or nothing. Once Git has acquired both a username and a
|
|
non-expired password, no more helpers will be tried.</p></div>
|
|
<div class="paragraph"><p>If <code>credential.helper</code> is configured to the empty string, this resets
|
|
the helper list to empty (so you may override a helper set by a
|
|
lower-priority config file by configuring the empty-string helper,
|
|
followed by whatever set of helpers you would like).</p></div>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
username
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
A default username, if one is not provided in the URL.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
useHttpPath
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
By default, Git does not consider the "path" component of an http URL
|
|
to be worth matching via external helpers. This means that a credential
|
|
stored for <code>https://example.com/foo.git</code> will also be used for
|
|
<code>https://example.com/bar.git</code>. If you do want to distinguish these
|
|
cases, set this option to <code>true</code>.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_custom_helpers">CUSTOM HELPERS</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>You can write your own custom helpers to interface with any system in
|
|
which you keep credentials.</p></div>
|
|
<div class="paragraph"><p>Credential helpers are programs executed by Git to fetch or save
|
|
credentials from and to long-term storage (where "long-term" is simply
|
|
longer than a single Git process; e.g., credentials may be stored
|
|
in-memory for a few minutes, or indefinitely on disk).</p></div>
|
|
<div class="paragraph"><p>Each helper is specified by a single string in the configuration
|
|
variable <code>credential.helper</code> (and others, see <a href="git-config.html">git-config(1)</a>).
|
|
The string is transformed by Git into a command to be executed using
|
|
these rules:</p></div>
|
|
<div class="olist arabic"><ol class="arabic">
|
|
<li>
|
|
<p>
|
|
If the helper string begins with "!", it is considered a shell
|
|
snippet, and everything after the "!" becomes the command.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Otherwise, if the helper string begins with an absolute path, the
|
|
verbatim helper string becomes the command.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Otherwise, the string "git credential-" is prepended to the helper
|
|
string, and the result becomes the command.
|
|
</p>
|
|
</li>
|
|
</ol></div>
|
|
<div class="paragraph"><p>The resulting command then has an "operation" argument appended to it
|
|
(see below for details), and the result is executed by the shell.</p></div>
|
|
<div class="paragraph"><p>Here are some example specifications:</p></div>
|
|
<div class="listingblock">
|
|
<div class="content">
|
|
<pre><code># run "git credential-foo"
|
|
[credential]
|
|
helper = foo
|
|
|
|
# same as above, but pass an argument to the helper
|
|
[credential]
|
|
helper = "foo --bar=baz"
|
|
|
|
# the arguments are parsed by the shell, so use shell
|
|
# quoting if necessary
|
|
[credential]
|
|
helper = "foo --bar='whitespace arg'"
|
|
|
|
# store helper (discouraged) with custom location for the db file;
|
|
# use `--file ~/.git-secret.txt`, rather than `--file=~/.git-secret.txt`,
|
|
# to allow the shell to expand tilde to the home directory.
|
|
[credential]
|
|
helper = "store --file ~/.git-secret.txt"
|
|
|
|
# you can also use an absolute path, which will not use the git wrapper
|
|
[credential]
|
|
helper = "/path/to/my/helper --with-arguments"
|
|
|
|
# or you can specify your own shell snippet
|
|
[credential "https://example.com"]
|
|
username = your_user
|
|
helper = "!f() { test \"$1\" = get && echo \"password=$(cat $HOME/.secret)\"; }; f"</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Generally speaking, rule (3) above is the simplest for users to specify.
|
|
Authors of credential helpers should make an effort to assist their
|
|
users by naming their program "git-credential-$NAME", and putting it in
|
|
the <code>$PATH</code> or <code>$GIT_EXEC_PATH</code> during installation, which will allow a
|
|
user to enable it with <code>git</code> <code>config</code> <code>credential.helper</code> <code>$NAME</code>.</p></div>
|
|
<div class="paragraph"><p>When a helper is executed, it will have one "operation" argument
|
|
appended to its command line, which is one of:</p></div>
|
|
<div class="dlist"><dl>
|
|
<dt class="hdlist1">
|
|
<code>get</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Return a matching credential, if any exists.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>store</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Store the credential, if applicable to the helper.
|
|
</p>
|
|
</dd>
|
|
<dt class="hdlist1">
|
|
<code>erase</code>
|
|
</dt>
|
|
<dd>
|
|
<p>
|
|
Remove matching credentials, if any, from the helper’s storage.
|
|
</p>
|
|
</dd>
|
|
</dl></div>
|
|
<div class="paragraph"><p>The details of the credential will be provided on the helper’s stdin
|
|
stream. The exact format is the same as the input/output format of the
|
|
<code>git</code> <code>credential</code> plumbing command (see the section <code>INPUT/OUTPUT</code>
|
|
<code>FORMAT</code> in <a href="git-credential.html">git-credential(1)</a> for a detailed specification).</p></div>
|
|
<div class="paragraph"><p>For a <code>get</code> operation, the helper should produce a list of attributes on
|
|
stdout in the same format (see <a href="git-credential.html">git-credential(1)</a> for common
|
|
attributes). A helper is free to produce a subset, or even no values at
|
|
all if it has nothing useful to provide. Any provided attributes will
|
|
overwrite those already known about by Git’s credential subsystem.
|
|
Unrecognised attributes are silently discarded.</p></div>
|
|
<div class="paragraph"><p>While it is possible to override all attributes, well behaving helpers
|
|
should refrain from doing so for any attribute other than username and
|
|
password.</p></div>
|
|
<div class="paragraph"><p>If a helper outputs a <code>quit</code> attribute with a value of <code>true</code> or <code>1</code>,
|
|
no further helpers will be consulted, nor will the user be prompted
|
|
(if no credential has been provided, the operation will then fail).</p></div>
|
|
<div class="paragraph"><p>Similarly, no more helpers will be consulted once both username and
|
|
password had been provided.</p></div>
|
|
<div class="paragraph"><p>For a <code>store</code> or <code>erase</code> operation, the helper’s output is ignored.</p></div>
|
|
<div class="paragraph"><p>If a helper fails to perform the requested operation or needs to notify
|
|
the user of a potential issue, it may write to stderr.</p></div>
|
|
<div class="paragraph"><p>If it does not support the requested operation (e.g., a read-only store
|
|
or generator), it should silently ignore the request.</p></div>
|
|
<div class="paragraph"><p>If a helper receives any other operation, it should silently ignore the
|
|
request. This leaves room for future operations to be added (older
|
|
helpers will just ignore the new requests).</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_git">GIT</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footnotes"><hr /></div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated
|
|
2025-08-18 02:18:23 CEST
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|