indico

Indico provides official installation guides for single-machine production setups on Alma/Rocky Linux and Debian/Ubuntu systems.

In these recommended single-machine configurations, the following components run on the same host:

• Indico (the core application)
• Celery (task queue)
• Redis (message broker/cache)
• PostgreSQL (database)

While other Linux distributions are not officially supported, they are expected to work, though you may need to adjust package names and installation steps. The single-machine architecture can be adapted for multi-machine deployments if necessary.

Indico provides a web service known as the HTTP Export API, which allows developers to programmatically access database content. You can use this API to retrieve information regarding:

• Category contents
• Events
• Rooms
• Room bookings

Indico is a web-based, open-source event management tool made at CERN. It is designed to be extensible through a plugin system.

Key capabilities include:

• Hierarchical Content Management: A flexible system for managing event content.
• Conference Organization: Includes modules for Call for Abstracts, abstract reviewing, paper reviewing, and drag-and-drop timetable management.
• Registration & Payments: Flexible registration form creation and integration with existing payment systems.
• Participant Tools: A badge editor for printing badges and tickets.
• Meeting & Room Management: Tools for meeting management, archival of materials, and a room booking interface.
• Video Conferencing: Integration with existing video conferencing solutions.

Indico uses a backend-agnostic search module that can be powered by different providers. Depending on your performance and feature requirements, you can choose from the following options:

• Default SQL-based search: Uses SQL storage by default. This is the built-in option.
• Citadel (ElasticSearch-based): A performant and feature-rich search service. It can be integrated into Indico using the official indico-plugin-citadel plugin.
• Custom External Search Service: You can support any external service by implementing a plugin that adheres to Indico's search module plugin interface specification.

The indico.modules.events module provides the core functionality for managing events within Indico. The module is organized into several sub-components:

• Models: Data structures for events, persons, principals, references, reviews, series, settings, and static list links.
• Operations: Business logic and actions performed on events.
• Utilities: Helper functions for event-related tasks.
• Settings: Configuration parameters specific to the event module.

Indico's documentation is organized into several key areas depending on your goal:

• Installation: Guides for setting up Indico.
• Configuration: Instructions for configuring the Indico instance.
• Building: Information on building the project.
• Search: Documentation regarding search engine integration.
• Plugins: Guides for developing and using Indico plugins.
• HTTP API: Reference for interacting with Indico via HTTP.
• Translating Indico: Information on contributing translations.
• API Reference: Detailed technical documentation of the internal API.

When using the room export API, you can specify different detail levels via the detail parameter:

• rooms: Returns basic data about the rooms (e.g., building, floor, equipment, name).
• reservations: Returns basic room data plus a list of reservations within the specified timeframe.

To handle large datasets, use the following parameters to implement pagination:

• limit (short: n): Specifies the maximum number of results to return.
• offset (short: O): Specifies the number of results to skip before starting to return results.

Setting CUSTOMIZATION_DEBUG = True enables detailed logging for customizable templates. The first time a template is accessed, the log will provide:

1. The relative path where you should place your customized version inside <CUSTOMIZATION_DIR>/templates/.
2. The full path of the original template.
3. A "reference" path that can be used to reference the original template from your customized one using Jinja inheritance.

Use the following parameters to control the order of returned elements:

• order (short: o): Sorts the results. Valid values are id, start, end, or title.
• descending (short: c): When set to yes, sorts the results in descending order.

When using an external search service (like Citadel), Indico supports advanced features like Aggregations and Filters to enhance search results.

Aggregations

Aggregations allow you to group information based on metrics such as field values, sums, or averages. Indico supports bucket or metric groups composed of a key, count, and filter key. These are defined using the following schemas:

• indico.modules.search.result_schemas.AggregationSchema
• indico.modules.search.result_schemas.BucketSchema

Filters

Filters act upon aggregations on structured data. The key and filter values from an AggregationSchema allow you to define human-readable labels. For example, a bucket with key: "CERN" and filter: "cern" can be used to construct a filter like affiliation=cern.