CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="./"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Welcome to Indico鈥檚 documentation! — Indico 3.3.5-dev documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />  <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=54c45b04"></script> <script src="_static/doctools.js?v=9a2dae69"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex/" /> <link rel="search" title="Search" href="search/" /> <link rel="next" title="Installation guides" href="installation/" /> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="indico" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></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"> Indico </a> <div class="version"> 3.3.5 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search/" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference internal" href="installation/">Installation guides</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="config/">Configuration</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="building/">Building</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="search-engine/">Search</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="plugins/">Indico plugins</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="http-api/">HTTP API</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="translations/">Translating Indico</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="api/">API reference</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="changelog/">Changelog</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="contact/">Contact</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">Indico</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Welcome to Indico鈥檚 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"> <section id="welcome-to-indico-s-documentation"> <h1>Welcome to Indico鈥檚 documentation!<a class="headerlink" href="#welcome-to-indico-s-documentation" title="Link to this heading">露</a></h1> <iframe src="https://ghbtns.com/github-btn.html?user=indico&repo=indico&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe> <a class="reference internal image-reference" href="_images/indico.png"><img alt="_images/indico.png" class="align-center" src="_images/indico.png" style="width: 300px;" /></a> <blockquote class="epigraph"> <div><p><em>The effortless open source tool for event organization, archival and collaboration.</em></p> </div></blockquote> <p><a class="reference external" href="https://github.com/indico/indico/actions"><img alt="CI Build Status" src="https://github.com/indico/indico/workflows/CI/badge.svg" /></a> <a class="reference external" href="https://github.com/indico/indico/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/indico/indico.png" /></a> <a class="reference external" href="https://pypi.python.org/pypi/indico/"><img alt="Available on PyPI" src="https://img.shields.io/pypi/v/indico.png" /></a> <a class="reference external" href="https://home.cern"><img alt="Made at CERN!" src="https://img.shields.io/badge/CERN-Open%20Source-%232980b9.svg" /></a></p> <p>Welcome to Indico鈥檚 documentation. This documentation is split into several parts, from <a class="reference external" href="installation/">installing Indico</a> to developing <a class="reference external" href="plugins">Indico plugins</a>. To dive into the internals of Indico, check out the <a class="reference external" href="api">API documentation</a>. Read more about Indico in our <a class="reference external" href="https://getindico.io">official website</a>.</p> <section id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">露</a></h2> <p>To simply install and use Indico, follow the <a class="reference internal" href="installation/production/#install-prod"><span class="std std-ref">production installation instructions</span></a>. For those who are interested in developing new features and plugins for Indico, check out the <a class="reference internal" href="installation/development/#install-dev"><span class="std std-ref">development installation instructions</span></a>.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="installation/">Installation guides</a><ul> <li class="toctree-l2"><a class="reference internal" href="installation/production/">Production</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/upgrade/">Upgrade</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/upgrade_legacy/">Migration from 1.2</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/development/">Development</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/plugins/">Plugins</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/translations/">Translations</a></li> <li class="toctree-l2"><a class="reference internal" href="installation/pdf_generation/">PDF Generation</a></li> </ul> </li> </ul> </div> </section> <section id="configuration"> <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">露</a></h2> <p>Indico is very flexible and many things can be configured/customized in its configuration file.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="config/">Configuration</a><ul> <li class="toctree-l2"><a class="reference internal" href="config/settings/">Settings</a></li> <li class="toctree-l2"><a class="reference internal" href="config/auth/">Authentication</a></li> </ul> </li> </ul> </div> </section> <section id="building"> <h2>Building<a class="headerlink" href="#building" title="Link to this heading">露</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="building/">Building</a><ul> <li class="toctree-l2"><a class="reference internal" href="building/#including-a-new-translation">Including a new translation</a></li> </ul> </li> </ul> </div> </section> <section id="search"> <h2>Search<a class="headerlink" href="#search" title="Link to this heading">露</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="search-engine/">Search</a><ul> <li class="toctree-l2"><a class="reference internal" href="search-engine/features/">Internal Search</a></li> <li class="toctree-l2"><a class="reference internal" href="search-engine/features/#external-search-service">External Search Service</a></li> <li class="toctree-l2"><a class="reference internal" href="search-engine/plugin/">API Reference</a></li> </ul> </li> </ul> </div> </section> <section id="plugins"> <h2>Plugins<a class="headerlink" href="#plugins" title="Link to this heading">露</a></h2> <p>Indico can be extended through plugins, standalone packages of code that do not require any modifications to the Indico core itself. A plugin can perform something very simple such as adding a new command to the Indico CLI to more complex functionalities like introducing new payment methods, chat integration, etc.</p> <p>We suggest that you first have a look at <a class="reference internal" href="plugins/getting_started/#plugins-getting-started"><span class="std std-ref">Getting started</span></a> and then head over to the more advance topics in the table of contents.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="plugins/">Indico plugins</a><ul> <li class="toctree-l2"><a class="reference internal" href="plugins/getting_started/">Getting started</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins/plugin/">Plugin API reference</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins/signals/">Hooking into Indico using Signals</a></li> <li class="toctree-l2"><a class="reference internal" href="plugins/models/">Adding models to your plugin</a></li> </ul> </li> </ul> </div> </section> <section id="http-api"> <h2>HTTP API<a class="headerlink" href="#http-api" title="Link to this heading">露</a></h2> <p>Indico allows you to programmatically access the content of its database by exposing various information like category contents, events, rooms and room bookings through a web service, the HTTP Export API.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="http-api/">HTTP API</a><ul> <li class="toctree-l2"><a class="reference internal" href="http-api/access/">Accessing the API</a></li> <li class="toctree-l2"><a class="reference internal" href="http-api/common/">Common Parameters</a></li> <li class="toctree-l2"><a class="reference internal" href="http-api/exporters/">API Resources</a></li> <li class="toctree-l2"><a class="reference internal" href="http-api/tools/">HTTP API Tools</a></li> </ul> </li> </ul> </div> </section> <section id="translating-indico"> <h2>Translating Indico<a class="headerlink" href="#translating-indico" title="Link to this heading">露</a></h2> <p>We are always looking for new translators to help us make Indico accessible to the widest possible audience. You can help us achieve that goal by <strong>contributing translations</strong> to Indico!</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="translations/">Translating Indico</a><ul> <li class="toctree-l2"><a class="reference internal" href="translations/#becoming-a-translator">Becoming a Translator</a></li> <li class="toctree-l2"><a class="reference internal" href="translations/#translating">Translating</a></li> <li class="toctree-l2"><a class="reference internal" href="translations/#see-your-translations-live">See your translations live</a></li> <li class="toctree-l2"><a class="reference internal" href="translations/#tips-for-better-translations">Tips for better translations</a></li> <li class="toctree-l2"><a class="reference internal" href="translations/#reporting-issues">Reporting issues</a></li> </ul> </li> </ul> </div> </section> <section id="api-reference"> <h2>API reference<a class="headerlink" href="#api-reference" title="Link to this heading">露</a></h2> <p>This part of the documentation focuses on the core modules of Indico and includes information about the <strong>models</strong> and <strong>utility functions and classes</strong> that are useful for understanding the internals of the application.</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="api/">API reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/event/">Event</a></li> <li class="toctree-l2"><a class="reference internal" href="api/abstract/">Event abstract</a></li> <li class="toctree-l2"><a class="reference internal" href="api/agreement/">Event agreement</a></li> <li class="toctree-l2"><a class="reference internal" href="api/contribution/">Event contribution</a></li> <li class="toctree-l2"><a class="reference internal" href="api/feature/">Event feature</a></li> <li class="toctree-l2"><a class="reference internal" href="api/layout/">Event layout</a></li> <li class="toctree-l2"><a class="reference internal" href="api/log/">Event log</a></li> <li class="toctree-l2"><a class="reference internal" href="api/event_management/">Event management</a></li> <li class="toctree-l2"><a class="reference internal" href="api/note/">Event note</a></li> <li class="toctree-l2"><a class="reference internal" href="api/paper/">Event paper</a></li> <li class="toctree-l2"><a class="reference internal" href="api/payment/">Event payment</a></li> <li class="toctree-l2"><a class="reference internal" href="api/person/">Event person</a></li> <li class="toctree-l2"><a class="reference internal" href="api/registration/">Event registration</a></li> <li class="toctree-l2"><a class="reference internal" href="api/reminder/">Event reminder</a></li> <li class="toctree-l2"><a class="reference internal" href="api/request/">Event request</a></li> <li class="toctree-l2"><a class="reference internal" href="api/session/">Event session</a></li> <li class="toctree-l2"><a class="reference internal" href="api/survey/">Event survey</a></li> <li class="toctree-l2"><a class="reference internal" href="api/timetable/">Event timetable</a></li> <li class="toctree-l2"><a class="reference internal" href="api/track/">Event track</a></li> <li class="toctree-l2"><a class="reference internal" href="api/static_site/">Event static site</a></li> <li class="toctree-l2"><a class="reference internal" href="api/category/">Category</a></li> <li class="toctree-l2"><a class="reference internal" href="api/user/">User</a></li> <li class="toctree-l2"><a class="reference internal" href="api/attachment/">Attachment</a></li> <li class="toctree-l2"><a class="reference internal" href="api/rb/">Room booking</a></li> <li class="toctree-l2"><a class="reference internal" href="api/auth/">Authentication</a></li> <li class="toctree-l2"><a class="reference internal" href="api/oauth/">OAuth</a></li> <li class="toctree-l2"><a class="reference internal" href="api/group/">Group</a></li> <li class="toctree-l2"><a class="reference internal" href="api/vc/">Video conference</a></li> <li class="toctree-l2"><a class="reference internal" href="api/designer/">Designer</a></li> <li class="toctree-l2"><a class="reference internal" href="api/network/">Network</a></li> <li class="toctree-l2"><a class="reference internal" href="api/news/">News</a></li> <li class="toctree-l2"><a class="reference internal" href="api/fields/">Indico fields</a></li> </ul> </li> </ul> </div> </section> <section id="what-s-new"> <h2>What鈥檚 New<a class="headerlink" href="#what-s-new" title="Link to this heading">露</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="changelog/">Changelog</a><ul> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-3-5">Version 3.3.5</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-3-4">Version 3.3.4</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-3-3">Version 3.3.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-3-2">Version 3.3.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-3-1">Version 3.3.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-3">Version 3.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-9">Version 3.2.9</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-8">Version 3.2.8</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-7">Version 3.2.7</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-6">Version 3.2.6</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-5">Version 3.2.5</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-4">Version 3.2.4</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-3">Version 3.2.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-2">Version 3.2.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2-1">Version 3.2.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-2">Version 3.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-1-2">Version 3.1.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-1-1">Version 3.1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-1">Version 3.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0-4">Version 3.0.4</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0-3">Version 3.0.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0-2">Version 3.0.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0-1">Version 3.0.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0">Version 3.0</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0rc2">Version 3.0rc2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-3-0rc1">Version 3.0rc1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3-6">Version 2.3.6</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3-5">Version 2.3.5</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3-4">Version 2.3.4</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3-3">Version 2.3.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3-2">Version 2.3.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3-1">Version 2.3.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-3">Version 2.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-9">Version 2.2.9</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-8">Version 2.2.8</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-7">Version 2.2.7</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-6">Version 2.2.6</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-5">Version 2.2.5</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-4">Version 2.2.4</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-3">Version 2.2.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-2">Version 2.2.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2-1">Version 2.2.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-2">Version 2.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-11">Version 2.1.11</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-10">Version 2.1.10</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-9">Version 2.1.9</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-8">Version 2.1.8</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-7">Version 2.1.7</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-6">Version 2.1.6</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-5">Version 2.1.5</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-4">Version 2.1.4</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-3">Version 2.1.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-2">Version 2.1.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1-1">Version 2.1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-1">Version 2.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0-3">Version 2.0.3</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0-2">Version 2.0.2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0-1">Version 2.0.1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0">Version 2.0</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0rc2">Version 2.0rc2</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0rc1">Version 2.0rc1</a></li> <li class="toctree-l2"><a class="reference internal" href="changelog/#version-2-0a1">Version 2.0a1</a></li> </ul> </li> </ul> </div> </section> <section id="indices-and-tables"> <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading">露</a></h2> <ul class="simple"> <li><p><a class="reference internal" href="genindex/"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="py-modindex/"><span class="std std-ref">Module Index</span></a></p></li> </ul> </section> <section id="contact"> <h2>Contact<a class="headerlink" href="#contact" title="Link to this heading">露</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="contact/">Contact</a><ul> <li class="toctree-l2"><a class="reference internal" href="contact/#website">Website</a></li> <li class="toctree-l2"><a class="reference internal" href="contact/#irc">IRC</a></li> <li class="toctree-l2"><a class="reference internal" href="contact/#forum">Forum</a></li> <li class="toctree-l2"><a class="reference internal" href="contact/#issue-tracker">Issue tracker</a></li> <li class="toctree-l2"><a class="reference internal" href="contact/#twitter">Twitter</a></li> </ul> </li> </ul> </div> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="installation/" class="btn btn-neutral float-right" title="Installation guides" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2021, Indico Team.</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> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>