From 1b28b587349b725145394c372270b87478e70c5e Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Mon, 21 Sep 2020 21:21:42 -0700
Subject: [PATCH] Normalize line-endings
This repo currently has 16 markdown files, of which 8 have `CR` endings and
8 have `CR-LF` endings. For comparison, the dev-docs and sysadmin-guide
have strictly `CR` endings.
---
.gitattributes | 1 +
docs/backdrop/index.md | 404 +++++++++++++++----------------
docs/drupal7/index.md | 412 ++++++++++++++++----------------
docs/general/i18n_l10n.md | 8 +-
docs/general/permissions.md | 8 +-
docs/general/requirements.md | 402 +++++++++++++++----------------
docs/general/troubleshooting.md | 348 +++++++++++++--------------
docs/index.md | 36 +--
docs/joomla/index.md | 144 +++++------
9 files changed, 882 insertions(+), 881 deletions(-)
create mode 100644 .gitattributes
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..1fe2478
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+*.md text eol=lf
diff --git a/docs/backdrop/index.md b/docs/backdrop/index.md
index a54ef8b..443a590 100644
--- a/docs/backdrop/index.md
+++ b/docs/backdrop/index.md
@@ -1,202 +1,202 @@
-## Scope of this guide and alternative installation methods
-
-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/).
-
-## Before installing
-
-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.
-
-## Determine Backdrop Database Settings {:#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:
-
-``` php
-$db_url = 'mysql://dbuser:dbpassword@localhost/backdrop';
-```
-
-or
-
-``` php
-$databases['default']['default'] = array(
- 'driver' => 'mysql',
- 'database' => 'database_name',
- 'username' => 'dbuser',
- 'password' => 'dbpassword',
- 'host' => 'localhost',
-);
-```
-
-In the above example:
-
-| Setting | Value |
-| ------- | ----- |
-| Database Server | localhost |
-| Backdrop Database Name | backdrop |
-| Database User Name | dbuser |
-| Database User Password | dbpassword |
-
-## Tell Backdrop where to find the CiviCRM Module {:#directory}
-
-First, download CiviCRM and install the files like you would any other module:
-
-* As administrator in Backdrop, go to Modules, click on **Install New Module**. Click **Manual Installation**, then **Install from a URL**. Fill in the URL of the module (see below). You will need to enable the **Project Installer** module in the backdrop modules page to see the **Install New Module** link.
-* Alternatively, you can upload and extract the file in `<BACKDROP ROOT>/modules`
-
-The result will be that the CiviCRM directory will be at `<BACKDROP ROOT>/modules/civicrm`
-
-The most up-to-date version of CiviCRM will always be available from the [CiviCRM website](https://civicrm.org/download).
-
-**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}
-
-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.
-
-## 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).
-
-* Login to your Backdrop site with Administrator level permissions.
-* Point your web browser to the following URL:
-
- `https://example.org/modules/civicrm/install/index.php?civicrm_install_type=backdrop`
-
-* You should see the **CiviCRM Installer** screen.
- * Initially, you will see a red bar with the message "These database details don't appear to be correct." This is expected as you haven't entered your database settings yet.
- * If you see other errors, check the **Requirements** details at the bottom of the page for more information. You will need to correct any issues before continuing.
-* Fill in the CiviCRM Database Settings.
-
- !!! tip "Where Should I Store CiviCRM Data?"
- CiviCRM may be configured to use your existing Backdrop database, or a separate (new) database. Using a separate database is generally preferred - as it makes backups and upgrades easier. The installer will create a new database for CiviCRM automatically if you enter a database name that doesn't already exist on your database server AND the database user you enter has permission to create databases. In case the installer does not automatically create a new database, simply create a new one following the same process as creating a new database for Backdrop. Note that if you plan to use the Backdrop Views module to display CiviCRM data within your Backdrop pages, and if you are going to use separate databases for Backdrop and CiviCRM, you need to ensure that your Backdrop database user has `SELECT` permissions for your CiviCRM database.
-
-* Fill in the Backdrop Database Settings for your existing Backdrop database (as noted [above](#db-settings)).
-
- !!! check "Loading Sample Data"
- The Installer includes an option to load a set of sample contact, group, and relationship data by default. Sample data can provide a useful head-start in learning to use CiviCRM. However, if you do NOT want the sample data to be loaded, just uncheck **Load sample data** under **Other Settings**.
-
-* Select the appropriate language for the base installation. You will be able to add other languages after the installation for multi-lingual sites.
-* Click the **Check Requirements and Install CiviCRM** button.
- * The installer will configure your databases, create the settings file and redirect you to your Backdrop Home page.
- * If you still see a red bar with the message "These database details don't appear to be correct." - check the Database Details section below your settings for specific errors and problems. Once you correct these problems, click "Recheck requirements" to verify your settings before continuing.
- * If you are on a Windows machine and get the message:
- > "The user account used by your web-server needs to be granted write access to the following directory in order to configure the CiviCRM settings file: `C:<BACKDROP ROOT>/`"
- 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}
-
-!!! 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.
-
-* Go to **Administer » Configuration » User accounts » Permissions**
-
-* Verify that the Roles that you want to have access to CiviCRM have the appropriate permissions checked. CiviCRM is installed with a number of fixed permissions (such as "edit contacts" and "administer CiviCRM").
-
-<!-- markdownlint-disable MD046 -->
-!!! tip "Permissions for the Anonymous Role"
- Many sites want anonymous visitors to have access to certain CiviCRM functionality. These permissions are enabled during installation for the Anonymous role. You should review them and modify if needed based on your requirements:
-
- * **access all custom data** : If you plan on collecting "custom" data from visitors in standalone forms or as they make a contribution - enable this permission.
- * **access CiviMail subscribe/unsubscribe pages** : If you are planning on using CiviMail, enable this permission to allow anonymous users to subscribe and unsubscribe from mailing lists via the web.
- * **access uploaded files** : If you plan on allowing visitors to upload or view photos or other files - enable this permission.
- * **make online contributions** : If you plan on soliciting online contributions from visitors, enable this permission for the "anonymous" role.
- * **profile listings and forms** : If you plan on collecting name and address or other information from visitors, enable this permission for the "anonymous" role.
- * **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 Backdrop 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.
-
-When CiviCRM is installed on top of an existing Backdrop site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Backdrop users:
-
-* Login to your Backdrop site with an administrator-level login
-* Click the **CiviCRM** link in the main navigation block
-* If your Backdrop site makes use of the `db_prefix` setting (in `settings.php`), in de top bar click **Administer » System Settings » CMS Database Integration** , and update the box for the Backdrop Users Table Name so that it includes the prefix.
-* 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}
-
-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**.
-
-## Test-drive CiviCRM {:#test-drive}
-
-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
-
-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.
-
-Full instructions on installing drupal are out of scope for this guide, but one method is to install into a test database first without MySQL encryption and then move the database to the live server and update settings.php to enable MySQL encryption.
-
-See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the settings for the CiviCRM database. For the Drupal database you have several options for updating settings.php:
-
-1. The simplest, which doesn't require a client certificate, but doesn't verify the server certificate.
-
- ``` php
- $databases = array (
- 'default' =>
- array (
- 'default' =>
- array (
- 'database' => 'drupal',
- 'username' => 'dbuser',
- 'password' => 'dbpassword',
- 'host' => 'db435.examplehost.com',
- 'port' => '',
- 'driver' => 'mysql',
- 'prefix' => '',
- 'pdo' => array(
- PDO::MYSQL_ATTR_SSL_CA => TRUE,
- PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
- ),
- ),
- ),
- );
- ```
-
-2. Verifies the server certificate, and doesn't require a client certificate.
-
- !!! warning "Host name must match certificate name"
- Note that the DATABASE SERVER certificate would have to have a CN (common name field) that matches exactly the `host` you are using in `$databases['default']['default']['host']`. So if the host is `db435.examplehost.com`, then that must be the name on the SERVER certificate.
-
- ``` php
- 'pdo' => array(
- // A certificate authority bundle.
- // If you are using a self-signed server certificate in a development
- // or testing environment, then this would be the same as the server
- // certificate.
- PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
- ),
- ```
-
-3. Client certificate/key pair (not self-signed), and do not verify the server certificate.
-
- ``` php
- 'pdo' => array(
- PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
- PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
- PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
- ),
- ```
-
-4. Client certificate/key pair (could be self-signed), and verify the server certificate.
-
- ``` php
- 'pdo' => array(
- // The SSL_CA can be the same as your.crt if self-signed, but note
- // that it would also have to be a certificate authority for the
- // server certificate. Self-signed would only be for local
- // development testing.
- PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
- PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
- PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
- ),
- ```
-
-## Trouble-shooting Resources {:#troubleshooting}
-
-* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.
+## Scope of this guide and alternative installation methods
+
+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/).
+
+## Before installing
+
+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.
+
+## Determine Backdrop Database Settings {:#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:
+
+``` php
+$db_url = 'mysql://dbuser:dbpassword@localhost/backdrop';
+```
+
+or
+
+``` php
+$databases['default']['default'] = array(
+ 'driver' => 'mysql',
+ 'database' => 'database_name',
+ 'username' => 'dbuser',
+ 'password' => 'dbpassword',
+ 'host' => 'localhost',
+);
+```
+
+In the above example:
+
+| Setting | Value |
+| ------- | ----- |
+| Database Server | localhost |
+| Backdrop Database Name | backdrop |
+| Database User Name | dbuser |
+| Database User Password | dbpassword |
+
+## Tell Backdrop where to find the CiviCRM Module {:#directory}
+
+First, download CiviCRM and install the files like you would any other module:
+
+* As administrator in Backdrop, go to Modules, click on **Install New Module**. Click **Manual Installation**, then **Install from a URL**. Fill in the URL of the module (see below). You will need to enable the **Project Installer** module in the backdrop modules page to see the **Install New Module** link.
+* Alternatively, you can upload and extract the file in `<BACKDROP ROOT>/modules`
+
+The result will be that the CiviCRM directory will be at `<BACKDROP ROOT>/modules/civicrm`
+
+The most up-to-date version of CiviCRM will always be available from the [CiviCRM website](https://civicrm.org/download).
+
+**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}
+
+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.
+
+## 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).
+
+* Login to your Backdrop site with Administrator level permissions.
+* Point your web browser to the following URL:
+
+ `https://example.org/modules/civicrm/install/index.php?civicrm_install_type=backdrop`
+
+* You should see the **CiviCRM Installer** screen.
+ * Initially, you will see a red bar with the message "These database details don't appear to be correct." This is expected as you haven't entered your database settings yet.
+ * If you see other errors, check the **Requirements** details at the bottom of the page for more information. You will need to correct any issues before continuing.
+* Fill in the CiviCRM Database Settings.
+
+ !!! tip "Where Should I Store CiviCRM Data?"
+ CiviCRM may be configured to use your existing Backdrop database, or a separate (new) database. Using a separate database is generally preferred - as it makes backups and upgrades easier. The installer will create a new database for CiviCRM automatically if you enter a database name that doesn't already exist on your database server AND the database user you enter has permission to create databases. In case the installer does not automatically create a new database, simply create a new one following the same process as creating a new database for Backdrop. Note that if you plan to use the Backdrop Views module to display CiviCRM data within your Backdrop pages, and if you are going to use separate databases for Backdrop and CiviCRM, you need to ensure that your Backdrop database user has `SELECT` permissions for your CiviCRM database.
+
+* Fill in the Backdrop Database Settings for your existing Backdrop database (as noted [above](#db-settings)).
+
+ !!! check "Loading Sample Data"
+ The Installer includes an option to load a set of sample contact, group, and relationship data by default. Sample data can provide a useful head-start in learning to use CiviCRM. However, if you do NOT want the sample data to be loaded, just uncheck **Load sample data** under **Other Settings**.
+
+* Select the appropriate language for the base installation. You will be able to add other languages after the installation for multi-lingual sites.
+* Click the **Check Requirements and Install CiviCRM** button.
+ * The installer will configure your databases, create the settings file and redirect you to your Backdrop Home page.
+ * If you still see a red bar with the message "These database details don't appear to be correct." - check the Database Details section below your settings for specific errors and problems. Once you correct these problems, click "Recheck requirements" to verify your settings before continuing.
+ * If you are on a Windows machine and get the message:
+ > "The user account used by your web-server needs to be granted write access to the following directory in order to configure the CiviCRM settings file: `C:<BACKDROP ROOT>/`"
+ 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}
+
+!!! 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.
+
+* Go to **Administer » Configuration » User accounts » Permissions**
+
+* Verify that the Roles that you want to have access to CiviCRM have the appropriate permissions checked. CiviCRM is installed with a number of fixed permissions (such as "edit contacts" and "administer CiviCRM").
+
+<!-- markdownlint-disable MD046 -->
+!!! tip "Permissions for the Anonymous Role"
+ Many sites want anonymous visitors to have access to certain CiviCRM functionality. These permissions are enabled during installation for the Anonymous role. You should review them and modify if needed based on your requirements:
+
+ * **access all custom data** : If you plan on collecting "custom" data from visitors in standalone forms or as they make a contribution - enable this permission.
+ * **access CiviMail subscribe/unsubscribe pages** : If you are planning on using CiviMail, enable this permission to allow anonymous users to subscribe and unsubscribe from mailing lists via the web.
+ * **access uploaded files** : If you plan on allowing visitors to upload or view photos or other files - enable this permission.
+ * **make online contributions** : If you plan on soliciting online contributions from visitors, enable this permission for the "anonymous" role.
+ * **profile listings and forms** : If you plan on collecting name and address or other information from visitors, enable this permission for the "anonymous" role.
+ * **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 Backdrop 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.
+
+When CiviCRM is installed on top of an existing Backdrop site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Backdrop users:
+
+* Login to your Backdrop site with an administrator-level login
+* Click the **CiviCRM** link in the main navigation block
+* If your Backdrop site makes use of the `db_prefix` setting (in `settings.php`), in de top bar click **Administer » System Settings » CMS Database Integration** , and update the box for the Backdrop Users Table Name so that it includes the prefix.
+* 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}
+
+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**.
+
+## Test-drive CiviCRM {:#test-drive}
+
+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
+
+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.
+
+Full instructions on installing drupal are out of scope for this guide, but one method is to install into a test database first without MySQL encryption and then move the database to the live server and update settings.php to enable MySQL encryption.
+
+See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the settings for the CiviCRM database. For the Drupal database you have several options for updating settings.php:
+
+1. The simplest, which doesn't require a client certificate, but doesn't verify the server certificate.
+
+ ``` php
+ $databases = array (
+ 'default' =>
+ array (
+ 'default' =>
+ array (
+ 'database' => 'drupal',
+ 'username' => 'dbuser',
+ 'password' => 'dbpassword',
+ 'host' => 'db435.examplehost.com',
+ 'port' => '',
+ 'driver' => 'mysql',
+ 'prefix' => '',
+ 'pdo' => array(
+ PDO::MYSQL_ATTR_SSL_CA => TRUE,
+ PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
+ ),
+ ),
+ ),
+ );
+ ```
+
+2. Verifies the server certificate, and doesn't require a client certificate.
+
+ !!! warning "Host name must match certificate name"
+ Note that the DATABASE SERVER certificate would have to have a CN (common name field) that matches exactly the `host` you are using in `$databases['default']['default']['host']`. So if the host is `db435.examplehost.com`, then that must be the name on the SERVER certificate.
+
+ ``` php
+ 'pdo' => array(
+ // A certificate authority bundle.
+ // If you are using a self-signed server certificate in a development
+ // or testing environment, then this would be the same as the server
+ // certificate.
+ PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
+ ),
+ ```
+
+3. Client certificate/key pair (not self-signed), and do not verify the server certificate.
+
+ ``` php
+ 'pdo' => array(
+ PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
+ PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
+ PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
+ ),
+ ```
+
+4. Client certificate/key pair (could be self-signed), and verify the server certificate.
+
+ ``` php
+ 'pdo' => array(
+ // The SSL_CA can be the same as your.crt if self-signed, but note
+ // that it would also have to be a certificate authority for the
+ // server certificate. Self-signed would only be for local
+ // development testing.
+ PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
+ PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
+ PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
+ ),
+ ```
+
+## Trouble-shooting Resources {:#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 a682bf1..bb275fe 100644
--- a/docs/drupal7/index.md
+++ b/docs/drupal7/index.md
@@ -1,206 +1,206 @@
-## Scope of this guide and alternative installation methods
-
-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/).
-
-## Before installing
-
-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.
-
-## Determine Drupal Database Settings {:#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:
-
-```php
-$databases = array (
- 'default' =>
- array (
- 'default' =>
- array (
- 'database' => 'drupal',
- 'username' => 'dbuser',
- 'password' => 'dbpassword',
- 'host' => 'localhost',
- 'port' => '',
- 'driver' => 'mysql',
- 'prefix' => '',
- ),
- ),
-);
-```
-
-In the above example:
-
-| Setting | Value |
-| ---------------------- | ---------- |
-| Database Server | localhost |
-| Drupal Database Name | drupal |
-| Database User Name | dbuser |
-| Database User Password | dbpassword |
-
-## Tell Drupal where to find the CiviCRM Module {:#directory}
-
-First, download CiviCRM and install the files like you would any other module:
-
-* As administrator in Drupal, go to Modules, click on **Install New Module** , and it will ask you to fill in the URL of the module. It will then fetch it and install it for you. You will need to enable the **Update Manager** module in the Drupal modules page to see the **Install New Module** link.
-* Alternatively, you can upload and extract the file in `<DRUPAL ROOT>/sites/all/modules`
-
-The result will be that the CiviCRM directory will be at `<DRUPAL ROOT>/sites/all/modules/civicrm`
-
-The most up-to-date version of CiviCRM is always available from the [CiviCRM website](https://civicrm.org/download)
-
-**Do NOT** activate the module yet - that will happen automatically when you run the installer.
-
-## Install localization files (only for non-English sites) {:#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.
-
-## 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).
-
-* Login to your Drupal site with Administrator level permissions.
-* Point your web browser to the following URL:
-
- `https://example.org/sites/all/modules/civicrm/install/index.php`
-
-* You should see the **CiviCRM Installer** screen.
- * Initially, you will see a red bar with the message "These database details don't appear to be correct." This is expected as you haven't entered your database settings yet.
- * If you see other errors, check the **Requirements** details at the bottom of the page for more information. You will need to correct any issues before continuing.
-* Fill in the CiviCRM Database Settings.
-
- !!! tip "Where Should I Store CiviCRM Data?"
- CiviCRM may be configured to use your existing Drupal database, or a separate (new) database. Using a separate database is generally preferred - as it makes backups and upgrades easier. The installer will create a new database for CiviCRM automatically if you enter a database name that doesn't already exist on your database server AND the database user you enter has permission to create databases. In case the installer does not automatically create a new database, simply create a new one following the same process as creating a new database for Drupal. Note that if you plan to use the Drupal Views module to display CiviCRM data within your Drupal pages, and if you are going to use separate databases for Drupal and CiviCRM, you need to ensure that your Drupal database user has `SELECT` permissions for your CiviCRM database.
-
-* Fill in the Drupal Database Settings for your existing Drupal database (as noted [above](#db-settings)).
-
- !!! check "Loading Sample Data"
- The Installer includes an option to load a set of sample contact, group, and relationship data by default. Sample data can provide a useful head-start in learning to use CiviCRM. However, if you do NOT want the sample data to be loaded, just uncheck **Load sample data** under **Other Settings**.
-
-* Select the appropriate language for the base installation. You will be able to add other languages after the installation for multi-lingual sites.
-* Click the **Check Requirements and Install CiviCRM** button.
- * The installer will configure your databases, create the settings file and redirect you to your Drupal Home page.
- * If you still see a red bar with the message "These database details don't appear to be correct." - check the Database Details section below your settings for specific errors and problems. Once you correct these problems, click "Recheck requirements" to verify your settings before continuing.
- * If you are on a Windows machine and get the message:
- > "The user account used by your web-server needs to be granted write access to the following directory in order to configure the CiviCRM settings file: `C:<DRUPAL ROOT>/sites/default/`"
- 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}
-
-!!! 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.
-
-* Go to the CiviCRM dashboard to see the CiviCRM menus:
-`https://example.org/civicrm` (or `https://example.org/index.php?q=civicrm` if you don't have Clean URLs enabled)
-
-* Go to **Administer » User management » Permissions**
-
-* Verify that the Roles that you want to have access to CiviCRM have the appropriate permissions checked. CiviCRM is installed with a number of fixed permissions (such as "edit contacts" and "administer CiviCRM").
-<!-- markdownlint-disable MD046 -->
-!!! tip "Permissions for the Anonymous Role"
- Many sites want anonymous visitors to have access to certain CiviCRM functionality. These permissions are enabled during installation for the Anonymous role. You should review them and modify if needed based on your requirements:
-
- * **access all custom data** : If you plan on collecting "custom" data from visitors in standalone forms or as they make a contribution - enable this permission.
- * **access CiviMail subscribe/unsubscribe pages** : If you are planning on using CiviMail, enable this permission to allow anonymous users to subscribe and unsubscribe from mailing lists via the web.
- * **access uploaded files** : If you plan on allowing visitors to upload or view photos or other files - enable this permission.
- * **make online contributions** : If you plan on soliciting online contributions from visitors, enable this permission for the "anonymous" role.
- * **profile listings and forms** : If you plan on collecting name and address or other information from visitors, enable this permission for the "anonymous" role.
- * **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}
-
-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.
-
-When CiviCRM is installed on top of an existing Drupal site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Drupal users:
-
-* Login to your Drupal site with an administrator-level login
-* Click the **CiviCRM** link in the main navigation block
-* If your Drupal site makes use of the `db_prefix` setting (in `settings.php`), in the top bar click **Administer » System Settings » CMS Database Integration** , and update the box for the Drupal Users Table Name so that it includes the prefix.
-* 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}
-
-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**.
-
-## Test-drive CiviCRM {:#test-drive}
-
-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
-
-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.
-
-Full instructions on installing drupal are out of scope for this guide, but one method is to install into a test database first without MySQL encryption and then move the database to the live server and update settings.php to enable MySQL encryption.
-
-See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the settings for the CiviCRM database. For the Drupal database you have several options for updating settings.php:
-
-1. The simplest, which doesn't require a client certificate, but doesn't verify the server certificate.
-
- ``` php
- $databases = array (
- 'default' =>
- array (
- 'default' =>
- array (
- 'database' => 'drupal',
- 'username' => 'dbuser',
- 'password' => 'dbpassword',
- 'host' => 'db435.examplehost.com',
- 'port' => '',
- 'driver' => 'mysql',
- 'prefix' => '',
- 'pdo' => array(
- PDO::MYSQL_ATTR_SSL_CA => TRUE,
- PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
- ),
- ),
- ),
- );
- ```
-
-2. Verifies the server certificate, and doesn't require a client certificate.
-
- !!! warning "Host name must match certificate name"
- Note that the DATABASE SERVER certificate would have to have a CN (common name field) that matches exactly the `host` you are using in `$databases['default']['default']['host']`. So if the host is `db435.examplehost.com`, then that must be the name on the SERVER certificate.
-
- ``` php
- 'pdo' => array(
- // A certificate authority bundle.
- // If you are using a self-signed server certificate in a development
- // or testing environment, then this would be the same as the server
- // certificate.
- PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
- ),
- ```
-
-3. Client certificate/key pair (not self-signed), and do not verify the server certificate.
-
- ``` php
- 'pdo' => array(
- PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
- PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
- PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
- ),
- ```
-
-4. Client certificate/key pair (could be self-signed), and verify the server certificate.
-
- ``` php
- 'pdo' => array(
- // The SSL_CA can be the same as your.crt if self-signed, but note
- // that it would also have to be a certificate authority for the
- // server certificate. Self-signed would only be for local
- // development testing.
- PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
- PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
- PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
- ),
- ```
-
-## Trouble-shooting Resources {:#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/)
+## Scope of this guide and alternative installation methods
+
+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/).
+
+## Before installing
+
+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.
+
+## Determine Drupal Database Settings {:#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:
+
+```php
+$databases = array (
+ 'default' =>
+ array (
+ 'default' =>
+ array (
+ 'database' => 'drupal',
+ 'username' => 'dbuser',
+ 'password' => 'dbpassword',
+ 'host' => 'localhost',
+ 'port' => '',
+ 'driver' => 'mysql',
+ 'prefix' => '',
+ ),
+ ),
+);
+```
+
+In the above example:
+
+| Setting | Value |
+| ---------------------- | ---------- |
+| Database Server | localhost |
+| Drupal Database Name | drupal |
+| Database User Name | dbuser |
+| Database User Password | dbpassword |
+
+## Tell Drupal where to find the CiviCRM Module {:#directory}
+
+First, download CiviCRM and install the files like you would any other module:
+
+* As administrator in Drupal, go to Modules, click on **Install New Module** , and it will ask you to fill in the URL of the module. It will then fetch it and install it for you. You will need to enable the **Update Manager** module in the Drupal modules page to see the **Install New Module** link.
+* Alternatively, you can upload and extract the file in `<DRUPAL ROOT>/sites/all/modules`
+
+The result will be that the CiviCRM directory will be at `<DRUPAL ROOT>/sites/all/modules/civicrm`
+
+The most up-to-date version of CiviCRM is always available from the [CiviCRM website](https://civicrm.org/download)
+
+**Do NOT** activate the module yet - that will happen automatically when you run the installer.
+
+## Install localization files (only for non-English sites) {:#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.
+
+## 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).
+
+* Login to your Drupal site with Administrator level permissions.
+* Point your web browser to the following URL:
+
+ `https://example.org/sites/all/modules/civicrm/install/index.php`
+
+* You should see the **CiviCRM Installer** screen.
+ * Initially, you will see a red bar with the message "These database details don't appear to be correct." This is expected as you haven't entered your database settings yet.
+ * If you see other errors, check the **Requirements** details at the bottom of the page for more information. You will need to correct any issues before continuing.
+* Fill in the CiviCRM Database Settings.
+
+ !!! tip "Where Should I Store CiviCRM Data?"
+ CiviCRM may be configured to use your existing Drupal database, or a separate (new) database. Using a separate database is generally preferred - as it makes backups and upgrades easier. The installer will create a new database for CiviCRM automatically if you enter a database name that doesn't already exist on your database server AND the database user you enter has permission to create databases. In case the installer does not automatically create a new database, simply create a new one following the same process as creating a new database for Drupal. Note that if you plan to use the Drupal Views module to display CiviCRM data within your Drupal pages, and if you are going to use separate databases for Drupal and CiviCRM, you need to ensure that your Drupal database user has `SELECT` permissions for your CiviCRM database.
+
+* Fill in the Drupal Database Settings for your existing Drupal database (as noted [above](#db-settings)).
+
+ !!! check "Loading Sample Data"
+ The Installer includes an option to load a set of sample contact, group, and relationship data by default. Sample data can provide a useful head-start in learning to use CiviCRM. However, if you do NOT want the sample data to be loaded, just uncheck **Load sample data** under **Other Settings**.
+
+* Select the appropriate language for the base installation. You will be able to add other languages after the installation for multi-lingual sites.
+* Click the **Check Requirements and Install CiviCRM** button.
+ * The installer will configure your databases, create the settings file and redirect you to your Drupal Home page.
+ * If you still see a red bar with the message "These database details don't appear to be correct." - check the Database Details section below your settings for specific errors and problems. Once you correct these problems, click "Recheck requirements" to verify your settings before continuing.
+ * If you are on a Windows machine and get the message:
+ > "The user account used by your web-server needs to be granted write access to the following directory in order to configure the CiviCRM settings file: `C:<DRUPAL ROOT>/sites/default/`"
+ 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}
+
+!!! 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.
+
+* Go to the CiviCRM dashboard to see the CiviCRM menus:
+`https://example.org/civicrm` (or `https://example.org/index.php?q=civicrm` if you don't have Clean URLs enabled)
+
+* Go to **Administer » User management » Permissions**
+
+* Verify that the Roles that you want to have access to CiviCRM have the appropriate permissions checked. CiviCRM is installed with a number of fixed permissions (such as "edit contacts" and "administer CiviCRM").
+<!-- markdownlint-disable MD046 -->
+!!! tip "Permissions for the Anonymous Role"
+ Many sites want anonymous visitors to have access to certain CiviCRM functionality. These permissions are enabled during installation for the Anonymous role. You should review them and modify if needed based on your requirements:
+
+ * **access all custom data** : If you plan on collecting "custom" data from visitors in standalone forms or as they make a contribution - enable this permission.
+ * **access CiviMail subscribe/unsubscribe pages** : If you are planning on using CiviMail, enable this permission to allow anonymous users to subscribe and unsubscribe from mailing lists via the web.
+ * **access uploaded files** : If you plan on allowing visitors to upload or view photos or other files - enable this permission.
+ * **make online contributions** : If you plan on soliciting online contributions from visitors, enable this permission for the "anonymous" role.
+ * **profile listings and forms** : If you plan on collecting name and address or other information from visitors, enable this permission for the "anonymous" role.
+ * **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}
+
+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.
+
+When CiviCRM is installed on top of an existing Drupal site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Drupal users:
+
+* Login to your Drupal site with an administrator-level login
+* Click the **CiviCRM** link in the main navigation block
+* If your Drupal site makes use of the `db_prefix` setting (in `settings.php`), in the top bar click **Administer » System Settings » CMS Database Integration** , and update the box for the Drupal Users Table Name so that it includes the prefix.
+* 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}
+
+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**.
+
+## Test-drive CiviCRM {:#test-drive}
+
+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
+
+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.
+
+Full instructions on installing drupal are out of scope for this guide, but one method is to install into a test database first without MySQL encryption and then move the database to the live server and update settings.php to enable MySQL encryption.
+
+See [TLS for MySQL](/general/mysql_tls/) for introductory concepts and the settings for the CiviCRM database. For the Drupal database you have several options for updating settings.php:
+
+1. The simplest, which doesn't require a client certificate, but doesn't verify the server certificate.
+
+ ``` php
+ $databases = array (
+ 'default' =>
+ array (
+ 'default' =>
+ array (
+ 'database' => 'drupal',
+ 'username' => 'dbuser',
+ 'password' => 'dbpassword',
+ 'host' => 'db435.examplehost.com',
+ 'port' => '',
+ 'driver' => 'mysql',
+ 'prefix' => '',
+ 'pdo' => array(
+ PDO::MYSQL_ATTR_SSL_CA => TRUE,
+ PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
+ ),
+ ),
+ ),
+ );
+ ```
+
+2. Verifies the server certificate, and doesn't require a client certificate.
+
+ !!! warning "Host name must match certificate name"
+ Note that the DATABASE SERVER certificate would have to have a CN (common name field) that matches exactly the `host` you are using in `$databases['default']['default']['host']`. So if the host is `db435.examplehost.com`, then that must be the name on the SERVER certificate.
+
+ ``` php
+ 'pdo' => array(
+ // A certificate authority bundle.
+ // If you are using a self-signed server certificate in a development
+ // or testing environment, then this would be the same as the server
+ // certificate.
+ PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
+ ),
+ ```
+
+3. Client certificate/key pair (not self-signed), and do not verify the server certificate.
+
+ ``` php
+ 'pdo' => array(
+ PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => FALSE,
+ PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
+ PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
+ ),
+ ```
+
+4. Client certificate/key pair (could be self-signed), and verify the server certificate.
+
+ ``` php
+ 'pdo' => array(
+ // The SSL_CA can be the same as your.crt if self-signed, but note
+ // that it would also have to be a certificate authority for the
+ // server certificate. Self-signed would only be for local
+ // development testing.
+ PDO::MYSQL_ATTR_SSL_CA => '/path/to/ca.crt',
+ PDO::MYSQL_ATTR_SSL_KEY => '/path/to/your.key',
+ PDO::MYSQL_ATTR_SSL_CERT => '/path/to/your.crt',
+ ),
+ ```
+
+## Trouble-shooting Resources {:#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/general/i18n_l10n.md b/docs/general/i18n_l10n.md
index 943c8e4..b1788f3 100644
--- a/docs/general/i18n_l10n.md
+++ b/docs/general/i18n_l10n.md
@@ -1,4 +1,4 @@
-## Coming Soon
-
-!!! note ""
- This page is a placeholder for content being migrated in from the old Wiki.
+## Coming Soon
+
+!!! note ""
+ This page is a placeholder for content being migrated in from the old Wiki.
diff --git a/docs/general/permissions.md b/docs/general/permissions.md
index a9c1e3a..74a6c0f 100644
--- a/docs/general/permissions.md
+++ b/docs/general/permissions.md
@@ -1,4 +1,4 @@
-## Coming Soon
-
-!!! note ""
- This page is a placeholder for content being created to help configure filesystem permissions for CiviCRM.
+## Coming Soon
+
+!!! note ""
+ This page is a placeholder for content being created to help configure filesystem permissions for CiviCRM.
diff --git a/docs/general/requirements.md b/docs/general/requirements.md
index be27e10..292a294 100644
--- a/docs/general/requirements.md
+++ b/docs/general/requirements.md
@@ -1,201 +1,201 @@
-# Installation Requirements
-
-Ensure that your system meets the following requirements before installing or upgrading CiviCRM.
-
-If you are curious what technologies other organizations are using to run CiviCRM, you can look at the [CiviCRM Stats](https://stats.civicrm.org/?tab=technology).
-
-## Server Environment {:#server}
-
-### Operating System {:#os}
-
-If your server meets all of the requirements described on this page, CiviCRM *should* function correctly. There are no explicit operating system requirements. However, it's worth noting that CiviCRM is far more widely deployed and tested on UNIX-based operating systems, in particular Linux (e.g. Ubuntu, Debian, etc.), than with Microsoft Windows. You can still use CiviCRM fine from Windows desktops when the hosting environment runs Linux.
-
-### Hosting
-
-In general, CiviCRM is a demanding web application which requires substantial server resources. It may not perform well on all hosting platforms. Learn more about [choosing your hosting platform](../planning/hosting.md).
-
-## CMS {:#cms}
-
-A CMS, or Content Management System, is a type of application which controls and manages the content of a website. CiviCRM must be installed within one of these compatible CMS platforms.
-
-See the page on [choosing a CMS](../planning/cms.md) for more information about the advantages and disadvantages of each compatible CMS platform.
-
-### Backdrop
-
-* [Backdrop](../backdrop/index.md) 1.0 or newer is required.
-
-### Drupal
-
-* [Drupal 8](../drupal8/index.md)
-
-* [Drupal 7](../drupal7/index.md)
-
-### Joomla
-
-* [Joomla](../joomla/index.md) 3.x.x is required.
-
-### WordPress
-
-* [WordPress](../wordpress/index.md) 4.9 or newer is required.
-
-## PHP {:#php}
-
-### PHP Version on the Command Line
-
-The PHP version used on the command line is important and should match the version used by the web server. Using PHP 7.1 (or lower) on the command line and using PHP 7.2 (or higher) on the web server can cause issues.
-
-It is also important to ensure that the same PHP extensions/modules are loaded on the command line and the web server.
-
-### PHP Version
-
-| | CiviCRM 5.27 ESR | CiviCRM 5.x.x stable |
-| ---- | ---- | ---- |
-| PHP 7.4 | **incompatible** | Testing has shown that as of CiviCRM 5.28 can be run but issues are still being worked on in this [lab issue](https://lab.civicrm.org/dev/core/-/issues/1496) |
-| PHP 7.3 | compatible and **recommended** | compatible and **recommended** |
-| PHP 7.2 | compatible and **recommended** - but see note below about resaving the SMTP password | compatible and **recommended** but see note below about resaving the SMTP password |
-| PHP 7.1 | compatible but **not recommended** due to to [PHP end-of life](http://php.net/eol.php) in Dec 2019 | compatible but **not recommended** due to to [PHP end-of life](http://php.net/eol.php) in Dec 2019 |
-| PHP 7.0 | **incompatible** | incompatible as of 5.25.0 |
-| PHP 5.6 | **incompatible** | **incompatible** |
-
-### PHP Extensions
-
-To install these extensions, you will typically install a separate package within your server's package manager (e.g. `apt-get` on Ubuntu).
-
-#### Required for CiviCRM Core
-
-* [PHP BCMath](https://www.php.net/bcmath) - required for calculating financial values in CiviCRM Core.
-* [PHP Curl](https://www.php.net/curl) - required for many payment processors, the extension manager, and the CiviCRM News dashlet.
-* [PHP DOM XML](https://www.php.net/manual/en/dom.setup.php) - required by CiviCase.
-* [PHP Multibyte](https://php.net/manual/en/ref.mbstring.php) - required for internationalisation and proper encoding of fields.
-* [PHP Zip](https://php.net/manual/en/book.zip.php) - required for unzipping auto-downloaded extensions so they can be installed from the browser.
-* [PHP INTL](https://www.php.net/intl) - required for outputting localized formatted number strings from CiviCRM 5.28 onwards
-
-#### Required for Third-Party Functionality or CiviCRM Extensions
-
-* [PHP SOAP](https://www.php.net/soap) - required to use the SOAP processor (required for the CiviSMTP service)
-
-#### PHP 7.1 and the MCrypt library
-
-* [PHP MCrypt](https://php.net/manual/en/intro.mcrypt.php) - the MCrypt extension is no longer recommended for new installations.
-
- !!! warning "PHP 7.2 Compatibility"
- 7.2 upgrade warning - 7.2 does not support MCrypt and if MCrypt is not installed the SMTP password (if entered) will need to be re-saved once you update your PHP version to 7.2.
- !!! warning "PHP 7.1 cannot access SMTP credentials"
- CiviCRM will incorrectly attempt to decrypt the SMTP password using the MCrypt library when executed using PHP 7.1. If PHP 7.2 or higher was used to save the SMTP password. This can occur if the PHP version on the command line does not match the web server version.
-
-### PHP Configuration
-
-* Set `memory_limit` between 256 and 512 megabytes
-* Don't enable the deprecated `open_basedir` or `safemode` PHP directives. Otherwise you will have an error when automatically installing most of the extensions.
-* Don't use MAMP XCache - Several people have reported "white screen of death" trying to run CiviCRM with MAMP's XCache enabled (check MAMP > Preferences > PHP > Cache).
-
-## MySQL
-
-CiviCRM requires MySQL (or compatible) database software.
-
-[MariaDB](https://mariadb.org/) and [Percona](https://www.percona.com/software/mysql-database/percona-server) are forks of the MySQL project and can be used as drop-in replacements for MySQL.
-
-Other database servers (such as PostgreSQL) are not compatible with CiviCRM.
-
-### MySQL Version
-
-Your MySQL version should be **5.7.5 or greater** or MariaDB **10.0.2 or greater**. As of version 5.28 the minimum install version for CiviCRM is 5.6 users on versions before that are advised to upgrade their MySQL instance to a recommended version. CiviCRM may not run correctly on MySQL 5.6 as these versions don't support some of the functionality CiviCRM uses to ensure that database actions don't compete for the same resources.
-
-#### MySQL 8
-
-As of version 5.24 CiviCRM has been shown to be able to run on MySQL 8 through the execution of our test matrix. Not all of the Content Management Systems support MySQL 8, CiviCRM MySQL 8 support is being tracked in this [open issue for MySQL 8 support](https://lab.civicrm.org/dev/core/issues/392). It is also worth knowing that both [Backdrop](https://forum.backdropcms.org/forum/installing-backdrop-1126-mysql-8-sqlmode-cant-be-set-value-noautocreateuser) and [Drupal 7](https://www.drupal.org/project/drupal/issues/2978575) have open issues with regards to MySQL 8 support. [Drupal 8](https://www.drupal.org/docs/8/system-requirements/database-server) [supports MySQL 8 as of version 8.6](https://www.drupal.org/project/drupal/issues/2966523), Current versions of WordPress and [Joomla](https://docs.joomla.org/Joomla_and_MySQL_8) appear to be compatible with MySQL 8
-
-### MySQL Configuration
-
-* Support for the `innodb` storage engine is required.
-* The `thread_stack` configuration variable should be set to 192k or higher.
-* Trigger support is required.
-* The `ONLY_FULL_GROUP_BY` mode should be turned off on production sites - although this is mostly precautionary now.
- * In MySQL 5.7+ the SQL mode `ONLY_FULL_GROUP_BY` is enabled by default which causes some errors due to some of CiviCRM's SQL queries that were written with the assumption that this mode would be disabled.
- * Administrators are advised to turn off this SQL mode by removing the string `ONLY_FULL_GROUP_BY` from the `sql_mode` variable. The following SQL query will do the trick.
-
- ```sql
- SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''));
- ```
-
- * See also:
- * A popular [Stack Exchange question](https://stackoverflow.com/a/36033983/895563) discussing this issue
- * [MySQL documentation on `sql_mode`](https://dev.mysql.com/doc/refman/5.7/en/sql-mode.html#sql-mode-setting)
-* If you plan to have multiple languages used in your CiviCRM installation it is strongly recommended that you ensure that `locale` is set to a UTF8 locale and also ensure that you set utf8 as the standard encoding for MySQL. To alter locale you can configure as per [Ubuntu instructions](https://www.thomas-krenn.com/en/wiki/Configure_Locales_in_Ubuntu), [Debian](https://wiki.debian.org/Locale), [CentOS](https://www.rosehosting.com/blog/how-to-set-up-system-locale-on-centos-7/). To set the default encoding for MySQL you should follow the steps provided in this [Stack Overflow post](https://stackoverflow.com/questions/3513773/change-mysql-default-character-set-to-utf-8-in-my-cnf)
-* In order to support a future data migration from `utf8` to the `utf8mb4` character set, it is recommended, though not yet required, to add the following configuration directives on MySQL 5.5 or 5.6 (these are the default values on MySQL 5.7):
-
- ```ini
- [mysqld]
- innodb_large_prefix=true
- innodb_file_format=barracuda
- innodb_file_per_table=true
- ```
-
-* In MySQL 8 the default authentication plugin changes from `mysql_native_password` to `caching_sha2_password`. This may cause issues with your PHP layer. Fortunately you can revert this change by specifying your chosen authentication plugin in your MySQL configuration:
-
- ```ini
- [mysqld]
- default_authentication_plugin=mysql_native_password
- ```
-
- Also in MySQL 8 the following variables, used fairly extensively in CiviCRM installs, have been removed `innodb_large_prefix` and `innodb_file_format`. In MySQL 8 binary logging is also turned on by default which many users may want to turn off, this can be achieved by adding to your MySQL configuration file:
-
- ```ini
- [mysqld]
- skip-log-bin
- ```
-
-#### MySQL Time
-
-CiviCRM performs various operations based on dates and times – for example, deactivating expired records or triggering scheduled reminders. To perform these operations correctly, the dates and times reported by PHP and MySQL should match. If the dates or times are mismatched, then one or more of the following may be the problem:
-
-* PHP and MySQL may be running on different servers, and the clocks may be out-of-sync. Configuring automatic clock synchronization is the best solution.
-* PHP, MySQL, and/or the operating system may be configured to use different default timezones. Verify the configuration of each.
-* The content management system (Drupal, Joomla, or WordPress) or one of its plugins may manipulate the timezone settings without informing CiviCRM's. You may wish to post to [Stack Exchange](https://civicrm.stackexchange.com/) or [Mattermost](https://chat.civicrm.org) about your problem. Please include any available details about the timezone settings in the operating system, PHP, MySQL, and the CMS; if you have any special CMS plugins or configuration options which may affect timezones, please report them.
-
-### MySQL Permissions
-
-The permissions you'll need to assign to the MySQL user that CiviCRM uses will **depend on your version of MySQL**. The following example assumes you have a database called `civicrm` and a MySQL user called `civicrm_user`.
-
-```sql
-GRANT
- SELECT,
- INSERT,
- UPDATE,
- DELETE,
- CREATE,
- DROP,
- INDEX,
- ALTER,
- CREATE TEMPORARY TABLES,
- LOCK TABLES,
- TRIGGER,
- CREATE ROUTINE,
- ALTER ROUTINE,
- REFERENCES,
- CREATE VIEW,
- SHOW VIEW
-ON civicrm.*
-TO 'civicrm_user'@'localhost'
-IDENTIFIED BY 'realpasswordhere';
-```
-
-#### Binary Logging
-
-If you want to enable binary logging you will need to choose one of the following. Either:
-
-* Add the following line to your `/etc/my.cnf` file.
-
- ```ini
- log_bin_trust_function_creators = 1
- ```
-
- (See the [MySQL manual reference](http://dev.mysql.com/doc/refman/5.1/en/server-system-variables.html#sysvar_log_bin_trust_function_creators) for more information.)
-
-* Or give the `SUPER` permission (even if your MySQL version is greater than 5.1.6).
-
- ```sql
- GRANT SUPER ON *.* TO 'civicrm_user'@'localhost';
- ```
-
- (More information on triggers is available in the MySQL documentation about [Binary Logging of Stored Programs](http://dev.mysql.com/doc/refman/5.1/en/stored-programs-logging.html).)
+# Installation Requirements
+
+Ensure that your system meets the following requirements before installing or upgrading CiviCRM.
+
+If you are curious what technologies other organizations are using to run CiviCRM, you can look at the [CiviCRM Stats](https://stats.civicrm.org/?tab=technology).
+
+## Server Environment {:#server}
+
+### Operating System {:#os}
+
+If your server meets all of the requirements described on this page, CiviCRM *should* function correctly. There are no explicit operating system requirements. However, it's worth noting that CiviCRM is far more widely deployed and tested on UNIX-based operating systems, in particular Linux (e.g. Ubuntu, Debian, etc.), than with Microsoft Windows. You can still use CiviCRM fine from Windows desktops when the hosting environment runs Linux.
+
+### Hosting
+
+In general, CiviCRM is a demanding web application which requires substantial server resources. It may not perform well on all hosting platforms. Learn more about [choosing your hosting platform](../planning/hosting.md).
+
+## CMS {:#cms}
+
+A CMS, or Content Management System, is a type of application which controls and manages the content of a website. CiviCRM must be installed within one of these compatible CMS platforms.
+
+See the page on [choosing a CMS](../planning/cms.md) for more information about the advantages and disadvantages of each compatible CMS platform.
+
+### Backdrop
+
+* [Backdrop](../backdrop/index.md) 1.0 or newer is required.
+
+### Drupal
+
+* [Drupal 8](../drupal8/index.md)
+
+* [Drupal 7](../drupal7/index.md)
+
+### Joomla
+
+* [Joomla](../joomla/index.md) 3.x.x is required.
+
+### WordPress
+
+* [WordPress](../wordpress/index.md) 4.9 or newer is required.
+
+## PHP {:#php}
+
+### PHP Version on the Command Line
+
+The PHP version used on the command line is important and should match the version used by the web server. Using PHP 7.1 (or lower) on the command line and using PHP 7.2 (or higher) on the web server can cause issues.
+
+It is also important to ensure that the same PHP extensions/modules are loaded on the command line and the web server.
+
+### PHP Version
+
+| | CiviCRM 5.27 ESR | CiviCRM 5.x.x stable |
+| ---- | ---- | ---- |
+| PHP 7.4 | **incompatible** | Testing has shown that as of CiviCRM 5.28 can be run but issues are still being worked on in this [lab issue](https://lab.civicrm.org/dev/core/-/issues/1496) |
+| PHP 7.3 | compatible and **recommended** | compatible and **recommended** |
+| PHP 7.2 | compatible and **recommended** - but see note below about resaving the SMTP password | compatible and **recommended** but see note below about resaving the SMTP password |
+| PHP 7.1 | compatible but **not recommended** due to to [PHP end-of life](http://php.net/eol.php) in Dec 2019 | compatible but **not recommended** due to to [PHP end-of life](http://php.net/eol.php) in Dec 2019 |
+| PHP 7.0 | **incompatible** | incompatible as of 5.25.0 |
+| PHP 5.6 | **incompatible** | **incompatible** |
+
+### PHP Extensions
+
+To install these extensions, you will typically install a separate package within your server's package manager (e.g. `apt-get` on Ubuntu).
+
+#### Required for CiviCRM Core
+
+* [PHP BCMath](https://www.php.net/bcmath) - required for calculating financial values in CiviCRM Core.
+* [PHP Curl](https://www.php.net/curl) - required for many payment processors, the extension manager, and the CiviCRM News dashlet.
+* [PHP DOM XML](https://www.php.net/manual/en/dom.setup.php) - required by CiviCase.
+* [PHP Multibyte](https://php.net/manual/en/ref.mbstring.php) - required for internationalisation and proper encoding of fields.
+* [PHP Zip](https://php.net/manual/en/book.zip.php) - required for unzipping auto-downloaded extensions so they can be installed from the browser.
+* [PHP INTL](https://www.php.net/intl) - required for outputting localized formatted number strings from CiviCRM 5.28 onwards
+
+#### Required for Third-Party Functionality or CiviCRM Extensions
+
+* [PHP SOAP](https://www.php.net/soap) - required to use the SOAP processor (required for the CiviSMTP service)
+
+#### PHP 7.1 and the MCrypt library
+
+* [PHP MCrypt](https://php.net/manual/en/intro.mcrypt.php) - the MCrypt extension is no longer recommended for new installations.
+
+ !!! warning "PHP 7.2 Compatibility"
+ 7.2 upgrade warning - 7.2 does not support MCrypt and if MCrypt is not installed the SMTP password (if entered) will need to be re-saved once you update your PHP version to 7.2.
+ !!! warning "PHP 7.1 cannot access SMTP credentials"
+ CiviCRM will incorrectly attempt to decrypt the SMTP password using the MCrypt library when executed using PHP 7.1. If PHP 7.2 or higher was used to save the SMTP password. This can occur if the PHP version on the command line does not match the web server version.
+
+### PHP Configuration
+
+* Set `memory_limit` between 256 and 512 megabytes
+* Don't enable the deprecated `open_basedir` or `safemode` PHP directives. Otherwise you will have an error when automatically installing most of the extensions.
+* Don't use MAMP XCache - Several people have reported "white screen of death" trying to run CiviCRM with MAMP's XCache enabled (check MAMP > Preferences > PHP > Cache).
+
+## MySQL
+
+CiviCRM requires MySQL (or compatible) database software.
+
+[MariaDB](https://mariadb.org/) and [Percona](https://www.percona.com/software/mysql-database/percona-server) are forks of the MySQL project and can be used as drop-in replacements for MySQL.
+
+Other database servers (such as PostgreSQL) are not compatible with CiviCRM.
+
+### MySQL Version
+
+Your MySQL version should be **5.7.5 or greater** or MariaDB **10.0.2 or greater**. As of version 5.28 the minimum install version for CiviCRM is 5.6 users on versions before that are advised to upgrade their MySQL instance to a recommended version. CiviCRM may not run correctly on MySQL 5.6 as these versions don't support some of the functionality CiviCRM uses to ensure that database actions don't compete for the same resources.
+
+#### MySQL 8
+
+As of version 5.24 CiviCRM has been shown to be able to run on MySQL 8 through the execution of our test matrix. Not all of the Content Management Systems support MySQL 8, CiviCRM MySQL 8 support is being tracked in this [open issue for MySQL 8 support](https://lab.civicrm.org/dev/core/issues/392). It is also worth knowing that both [Backdrop](https://forum.backdropcms.org/forum/installing-backdrop-1126-mysql-8-sqlmode-cant-be-set-value-noautocreateuser) and [Drupal 7](https://www.drupal.org/project/drupal/issues/2978575) have open issues with regards to MySQL 8 support. [Drupal 8](https://www.drupal.org/docs/8/system-requirements/database-server) [supports MySQL 8 as of version 8.6](https://www.drupal.org/project/drupal/issues/2966523), Current versions of WordPress and [Joomla](https://docs.joomla.org/Joomla_and_MySQL_8) appear to be compatible with MySQL 8
+
+### MySQL Configuration
+
+* Support for the `innodb` storage engine is required.
+* The `thread_stack` configuration variable should be set to 192k or higher.
+* Trigger support is required.
+* The `ONLY_FULL_GROUP_BY` mode should be turned off on production sites - although this is mostly precautionary now.
+ * In MySQL 5.7+ the SQL mode `ONLY_FULL_GROUP_BY` is enabled by default which causes some errors due to some of CiviCRM's SQL queries that were written with the assumption that this mode would be disabled.
+ * Administrators are advised to turn off this SQL mode by removing the string `ONLY_FULL_GROUP_BY` from the `sql_mode` variable. The following SQL query will do the trick.
+
+ ```sql
+ SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''));
+ ```
+
+ * See also:
+ * A popular [Stack Exchange question](https://stackoverflow.com/a/36033983/895563) discussing this issue
+ * [MySQL documentation on `sql_mode`](https://dev.mysql.com/doc/refman/5.7/en/sql-mode.html#sql-mode-setting)
+* If you plan to have multiple languages used in your CiviCRM installation it is strongly recommended that you ensure that `locale` is set to a UTF8 locale and also ensure that you set utf8 as the standard encoding for MySQL. To alter locale you can configure as per [Ubuntu instructions](https://www.thomas-krenn.com/en/wiki/Configure_Locales_in_Ubuntu), [Debian](https://wiki.debian.org/Locale), [CentOS](https://www.rosehosting.com/blog/how-to-set-up-system-locale-on-centos-7/). To set the default encoding for MySQL you should follow the steps provided in this [Stack Overflow post](https://stackoverflow.com/questions/3513773/change-mysql-default-character-set-to-utf-8-in-my-cnf)
+* In order to support a future data migration from `utf8` to the `utf8mb4` character set, it is recommended, though not yet required, to add the following configuration directives on MySQL 5.5 or 5.6 (these are the default values on MySQL 5.7):
+
+ ```ini
+ [mysqld]
+ innodb_large_prefix=true
+ innodb_file_format=barracuda
+ innodb_file_per_table=true
+ ```
+
+* In MySQL 8 the default authentication plugin changes from `mysql_native_password` to `caching_sha2_password`. This may cause issues with your PHP layer. Fortunately you can revert this change by specifying your chosen authentication plugin in your MySQL configuration:
+
+ ```ini
+ [mysqld]
+ default_authentication_plugin=mysql_native_password
+ ```
+
+ Also in MySQL 8 the following variables, used fairly extensively in CiviCRM installs, have been removed `innodb_large_prefix` and `innodb_file_format`. In MySQL 8 binary logging is also turned on by default which many users may want to turn off, this can be achieved by adding to your MySQL configuration file:
+
+ ```ini
+ [mysqld]
+ skip-log-bin
+ ```
+
+#### MySQL Time
+
+CiviCRM performs various operations based on dates and times – for example, deactivating expired records or triggering scheduled reminders. To perform these operations correctly, the dates and times reported by PHP and MySQL should match. If the dates or times are mismatched, then one or more of the following may be the problem:
+
+* PHP and MySQL may be running on different servers, and the clocks may be out-of-sync. Configuring automatic clock synchronization is the best solution.
+* PHP, MySQL, and/or the operating system may be configured to use different default timezones. Verify the configuration of each.
+* The content management system (Drupal, Joomla, or WordPress) or one of its plugins may manipulate the timezone settings without informing CiviCRM's. You may wish to post to [Stack Exchange](https://civicrm.stackexchange.com/) or [Mattermost](https://chat.civicrm.org) about your problem. Please include any available details about the timezone settings in the operating system, PHP, MySQL, and the CMS; if you have any special CMS plugins or configuration options which may affect timezones, please report them.
+
+### MySQL Permissions
+
+The permissions you'll need to assign to the MySQL user that CiviCRM uses will **depend on your version of MySQL**. The following example assumes you have a database called `civicrm` and a MySQL user called `civicrm_user`.
+
+```sql
+GRANT
+ SELECT,
+ INSERT,
+ UPDATE,
+ DELETE,
+ CREATE,
+ DROP,
+ INDEX,
+ ALTER,
+ CREATE TEMPORARY TABLES,
+ LOCK TABLES,
+ TRIGGER,
+ CREATE ROUTINE,
+ ALTER ROUTINE,
+ REFERENCES,
+ CREATE VIEW,
+ SHOW VIEW
+ON civicrm.*
+TO 'civicrm_user'@'localhost'
+IDENTIFIED BY 'realpasswordhere';
+```
+
+#### Binary Logging
+
+If you want to enable binary logging you will need to choose one of the following. Either:
+
+* Add the following line to your `/etc/my.cnf` file.
+
+ ```ini
+ log_bin_trust_function_creators = 1
+ ```
+
+ (See the [MySQL manual reference](http://dev.mysql.com/doc/refman/5.1/en/server-system-variables.html#sysvar_log_bin_trust_function_creators) for more information.)
+
+* Or give the `SUPER` permission (even if your MySQL version is greater than 5.1.6).
+
+ ```sql
+ GRANT SUPER ON *.* TO 'civicrm_user'@'localhost';
+ ```
+
+ (More information on triggers is available in the MySQL documentation about [Binary Logging of Stored Programs](http://dev.mysql.com/doc/refman/5.1/en/stored-programs-logging.html).)
diff --git a/docs/general/troubleshooting.md b/docs/general/troubleshooting.md
index 2cedcc5..ed908e5 100644
--- a/docs/general/troubleshooting.md
+++ b/docs/general/troubleshooting.md
@@ -1,174 +1,174 @@
-## General advice
-
-Try searching the [CiviCRM Stack Exchange](https://civicrm.stackexchange.com/tour) for solutions.
-
-Try to replicate the problem on the CiviCRM sandboxes - see "Testing Sandboxes" on the [CiviCRM demo page](https://civicrm.org/demo). If you can demonstrate that the problem doesn't just exist for you, more community members will give assistance.
-
-Post a question on [CiviCRM Stack Exchange](https://civicrm.stackexchange.com/tour). Be sure to include:
-
-* your CiviCRM version
-* which CMS you use
-* your CMS version
-
-Consider improving the question with screenshots and/or detailed error messages. Be sure to mention if the problem exists on the demo site.
-
-## More Detailed Errors (Debugging and Backtrace) {:#debugging}
-
-If you receive a CiviCRM fatal error, you can find a more detailed error in one of two ways.
-
-CiviCRM fatal errors are characterized by a yellow background:
-
-
-
-### Review the CiviCRM log
-
-If you have direct access to the files on your server, the CiviCRM log can be found in the ConfigAndLog directory. [Directions to find the ConfigAndLog directory can be found here](https://civicrm.stackexchange.com/a/15932/12). Errors are labeled with timestamps, and include both debug and backtrace information.
-
-### Using the built-in Debugging Tools
-
-Go to **Administer menu > System Settings > Debugging and Error Handling**, select "Yes" to both "Enable Debugging" and "Display Backtrace", and press "Save". Repeat the steps that caused your error, and you'll see a much more detailed error.
-
-!!! danger "Do NOT Leave Debug Turned On in Production Sites"
- When debugging is turned on, some internal settings are visible to site visitors. For security purposes, it's best to avoid turning on debugging/backtrace on public sites whenever possible.
-
-Example with debug/backtrace enabled:
-
-
-
-## Symptoms
-
-* **Directory Cleanup** - Empties template cache and/or upload file folders.
- * To empty template cache (civicrm/templates_c folder), add `&directoryCleanup=1`
- * To remove temporary upload files (civicrm/upload folder), add `&directoryCleanup=2`
- * To cleanup both, add `&directoryCleanup=3`
-
-* **Stack Trace** - To display stack trace at the top of the page when an error occurs, set Enable Backtrace from **Administer » System Settings » Debugging** **and Error Handling**.
-
-### "civicrm_strip_non_numeric does not exist"
-
-This error occurs when your database has lost a MySQL function definition for `civicrm_strip_non_numeric`. It can happen when moving from one server to another with the wrong `mysqldump` parameters, or if you use phpMyAdmin or certain other tools to rename a database, since they copy most but not all of the contents of the database to a database with the new name before deleting the old one. [Re-build your database triggers](#trigger-rebuild) to fix the problem.
-
-### "Could not find valid Key"
-
-If you are getting this error when submitting a form (search or adding / editing records), check the following:
-
-* Ensure cookies are enabled on browser. Like most web applications, CiviCRM can not function properly with cookies disabled.
-* Ensure your configuration settings are using the same "machine name" for CiviCRM and your CMS. For example, you will have problems if CiviCRM is configured to use `http://example.com` as its `BASE_URL` and your CMS is using `http://www.example.com`. You can use an `.htaccess` entry to redirect to the configured URL if needed (i.e. push all users to `http://www.example.com` even if they hit `http://example.com`).
-
- 1. For Drupal sites, ensure that `uid = 0` exists in your Drupal users table. This is required for anonymous access to CiviCRM pages and forms to work properly.
- 1. For Drupal sites, ensure that Drupal sessions table uses UTF8 collation, AND that the session column in this table is of SQL type longtext in the schema. You can check both of these in phpMyAdmin, or issue these commands from mysql command line:
-
- ```sql
- desc session;
- show create table sessions;
- ```
-
-### "DB_DataObject Error: DB Error: connect failed"
-
-If you get this error on a new Drupal/CiviCRM installation, you may have skipped the step of running CiviCRM's installation script. You can not install CiviCRM using the standard Drupal module installer.
-
-### "Failed to initialize storage module: user" fatal error message (new installs)
-
-If you see this error, you may need to modify the session.save_handler method for your site. Check with your hosting provider for the recommended way to do this.
-
-### WordPress menus are wrong
-
-Try [rebuilding the WordPress menus](#rebuild-wp-menus).
-
-### "Your PHP version is missing zip functionality"
-
-If you get this error when installing or upgrading CiviCRM for Joomla, download and use the `civicrm-x.x.x-joomla-alt.zip` package.
-
-## Solutions
-
-### Cleanup Caches and Update Paths {:#clear-cache}
-
-On this settings page you can:
-
-* Clear the cache
-* View and update the value that CiviCRM has determined for your Base Url and site name.
-
- 
-
-Although you enter your Base URL in `civicrm.settings.php` the value shown here reflects additional attempts by CiviCRM to automatically detect the correct base url in various environments - for example in multilingual sites.
-
-### Create a config file pointing to your Drupal sites directory {:#conf-drupal-sites}
-
-If your CiviCRM codebase is not located in either `<drupal_root>/modules/civicrm` or `<drupal_root>/sites/all/modules` (for example, if you're using a symlink from there to your codebase) - you will need to create a local file in the top-level directory of your codebase which points to the location of your drupal sites directory.
-
-```php
-// Create a new file - settings_location.php
-// Enter the following code (substitute the actual location of your
-// <drupal root>/sites directory)
-<?php
-define( 'CIVICRM_CONFDIR', '/home/lobo/public_html/drupal/sites' );
-?>
-```
-
-### Make CiviCRM available behind a NAT firewall {:#nat-firewall}
-
-If CiviCRM is installed on a server behind a firewall with NAT, you'll need to add your **internal** IP address and host name to `/etc/hosts` (on Linux). Otherwise, the dashboard will time out and the Force Secure URLs option will have issues. The reasoning behind this is, the dashboard tries to connect to `http(s)://www.example.org` to load the dashboard, but times out since `example.org` is being resolved via the public IP address. Your server can't access this public IP address if it's behind a firewall with NAT.
-
-### Rebuild CiviCRM menus {:#rebuild-civicrm-menus}
-
-Sometimes it helps to rebuild the menu/admin dashboard by visiting the following URL:
-
-`http://example.org/civicrm/menu/rebuild?reset=1`
-
-### Rebuild database triggers {:#trigger-rebuild}
-
-If you need to rebuild your database triggers, navigate to the following url:
-
-`http://example.org/civicrm/menu/rebuild?reset=1&triggerRebuild=1`
-
-Note the `&triggerRebuild=1` key-value pair.
-
-### Rebuild WordPress menus {:#rebuild-wp-menus}
-
-You can re-build the menu/admin dashboard by visiting the following url
-
-`http://example.org/wp-admin/admin.php?page=CiviCRM&q=civicrm/menu/rebuild&reset=1`
-
-### Reset config_backend
-
-Having strange problems with Administrative settings forms after upgrade? Try deleting all files in the following directories:
-
-* `sites/default/files/civicrm/templates_c/`
-* `sites/default/files/civicrm/ConfigAndLog/Config.IDS.ini`
-
-### Reset Your User Session {:#reset-session}
-
-To reset your user session:
-
-1. Temporarily enable CiviCRM debug features:
- * Go to **Administer CiviCRM » System Settings » Debugging and Error Handling**
- * Set **Enable Debugging** to Yes and click Save.
-1. Click the Administer CiviCRM menu (or any other CiviCRM menu item). After the page is loaded, add an additional query string value (`sessionReset=2`) to the URL in your browser's location bar, and reload the page.
-
-1. Now reset **Enable Debugging** to No and click Save.
-
-!!! danger "Do Not Leave Debug Features Enabled for a Public Site"
- Debugging should be disabled for publicly available sites as it may allow browsers to view system configuration information.
-
-### Roll back to previous version of CiviCRM (from a backup)
-
-Sometimes an upgrade fails and you need to get back to the last working version. You should have backups of the database saved as well as a backup of the civicrm files from the `/sites/all/modules/` directory. Here are the steps you need to take in order to roll back to the last working version before your upgrade:
-
-* Go into maintenance mode and take the site offline.
-* In the modules screen, disable all the CiviCRM modules EXCEPT the Core CiviCRM module. Make sure to take note of which CiviCRM modules you've disabled so you can enable them again after you restore the backups.
-* Make sure to drop all the tables in the civicrm database that relate to civicrm. If you're sharing a database with Drupal, make sure to ONLY drop the tables that belong to CiviCRM and NOT the tables for Drupal. If Drupal's tables are in a separate database, then you should be safe as long as you don't touch any of the Drupal tables.
-* Restore all the civicrm tables from your database backup back into the database.
-* In the `/sites/all/modules` directory, make sure to delete the entire civicrm directory (`../sites/all/modules/civicrm`).
-* Restore the civicrm directory in `/sites/all/modules/` from your files backup.
-* CRUCIAL: Remove the `templates_c` directory from `../sites/default/files/civicrm/` (don't worry, CiviCRM will recreate these files when you reload the pages).
-* Go back to Drupal's Modules screen and enable the CiviCRM modules you disabled.
-* Bring the site back online by turning off Maintenance mode.
-* Load up civicrm by going to `http://example.org/civicrm` (or wherever you have civicrm installed). This should have restored you back to the last working condition.
-
-Sometimes it helps to [rebuild the CiviCRM menus](#rebuild-civicrm-menus).
-
-### Update Base Directory and Base URL Settings {:#base-settings}
-
-To update your Base Directory and Base URL Settings in the database, visit this settings page:
-
-* **Administer CiviCRM > System Settings > Cleanup Caches and Update Paths**
+## General advice
+
+Try searching the [CiviCRM Stack Exchange](https://civicrm.stackexchange.com/tour) for solutions.
+
+Try to replicate the problem on the CiviCRM sandboxes - see "Testing Sandboxes" on the [CiviCRM demo page](https://civicrm.org/demo). If you can demonstrate that the problem doesn't just exist for you, more community members will give assistance.
+
+Post a question on [CiviCRM Stack Exchange](https://civicrm.stackexchange.com/tour). Be sure to include:
+
+* your CiviCRM version
+* which CMS you use
+* your CMS version
+
+Consider improving the question with screenshots and/or detailed error messages. Be sure to mention if the problem exists on the demo site.
+
+## More Detailed Errors (Debugging and Backtrace) {:#debugging}
+
+If you receive a CiviCRM fatal error, you can find a more detailed error in one of two ways.
+
+CiviCRM fatal errors are characterized by a yellow background:
+
+
+
+### Review the CiviCRM log
+
+If you have direct access to the files on your server, the CiviCRM log can be found in the ConfigAndLog directory. [Directions to find the ConfigAndLog directory can be found here](https://civicrm.stackexchange.com/a/15932/12). Errors are labeled with timestamps, and include both debug and backtrace information.
+
+### Using the built-in Debugging Tools
+
+Go to **Administer menu > System Settings > Debugging and Error Handling**, select "Yes" to both "Enable Debugging" and "Display Backtrace", and press "Save". Repeat the steps that caused your error, and you'll see a much more detailed error.
+
+!!! danger "Do NOT Leave Debug Turned On in Production Sites"
+ When debugging is turned on, some internal settings are visible to site visitors. For security purposes, it's best to avoid turning on debugging/backtrace on public sites whenever possible.
+
+Example with debug/backtrace enabled:
+
+
+
+## Symptoms
+
+* **Directory Cleanup** - Empties template cache and/or upload file folders.
+ * To empty template cache (civicrm/templates_c folder), add `&directoryCleanup=1`
+ * To remove temporary upload files (civicrm/upload folder), add `&directoryCleanup=2`
+ * To cleanup both, add `&directoryCleanup=3`
+
+* **Stack Trace** - To display stack trace at the top of the page when an error occurs, set Enable Backtrace from **Administer » System Settings » Debugging** **and Error Handling**.
+
+### "civicrm_strip_non_numeric does not exist"
+
+This error occurs when your database has lost a MySQL function definition for `civicrm_strip_non_numeric`. It can happen when moving from one server to another with the wrong `mysqldump` parameters, or if you use phpMyAdmin or certain other tools to rename a database, since they copy most but not all of the contents of the database to a database with the new name before deleting the old one. [Re-build your database triggers](#trigger-rebuild) to fix the problem.
+
+### "Could not find valid Key"
+
+If you are getting this error when submitting a form (search or adding / editing records), check the following:
+
+* Ensure cookies are enabled on browser. Like most web applications, CiviCRM can not function properly with cookies disabled.
+* Ensure your configuration settings are using the same "machine name" for CiviCRM and your CMS. For example, you will have problems if CiviCRM is configured to use `http://example.com` as its `BASE_URL` and your CMS is using `http://www.example.com`. You can use an `.htaccess` entry to redirect to the configured URL if needed (i.e. push all users to `http://www.example.com` even if they hit `http://example.com`).
+
+ 1. For Drupal sites, ensure that `uid = 0` exists in your Drupal users table. This is required for anonymous access to CiviCRM pages and forms to work properly.
+ 1. For Drupal sites, ensure that Drupal sessions table uses UTF8 collation, AND that the session column in this table is of SQL type longtext in the schema. You can check both of these in phpMyAdmin, or issue these commands from mysql command line:
+
+ ```sql
+ desc session;
+ show create table sessions;
+ ```
+
+### "DB_DataObject Error: DB Error: connect failed"
+
+If you get this error on a new Drupal/CiviCRM installation, you may have skipped the step of running CiviCRM's installation script. You can not install CiviCRM using the standard Drupal module installer.
+
+### "Failed to initialize storage module: user" fatal error message (new installs)
+
+If you see this error, you may need to modify the session.save_handler method for your site. Check with your hosting provider for the recommended way to do this.
+
+### WordPress menus are wrong
+
+Try [rebuilding the WordPress menus](#rebuild-wp-menus).
+
+### "Your PHP version is missing zip functionality"
+
+If you get this error when installing or upgrading CiviCRM for Joomla, download and use the `civicrm-x.x.x-joomla-alt.zip` package.
+
+## Solutions
+
+### Cleanup Caches and Update Paths {:#clear-cache}
+
+On this settings page you can:
+
+* Clear the cache
+* View and update the value that CiviCRM has determined for your Base Url and site name.
+
+ 
+
+Although you enter your Base URL in `civicrm.settings.php` the value shown here reflects additional attempts by CiviCRM to automatically detect the correct base url in various environments - for example in multilingual sites.
+
+### Create a config file pointing to your Drupal sites directory {:#conf-drupal-sites}
+
+If your CiviCRM codebase is not located in either `<drupal_root>/modules/civicrm` or `<drupal_root>/sites/all/modules` (for example, if you're using a symlink from there to your codebase) - you will need to create a local file in the top-level directory of your codebase which points to the location of your drupal sites directory.
+
+```php
+// Create a new file - settings_location.php
+// Enter the following code (substitute the actual location of your
+// <drupal root>/sites directory)
+<?php
+define( 'CIVICRM_CONFDIR', '/home/lobo/public_html/drupal/sites' );
+?>
+```
+
+### Make CiviCRM available behind a NAT firewall {:#nat-firewall}
+
+If CiviCRM is installed on a server behind a firewall with NAT, you'll need to add your **internal** IP address and host name to `/etc/hosts` (on Linux). Otherwise, the dashboard will time out and the Force Secure URLs option will have issues. The reasoning behind this is, the dashboard tries to connect to `http(s)://www.example.org` to load the dashboard, but times out since `example.org` is being resolved via the public IP address. Your server can't access this public IP address if it's behind a firewall with NAT.
+
+### Rebuild CiviCRM menus {:#rebuild-civicrm-menus}
+
+Sometimes it helps to rebuild the menu/admin dashboard by visiting the following URL:
+
+`http://example.org/civicrm/menu/rebuild?reset=1`
+
+### Rebuild database triggers {:#trigger-rebuild}
+
+If you need to rebuild your database triggers, navigate to the following url:
+
+`http://example.org/civicrm/menu/rebuild?reset=1&triggerRebuild=1`
+
+Note the `&triggerRebuild=1` key-value pair.
+
+### Rebuild WordPress menus {:#rebuild-wp-menus}
+
+You can re-build the menu/admin dashboard by visiting the following url
+
+`http://example.org/wp-admin/admin.php?page=CiviCRM&q=civicrm/menu/rebuild&reset=1`
+
+### Reset config_backend
+
+Having strange problems with Administrative settings forms after upgrade? Try deleting all files in the following directories:
+
+* `sites/default/files/civicrm/templates_c/`
+* `sites/default/files/civicrm/ConfigAndLog/Config.IDS.ini`
+
+### Reset Your User Session {:#reset-session}
+
+To reset your user session:
+
+1. Temporarily enable CiviCRM debug features:
+ * Go to **Administer CiviCRM » System Settings » Debugging and Error Handling**
+ * Set **Enable Debugging** to Yes and click Save.
+1. Click the Administer CiviCRM menu (or any other CiviCRM menu item). After the page is loaded, add an additional query string value (`sessionReset=2`) to the URL in your browser's location bar, and reload the page.
+
+1. Now reset **Enable Debugging** to No and click Save.
+
+!!! danger "Do Not Leave Debug Features Enabled for a Public Site"
+ Debugging should be disabled for publicly available sites as it may allow browsers to view system configuration information.
+
+### Roll back to previous version of CiviCRM (from a backup)
+
+Sometimes an upgrade fails and you need to get back to the last working version. You should have backups of the database saved as well as a backup of the civicrm files from the `/sites/all/modules/` directory. Here are the steps you need to take in order to roll back to the last working version before your upgrade:
+
+* Go into maintenance mode and take the site offline.
+* In the modules screen, disable all the CiviCRM modules EXCEPT the Core CiviCRM module. Make sure to take note of which CiviCRM modules you've disabled so you can enable them again after you restore the backups.
+* Make sure to drop all the tables in the civicrm database that relate to civicrm. If you're sharing a database with Drupal, make sure to ONLY drop the tables that belong to CiviCRM and NOT the tables for Drupal. If Drupal's tables are in a separate database, then you should be safe as long as you don't touch any of the Drupal tables.
+* Restore all the civicrm tables from your database backup back into the database.
+* In the `/sites/all/modules` directory, make sure to delete the entire civicrm directory (`../sites/all/modules/civicrm`).
+* Restore the civicrm directory in `/sites/all/modules/` from your files backup.
+* CRUCIAL: Remove the `templates_c` directory from `../sites/default/files/civicrm/` (don't worry, CiviCRM will recreate these files when you reload the pages).
+* Go back to Drupal's Modules screen and enable the CiviCRM modules you disabled.
+* Bring the site back online by turning off Maintenance mode.
+* Load up civicrm by going to `http://example.org/civicrm` (or wherever you have civicrm installed). This should have restored you back to the last working condition.
+
+Sometimes it helps to [rebuild the CiviCRM menus](#rebuild-civicrm-menus).
+
+### Update Base Directory and Base URL Settings {:#base-settings}
+
+To update your Base Directory and Base URL Settings in the database, visit this settings page:
+
+* **Administer CiviCRM > System Settings > Cleanup Caches and Update Paths**
diff --git a/docs/index.md b/docs/index.md
index deab4b5..dcb375c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,18 +1,18 @@
-## Scope of this guide
-
-This guide is for people installing a [CiviCRM](https://civicrm.org) instance for an organization. It will take you through downloading and installing CiviCRM on one of the supported Content Management Systems. It is not intended to provide information on installing the CMS itself.
-
-### Installation Guide vs other guides
-
-We also have a [User Guide](https://docs.civicrm.org/user/en/latest) which covers all the functionality available through CiviCRM's web-based interface and a [SysAdmin Guide](https://docs.civicrm.org/sysadmin/en/latest) which covers more advanced administration.
-
-The two guides have some overlapping scope when it comes to setup and configuration. In general, we try to cover actions in the User Guide which the user can perform from within CiviCRM's user interface. Actions that require work outside of the CiviCRM interface (e.g. file-system or shell access) are covered in the System Administrator Guide.
-
-## Editing this guide
-
-* This guide is made with MkDocs and stored in a [GitLab repository](https://lab.civicrm.org/documentation/docs/installation).
-* See the ["Writing Documentation"](https://docs.civicrm.org/dev/en/latest/documentation)" page in the Developer Guide for specific details on editing this guide.
-
-## Credits
-
-This guide is collaboratively written by the CiviCRM community, with facilitation from the [Documentation Working Group](https://civicrm.org/working-groups/documentation).
+## Scope of this guide
+
+This guide is for people installing a [CiviCRM](https://civicrm.org) instance for an organization. It will take you through downloading and installing CiviCRM on one of the supported Content Management Systems. It is not intended to provide information on installing the CMS itself.
+
+### Installation Guide vs other guides
+
+We also have a [User Guide](https://docs.civicrm.org/user/en/latest) which covers all the functionality available through CiviCRM's web-based interface and a [SysAdmin Guide](https://docs.civicrm.org/sysadmin/en/latest) which covers more advanced administration.
+
+The two guides have some overlapping scope when it comes to setup and configuration. In general, we try to cover actions in the User Guide which the user can perform from within CiviCRM's user interface. Actions that require work outside of the CiviCRM interface (e.g. file-system or shell access) are covered in the System Administrator Guide.
+
+## Editing this guide
+
+* This guide is made with MkDocs and stored in a [GitLab repository](https://lab.civicrm.org/documentation/docs/installation).
+* See the ["Writing Documentation"](https://docs.civicrm.org/dev/en/latest/documentation)" page in the Developer Guide for specific details on editing this guide.
+
+## Credits
+
+This guide is collaboratively written by the CiviCRM community, with facilitation from the [Documentation Working Group](https://civicrm.org/working-groups/documentation).
diff --git a/docs/joomla/index.md b/docs/joomla/index.md
index 9342354..28d1852 100644
--- a/docs/joomla/index.md
+++ b/docs/joomla/index.md
@@ -1,72 +1,72 @@
-## Scope of this guide and alternative installation methods
-
-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/).
-
-## 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.
-
-!!! 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}
-
-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:
-
-* Download the appropriate tarball file from the [CiviCRM website](https://civicrm.org/download) within your browser. Tarball file-names include the CiviCRM version. For example, `civicrm-x.x.x-joomla.zip`. If you have command line access to your server, use `wget` and the URL of the file to pull a copy directly to your server. Then you can skip the next step.
-* Upload this file to a folder in your root Joomla directory. Recommended location: `JOOMLA_ROOT/tmp/`.
-* Unzip the package, which will create a directory called: `com_civicrm`. On cPanel, you can use the File Manager's Extract function to unzip the file you uploaded.
-
-Note: when installing a new version over an old one, please first check [troubleshooting resources](#troubleshooting) below.
-
-## Run the Installer {:#installer}
-
-* Login to your Joomla Administrator site.
-* Go to **Extensions >> Install/Uninstall**.
-* Use **Install from Directory** and enter the full path to the un-zipped com_civicrm directory, which should be something like: `JOOMLA_ROOT/tmp/com_civicrm` . In most Joomla installations, the root directory and /tmp/ folder will already populate the "install from directory" field. You must simply add the /com_civicrm/ subfolder at the end. Click Install. If that doesn't work:
- * put the full file system path to the `com_civicrm`, something like `/var/www/JOOMLA_ROOT/tmp/com_civicrm/`.
-* You should see "Component successfully installed" message.
-
-!!! warning
- If you get the following error when installing or upgrading CiviCRM for Joomla - you can downloading the alternate Joomla install file - `civicrm-x.x.x-joomla-alt.zip` - which doesn't require built-in unzip functionality on your server. Then repeat the install steps starting with [running the installer](#installer).
-
- > Your PHP version is missing zip functionality. Please ask your system administrator / hosting provider to recompile PHP with zip support.
-
- Note that missing PHP Zip functionality *will* prevent CiviCRM from installing extensions via the GUI.
-
-## Create CiviCRM Contacts for Existing Joomla 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.
-
-When CiviCRM is installed on top of an existing Joomla site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Joomla users:
-
-* Login to your Joomla site with an administrator-level login
-* Click the **Components > CiviCRM > CiviCRM Home** link in the main navigation block
-* Click **Administer > Users and Permissions > Synchronize Users-to-Contacts**
-
-## Troubleshooting Resources {:#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:
-
- * In your `php.ini` file or in `.htaccess` file in the Joomla root folder (if your server allows it), increase the `max_execution_time` to `600` and memory limit to more than 64M. Add the following to the `.htaccess` file in your Joomla root folder
- <!-- markdownlint-disable MD046 -->
- ``` htaccess
- php_value memory_limit 128M
- php_value register_globals off
- php_value max_execution_time 600
- ```
-
- If you can't change the `.htaccess` file you can add a php.ini (or `.user.ini`) file in Joomla root folder or all directories, depending on your web server or hosting company.
-
- ``` ini
- memory_limit = 128M
- register_globals = off
- max_execution_time = 600
- ```
- <!-- markdownlint-enable MD046 -->
- * CiviCRM is packaged with all the libraries (PEAR etc) that it uses. However a misconfigured or overly restrictive `open_basedir` directive on your web server might interfere with CiviCRM's ability to access some required files or directories. To turn `open_basedir` off, add this to your `vhost.conf` file: `php_admin_value open_basedir none` or ask your host to either turn it off or ensure that it is not preventing access to required directories (e.g. if you move configuration files or temp folders outside your web root). The configuration of sub domains might cause related issues: try installing in the main domain root or a sub folder instead.
-
-* If CiviCRM screens are not displaying properly and/or javascript widgets are not functioning, check your CiviCRM Resource URL (Administer >> System Settings >> Resource URLs). For Joomla installs, it should be something like: `http://example.org/administrator/components/com_civicrm/civicrm`
-
-* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.
+## Scope of this guide and alternative installation methods
+
+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/).
+
+## 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.
+
+!!! 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}
+
+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:
+
+* Download the appropriate tarball file from the [CiviCRM website](https://civicrm.org/download) within your browser. Tarball file-names include the CiviCRM version. For example, `civicrm-x.x.x-joomla.zip`. If you have command line access to your server, use `wget` and the URL of the file to pull a copy directly to your server. Then you can skip the next step.
+* Upload this file to a folder in your root Joomla directory. Recommended location: `JOOMLA_ROOT/tmp/`.
+* Unzip the package, which will create a directory called: `com_civicrm`. On cPanel, you can use the File Manager's Extract function to unzip the file you uploaded.
+
+Note: when installing a new version over an old one, please first check [troubleshooting resources](#troubleshooting) below.
+
+## Run the Installer {:#installer}
+
+* Login to your Joomla Administrator site.
+* Go to **Extensions >> Install/Uninstall**.
+* Use **Install from Directory** and enter the full path to the un-zipped com_civicrm directory, which should be something like: `JOOMLA_ROOT/tmp/com_civicrm` . In most Joomla installations, the root directory and /tmp/ folder will already populate the "install from directory" field. You must simply add the /com_civicrm/ subfolder at the end. Click Install. If that doesn't work:
+ * put the full file system path to the `com_civicrm`, something like `/var/www/JOOMLA_ROOT/tmp/com_civicrm/`.
+* You should see "Component successfully installed" message.
+
+!!! warning
+ If you get the following error when installing or upgrading CiviCRM for Joomla - you can downloading the alternate Joomla install file - `civicrm-x.x.x-joomla-alt.zip` - which doesn't require built-in unzip functionality on your server. Then repeat the install steps starting with [running the installer](#installer).
+
+ > Your PHP version is missing zip functionality. Please ask your system administrator / hosting provider to recompile PHP with zip support.
+
+ Note that missing PHP Zip functionality *will* prevent CiviCRM from installing extensions via the GUI.
+
+## Create CiviCRM Contacts for Existing Joomla 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.
+
+When CiviCRM is installed on top of an existing Joomla site, a special CiviCRM Administrative feature allows you to automatically create CiviCRM contacts for all existing Joomla users:
+
+* Login to your Joomla site with an administrator-level login
+* Click the **Components > CiviCRM > CiviCRM Home** link in the main navigation block
+* Click **Administer > Users and Permissions > Synchronize Users-to-Contacts**
+
+## Troubleshooting Resources {:#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:
+
+ * In your `php.ini` file or in `.htaccess` file in the Joomla root folder (if your server allows it), increase the `max_execution_time` to `600` and memory limit to more than 64M. Add the following to the `.htaccess` file in your Joomla root folder
+ <!-- markdownlint-disable MD046 -->
+ ``` htaccess
+ php_value memory_limit 128M
+ php_value register_globals off
+ php_value max_execution_time 600
+ ```
+
+ If you can't change the `.htaccess` file you can add a php.ini (or `.user.ini`) file in Joomla root folder or all directories, depending on your web server or hosting company.
+
+ ``` ini
+ memory_limit = 128M
+ register_globals = off
+ max_execution_time = 600
+ ```
+ <!-- markdownlint-enable MD046 -->
+ * CiviCRM is packaged with all the libraries (PEAR etc) that it uses. However a misconfigured or overly restrictive `open_basedir` directive on your web server might interfere with CiviCRM's ability to access some required files or directories. To turn `open_basedir` off, add this to your `vhost.conf` file: `php_admin_value open_basedir none` or ask your host to either turn it off or ensure that it is not preventing access to required directories (e.g. if you move configuration files or temp folders outside your web root). The configuration of sub domains might cause related issues: try installing in the main domain root or a sub folder instead.
+
+* If CiviCRM screens are not displaying properly and/or javascript widgets are not functioning, check your CiviCRM Resource URL (Administer >> System Settings >> Resource URLs). For Joomla installs, it should be something like: `http://example.org/administrator/components/com_civicrm/civicrm`
+
+* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.
--
GitLab