/usr/share/doc/mini-buildd/html/introduction.html is in mini-buildd 1.0.0~rc.5.
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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | <!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>Introduction — mini-buildd 1.0.0~rc.5 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0.0~rc.5',
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="shortcut icon" href="/static/favicon.ico" />
<link rel="stylesheet" type="text/css" href="/static/css/sphinx.css" />
<link rel="top" title="mini-buildd 1.0.0~rc.5 documentation" href="index.html" />
<link rel="next" title="Quickstart" href="quickstart.html" />
<link rel="prev" title="mini-buildd" href="index.html" />
</head>
<body>
<div class="related">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="quickstart.html" title="Quickstart"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="mini-buildd"
accesskey="P">previous</a> |</li>
<li><a title="mini-buildd Home" href="../"><img class="logo" src="_static/img/icon_48x48.png" alt="mini-buildd logo" /></a></li>
<li><a href="index.html">mini-buildd 1.0.0~rc.5 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p><strong>mini-buildd</strong> is a custom build daemon for <em>Debian</em>-based
distributions with <em>all batteries included</em>: I.e., it covers
<strong>incoming</strong>, <strong>(distributed) building</strong>, <strong>installing</strong>,
<strong>repository maintenance</strong> and <strong>repository delivery</strong>.</p>
<div class="section" id="main-components">
<span id="introduction-main-components"></span><h2>Main Components<a class="headerlink" href="#main-components" title="Permalink to this headline">¶</a></h2>
<p>mini-buildd does not re-invent the wheel, it’s rather a
sophisticated glue written in <a class="reference external" href="http://packages.qa.debian.org/p/python.html">python</a> to a number of
standard (Debian) or off-the-shelf software components. The most
prominent parts are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="10%" />
<col width="24%" />
<col width="67%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Component</th>
<th class="head">Used for</th>
<th class="head">Realized with</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><strong>HTTP server</strong></td>
<td>Web application, repository delivery</td>
<td><a class="reference external" href="http://packages.qa.debian.org/c/cherrypy3.html">cherrypy3</a></td>
</tr>
<tr class="row-odd"><td><strong>Web application</strong></td>
<td>Configuration, package tracking</td>
<td><a class="reference external" href="http://packages.qa.debian.org/p/python-django.html">python-django</a></td>
</tr>
<tr class="row-even"><td><strong>FTP server</strong></td>
<td>Incoming (user uploads, build requests and results)</td>
<td><a class="reference external" href="http://packages.qa.debian.org/p/python-pyftpdlib.html">python-pyftpdlib</a></td>
</tr>
<tr class="row-odd"><td><strong>Packager</strong></td>
<td>Source package manager, build distribution</td>
<td> </td>
</tr>
<tr class="row-even"><td><strong>Builder</strong></td>
<td>Package builds</td>
<td><a class="reference external" href="http://packages.qa.debian.org/s/sbuild.html">sbuild</a> / <a class="reference external" href="http://packages.qa.debian.org/s/schroot.html">schroot</a> combo using snapshot-able chroots.</td>
</tr>
<tr class="row-odd"><td><strong>Repository</strong></td>
<td>APT package archive</td>
<td><a class="reference external" href="http://packages.qa.debian.org/r/reprepro.html">reprepro</a></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="features">
<span id="introduction-features"></span><h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<p><em>Core features</em>:</p>
<ul class="simple">
<li>Integrated <strong>HTTP server</strong> (webapp and repository delivery).</li>
<li>Integrated <strong>FTP server</strong> (incoming).</li>
<li><strong>Web-based configuration</strong>, with integrated managing of chroots and repositories.</li>
<li><strong>Distributed builders</strong>.</li>
<li><strong>Web-based</strong> or <strong>command line</strong> repository maintenance via <em>API</em> calls.</li>
</ul>
<p><em>Some prominent extras</em>:</p>
<ul class="simple">
<li><em>mini-buildd-tool</em>: Use from the command line, write scripts.</li>
<li><em>User management</em>: Package subscriptions, GPG key management, upload authorization.</li>
<li><em>Package QA</em>: Internal sanity checks, version enforcing, lintian.</li>
<li><em>Package Tracking</em>: <tt class="docutils literal"><span class="pre">Debian</span> <span class="pre">PTS</span></tt>-like web based source package tracker.</li>
<li><em>No-Changes-Ports</em>: Automates these ports for internal or external source packages.</li>
<li><em>Rollback handling</em>: Keeps <tt class="docutils literal"><span class="pre">N</span></tt> rollbacks for any distribution.</li>
<li><em>Builds keyring packages</em> automatically.</li>
</ul>
<p>The <a class="reference internal" href="todo.html"><em>FAQ, Hints, Todos, Troubleshooting, Bugs</em></a> section may also help you to figure out what
mini-buildd is not, or not yet.</p>
</div>
<div class="section" id="example-use-cases">
<span id="introduction-use-cases"></span><h2>Example Use Cases<a class="headerlink" href="#example-use-cases" title="Permalink to this headline">¶</a></h2>
<ul>
<li><dl class="first docutils">
<dt><em>Sandboxing</em>: Just setup a default <tt class="docutils literal"><span class="pre">test</span></tt> (sandbox) repository:</dt>
<dd><ul class="first last simple">
<li>Test-drive mini-buildd. Click schlimm on the WebApp.</li>
<li>Checkout what No-Changes-Ports are possible.</li>
<li>Add a fake user as admin, and spam a colleague with mini-buildd status mails.</li>
</ul>
</dd>
</dl>
</li>
<li><p class="first"><em>Debian User</em>: Maintain a personal package archive. Publish it to your web space via debmirror.</p>
</li>
<li><p class="first"><em>Debian Developer</em>: Replace your pbuilder setup.</p>
</li>
<li><p class="first"><em>Organization</em>: Set up an archive for all organizational extra packages, ports, etc.</p>
</li>
</ul>
</div>
<div class="section" id="basic-mode-of-operation">
<span id="introduction-overview"></span><h2>Basic Mode Of Operation<a class="headerlink" href="#basic-mode-of-operation" title="Permalink to this headline">¶</a></h2>
<p><strong>mini-buildd</strong> is a Unix daemon written in python. When
running, it provides a HTTP server (on port <tt class="docutils literal"><span class="pre">8066</span></tt> by default).</p>
<p>The HTTP server serves both, mini-buildd’s web application as
well as the delivery of the package repositories.</p>
<p>The instance is being configured in the configuration section of
the web application.</p>
<p>As soon as a <em>mini-buildd</em> instance has been configured to have
an active ‘Daemon’, you may <tt class="docutils literal"><span class="pre">start</span></tt> the engine, running an FTP
server (on port <tt class="docutils literal"><span class="pre">8067</span></tt> by default).</p>
<p>The FTP server acts on incoming <tt class="docutils literal"><span class="pre">*.changes</span></tt> files, both from
developers and other mini-buildd instances (via special
<tt class="docutils literal"><span class="pre">buildrequest</span></tt> and <tt class="docutils literal"><span class="pre">buildresult</span></tt> changes).</p>
<p>As soon as an instance of <em>mini-buildd</em> has active chroots
configured, it acts as <em>builder</em>. Chroots are completely generic
and interchangeable, and identified by <em>codename</em> and <em>arch</em>
only; distribution-specific build configuration is all carried
through the internal buildrequests. Thus, <em>mini-buildd</em>
instances may be interconnected as so-called ‘Remotes’ to share
builders.</p>
<p>This is a simplified example mini-buildd ‘network’ with three
mini-buildd instances <em>ernie</em>, <em>grover</em> and <em>bert</em>:</p>
<p class="graphviz">
<img src="_images/graphviz-2485d4d54ab89fd841fb210afebf584e6d88f774.png" alt="digraph flow_simple
{
node [fontname=Arial fontsize=11 shape=diamond style=filled fillcolor=grey];
edge [fontname=Helvetica fontsize=8];
subgraph cluster_0
{
style=filled;
color=lightgrey;
label="ernie";
"Ernie-Packager" [label="Packager"];
"Ernie-Builder" [label="Builder"];
"Ernie-Repositories" [label="Repositories" shape=folder];
}
"Ernie-Developer" [shape=oval fillcolor=lightgrey];
"Ernie-Developer" -> "Ernie-Packager" [label="uploads"];
"Ernie-Packager" -> "Ernie-Repositories" [label="installs"];
"Ernie-Packager" -> {"Ernie-Builder" "Grover-Builder"} [dir=both label="builds"];
"Ernie-Manager" [shape=oval fillcolor=lightgrey];
"Ernie-Manager" -> "Ernie-Repositories" [label="manages"];
"Ernie-User" [shape=oval fillcolor=lightgrey];
"Ernie-Repositories" -> "Ernie-User" [label="apt"];
subgraph cluster_1
{
style=filled;
color=lightgrey;
label="grover";
"Grover-Builder" [label="Builder"];
}
subgraph cluster_2
{
style=filled;
color=lightgrey;
label="bert";
"Bert-Packager" [label="Packager"];
"Bert-Repositories" [label="Repositories" shape=folder];
}
"Bert-Developer" [shape=oval fillcolor=lightgrey];
"Bert-Developer" -> "Bert-Packager" [label="uploads"];
"Bert-Packager" -> "Bert-Repositories" [label="installs"];
"Bert-Packager" -> {"Ernie-Builder" "Grover-Builder"} [dir=both label="builds"];
"Bert-Manager" [shape=oval fillcolor=lightgrey];
"Bert-Manager" -> "Bert-Repositories" [label="manages"];
"Bert-User" [shape=oval fillcolor=lightgrey];
"Bert-Repositories" -> "Bert-User" [label="apt"];
}" />
</p>
<ul class="simple">
<li><em>ernie</em> has repositories and chroots, and uses himself and <em>grover</em> as remote for building.</li>
<li><em>grover</em> only has chroots, and is used by <em>ernie</em> and <em>bert</em> for building.</li>
<li><em>bert</em> only has repositories, and uses <em>ernie</em> and <em>grover</em> as remotes for building.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Introduction</a><ul>
<li><a class="reference internal" href="#main-components">Main Components</a></li>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#example-use-cases">Example Use Cases</a></li>
<li><a class="reference internal" href="#basic-mode-of-operation">Basic Mode Of Operation</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">mini-buildd</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="quickstart.html"
title="next chapter">Quickstart</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/introduction.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="quickstart.html" title="Quickstart"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="mini-buildd"
>previous</a> |</li>
<li><a title="mini-buildd Home" href="../"><img class="logo" src="_static/img/icon_48x48.png" alt="mini-buildd logo" /></a></li>
<li><a href="index.html">mini-buildd 1.0.0~rc.5 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, 2013, mini-buildd maintainers.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
</html>
|