CiviCRM offers community contributed documentation below. We encourage everyone to contribute to documentation. CiviCRM welcomes all contributions and contributors in line with our community code of conduct.

Community

These books contain information on the CiviCRM Commmunity including policies, notable groups and useful processes.

  • Handbook

    by the CiviCRM Community

    A collection of CiviCRM's community policies and conventions.

Core

These books contain information on installing and configuring the CiviCRM core, that is, CiviCRM without community-contributed extensions. In these books you'll also find information on CiviCRM's underlying coding concepts, APIs, hooks and really everything you need to get started developing for CiviCRM.

Extensions

Extensions can be installed within CiviCRM to provide new functionality not available in core. Below are extension-specific documentation books for those extensions which have documentation provided on this site.

  • Activity iCal

    by the CiviCRM Community

    Provides an iCalendar feed of assigned activities per contact

  • Advanced Events

    by the CiviCRM Community

    Improved Event and event template functionality for CiviCRM

  • Advanced Newsletter Management

    by the CiviCRM Community

    Provides an API and configuration for advanced newsletter management.

  • Authorize.Net Payment processor

    by the CiviCRM Community

    CiviCRM Extension that provides support for Authorize.Net payments using Credit Card and echeck (EFT).

  • Betterplace API

    by the CiviCRM Community

    Integration for the betterplace.org Direkt donation page

  • Birthdays

    by the CiviCRM Community

    Provides a report on upcoming birthdays and an API for sending birthday greetings via e-mail using scheduled jobs.

  • Bitpay

    by the CiviCRM Community

    A payment processor for CiviCRM for Bitpay cryptocurrency service

  • Campaign Manager

    by the CiviCRM Community

    Extended campaign features for CiviCRM

  • Chassé

    by the CiviCRM Community

    Automated email based supporter journeys

  • Chatbot

    by the CiviCRM Community

    A chatbot for CiviCRM. Integrates various chat services (e.g. Facebook messenger) so you can chat with your contacts.

  • CiviBanking

    by the CiviCRM Community

    Implements handling of bank accounts for contacts, as well as handling of bank files (and individual bank payements extracted from the files). Bank files can be imported, payments matched to CiviCRM entities, and the resulting data exported.

  • CiviCRM Configuration Loader

    by the CiviCRM Community

    The CiviCRM Configuration Loader extension version 2 lets you export and import configuration sets from CiviCRM into another CiviCRM installation.

  • CiviCRM Resource Management

    by the CiviCRM Community

    A framework allowing definition, management, allocation, and optimisation of resources

  • CiviDiscount

    by the CiviCRM Community

    An extension implementing discounts for CiviCRM contributions, memberships, donations, registrations etc.

  • CiviOffice

    by the CiviCRM Community

    CiviCRM integration for various exchangeable office suites

  • CiviProxy

    by the CiviCRM Community

    Scripts to install on separate server to police data traffic between CiviCRM on a secure server and the outside world

  • CiviRules

    by the CiviCRM Community

    Rule based engine to automate administrative processes.

  • CiviSEPA

    by the CiviCRM Community

    Provides documentation for the CiviSEPA extension.

  • CiviSEPA PSP

    by the CiviCRM Community

    Use CiviSEPA for other Payment Service Providers (PSPs).

  • CiviVolunteer

    by the CiviCRM Community

    Create volunteer Projects, manage schedules, sign-up volunteers, and log volunteer hours.

  • CiviXero

    by the CiviCRM Community

    Integrate with Xero

  • Committees

    by the CiviCRM Community

    The focus of this extension is to facilitate the initial import and continuous update of committee/parliament structures. The model can import and sync the following data: Committees - e.g. parliaments - Contacts, along with address, email, phone and website - e.g. members of parliament - Committee memberships The extension compares the imported data to the CiviCRM instance and only synchronizes differences. It consists of an import module to automate the import of a committee-structured data source (e.g. the German Kürschner list) and a syncer module that defines the way the data is represented in your CiviCRM instance.

  • Configuration Profiles

    by the CiviCRM Community

    This extension provides a data structure and UI for configuration that is organized in configurable profiles.

  • Custom Event Communication

    by the CiviCRM Community

    Provides an alternative way to send confirmation emails for CiviCRM Events.

  • Deduper

    by the CiviCRM Community

    Deduping tools and interface

  • Dialogflow

    by the CiviCRM Community

    Build natural and rich conversational experiences with CiviCRM through the power of Dialogflow.

  • Donation Receipts

    by the CiviCRM Community

    This extension can generate and manage donation receipts for tax deductions

  • Entity Construction Kit (ECK)

    by the CiviCRM Community

    Provides the ability to create and manage custom CiviCRM entities.

  • Entity Templates

    by the CiviCRM Community

    Create templates for Contacts and Contributions.

  • Event Check-In

    by the CiviCRM Community

    Provides convenient check-in functions like QR codes

  • Event Invitation

    by the CiviCRM Community

    Allows issuing event invitations for selected contacts

  • Expenses

    by the CiviCRM Community

    An extension to record expenses and financial declarations in CiviCRM.

  • Extended Contact Matcher (XCM)

    by the CiviCRM Community

    Provides configurable contact matching.

  • Fast Action Links

    by the CiviCRM Community

    Create links to perform custom actions on your search results

  • Fast Activities

    by the CiviCRM Community

    High Performance Activity Features

  • Firewall

    by the CiviCRM Community

    IP based Firewall to prevent certain types of attack

  • FlexMailer

    by the CiviCRM Community

    Extensible email delivery engine for CiviMail

  • FormProcessor

    by the CiviCRM Community

    Engine to define forms from CiviCRM turning into API requests (which can be processed by public website)

  • Form Protection

    by the CiviCRM Community

    Provides various ways to help protect forms from spammers

  • Funding Program Manager

    by the CiviCRM Community

    This extension forms the basis for funding application management in CiviCRM: manage funding programs from application to payout.

  • GDPR

    by the CiviCRM Community

    Extension to support General Data Protection Regulation

  • GDPRX

    by the CiviCRM Community

    A toolkit to help with GDPR Compliance

  • GoCardless

    by the CiviCRM Community

    UK Direct Debit Payment Processor

  • GroupAdmin

    by the CiviCRM Community

    Allows you to specify administrators who have access to groups and contacts within those groups.

  • Hark Surveys

    by the CiviCRM Community

    Design complex (or not) surveys with multiple pages, conditionals, calculated fields and multi-layer access and embed them in your website.

  • I3Val Input Validation

    by the CiviCRM Community

    Ilja's Initiative for Input Validation

  • Inlay

    by the CiviCRM Community

    A framework to help CiviCRM extension developers embed functionality on external websites.

  • Login Security

    by the CiviCRM Community

    Provides more logging and alerts about who is accessing your CiviCRM instance

  • Mail Attachments

    by the CiviCRM Community

    Provides a Framework for attaching files to e-mail sent from CiviCRM.

  • Mailbatch

    by the CiviCRM Community

    Allows you to send e-mails to a previously defined selection of contacts

  • Mailbox Mailing

    by the CiviCRM Community

    This Extension allows you to create and schedule CiviCRM mailings without using the CiviCRM user interface.

  • Mailchimp Sync

    by the CiviCRM Community

    Two-way Mailchimp and CiviCRM sync

  • More Greeting Options

    by the CiviCRM Community

    Extension for additional greetings

  • Mosaico

    by the CiviCRM Community

    Responsive Email Template Editor

  • Omnipay

    by the CiviCRM Community

    Payment processor library based on Omnipay project

  • OpenStreetMap (OSM) Geocoding

    by the CiviCRM Community

    This CiviCRM extension adds the Nominatim OpenStreetMap server as a geocoding option

  • Payment Shared (MJWshared)

    by the CiviCRM Community

    Shared library used by multiple payment processors

  • Pelf

    by the CiviCRM Community

    A CiviCRM extension to help manage different funding pipelines, e.g. grant applications, partnerships, consultancy.

  • Phone Input Mask

    by the CiviCRM Community

    Provides validator for phone number formatting. So that your users enter the phone number according a format you wish.

  • Project 60 Membership Extension

    by the CiviCRM Community

    Tools for a "European" interpretation of the membership concept

  • Remote Event Extension

    by the CiviCRM Community

    This extension provides a lot of additional features to CiviCRMs events

  • Database support to allow use of replica dbs

  • SMS conversation

    by the CiviCRM Community

    Automate SMS conversations with your contacts

  • SQL Tasks

    by the CiviCRM Community

    Manage recurring tasks based on SQL queries

  • Self-Service

    by the CiviCRM Community

    Infrastructure for personalised and self-service forms

  • Signatures

    by the CiviCRM Community

    Provides configurable signatures per contact to be used in e-mails and letters, for single and mass mailings

  • Smart Debit

    by the CiviCRM Community

    Smart Debit Payment Processor (UK Direct Debit Handler)

  • SparkPost

    by the CiviCRM Community

    Allows CiviCRM to send emails and process bounces through the SparkPost service.

  • Stripe

    by the CiviCRM Community

    Stripe Payment Processor (https://stripe.com)

  • System tools

    by the CiviCRM Community

    Tools for parsing logged output for finding performance issues

  • TSYS

    by the CiviCRM Community

    TSYS Payment Processor Integration

  • Temporary Groups

    by the CiviCRM Community

    Create temporary groups with this extension. A temporary group will be automatically deleted after a given date.

  • This extension adds bounce handling to CiviCRM's transactional emails (eg Receipts, Scheduled Reminders) and creates Activities for mail such as Receipts and Invoices, which by default are not tracked in CiviCRM.

  • Twingle API

    by the CiviCRM Community

    Provides an API for Twingle payments

  • UK Gift Aid

    by the CiviCRM Community

    Adds a profile, custom fields and code for managing the UK Gift Aid scheme.

  • UK Gift Aid online submission

    by the CiviCRM Community

    Allows online submission of Gift Aid reports to HMRC

  • UK Postcode Lookup

    by the CiviCRM Community

    Extension to enable UK postcode lookup feature in CiviCRM using various providers.

  • This extension allows for much more flexible payment amounts for recurring contributions (when linked to memberships).

  • Webform CiviCRM

    by the CiviCRM Community

    Documentation for the Drupal 9 Webform CiviCRM integration module.

  • X-Dedupe

    by the CiviCRM Community

    Modular Deduplication Framwork

  • CiviCRM payment processor extension for eWay which uses the latest eWay Rapid API and ensures PCI DSS compliance.

If your extension isn't listed above, it may have documentation elsewhere. Here are some places you can look:

  • The extension's website as listed in the CiviCRM Extensions Directory
  • The "Documentation" link when viewing the extension details in CiviCRM at Admin -> Settings -> Extensions
  • If no luck there, find the extension online and look for documentation
  • Finally, consider contributing to documentation for the extension - the first step is to open an issue on the extension's issue tracker!

If you are an extension maintainer, follow these instructions to add documentation for your extension here.