diff --git a/docs/backdrop/index.md b/docs/backdrop/index.md index 443a590e085af52c4ed27726cf2a68d130d09322..6085d75ff04b2fa59879042a57d9d7749cdbbc44 100644 --- a/docs/backdrop/index.md +++ b/docs/backdrop/index.md @@ -1,13 +1,15 @@ -## Scope of this guide and alternative installation methods +!!! tldr "About this document" -This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). + This guide covers standard installation of CiviCRM on an existing Backdrop site. It assumes that you previously completed these tasks: -## Before installing + 1. [Install Backdrop](https://backdropcms.org/installation), and... + 1. [Review the CiviCRM requirements](../general/requirements.md) -1. Ensure that your system meets the [requirements](../general/requirements.md). -1. Install Backdrop by referring to the [Backdrop Installation Guide](https://backdropcms.org/installation) if needed. +!!! tldr "Similar alternatives" -## Determine Backdrop Database Settings {:#db-settings} + If you plan to develop patches for CiviCRM on WordPress, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/). + +## Identify the database {:#db-settings} You will need to know the database settings for your Backdrop installation prior to running the CiviCRM installer. You can look up these values in your Backdrop `settings.php` file (located in your Backdrop root) be looking for the following code: @@ -36,7 +38,8 @@ In the above example: | Database User Name | dbuser | | Database User Password | dbpassword | -## Tell Backdrop where to find the CiviCRM Module {:#directory} +<a name="directory"></a><!-- old anchor --> +## Get the code {:#download} First, download CiviCRM and install the files like you would any other module: @@ -49,11 +52,11 @@ The most up-to-date version of CiviCRM will always be available from the [CiviCR **Do NOT** proceed to "activate" the module - that will happen automatically when you run the installer. -## Install localization files (only for sites in a language other than US English) {:#i18n} +## Get the translations {:#i18n} -If using CiviCRM in another language than English, see the [internationalisation and localisation](../general/i18n_l10n.md) page about how to install files for running CiviCRM in other languages. +The basic CiviCRM release includes support for US English (`en_US`). To use another language or dialect, please [download and extract the translation files](../general/i18n_l10n.md). -## Run the Installer {:#installer} +## Run the installer {:#installer} The installer will verify that you've downloaded the correct version of CiviCRM, and will check your server environment to make sure it meets CiviCRM requirements. It will then create and populate a database for CiviCRM as well as create your CiviCRM settings file (civicrm.settings.php). @@ -84,7 +87,7 @@ The installer will verify that you've downloaded the correct version of CiviCRM, even after changing directory permission in Explorer, see [the permissions page](../general/permissions.md) for instructions on how to set permissions on Linux, MacOS and Windows. * Once you see the green "You're ready to install!" message - you can click **Check Requirements and Install CiviCRM** -## Review Permissions {:#permissions} +## Review the permissions {:#permissions} !!! check "" Note that Backdrop tries to create the `/files/` directory (and make it writeable), but only when saving `admin/settings`. Same holds for `/temp` directory, and a `/uploads/` directory in the CiviCRM module root. On a brand-new Backdrop install, this directory may be missing. Even on an existing installation, if file permissions are not set properly, the directory may be missing. If enabling the **CiviCRM** module generates errors regarding the files directory, you must create it (writeable) manually. @@ -106,7 +109,7 @@ The installer will verify that you've downloaded the correct version of CiviCRM, * **view event participants** : Enable this permission to allow anonymous users to access participant listing pages for events. <!-- markdownlint-enable MD046 --> -## Create CiviCRM Contacts for Existing Backdrop Users {:#contacts-users} +## Synchronize the users {:#contacts-users} Once installed, CiviCRM keeps your Backdrop Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Backdrop user record. Conversely, only contacts who are authenticated users of your site will have corresponding Backdrop user records. @@ -118,7 +121,7 @@ When CiviCRM is installed on top of an existing Backdrop site, a special CiviCRM * Click **Administer** in the menu bar * Click **Users and Permissions** from the drop-down menu, then select **Synchronize Users to Contacts** -## Review the Configuration Checklist {:#checklist} +## Review the checklist {:#checklist} The **Configuration Checklist** provides a convenient way to work through the settings that need to be reviewed and configured for a new site. You can link to this checklist from the installation success page AND you can visit it at any time from **Administer** » **Administration Console** » **Configuration Checklist**. @@ -126,7 +129,9 @@ The **Configuration Checklist** provides a convenient way to work through the se There should now be a **CiviCRM** link in your Backdrop menu. Click that link and the CiviCRM Menu, Shortcuts, Search and New Individual Blocks should appear. You can now explore CiviCRM end-user features and begin configuring CiviCRM for your site/organization needs. -## Using Encryption with MySQL +## Addenda + +### TLS for MySQL If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server. @@ -197,6 +202,6 @@ See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the setti ), ``` -## Trouble-shooting Resources {:#troubleshooting} +### Troubleshooting {:#troubleshooting} * Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation. diff --git a/docs/drupal7/index.md b/docs/drupal7/index.md index bb275fe29910410c61996b67f5fdc5bc52a8c37b..36d8a49c13419fe358299f5b53dd5cf3ee56140b 100644 --- a/docs/drupal7/index.md +++ b/docs/drupal7/index.md @@ -1,13 +1,15 @@ -## Scope of this guide and alternative installation methods +!!! tldr "About this document" -This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). + This guide covers standard installation of CiviCRM on an existing Drupal 7 site. It assumes that you previously completed these tasks: -## Before installing + 1. [Install Drupal 7](https://www.drupal.org/docs/7/install), and... + 1. [Review the CiviCRM requirements](../general/requirements.md) -1. Ensure that your system meets the [requirements](../general/requirements.md). -1. Install Drupal 7 by referring to the [Drupal 7 Installation Guide](https://www.drupal.org/docs/7/install) if needed. +!!! tldr "Similar alternatives" -## Determine Drupal Database Settings {:#db-settings} + If you plan to develop patches for CiviCRM on Drupal 7, then please use the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/). + +## Identify the database {:#db-settings} You will need to know the database settings for your Drupal installation prior to running the CiviCRM installer: You can look up these values in your Drupal `settings.php` file (located by default in your `<drupal_root>/sites/default directory`) be looking for the following code: @@ -38,7 +40,8 @@ In the above example: | Database User Name | dbuser | | Database User Password | dbpassword | -## Tell Drupal where to find the CiviCRM Module {:#directory} +<a name="directory"></a><!-- old anchor --> +## Get the code {:#download} First, download CiviCRM and install the files like you would any other module: @@ -51,11 +54,11 @@ The most up-to-date version of CiviCRM is always available from the [CiviCRM web **Do NOT** activate the module yet - that will happen automatically when you run the installer. -## Install localization files (only for non-English sites) {:#i18n} +## Get the translations {:#i18n} -If using CiviCRM in another language than English, see the [internationalisation and localisation](../general/i18n_l10n.md) page about how to install files for running CiviCRM in other languages. +The basic CiviCRM release includes support for US English (`en_US`). To use another language or dialect, please [download and extract the translation files](../general/i18n_l10n.md). -## Run the Installer {:#installer} +## Run the installer {:#installer} The installer will verify that you've downloaded the correct version of CiviCRM, and will check your server environment to make sure it meets CiviCRM requirements. It will then create and populate a database for CiviCRM as well as create your CiviCRM settings file (civicrm.settings.php). @@ -86,7 +89,7 @@ The installer will verify that you've downloaded the correct version of CiviCRM, even after changing directory permission in Explorer, see [the permissions page](../general/permissions.md) for instructions on how to set permissions on Linux, MacOS and Windows. * Once you see the green "You're ready to install!" message - you can click **Check Requirements and Install CiviCRM** -## Review Permissions {:#permissions} +## Review the permissions {:#permissions} !!! check "" Note that Drupal tries to create the `/files/` directory (and make it writeable), but only when saving `admin/settings`. Same holds for `/temp` directory, and a `/uploads/` directory in the CiviCRM module root. On a brand-new Drupal install, this directory may be missing. Even on an existing installation, if file permissions are not set properly, the directory may be missing. If enabling the **CiviCRM** module generates errors regarding the files directory, you must create it (writeable) manually. @@ -109,7 +112,8 @@ The installer will verify that you've downloaded the correct version of CiviCRM, * **view event info** and **register for events** : If you plan to use CiviEvent and want to allow un-authenticated visitors to view event information and register for events online - enable these permissions for the "anonymous" role. * **view event participants** : Enable this permission to allow anonymous users to access participant listing pages for events. <!-- markdownlint-enable MD046 --> -## Create CiviCRM Contacts for Existing Drupal Users {:#contacts-users} + +## Synchronize the users {:#contacts-users} Once installed, CiviCRM keeps your Drupal Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Drupal user record. Conversely, only contacts who are authenticated users of your site will have corresponding Drupal user records. @@ -121,7 +125,7 @@ When CiviCRM is installed on top of an existing Drupal site, a special CiviCRM A * Click **Administer** in the menu bar * Click **Users and Permissions** from the drop-down menu, then select **Synchronize Users to Contacts** -## Review the Configuration Checklist {:#checklist} +## Review the checklist {:#checklist} The **Configuration Checklist** provides a convenient way to work through the settings that need to be reviewed and configured for a new site. You can link to this checklist from the installation success page AND you can visit it at any time from **Administer** » **Administration Console** » **Configuration Checklist**. @@ -129,7 +133,9 @@ The **Configuration Checklist** provides a convenient way to work through the se There should now be a **CiviCRM** link in your Drupal menu. Click that link and the CiviCRM Menu, Shortcuts, Search and New Individual Blocks should appear. You can now explore CiviCRM end-user features and begin configuring CiviCRM for your site/organization needs. -## Using Encryption with MySQL +## Addenda + +### TLS for MySQL If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server. @@ -200,7 +206,7 @@ See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the setti ), ``` -## Trouble-shooting Resources {:#troubleshooting} +### Troubleshooting {:#troubleshooting} * Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation. * To check compatibility with other Drupal modules see: [Drupal modules incompatible with CiviCRM](https://docs.civicrm.org/sysadmin/en/latest/integration/drupal/incompatibilities/) diff --git a/docs/drupal8/index.md b/docs/drupal8/index.md index a33ee649852770c46e16078321819d1c7eb35fe3..30ec1794d9fcc30511e40d62f5f21fcdfbee0370 100644 --- a/docs/drupal8/index.md +++ b/docs/drupal8/index.md @@ -1,16 +1,19 @@ -## Scope of this guide and alternative installation methods +!!! tldr "About this document" -This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). + This guide covers standard installation of CiviCRM on an existing Drupal 8 site. It assumes that you previously completed these tasks: -## Before installing + 1. [Install Drupal 8](https://www.drupal.org/docs/8/install), and... + 1. [Review the CiviCRM requirements](../general/requirements.md) -1. Ensure that your system meets the [requirements](../general/requirements.md). -1. Install Drupal 8 by referring to the [Drupal 8 Installation Guide](https://www.drupal.org/docs/8/install) if needed. +!!! tldr "Similar alternatives" + + If you plan to develop patches for CiviCRM on Drupal 8, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/). !!! warning "Composer install required!" This guide will assume that you have installed Drupal 8 using composer. At this time manual installation of Drupal 8 using zip or tarball install methods is not supported. -## Downloading CiviCRM on Drupal 8 with Composer {:#downloading} +<a name="downloading"></a><!-- old anchor --> +## Get the code {:#download} To download CiviCRM on a Drupal 8 site we'll need to ask [Composer](https://www.getcomposer.org) to `require` the CiviCRM libraries. We do this by requiring the `civicrm-core`, `civicrm-drupal-8`, `civicrm-packages` and `civicrm-asset-plugin` libraries. @@ -26,7 +29,7 @@ To download CiviCRM on a Drupal 8 site we'll need to ask [Composer](https://www. Best practice is to use `composer require` locally or in dev/test and then deploy your `composer.lock` to staging and use `composer install` which requires less memory and implements the changes you've tested and committed to your repo! <!-- markdownlint-enable MD046 --> -### Expert Mode - Just the command +### Expert mode - Just the command To require the CiviCRM libraries on a Drupal 8 site you can use the following one-line command: @@ -35,7 +38,7 @@ To require the CiviCRM libraries on a Drupal 8 site you can use the following on * `composer require civicrm/civicrm-asset-plugin:'~1.0.0' civicrm/civicrm-{core,packages,drupal-8}:'~5.29'` -### Guided Mode - More context and information +### Guided mode - More context and information !!! tip "Location, Location... Location" You should always run `composer` commands from the top-level folder above the web and vendor folders, where in the same place as your `composer.json` file. @@ -60,7 +63,7 @@ Optionally you can also require the [`cv`](https://github.com/civicrm/cv) comman * `composer require civicrm/cv` - This will place the cv binary in `./vendor/bin/cv` relative to your `composer.json` file. -## Install localization files (for sites needing languages other than US-English) {:#i18n} +## Get the translations {:#i18n} !!! warning "I18n & L10n on Drupal 8" If installing with the GUI it is currently only possible to install CiviCRM in English (US) on Drupal 8. Adding the language files involves breaking with Composer best practices by writing the contents of the `civicrm-l10n` tarball into `vendor/civicrm/civicrm-core` or configuring the `civicrm.l10n` directory path after you install and placing the contents of the `civicrm-l10n` tarball into the configured directory. @@ -95,9 +98,12 @@ The warnings above notwithstanding to install CiviCRM on Drupal 8 requires the f Now we move onto [Installing CiviCRM - Command line install](#installing-commandline) -## Installing CiviCRM {:#installing} +<a name="installing"></a> +## Run the installer {:#installer} + +The installer prepares the database and configuration files. You may run the installer through the web interface (which is simpler) or the command-line interface (which has more options). -### GUI install {:#installing-gui} +### Web installer {:#installing-gui} <!-- markdownlint-disable MD046 --> !!! warning "Write permissions" @@ -116,7 +122,7 @@ Now we move onto [Installing CiviCRM - Command line install](#installing-command !!! tip "Where Should I Store CiviCRM Data?" [GUI installs](#installing-gui) of CiviCRM on Drupal 8 can only install into your existing Drupal 8 database. However using a separate database is generally preferred - as it makes backups and upgrades easier. If you want to install via the GUI **and** use a separate CiviCRM database you'd need to create the CiviCRM database manually and move the `civicrm_` tables into the new CiviCRM database, then update `civicrm.settings.php` with the new database details. If you want to install directly into a separate database see the [command line install](#installing-commandline) instructions. -### Command line install {:installing-commandline} +### CLI installer {:installing-commandline} <!-- markdownlint-disable MD046 --> !!! note "Prerequisites" @@ -156,7 +162,7 @@ cv core:install -vv --cms-base-url="URL" -m loadGenerated=1 ``` <!-- markdownlint-enable MD046 --> -## Review Permissions {:#permissions} +## Review the permissions {:#permissions} !!! note "" Drupal will create the `/files/` directory (and make it writeable), but only when saving `admin/settings`. Same holds for `/temp` directory, and a `/uploads/` directory in the CiviCRM module root. On a brand-new Drupal install, this directory may be missing. Even on an existing installation, if file permissions are not set properly, the directory may be missing. If enabling the **CiviCRM** module generates errors regarding the files directory, you must create it (writeable) manually. @@ -181,7 +187,7 @@ cv core:install -vv --cms-base-url="URL" -m loadGenerated=1 * **view event participants** : Enable this permission to allow anonymous users to access participant listing pages for events. <!-- markdownlint-enable MD046 --> -## Create CiviCRM Contacts for Existing Drupal Users {:#contacts-users} +## Synchronize the users {:#contacts-users} Once installed, CiviCRM keeps your Drupal Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Drupal user record. Conversely, only contacts who are authenticated users of your site will have corresponding Drupal user records. @@ -193,7 +199,7 @@ When CiviCRM is installed on top of an existing Drupal site, a special CiviCRM A * Click **Administer** in the menu bar * Click **Users and Permissions** from the drop-down menu, then select **Synchronize Users to Contacts** -## Review the Configuration Checklist {:#checklist} +## Review the checklist {:#checklist} The **Configuration Checklist** provides a convenient way to work through the settings that need to be reviewed and configured for a new site. You can link to this checklist from the installation success page and you can visit it at any time from **Administer** » **Administration Console** » **Configuration Checklist**. @@ -201,7 +207,9 @@ The **Configuration Checklist** provides a convenient way to work through the se There should now be a **CiviCRM** link in your Drupal menu. Click that link and the CiviCRM Menu, Shortcuts, Search and New Individual Blocks should appear. You can now explore CiviCRM end-user features and begin configuring CiviCRM for your site/organization needs. -## Using Encryption with MySQL +## Addenda + +### TLS for MySQL If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server. @@ -272,17 +280,17 @@ See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the setti ), ``` -## D8 <-> CiviCRM Integration modules {:#integration-modules} +### Integration modules {:#integration-modules} -### Webform CiviCRM module +__Webform CiviCRM module__ * [Project page on Drupal.org](https://www.drupal.org/project/webform_civicrm) * [Documentation on CiviCRM.org](https://docs.civicrm.org/webform-civicrm/en/latest) -### CiviCRM Entity module +__CiviCRM Entity module__ * [Project page on Drupal.org](https://www.drupal.org/project/civicrm_entity) -## Troubleshooting Resources {:#troubleshooting} +### Troubleshooting {:#troubleshooting} * Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation. diff --git a/docs/drupal9/index.md b/docs/drupal9/index.md index 22281d7b8def7d12c9b6eff2825cc9ec34871b53..e896f3b645b5824c1f9d11073a68d937a27424fd 100644 --- a/docs/drupal9/index.md +++ b/docs/drupal9/index.md @@ -4,19 +4,22 @@ document, but it has not been carefully reviewed/tested. Consequently, it is not linked in the main menu. -## Scope of this guide and alternative installation methods +!!! tldr "About this document" -This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). + This guide covers standard installation of CiviCRM on an existing Drupal 9 site. It assumes that you previously completed these tasks: -## Before installing + 1. Install Drupal 9, and... + 1. [Review the CiviCRM requirements](../general/requirements.md) -1. Ensure that your system meets the [requirements](../general/requirements.md). -1. Install Drupal 9 by referring to the [Drupal 8 Installation Guide](https://www.drupal.org/docs/8/install) if needed. +!!! tldr "Similar alternatives" + + If you plan to develop patches for CiviCRM on Drupal 9, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/). !!! warning "Composer install required!" This guide will assume that you have installed Drupal 9 using composer. At this time manual installation of Drupal 8 using zip or tarball install methods is not supported. -## Downloading CiviCRM on Drupal 9 with Composer {:#downloading} +<a name="downloading"></a><!-- old anchor --> +## Get the code {:#download} To download CiviCRM on a Drupal 9 site we'll need to ask [Composer](https://www.getcomposer.org) to `require` the CiviCRM libraries. We do this by requiring the `civicrm-core`, `civicrm-drupal-8`, `civicrm-packages` and `civicrm-asset-plugin` libraries. @@ -34,7 +37,7 @@ To download CiviCRM on a Drupal 9 site we'll need to ask [Composer](https://www. Best practice is to use `composer require` locally or in dev/test and then deploy your `composer.lock` to staging and use `composer install` which requires less memory and implements the changes you've tested and committed to your repo! <!-- markdownlint-enable MD046 --> -### Expert Mode - Just the command +### Expert mode - Just the command To require the CiviCRM libraries on a Drupal 9 site you can use the following one-line command: @@ -43,7 +46,7 @@ To require the CiviCRM libraries on a Drupal 9 site you can use the following on * `composer require civicrm/civicrm-asset-plugin:'~1.0.0' civicrm/civicrm-{core,packages,drupal-8}:'~5.28'` -### Guided Mode - More context and information +### Guided mode - More context and information !!! tip "Location, Location... Location" You should always run `composer` commands from the top-level folder above the web and vendor folders, where in the same place as your `composer.json` file. @@ -65,7 +68,7 @@ Optionally you can also require the [`cv`](https://github.com/civicrm/cv) comman * `composer require civicrm/cv` - This will place the cv binary in `./vendor/bin/cv` relative to your `composer.json` file. -## Install localization files (for sites needing languages other than US-English) {:#i18n} +## Get the translations {:#i18n} !!! warning "I18n & L10n on Drupal 9" If installing with the GUI it is currently only possible to install CiviCRM in English (US) on Drupal 9. Adding the language files involves breaking with Composer best practices by writing the contents of the `civicrm-l10n` tarball into `vendor/civicrm/civicrm-core` or configuring the `civicrm.l10n` directory path after you install and placing the contents of the `civicrm-l10n` tarball into the configured directory. @@ -100,9 +103,12 @@ The warnings above notwithstanding to install CiviCRM on Drupal 9 requires the f Now we move onto [Installing CiviCRM - Command line install](#installing-commandline) -## Installing CiviCRM {:#installing} +<a name="installing"></a> +## Run the installer {:#installer} + +The installer prepares the database and configuration files. You may run the installer through the web interface (which is simpler) or the command-line interface (which has more options). -### GUI install {:#installing-gui} +### Web installer {:#installing-gui} <!-- markdownlint-disable MD046 --> !!! warning "Write permissions" @@ -121,7 +127,7 @@ Now we move onto [Installing CiviCRM - Command line install](#installing-command !!! tip "Where Should I Store CiviCRM Data?" [GUI installs](#installing-gui) of CiviCRM on Drupal 9 can only install into your existing Drupal 8 database. However using a separate database is generally preferred - as it makes backups and upgrades easier. If you want to install via the GUI **and** use a separate CiviCRM database you'd need to create the CiviCRM database manually and move the `civicrm_` tables into the new CiviCRM database, then update `civicrm.settings.php` with the new database details. If you want to install directly into a separate database see the [command line install](#installing-commandline) instructions. -### Command line install {:installing-commandline} +### CLI installer {:installing-commandline} <!-- markdownlint-disable MD046 --> !!! note "Prerequisites" @@ -151,7 +157,7 @@ Replace `cv` with the path to the cv phar on your system if applicable. The part * `URL` (required) is the canonical URL to the root of your CMS site. * `LANG` (optional) is one of the supported languages for CiviCRM - it **must** exist in your `l10n` folder. -## Review Permissions {:#permissions} +## Review the permissions {:#permissions} !!! note "" Drupal will create the `/files/` directory (and make it writeable), but only when saving `admin/settings`. Same holds for `/temp` directory, and a `/uploads/` directory in the CiviCRM module root. On a brand-new Drupal install, this directory may be missing. Even on an existing installation, if file permissions are not set properly, the directory may be missing. If enabling the **CiviCRM** module generates errors regarding the files directory, you must create it (writeable) manually. @@ -176,7 +182,7 @@ Replace `cv` with the path to the cv phar on your system if applicable. The part * **view event participants** : Enable this permission to allow anonymous users to access participant listing pages for events. <!-- markdownlint-enable MD046 --> -## Create CiviCRM Contacts for Existing Drupal Users {:#contacts-users} +## Synchronize the users {:#contacts-users} Once installed, CiviCRM keeps your Drupal Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Drupal user record. Conversely, only contacts who are authenticated users of your site will have corresponding Drupal user records. @@ -188,7 +194,7 @@ When CiviCRM is installed on top of an existing Drupal site, a special CiviCRM A * Click **Administer** in the menu bar * Click **Users and Permissions** from the drop-down menu, then select **Synchronize Users to Contacts** -## Review the Configuration Checklist {:#checklist} +## Review the checklist {:#checklist} The **Configuration Checklist** provides a convenient way to work through the settings that need to be reviewed and configured for a new site. You can link to this checklist from the installation success page and you can visit it at any time from **Administer** » **Administration Console** » **Configuration Checklist**. @@ -196,7 +202,9 @@ The **Configuration Checklist** provides a convenient way to work through the se There should now be a **CiviCRM** link in your Drupal menu. Click that link and the CiviCRM Menu, Shortcuts, Search and New Individual Blocks should appear. You can now explore CiviCRM end-user features and begin configuring CiviCRM for your site/organization needs. -## Using Encryption with MySQL +## Addenda + +### TLS for MySQL If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server. @@ -267,17 +275,17 @@ See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the setti ), ``` -## D8 <-> CiviCRM Integration modules {:#integration-modules} +### Integration modules {:#integration-modules} -### Webform CiviCRM module +__Webform CiviCRM module__ * [Project page on Drupal.org](https://www.drupal.org/project/webform_civicrm) * [Documentation on CiviCRM.org](https://docs.civicrm.org/webform-civicrm/en/latest) -### CiviCRM Entity module +__CiviCRM Entity module__ * [Project page on Drupal.org](https://www.drupal.org/project/civicrm_entity) -## Troubleshooting Resources {:#troubleshooting} +### Troubleshooting {:#troubleshooting} * Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation. diff --git a/docs/joomla/index.md b/docs/joomla/index.md index 28d1852a31e4c0ed5854d1db079cb71df9bded26..4f64e63f8940a51cebefe16c41a643cd41e7053b 100644 --- a/docs/joomla/index.md +++ b/docs/joomla/index.md @@ -1,16 +1,14 @@ -## Scope of this guide and alternative installation methods +!!! tldr "About this document" -This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). + This guide covers standard installation of CiviCRM on an existing Joomla site. It assumes that you previously completed these tasks: -## Before installing - -1. Ensure that your system meets the [requirements](../general/requirements.md). -1. Install Joomla by referring to the [Joomla Installation Guide](https://docs.joomla.org/J3.x:Installing_Joomla) if needed. + 1. [Install Joomla](https://docs.joomla.org/J3.x:Installing_Joomla), and... + 1. [Review the CiviCRM requirements](../general/requirements.md) !!! note "Path for Joomla" The rest of these instructions assume that you have Joomla installed in `/var/www/JOOMLA_ROOT`. Adjust paths as needed. -## Download and Un-tar CiviCRM Code {:#download} +## Get the code {:#download} All CiviCRM code and packages used by CiviCRM (such as PEAR libraries) are included in the compressed CiviCRM distribution files ('tarballs'). Follow these steps to download and install the codebase: @@ -20,7 +18,7 @@ All CiviCRM code and packages used by CiviCRM (such as PEAR libraries) are inclu Note: when installing a new version over an old one, please first check [troubleshooting resources](#troubleshooting) below. -## Run the Installer {:#installer} +## Run the installer {:#installer} * Login to your Joomla Administrator site. * Go to **Extensions >> Install/Uninstall**. @@ -35,7 +33,7 @@ Note: when installing a new version over an old one, please first check [trouble Note that missing PHP Zip functionality *will* prevent CiviCRM from installing extensions via the GUI. -## Create CiviCRM Contacts for Existing Joomla Users {:#contacts-users} +## Synchronize the users {:#contacts-users} Once installed, CiviCRM keeps your Joomla Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Joomla user record. Conversely, only contacts who are authenticated users of your site will have corresponding Joomla user records. @@ -45,7 +43,9 @@ When CiviCRM is installed on top of an existing Joomla site, a special CiviCRM A * Click the **Components > CiviCRM > CiviCRM Home** link in the main navigation block * Click **Administer > Users and Permissions > Synchronize Users-to-Contacts** -## Troubleshooting Resources {:#troubleshooting} +## Addenda + +### Troubleshooting {:#troubleshooting} * If the CiviCRM component does not install correctly (for example you get a blank screen instead of the confirmation page), delete the `~/components/com_civicrm` and `~/administrator/components/com_civicrm` and `~/media/civicrm directories` manually and then try each of the following before attempting to reinstall: diff --git a/docs/wordpress/index.md b/docs/wordpress/index.md index f24f4c8eb9216725b48d166aa06e459f3559cae1..9ecaed295ddd976605149a44ceea88b2f3c63d9a 100644 --- a/docs/wordpress/index.md +++ b/docs/wordpress/index.md @@ -1,16 +1,18 @@ -## Scope of this guide and alternative installation methods +!!! tldr "About this document" -This guide covers standard installation of CiviCRM for production use. For installing a development environment, refer to the [section on Buildkit in the Developer Documentation](https://docs.civicrm.org/dev/en/latest/tools/buildkit/). + This guide covers standard installation of CiviCRM on an existing WordPress site. It assumes that you previously completed these tasks: -## Before installing + 1. [Install WordPress](https://wordpress.org/support/article/how-to-install-wordpress/), and... + 1. [Review the CiviCRM requirements](../general/requirements.md) -1. Ensure that your system meets the [requirements](../general/requirements.md). -1. Install WordPress by referring to the [WordPress Installation Guide](https://wordpress.org/support/article/how-to-install-wordpress/) if needed. +!!! tldr "Similar alternatives" + + If you plan to develop patches for CiviCRM on WordPress, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/). !!! note "Path for WordPress" The rest of these instructions assume that you have WordPress installed in `/var/www/wordpress`. Adjust paths as needed. -## Download and Un-zip CiviCRM Code +## Get the code {:#download} All CiviCRM code and packages used by CiviCRM (such as PEAR libraries) are included in the compressed CiviCRM distribution files ('zips'). Follow these steps to download and install the codebase: @@ -52,11 +54,11 @@ All CiviCRM code and packages used by CiviCRM (such as PEAR libraries) are inclu <!-- markdownlint-enable MD046 --> * You should now have a `/var/www/wordpress/wp-content/plugins/civicrm` directory containing `civicrm.php`, `README.txt` and another civicrm directory (which in turn contains bin, CRM, sql, templates, etc.). -## Install localization files (only for non-English sites) {:#i18n} +## Get the translations {:#i18n} -If using CiviCRM in another language than English, see the [internationalisation and localisation](../general/i18n_l10n.md) page about how to install files for running CiviCRM in other languages. +The basic CiviCRM release includes support for US English (`en_US`). To use another language or dialect, please [download and extract the translation files](../general/i18n_l10n.md). -## Enable CiviCRM plugin and run installer +## Run the installer The installer will verify that you've downloaded the correct version of CiviCRM, and will check your server environment to make sure it meets CiviCRM requirements. It will then create and populate a database for CiviCRM as well as create your CiviCRM settings file `civicrm.settings.php`. @@ -97,15 +99,17 @@ The installer will verify that you've downloaded the correct version of CiviCRM, even after changing directory permission in Explorer, see [the permissions page](../general/permissions.md) for instructions on how to set permissions on Linux, MacOS and Windows. * Once you see the green "You're ready to install!" message - you can click **Check Requirements and Install CiviCRM** -## Locate and Backup the CiviCRM settings file +## Backup the settings file -After installation, a configuration file will have been created by CiviCRM at: `<wordpress>/wp-content/uploads/civicrm/civicrm.settings.php` +The installer created a configuration file at `<wordpress>/wp-content/uploads/civicrm/civicrm.settings.php` It is critical you make a copy of this file and save as a backup in a safe location. This file contains passwords and other critical information, take precautions to secure the copy from prying eyes. Should an upgrade fail, you will need this backup copy to restore your site. -## Enabling Cleaner URLs for WordPress +<!-- Is the above still true for new installations in Civi 4.7/5.x? Makes sense if 4.6, which bizarrely placed the config-file in the code-directory.But in 4.7+?? --> + +## Enable clean URLs * Starting in Version 5.13.x CiviCRM now can support "Clean URLs" for WordPress front-end (user-facing) pages. * By default CiviCRM URLs are in the format of `https://example.org/civicrm?page=CiviCRM&q=civicrm/contribute/transact&reset=1&id=1` for a Contribution Page. With clean URLs enabled: @@ -159,7 +163,7 @@ if (!defined('CIVICRM_CLEANURL')) { * Now Cleaner URLs will be enabled. Enabling Cleaner URLs does not change how shortcodes work in CiviCRM and existing "Old" style URLs will still work -## Create CiviCRM Contacts for Existing WordPress Users +## Synchronize the users {:#contacts-users} Once installed, CiviCRM keeps your WordPress Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each WordPress user record. Conversely, only contacts who are authenticated users of your site will have corresponding WordPress user records. @@ -171,7 +175,7 @@ When CiviCRM is installed on top of an existing WordPress site, a special CiviCR * Click **Administer** in the menu bar * Click **Users and Permissions** from the drop-down menu, then select **Synchronize Users to Contacts**. -## Review the Configuration Checklist +## Review the checklist {:#checklist} The **Configuration Checklist** provides a convenient way to work through the settings that need to be reviewed and configured for a new site. You can link to this checklist from the installation success page AND you can visit it at any time from **Administer** » **Administration Console** » **Configuration Checklist**. @@ -179,7 +183,9 @@ The **Configuration Checklist** provides a convenient way to work through the se There should now be a **CiviCRM** link in your WordPress menu. Click that link and the CiviCRM Menu, Shortcuts, Search and New Individual Blocks should appear. You can now explore CiviCRM end-user features and begin configuring CiviCRM for your site/organization needs. -## Using Encryption with MySQL +## Addenda + +### TLS for MySQL If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server. @@ -187,6 +193,6 @@ See [TLS for MySQL](../general/mysql_tls.md) for introductory concepts and the s * `define('MYSQL_CLIENT_FLAGS', MYSQLI_CLIENT_SSL);` -## Troubleshooting Resources {:#troubleshooting} +### Troubleshooting {:#troubleshooting} * Review the [troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.