Developers¶
Install, maintain, integrate and extend CiviCRM.
132 page(s) in this audience.
Appendices¶
- Free software? Understand what free software means for CiviCRM and why it matters to non-profit organisations. CiviCRM latest Updated 2026-10-06
- Credits Find contributor credits for the user guide and its licensing information. CiviCRM latest Updated 2026-10-06
- Glossary Look up CiviCRM terms and related technical terminology. CiviCRM latest Updated 2026-10-06
Communication — Mailings¶
- CiviMail mailer settings Configure CiviMail mailer properties and determine a mailer batch limit. CiviCRM latest Updated 2026-07-02
- Allow people to sign up for mailing lists online Make a mailing list available online and offer a subscribe link or profile for sign-up. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — Configuration¶
- Configure CiviCRM Review the configuration checklist and the settings available for an installed CiviCRM site. CiviCRM latest Updated 2026-10-06
- Address Settings Individual Name Format - The order and the specific fields for Individual Contact names when they are included in mailing labels. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — Custom data¶
- Profiles Understand what Profiles can do and how field choices affect their use. CiviCRM latest Updated 2026-10-06
Configure, automate and extend — Extensions¶
- Extensions Understand what extensions provide, where to find them, and what happens when you install, disable, or uninstall them. CiviCRM latest Updated 2026-10-06
- Extensions Learn where CiviCRM extensions come from and what their states mean. CiviCRM latest Updated 2026-07-02
- Configure extension locations and installation options Configure extension locations, resource URLs, and repository-based installation options. CiviCRM latest Updated 2026-07-02
- Install, upgrade, and uninstall extensions Install extensions from available sources, upgrade them, and uninstall them. CiviCRM latest Updated 2026-07-02
Configure, automate and extend — Installation¶
- CiviCRM Installation Guide Explains the scope of the installation guide and where to find related guidance. CiviCRM latest Updated 2026-08-20
- Install CiviCRM on Backdrop Install CiviCRM on an existing Backdrop site and review its initial configuration. CiviCRM latest Updated 2026-08-20
- Choosing a CMS for CiviCRM Compare CMS options and consider how your website needs to integrate with CiviCRM. CiviCRM latest Updated 2026-08-20
- Install CiviCRM with cv Install CiviCRM from the command line with cv, then configure the site and troubleshoot common installation problems. CiviCRM latest Updated 2026-08-20
- Install CiviCRM on WordPress with Composer Add CiviCRM to a Composer-based WordPress site and configure its asset path and resource URL. CiviCRM latest Updated 2026-08-20
- Install CiviCRM on Drupal Install CiviCRM on Drupal and review the post-installation settings. CiviCRM latest Updated 2026-08-20
- Filesystem permissions Identifies this page as a placeholder for filesystem permissions guidance. CiviCRM latest Updated 2026-08-20
- Install CiviCRM on Drupal 7 Download CiviCRM, run the Drupal 7 installer, and find troubleshooting and post-installation guidance. CiviCRM latest Updated 2026-08-20
- Drupal multisite Set up another CiviCRM domain for a Drupal site and configure its domain settings and access control. CiviCRM latest Updated 2026-08-20
- Explore CiviCRM before installing Compare public demo sites, a local test installation, CiviCRM Spark, and supplier guidance as ways to explore CiviCRM. CiviCRM latest Updated 2026-08-20
- Hosting options for CiviCRM Compare hosting options and considerations before installing CiviCRM. CiviCRM latest Updated 2026-08-20
- Install CiviCRM Standalone Install CiviCRM Standalone from a release tarball and complete the initial site setup. CiviCRM latest Updated 2026-08-20
- Using TLS encryption to connect to MySQL Configure TLS for CiviCRM's MySQL connections during installation and in DSN settings. CiviCRM latest Updated 2026-08-20
- Using CiviCRM in a language other than US-English Install and update translation files, change the default language, and configure native gettext. CiviCRM latest Updated 2026-08-20
- WordPress Multisite, CiviCRM Multi-Domain Setup These instructions are for setting up a network from scratch. If you already have an existing WordPress Multisite, then some of the procedures will need to be skipped and some will need to be amended for your situation. This is the recommen CiviCRM latest Updated 2026-08-20
- Plan for CiviCRM adoption Identify your organization's CRM needs, build internal support, and prepare a recommendation. CiviCRM latest Updated 2026-08-20
- Installation and basic set-up Understand the prerequisites, hosting choices, security considerations, and upgrade planning for a CiviCRM installation. CiviCRM latest Updated 2026-10-06
- Planning a CiviCRM project Understand the people, goals, development approach, support, training, infrastructure, and change management involved in a CiviCRM project. CiviCRM latest Updated 2026-08-20
- Installation requirements Check the server, software, and database requirements before installing or upgrading CiviCRM. CiviCRM latest Updated 2026-08-20
- Install CiviCRM on Joomla Install CiviCRM on an existing Joomla site and synchronize existing Joomla users with CiviCRM contacts. CiviCRM latest Updated 2026-08-20
- Install CiviCRM on WordPress Install CiviCRM on an existing WordPress site, then back up its settings file and review the new installation. CiviCRM latest Updated 2026-08-20
- Using your own font or CJK characters in PDF output Add a web font or locally stored font for CJK characters in PDF output. CiviCRM latest Updated 2026-08-20
- Troubleshooting CiviCRM installation Find diagnostic steps and possible solutions for CiviCRM installation and upgrade problems. CiviCRM latest Updated 2026-08-20
Configure, automate and extend — System administration¶
- System Administrator Guide Understand what this guide covers, how it relates to the User Guide, and how to contribute to it. CiviCRM latest Updated 2026-07-02
- Integrating with Drupal Understand how Drupal modules, roles, and permissions relate to CiviCRM integration. CiviCRM latest Updated 2026-07-02
- Integrating with Backdrop Understand how Backdrop modules, roles, and permissions affect CiviCRM integration and access. CiviCRM latest Updated 2026-07-02
- Security Understand the security considerations involved in hosting CiviCRM and handling sensitive data. CiviCRM latest Updated 2026-07-02
- API keys Choose a contact and assign a unique API key using an extension, an API explorer, the CLI, or MySQL. CiviCRM latest Updated 2026-07-02
- Authorize.net configuration Configure Authorize.net payments and recurring contribution notifications, and test transactions. CiviCRM 4.3.0 Updated 2026-07-02
- Configure CiviCRM caching Choose, install, and configure a cache service for CiviCRM. CiviCRM latest Updated 2026-07-02
- Card Access Services CASConnect configuration Download, install, and configure the CASConnect payment processor extension. CiviCRM latest Updated 2026-07-02
- CiviCRM themes Understand how CiviCRM themes interact with CMS themes and how to select a CiviCRM theme. CiviCRM latest Updated 2026-07-02
- Views integration Configure Drupal Views to display CiviCRM data on your website. CiviCRM latest Updated 2026-07-02
- Views integration Configure Backdrop Views to display CiviCRM data on a website. CiviCRM latest Updated 2026-07-02
- Tactics for staying off email blacklists Check mail server settings and use provider guidance to improve CiviMail email deliverability. CiviCRM latest Updated 2026-07-02
- OAuth Configure the CiviCRM OAuth Client, register a connection with a provider, and authorize access to resources. CiviCRM latest Updated 2026-07-02
- Payment processors Compare payment processors and find the configuration guidance provided for accepting payments through CiviCRM pages. CiviCRM latest Updated 2026-07-02
- Manage detailed logging Enable or disable detailed logging, review changes, and manage log tables. CiviCRM latest Updated 2026-07-02
- PayFlow Link Configure Payflow Link in PayPal Manager and test payments. CiviCRM latest Updated 2026-07-02
- Custom templates and PHP files Store custom templates outside the main CiviCRM fileset and review how custom PHP files affect upgrades. CiviCRM latest Updated 2026-07-02
- Backup data Identify what to back up, how often to do it, and how to protect the backups. CiviCRM latest Updated 2026-07-02
- Configuring CiviCRM to use the default Drupal editor Configure CiviCRM to use Drupal input formats and WYSIWYG profiles for rich-text editing. CiviCRM latest Updated 2026-07-02
- Moving CiviCRM from Drupal to WordPress Move a CiviCRM database and its files from a Drupal site to a WordPress site. CiviCRM latest Updated 2026-07-02
- Setting up SSL Set up an SSL certificate and choose how to redirect CiviCRM traffic to HTTPS. CiviCRM latest Updated 2026-07-02
- eProcessing Network configuration via Authorize.net Emulation Configure eProcessing Network through Authorize.net Emulation and test payments. CiviCRM 4.3.0 Updated 2026-07-02
- Configure AdminTools for CiviCRM in Joomla Review Joomla extension interactions and add the AdminTools exceptions described for CiviCRM. CiviCRM latest Updated 2026-07-02
- First Data, Linkpoint, Global Gateway Configure First Data as a CiviCRM payment processor using a `.pem` certificate, an open port, a store number, and a server URL. CiviCRM latest Updated 2026-07-02
- iATS Payments configuration Set up an iATS account and configure payment processors for the payment types you receive. CiviCRM latest Updated 2026-07-02
- Configure the front-end Contact Dashboard in Joomla Add the Contact Dashboard to a Joomla front-end menu and verify access to it. CiviCRM latest Updated 2026-07-02
- Integrating with Joomla Create Joomla! menu items for CiviCRM content and set access levels for pages that require a logged-in user. CiviCRM latest Updated 2026-07-02
- Switching CMS platforms Find the guide for moving a CiviCRM installation from one CMS to another. CiviCRM latest Updated 2026-07-02
- Moneris configuration guide Set up the Moneris Hosted Paypage payment processor in CiviCRM and find the guidance for the Post extension. CiviCRM latest Updated 2026-07-02
- Moving a CiviCRM instance from production to staging Set the environment when copying a production CiviCRM instance to a non-production site and understand the resulting changes. CiviCRM 4.7.2, 4.7.25 Updated 2026-07-02
- Setting up Ogone Payment Processor for CiviCRM This document serves as a brief description of how you go about setting up Ogone to work with CiviCRM. CiviCRM latest Updated 2026-07-02
- Configure PayPal Website Payments Pro and Express Configure and test PayPal Website Payments Pro and Express for CiviContribute. CiviCRM latest Updated 2026-07-02
- PayPal Standard configuration Configure PayPal Website Payments Standard for contributions and event registration, and troubleshoot payment notifications. CiviCRM latest Updated 2026-07-02
- Email system configuration Configure outbound email, inbound processing, scheduled mail jobs, and related CiviMail settings. CiviCRM latest Updated 2026-07-02
- Moving an existing installation to a new URL, location or CMS Move a CiviCRM installation to a new URL, location, or CMS and update its files, database, and location-dependent settings. CiviCRM latest Updated 2026-07-02
- Override CiviCRM settings Override settings in civicrm.settings.php when managing copies of a CiviCRM site. CiviCRM latest Updated 2026-07-02
- Running CiviCRM behind a firewall Configure system checks and email images when running CiviCRM behind a firewall. CiviCRM latest Updated 2026-07-02
- Outbound email Configure SMTP settings and the source-described OAuth setup for outbound email. CiviCRM latest Updated 2026-07-02
- Upgrades Prepare for a CiviCRM upgrade and complete the checks needed afterward. CiviCRM 4.7.2, 4.7.3, 4.7.20, 4.7.31, 5.49.0 Updated 2026-07-02
- Switching Smarty Choose and configure a supported Smarty version for a CiviCRM installation. CiviCRM latest Updated 2026-07-02
- Recurring contributions and webhooks Find the IPN notify URL to use when configuring a payment processor webhook. CiviCRM latest Updated 2026-07-02
- Clean URLs Learn how clean URLs work on WordPress front-end pages and how to enable them for an older installation. CiviCRM latest Updated 2026-07-02
- Drupal to Backdrop For some use cases, instead of a Drupal 7 to Drupal 8 migration, a migration from Drupal 7 to Backdrop is a great alternative. CiviCRM latest Updated 2026-07-02
- Moving CiviCRM from Joomla to Drupal Backup your system Backup the CiviCRM database that was set up for Joomla. Backup the Drupal site before making any changes to it. CiviCRM latest Updated 2026-07-02
- Upgrading CiviCRM for Joomla Use this document to upgrade CiviCRM installations on Joomla to the latest CiviCRM release. CiviCRM latest Updated 2026-07-02
- Scheduled jobs Set up automatic execution of scheduled jobs and troubleshoot common failures. CiviCRM latest Updated 2026-07-02
- Upgrading CiviCRM for Backdrop CMS Upgrade a CiviCRM installation on Backdrop CMS to the latest CiviCRM release. CiviCRM latest Updated 2026-07-02
- Handle bounced mail Set up bounce handling and find or remove on-hold email addresses. CiviCRM latest Updated 2026-07-02
- Upgrading CiviCRM for Drupal 7 Upgrade a CiviCRM installation on Drupal 7 to the latest CiviCRM release. CiviCRM latest Updated 2026-07-02
- Upgrading CiviCRM for Drupal 8/9/10 Upgrade CiviCRM code and its database on a Drupal 8/9/10 site using Composer. CiviCRM 5.29.0, 5.30.0, 5.31.0 Updated 2026-07-02
- Archive CiviMail emails with Drupal Mailhandler Archive emails sent through CiviMail as Drupal nodes. CiviCRM latest Updated 2026-07-02
- Autofile email activities via EmailProcessor Configure an email account to file incoming messages as contact activities. CiviCRM latest Updated 2026-07-02
- Sync CiviCRM groups to Backdrop roles Prepare and configure associations that synchronize CiviCRM groups with Backdrop roles. CiviCRM latest Updated 2026-07-02
- Synchronize CiviCRM groups with Drupal roles Prepare group-to-role associations and configure CiviGroup Roles Sync. CiviCRM latest Updated 2026-07-02
- Sync CiviCRM memberships to Backdrop roles Configure membership-to-role associations and choose when Backdrop roles are synchronized. CiviCRM latest Updated 2026-07-02
- Synchronize CiviCRM memberships with Drupal roles Configure membership-to-role association rules and choose when CiviMember Roles Sync runs. CiviCRM latest Updated 2026-07-02
- CiviCRM Organic Groups Sync Understand which groups the Organic Groups CiviCRM module creates and how one-way synchronization works. CiviCRM latest Updated 2026-07-02
- Optimize CiviCRM performance Review search, template, cache, directory-scanning, and database options that may improve CiviCRM performance. CiviCRM latest Updated 2026-07-02
- Updating system workflow message templates Merge customized system workflow message templates with changes made by a CiviCRM upgrade. CiviCRM 4.7.2, 4.7.3, 4.7.20, 4.7.31, 5.49.0 Updated 2026-07-02
- Upgrade CiviCRM Standalone Upgrade CiviCRM Standalone to the latest CiviCRM release. CiviCRM latest Updated 2026-07-02
- Upgrade CiviCRM for WordPress Upgrade a CiviCRM installation on WordPress to the latest CiviCRM release. CiviCRM latest Updated 2026-07-02
- Multisite components and functional separation Look up how multisite functionality is delivered and which entities are separated by domain. CiviCRM latest Updated 2026-07-02
- Secret keys Find how to configure, generate, and manage CiviCRM secret keys. CiviCRM latest Updated 2026-07-02
- Filesystem permissions and file access Assess filesystem permissions and investigate warnings about publicly accessible CiviCRM files. CiviCRM latest Updated 2026-07-02
- Configuring PayPal API Certificate credentials Preserve the documented API Certificate procedure and its stated support limitation. CiviCRM latest Updated 2026-07-02
- Version-specific upgrade tasks Find additional tasks and changes to check when an upgrade crosses specific CiviCRM versions. CiviCRM 4.7.3, 4.7.31, 5.27.0, 5.29.0 Updated 2026-07-02
- Webform CiviCRM integration Learn how the Webform CiviCRM module connects Backdrop webforms with CiviCRM data and what to consider when configuring forms. CiviCRM latest Updated 2026-07-02
- The Bootstrap base theme Explains approaches to using the Bootstrap framework with CiviCRM and the Drupal Bootstrap base theme. CiviCRM latest Updated 2026-07-02
- WordPress integration Find CiviCRM extensions, WordPress plugins, and widgets that support integration between CiviCRM and WordPress. CiviCRM latest Updated 2026-07-02
- Displaying Public Forms in WordPress Frontend Sites CiviCRM includes the ability to present online contribution pages, event information pages and registration forms, and profile forms to users and visitors of the 'front-end' of your WordPress sites. CiviCRM latest Updated 2026-07-02
- Integrating with WordPress CiviCRM integrates with WordPress as a plugin starting with WordPress version 3.3.1 (those using earlier versions of WordPress will need to upgrade prior to installing CiviCRM). CiviCRM latest Updated 2026-07-02
Configure, automate and extend — Troubleshooting¶
- Troubleshooting Find more detailed errors and use symptom checks and recovery steps to troubleshoot CiviCRM. CiviCRM latest Updated 2026-07-02
Contacts and data — Contacts¶
- How are Drupal or Joomla Users Linked to CiviCRM Contact Records Every CiviCRM instance sits within a "User Framework" — a CMS (Backdrop, Drupal, Joomla or WordPress) that handles user authentication (logging in) and gives users various levels of access to CiviCRM features (permissions). CiviCRM latest Updated 2026-10-06
Contacts and data — Data management¶
- Import contributions using Civi Import Prepare a contribution file, map its fields, and import contributions using Civi Import. CiviCRM latest Updated 2026-10-06
- Tokens and mail merge Find tokens for mail merge and look up checksum links, date formatting, click-tracking rules, and available tokens. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Contributions¶
- Creating contribution forms using FormBuilder Set up a contribution form with FormBuilder and configure its checkout and confirmation options. CiviCRM latest Updated 2026-10-06
- Payment processors Compare payment processor characteristics and support before choosing one for CiviCRM. CiviCRM latest Updated 2026-10-06
- Accounting integration Create and manage accounting batches, then export their transactions for accounting software. CiviCRM latest Updated 2026-10-06
Fundraising and engagement — Pledges¶
- Create and manage pledges Enable CiviPledge, create pledges, set up payment reminders, and find and review pledges. CiviCRM latest Updated 2026-10-06
Home¶
- CiviCRM User Guide Learn what the User Guide covers, how to search the documentation, and how to contribute. CiviCRM latest Updated 2026-10-06
Initial set up¶
- Mapping and geocoding Configure mapping and geocoding providers and their keys. CiviCRM latest Updated 2026-10-06
- Scheduled jobs Learn how scheduled jobs are initiated and configured, and look up the available jobs and their parameters. CiviCRM latest Updated 2026-10-06
Introduction¶
- Real world examples See how six organizations have used CiviCRM to manage their work. CiviCRM latest Updated 2026-10-06
- What is CiviCRM? Learn what CiviCRM is, what it helps organizations manage, and how it works with a website. CiviCRM latest Updated 2026-10-06
- Who is CiviCRM? Learn who makes up the CiviCRM community, how it developed, and how to take part. CiviCRM latest Updated 2026-10-06
Mailings¶
- Set-up In this chapter, the steps required to set up an SMS gateway will be explored. Once configured, you will be able to send both single and mass text messages to individual contacts which have a mobile phone number defined, ie. Phone Type must CiviCRM latest Updated 2026-10-06
Search and reporting — Forms¶
- What is FormBuilder Learn what FormBuilder is and how access to forms is controlled. CiviCRM latest Updated 2026-10-06
- Creating custom data entry forms Create, configure, and preview a custom form for collecting data in CiviCRM. CiviCRM latest Updated 2026-10-06
Search and reporting — Reporting¶
- Bug reporting Check possible causes of a problem, try to reproduce it, and provide the details needed for a useful bug report. CiviCRM latest Updated 2026-10-06
Search and reporting — Search¶
- Search displays Learn how to add a SearchKit display, choose a display type, and configure how results appear. CiviCRM latest Updated 2026-10-06
Search and reporting — SearchKit¶
- What is SearchKit? Learn what SearchKit is and how its entities, criteria, joins, grouping, and displays affect search results. CiviCRM latest Updated 2026-10-06
- Translating FormBuilder Build a FormBuilder form and translate its saved strings into an installed language. CiviCRM latest Updated 2026-10-06
- Export and import SearchKit searches Export a saved SearchKit search to share or reuse it, and import a search shared with you. CiviCRM latest Updated 2026-10-06
The CiviCRM Community¶
- The CiviCRM community Find places to connect with the CiviCRM community and ways to contribute. CiviCRM latest Updated 2026-10-06
- Asking for help in chat.civicrm.org Learn what to include in a CiviCRM chat question and how to ask it in the right channel. CiviCRM latest Updated 2026-10-06
Translation¶
- Localising CiviCRM CiviCRM is written with English-language code and strings for display. It has, however, also been built for organisations worldwide. They need to be able to adapt the tool to local circumstances and demands without modifying the tool techni CiviCRM latest Updated 2026-10-06
- Translating CiviCRM CiviCRM is written with English-language code and strings for display. Using, Transifex CiviCRM is able to translate the entire interface into dozens of different languages for the use of many different organizations worldwide. Each local l CiviCRM latest Updated 2026-10-06