/usr/share/doc/python-social-auth-doc/html/backends/github_enterprise.html is in python-social-auth-doc 1:0.2.21+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>GitHub Enterprise — Python Social Auth documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python Social Auth documentation" href="../index.html" />
<link rel="up" title="Backends" href="index.html" />
<link rel="next" title="Google" href="google.html" />
<link rel="prev" title="GitHub" href="github.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="google.html" title="Google"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="github.html" title="GitHub"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Python Social Auth documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Backends</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="github-enterprise">
<span id="id1"></span><h1>GitHub Enterprise<a class="headerlink" href="#github-enterprise" title="Permalink to this headline">¶</a></h1>
<p>GitHub Enterprise works similar to regular Github, which is in turn based on Facebook (OAuth).</p>
<ul>
<li><p class="first">Register a new application on your instance of <a class="reference external" href="https://<your_github_enterprise_domain>/settings/applications/new">GitHub Enterprise Developers</a>,
set the callback URL to <code class="docutils literal"><span class="pre">http://example.com/complete/github/</span></code> replacing <code class="docutils literal"><span class="pre">example.com</span></code>
with your domain.</p>
</li>
<li><p class="first">Set the API URL for your Github Enterprise appliance:</p>
<blockquote>
<div><p>SOCIAL_AUTH_GITHUB_ENTERPRISE_API_URL = ‘<a class="reference external" href="https://git.example.com/api/v3/">https://git.example.com/api/v3/</a>‘</p>
</div></blockquote>
</li>
<li><p class="first">Fill the <code class="docutils literal"><span class="pre">Client</span> <span class="pre">ID</span></code> and <code class="docutils literal"><span class="pre">Client</span> <span class="pre">Secret</span></code> values from GitHub in the settings:</p>
<blockquote>
<div><p>SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY = ‘’
SOCIAL_AUTH_GITHUB_ENTERPRISE_SECRET = ‘’</p>
</div></blockquote>
</li>
<li><p class="first">Also it’s possible to define extra permissions with:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">SOCIAL_AUTH_GITHUB_ENTERPRISE_SCOPE</span> <span class="o">=</span> <span class="p">[</span><span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
</li>
</ul>
<div class="section" id="github-enterprise-for-organizations">
<h2>GitHub Enterprise for Organizations<a class="headerlink" href="#github-enterprise-for-organizations" title="Permalink to this headline">¶</a></h2>
<p>When defining authentication for organizations, use the
<code class="docutils literal"><span class="pre">GithubEnterpriseOrganizationOAuth2</span></code> backend instead. The settings are the same as
the non-organization backend, but the names must be:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_</span><span class="o">*</span>
</pre></div>
</div>
<p>Be sure to define the organization name using the setting:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_NAME</span> <span class="o">=</span> <span class="s1">''</span>
</pre></div>
</div>
<p>This name will be used to check that the user really belongs to the given
organization and discard it if they’re not part of it.</p>
</div>
<div class="section" id="github-enterprise-for-teams">
<h2>GitHub Enterprise for Teams<a class="headerlink" href="#github-enterprise-for-teams" title="Permalink to this headline">¶</a></h2>
<p>Similar to <code class="docutils literal"><span class="pre">GitHub</span> <span class="pre">Enterprise</span> <span class="pre">for</span> <span class="pre">Organizations</span></code>, there’s a GitHub for Teams backend,
use the backend <code class="docutils literal"><span class="pre">GithubEnterpriseTeamOAuth2</span></code>. The settings are the same as
the basic backend, but the names must be:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_</span><span class="o">*</span>
</pre></div>
</div>
<p>Be sure to define the <code class="docutils literal"><span class="pre">Team</span> <span class="pre">ID</span></code> using the setting:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_ID</span> <span class="o">=</span> <span class="s1">''</span>
</pre></div>
</div>
<p>This <code class="docutils literal"><span class="pre">id</span></code> will be used to check that the user really belongs to the given
team and discard it if they’re not part of it.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">GitHub Enterprise</a><ul>
<li><a class="reference internal" href="#github-enterprise-for-organizations">GitHub Enterprise for Organizations</a></li>
<li><a class="reference internal" href="#github-enterprise-for-teams">GitHub Enterprise for Teams</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="github.html"
title="previous chapter">GitHub</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="google.html"
title="next chapter">Google</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/backends/github_enterprise.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="google.html" title="Google"
>next</a> |</li>
<li class="right" >
<a href="github.html" title="GitHub"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Python Social Auth documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Backends</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../copyright.html">Copyright</a> 2017, Matías Aguirre.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</div>
</body>
</html>
|