CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Welcome to Distro Tracker鈥檚 Documentation! — Distro Tracker 1.2.1 documentation</title> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/doctools.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Following Packages" href="usage/follow-packages.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> Distro Tracker </a> <div class="version"> 1.2.1 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <p class="caption"><span class="caption-text">Documentation for End-Users</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="usage/follow-packages.html">Following Packages</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/messages.html">Email Messages</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/teams.html">Working with Teams</a></li> <li class="toctree-l1"><a class="reference internal" href="usage/mailbot.html">Interacting with Distro-Tracker by Email</a></li> </ul> <p class="caption"><span class="caption-text">Documentation for Administrators</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="admin/initial-setup.html">Initial Setup</a></li> <li class="toctree-l1"><a class="reference internal" href="admin/email.html">Forwarding Mails through the Package Tracker</a></li> <li class="toctree-l1"><a class="reference internal" href="admin/vendor.html">Vendor Customization</a></li> <li class="toctree-l1"><a class="reference internal" href="admin/upgrade-notes.html">Upgrade Notes</a></li> </ul> <p class="caption"><span class="caption-text">Documentation for Developers</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="devel/design.html">Design Overview</a></li> <li class="toctree-l1"><a class="reference internal" href="api/modules.html">API Documentation</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">Distro Tracker</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home"></a> »</li> <li>Welcome to Distro Tracker鈥檚 Documentation!</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="welcome-to-distro-tracker-s-documentation"> <h1>Welcome to Distro Tracker鈥檚 Documentation!<a class="headerlink" href="#welcome-to-distro-tracker-s-documentation" title="Permalink to this headline">露</a></h1> <p>Distro Tracker is the name of the software that powers the <a class="reference external" href="https://tracker.debian.org">Debian Package Tracker</a>.</p> <p>This software lets you follow the evolution of a Debian-based distribution both with email updates and with a comprehensive web interface.</p> <p>Having all the information about packages conveniently available in a single place is particularly interesting for package maintainers, contributors, advanced users, etc.</p> <div class="toctree-wrapper compound"> <p class="caption"><span class="caption-text">Documentation for End-Users</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="usage/follow-packages.html">Following Packages</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/follow-packages.html#visiting-the-package-s-page">Visiting the Package鈥檚 Page</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/follow-packages.html#getting-updates-by-email">Getting Updates by Email</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/follow-packages.html#following-updates-with-an-rss-feed">Following Updates with an RSS Feed</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/messages.html">Email Messages</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/messages.html#type-of-emails">Type of Emails</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/messages.html#mail-headers">Mail Headers</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/messages.html#subscribing-to-a-package">Subscribing to a package</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/teams.html">Working with Teams</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#purpose-of-teams">Purpose of Teams</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#team-email-address">Team Email Address</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#team-packages-overview">Team Packages Overview</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#creating-a-team">Creating a Team</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#joining-a-team">Joining a Team</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#adding-and-removing-packages">Adding and Removing Packages</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#adding-and-removing-members">Adding and Removing Members</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/teams.html#managing-subscriptions-to-teams">Managing Subscriptions to Teams</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="usage/mailbot.html">Interacting with Distro-Tracker by Email</a><ul> <li class="toctree-l2"><a class="reference internal" href="usage/mailbot.html#how-the-mailbot-works">How the Mailbot Works</a></li> <li class="toctree-l2"><a class="reference internal" href="usage/mailbot.html#mailbot-commands-reference">Mailbot Commands Reference</a></li> </ul> </li> </ul> </div> <div class="toctree-wrapper compound"> <p class="caption"><span class="caption-text">Documentation for Administrators</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="admin/initial-setup.html">Initial Setup</a><ul> <li class="toctree-l2"><a class="reference internal" href="admin/installation.html">Setting up Distro Tracker</a></li> <li class="toctree-l2"><a class="reference internal" href="admin/webserver.html">Integration with a Web Server</a></li> <li class="toctree-l2"><a class="reference internal" href="admin/mailbot.html">Setting up the mailbot</a></li> <li class="toctree-l2"><a class="reference internal" href="admin/repositories.html">Setting up the package repositories</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="admin/email.html">Forwarding Mails through the Package Tracker</a><ul> <li class="toctree-l2"><a class="reference internal" href="admin/email.html#general-principle">General Principle</a></li> <li class="toctree-l2"><a class="reference internal" href="admin/email.html#forwarding-vcs-commits-to-the-package-tracker">Forwarding VCS Commits to the Package Tracker</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="admin/vendor.html">Vendor Customization</a></li> <li class="toctree-l1"><a class="reference internal" href="admin/upgrade-notes.html">Upgrade Notes</a><ul> <li class="toctree-l2"><a class="reference internal" href="admin/upgrade-notes.html#update-to-debian-12-distro-tracker-1-2-x">Update to Debian 12 / distro-tracker 1.2.x</a></li> <li class="toctree-l2"><a class="reference internal" href="admin/upgrade-notes.html#update-to-debian-11-distro-tracker-1-1-3">Update to Debian 11 / distro-tracker 1.1.3</a></li> </ul> </li> </ul> </div> <div class="toctree-wrapper compound"> <p class="caption"><span class="caption-text">Documentation for Developers</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul> <li class="toctree-l2"><a class="reference internal" href="contributing.html#join-the-community">Join the community</a></li> <li class="toctree-l2"><a class="reference internal" href="contributing.html#contribute">Contribute</a><ul> <li class="toctree-l3"><a class="reference internal" href="contributing.html#usual-workflow">Usual workflow</a></li> <li class="toctree-l3"><a class="reference internal" href="contributing.html#test-driven-development">Test Driven Development</a></li> <li class="toctree-l3"><a class="reference internal" href="contributing.html#conventions">Conventions</a></li> <li class="toctree-l3"><a class="reference internal" href="contributing.html#git-commit-notices">Git commit notices</a></li> <li class="toctree-l3"><a class="reference internal" href="contributing.html#write-access-to-the-git-repository">Write access to the git repository</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="devel/design.html">Design Overview</a><ul> <li class="toctree-l2"><a class="reference internal" href="devel/design.html#introduction">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="devel/design.html#email-interface">Email Interface</a><ul> <li class="toctree-l3"><a class="reference internal" href="devel/design.html#email-control-messages">Email Control Messages</a></li> <li class="toctree-l3"><a class="reference internal" href="devel/design.html#email-dispatch">Email Dispatch</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="devel/design.html#tasks-framework">Tasks Framework</a></li> <li class="toctree-l2"><a class="reference internal" href="devel/design.html#vendor-specific-rules">Vendor-specific Rules</a></li> <li class="toctree-l2"><a class="reference internal" href="devel/design.html#package-information">Package Information</a><ul> <li class="toctree-l3"><a class="reference internal" href="devel/design.html#data-model">Data model</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="devel/design.html#web-interface">Web Interface</a><ul> <li class="toctree-l3"><a class="reference internal" href="devel/design.html#panels-framework">Panels Framework</a></li> <li class="toctree-l3"><a class="reference internal" href="devel/design.html#views-and-templates">Views and Templates</a></li> <li class="toctree-l3"><a class="reference internal" href="devel/design.html#client-side-functionality">Client-side Functionality</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api/modules.html">API Documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.accounts.html">distro_tracker.accounts</a><ul> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.accounts.html#module-distro_tracker.accounts.models">distro_tracker.accounts.models</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.accounts.html#module-distro_tracker.accounts.views">distro_tracker.accounts.views</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.accounts.html#module-distro_tracker.accounts.hooks">distro_tracker.accounts.hooks</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.core.html">distro_tracker.core</a><ul> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.core.html#core-internal-api">Core internal API</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.core.html#extendable-parts-of-the-web-interface">Extendable parts of the web interface</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.core.html#web-interface-implementation">Web interface implementation</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.html.html">distro_tracker.html</a><ul> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.html.html#module-distro_tracker.html.templatetags.bootstrap">distro_tracker.html.templatetags.bootstrap</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.mail.html">distro_tracker.mail</a><ul> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.mail.html#module-distro_tracker.mail.control">distro_tracker.mail.control</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.mail.html#module-distro_tracker.mail.dispatch">distro_tracker.mail.dispatch</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.mail.html#module-distro_tracker.mail.mail_news">distro_tracker.mail.mail_news</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.mail.html#module-distro_tracker.mail.models">distro_tracker.mail.models</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.mail.html#module-distro_tracker.mail.processor">distro_tracker.mail.processor</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.project.html">distro_tracker.project</a><ul> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.project.html#module-distro_tracker.project.settings">distro_tracker.settings</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.project.html#module-distro_tracker.project.settings.defaults">distro_tracker.settings.defaults</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.project.html#distro-tracker-settings-local">distro_tracker.settings.local</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.project.html#module-distro_tracker.project.settings.production">distro_tracker.settings.production</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.project.html#module-distro_tracker.project.settings.development">distro_tracker.settings.development</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.project.html#module-distro_tracker.project.settings.test">distro_tracker.settings.test</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.test.html">distro_tracker.test</a></li> <li class="toctree-l2"><a class="reference internal" href="api/distro_tracker.vendor.html">distro_tracker.vendor</a><ul> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.vendor.html#module-distro_tracker.vendor.skeleton.rules">Sample skeleton vendor</a></li> <li class="toctree-l3"><a class="reference internal" href="api/distro_tracker.vendor.html#existing-vendors">Existing vendors</a></li> </ul> </li> </ul> </li> </ul> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="usage/follow-packages.html" class="btn btn-neutral float-right" title="Following Packages" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2013-2021, The Distro Tracker Developers. </p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>