docs/backdrop/index.md

@@ -5,9 +5,13 @@
     1. [Install Backdrop](https://backdropcms.org/installation), and...
     1. [Review the CiviCRM requirements](../general/requirements.md)
 
+???+ tldr "Migrating from Drupal 7"?
+
+    If you are migrating to Backdrop from Drupal 7, see [Switch from Drupal to Backdrop](https://docs.civicrm.org/sysadmin/en/latest/misc/switching-cms/drupal-to-backdrop/) in the [System Administrator Guide](https://docs.civicrm.org/sysadmin/en/latest).
+
 ??? tldr "Alternative: Civibuild for developers"
 
-    If you plan to develop patches for CiviCRM on WordPress, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/).
+    If you plan to develop patches for CiviCRM on Backdrop, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/).
 
 <a name="directory"></a><!-- old anchor -->
 ## Get the code {:#download}
@@ -158,9 +162,9 @@ There should now be a **CiviCRM** link in your Backdrop menu. Click that link an
 
 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.
+Full instructions on installing Backdrop 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.md) for introductory concepts and the settings for the CiviCRM database. For the Drupal database you have several options for updating settings.php:
+See [TLS for MySQL](../general/mysql_tls.md) for introductory concepts and the settings for the CiviCRM database. For the Backdrop 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.
 
@@ -170,7 +174,7 @@ See [TLS for MySQL](../general/mysql_tls.md) for introductory concepts and the s
       array (
         'default' =>
         array (
-          'database' => 'drupal',
+          'database' => 'backdrop',
           'username' => 'dbuser',
           'password' => 'dbpassword',
           'host' => 'db435.examplehost.com',

docs/drupal7/index.md

-???+ tldr "About this document"
-
-    This guide covers standard installation of CiviCRM on an existing Drupal 7 site. It assumes that you previously completed these tasks:
-
-    1. [Install Drupal 7](https://www.drupal.org/docs/7/install), and...
-    1. [Review the CiviCRM requirements](../general/requirements.md)
-
-??? tldr "Alternative: Civibuild for developers"
-
-    If you plan to develop patches for CiviCRM on Drupal 7, then please use the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/).
-
-<a name="directory"></a><!-- old anchor -->
-## Get the code {:#download}
-
-The [CiviCRM download page](https://civicrm.org/download) provides a pre-built archive for use with Drupal 7.  A
-typical archive file is ~20mb and looks like `civicrm-X.Y.Z-drupal.tar.gz`. It contains a folder named `civicrm/`.
-
-In Drupal 7, there is a folder for storing add-on modules: `DRUPAL_ROOT/sites/all/modules`.
-
-Our goal is to download the archive and extract into this folder. Here are a few example ways to download and extract:
-
-??? example "Download via web-browser"
-
-    This method does not require shell access on the server. You may adapt based your server's arrangement.
-
-    * On the [CiviCRM download page](https://civicrm.org/download), click the link for CiviCRM / Drupal 7. Save the file locally.
-    * Extract the archive locally. For example, in a Linux workstation, one might say:
-      ```bash
-      cd ~/Downloads
-      tar xvzf civicrm-X.Y.Z-drupal.tar.gz
-      ```
-    * Observe the new folder `civicrm/`.
-    * Using your favor file-transfer system (SSH/SFTP, `rsync`, `git`, `mv`, etc), transfer the `civicrm/` folder
-      to `DRUPAL_ROOT/sites/all/modules`.
-
-??? example "Download via curl + tar"
-
-    This method require shell access to the Drupal server.
-
-    * On the [CiviCRM download page](https://civicrm.org/download), note the current version.
-    * In the shell, navigate to the Drupal module folder (*adjust as appropriate*):
-      ```bash
-      cd DRUPAL_ROOT/sites/all/modules
-      ```
-    * In the shell, run the `curl` and `tar` commands. Adjust the version `X.Y.Z` to the appropriate value.
-      ```bash
-      curl -L "https://download.civicrm.org/civicrm-X.Y.Z-drupal.tar.gz" | tar xvz
-      ```
-
-??? example "Download via Drupal web UI"
-
-    This is the easiest way for a new administrator. However, it may not work in all deployments or
-    all versions. For
-    example, if the Drupal server has a locked-down configuration, then it may encounter permission errors
-    or timeouts. The only way to find out is to try.
-
-    * On the [CiviCRM download page](https://civicrm.org/download), right-click the link for CiviCRM / Drupal 7. Copy the URL.
-    * Login to your Drupal site with *administrator* permissions.
-    * Navigate to **Modules >> Install new module**.
-    * Paste the URL
-    * Click "Install"
-
-    ??? warning "This may not work with CiviCRM 5.13-5.30"
-
-        In CiviCRM versions 5.13 - 5.30, the prebuilt tarball included a symlink which is not accepted by
-        the Drupal 7 installer. This should work again in 5.31.
-
-        <!-- TODO: After 5.31 has been out for a while, we can move this option higher up and remove/downgrade the notice. -->
-
-    ??? warning "The "Upload"/"Browse" option is unlikely to work."
-
-        The **Install new module** page provides another option for uploading the archive from your local computer.
-        In a default PHP configuration, the upload limits are too conservative to accept the CiviCRM archive.
-
-In all cases, the final outcome should be the creation of a new folder
-
-```
-DRUPAL_ROOT/sites/all/modules/civicrm
-```
-
-## Get the translations {:#i18n}
-
-The basic CiviCRM release includes support for US English (`en_US`). To use another language or dialect, please [download and extract the translation files](../general/i18n_l10n.md).
-
-## Run the installer {:#installer}
-
-The installer verifies requirements, prepares the database, and initializes the configuration file. You may run the installer through the web interface (*which is simpler*) or the command-line interface (*which has more options*).
-
-??? example "Run installer via Drupal 7 web UI"
-
-    1. Enable the "CiviCRM" module
-        * Login to your Drupal site with *administrator* permissions.
-        * Navigate to the "Modules" page (`admin/modules`).
-        * Find "CiviCRM" and enable it.
-        * At the bottom, click "Save Configuration".
-    2. After enabling, the status message will display a link to "configure CiviCRM". Click it.
-
-        ??? question "What if I didn't notice the link?"
-            Use the URL bar. Navigate to the `civicrm` page (e.g. `https://example.com/civicrm`).
-
-    3. The CiviCRM installer will open.
-        * *If there are unmet requirements*, the installer will list them. Consult the [Requirements](../general/requirements.md) documentation for additional advice.
-        * *If all the requirements are met*, proceed through the brief questionnaire.
-        * *If you have [a separate MySQL database for CiviCRM](../general/requirements.md#mysql-connection)*, then locate "Environment: CiviCRM Database". Click the edit icon and enter the [database URL](../general/requirements.md#mysql-connection).
-        * Finally, click "Install CiviCRM".
-
-??? example "Run installer via the command-line"
-
-    CiviCRM has a command-line administration tool, `cv`, which can perform installation. For details, see [command-line installer](../general/cli-cv.md).
-
-## Review the permissions {:#permissions}
-
-!!! check ""
-    Note that Drupal tries to create the `/files/` directory (and make it writeable), but only when saving `admin/settings`. Same holds for `/temp` directory, and a `/uploads/` directory in the CiviCRM module root. On a brand-new Drupal install, this directory may be missing. Even on an existing installation, if file permissions are not set properly, the directory may be missing. If enabling the **CiviCRM** module generates errors regarding the files directory, you must create it (writeable) manually.
-
-* 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 -->
-
-## Synchronize the users {:#contacts-users}
-
-Once installed, CiviCRM keeps your Drupal Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Drupal user record. Conversely, only contacts who are authenticated users of your site will have corresponding Drupal user records.
-
-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 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.
-
-## Addenda
-
-### TLS for MySQL
-
-If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server.
-
-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.md) 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',
-    ),
-    ```
-
-### Troubleshooting {:#troubleshooting}
-
-* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.
-* To check compatibility with other Drupal modules see: [Drupal modules incompatible with CiviCRM](https://docs.civicrm.org/sysadmin/en/latest/integration/drupal/incompatibilities/)

docs/drupal8/index.md

-???+ tldr "About this document"
-
-    This guide covers standard installation of CiviCRM on an existing Drupal 8 site. It assumes that you previously completed these tasks:
-
-    1. [Install Drupal 8](https://www.drupal.org/docs/8/install), and...
-    1. [Review the CiviCRM requirements](../general/requirements.md)
-
-??? tldr "Alternative: Civibuild for developers"
-
-    If you plan to develop patches for CiviCRM on Drupal 8, then please read the [Developer Guide](https://docs.civicrm.org/dev/en/latest) for information about [Buildkit](https://docs.civicrm.org/dev/en/latest/tools/buildkit/) and [civibuild](https://docs.civicrm.org/dev/en/latest/tools/civibuild/).
-
-<a name="downloading"></a><!-- old anchor -->
-## Get the code {:#download}
-
-Drupal 8 (D8) sites are typically administered with [Composer](https://www.getcomposer.org). Composer is a *dependency management* tool which can add, upgrade, and remove software *packages* for your site.
-
-CiviCRM is published as a suite of related packages. Our goal is to use Composer to add CiviCRM's packages to the D8 site.
-
-If you do not work regularly with D8+Composer, then you should take a refresher before installing CiviCRM.
-
-??? example "Quick and dirty introduction to D8 with `composer`"
-
-    Composer requires shell access to the D8 site. It defines a command `composer`.
-
-    Many D8 sites are initialized via `composer`, which means that `composer` is already available.  This
-    can be confirmed in the shell by running `composer --version`:
-
-    ```
-    $ composer --version
-    Composer version 1.10.13 2020-09-09 11:46:34
-    ```
-
-    It is possible that your system does not have `composer` -- for example, if you used a tar-based installation of D8,
-    then you may never have needed `composer` before.
-
-    If `composer` is missing, then you must [download and install it](https://getcomposer.org/download/) first.
-    Additionally, you probably need to [set composer's memory limit](https://getcomposer.org/doc/articles/troubleshooting.md#memory-limit-errors)
-    high enough for D8.
-
-    Once you have `composer`, you need to navigate to the composer-root. You can recognize it by the following:
-
-    * It has the files `composer.json` and `composer.lock`.
-    * It has a subfolder `vendor/`.
-    * It usually has a subfolder `web/` (the web-root); alternatively, it may *be* the web-root.
-
-    A typical file-hierarchy might look like:
-
-    ```
-    /var/www/d8.example.org/                Composer-root
-    /var/www/d8.example.org/composer.json   Composer-configuration
-    /var/www/d8.example.org/composer.lock   Composer-configuration
-    /var/www/d8.example.org/web/            Web-root (usually)
-    /var/www/d8.example.org/vendor/         Downloaded packages
-    ```
-
-    To work with `composer` and D8, you must open a shell and navigate to the composer-root, e.g.
-
-    ```
-    cd /var/www/d8.example.org
-    ```
-
-If `composer` is properly installed, then these example commands will add CiviCRM to D8:
-
-```
-cd /var/www/d8.example.org
-composer config extra.enable-patching true
-composer require civicrm/civicrm-asset-plugin:'~1.1'
-composer require civicrm/civicrm-{core,packages,drupal-8}:'~5.29'
-```
-
-You should adjust the example path (`/var/www/d8.example.org`) and the example version (`~5.29`) as needed.
-
-If you'd like more details to understand these commands or common errors, then please drill-down below.
-
-??? info "More detail: Enable patching"
-
-    A handful of packages used by CiviCRM require extra patch-files.
-
-    This is possible with the popular [cweagans/composer-patches](https://github.com/cweagans/composer-patches)
-    plugin. However, you must [opt-in to enable it](https://github.com/cweagans/composer-patches#allowing-patches-to-be-applied-from-dependencies).
-
-??? info "More detail: Compilation tasks"
-
-    When you first install or upgrade to CiviCRM 5.31+, `composer` will prompt for permission to run CiviCRM compilation tasks. We recommend that you select `[a]lways`.
-
-    If you wish to suppress the prompt, see [Composer Compile Plugin: Managing the root package (for site-builders)](https://github.com/civicrm/composer-compile-plugin/blob/master/doc/site-build.md).
-
-??? info "More detail: Required packages"
-
-    | Package | Description |
-    | -- | -- |
-    | `civicrm/civicrm-asset-plugin` | A tool which automatically copies JS+CSS assets from CiviCRM to D8's `web/` folder |
-    | `civicrm/civicrm-core` | The primary CiviCRM codebase |
-    | `civicrm/civicrm-drupal-8` | The integration module for CiviCRM and D8 |
-    | `civicrm/civicrm-packages` | A collection of third-party/legacy packages used by CiviCRM |
-
-??? info "More detail: Version constraints"
-
-    The primary CiviCRM packages (`civicrm-core`, `civicrm-drupal-8`, `civicrm-packages`) have *synchronized*
-    versions. If one package is installed with v5.30.1, then the others should also be v5.30.1.
-
-    The following expression references the three packages and applies the same version-constraint to each:
-
-    ```
-    civicrm/civicrm-{core,packages,drupal-8}:'~5.29'
-    ```
-
-    The expression `~5.29` is a version-constraint.  It means that composer will install *approximately* v`5.29`.  It may
-    install a newer patch-release (e.g.  `5.29.1`) or a newer minor-release (e.g.  `5.31.0`).  However, it will avoid
-    major-releases (e.g. `6.0.0`).
-
-    Many `composer` tutorials rely on `composer` to automatically choose package-versions.
-    This is not recommended for CiviCRM/D8. Instead, package versioning should be explicit to ensure that:
-
-    1. CiviCRM versions remain synchronized.
-    2. CiviCRM stable releases are preferred over developmental releases.
-
-       <!-- honestly, that second thing is weird to me.  if people get dev releases unintentionally, then they've
-        probably misconfigured/misunderstood their `composer.json`.  but given how consultancies blend upstream/public
-        pkgs and inhouse/private pkgs, and given how inhouse pkgs tend to have lax versioning, i can see how there'd
-        be pressure on D8 site-builders to make the configuration promiscuous -->
-
-??? question "How to resolve conflicts in `pear/exception`?"
-
-    In some D8 configurations, you may see an error message about the package `pear/exception`. This is
-    because some packages use `pear/exception` -- but they have been overly specific about the required
-    version. (To wit: they require version `1.0.0` when version `1.0.1` will also work.)
-
-    To resolve this error, you can install v1.0.1 and *pretend* that it is v1.0.0:
-
-    ```
-    composer require pear/pear_exception:'1.0.1 as 1.0.0'
-    ```
-
-    After fixing this, you may continue the regular installation commands.
-
-<!--
-
-Optionally you can also require the [`cv`](https://github.com/civicrm/cv) command-line helper/interface for CiviCRM with:
-
-!!! note ""
-    **Composer installs of cv are currently broken** for now use the [manual install steps](https://github.com/civicrm/cv#download).
-
-* `composer require civicrm/cv` - This will place the cv binary in `./vendor/bin/cv` relative to your `composer.json` file.
-
--->
-
-## Get the translations {:#i18n}
-
-!!! warning "I18n & L10n on Drupal 8"
-    If installing with the GUI it is currently only possible to install CiviCRM in English (US) on Drupal 8. Adding the language files involves breaking with Composer best practices by writing the contents of the `civicrm-l10n` tarball into `vendor/civicrm/civicrm-core` or configuring the `civicrm.l10n` directory path after you install and placing the contents of the `civicrm-l10n` tarball into the configured directory.
-
-!!! error "Here Be Dragons..."
-    The following steps are provided as an example - they are not supported or widely tested and may leave your site in a broken state. You use them at your own risk. No. Seriously...
-
-    You will also have to repeat these steps **every** time you upgrade CiviCRM.
-
-The warnings above notwithstanding to install CiviCRM on Drupal 8 requires the following additional steps to prepare:
-
-1. Add [`cv`](https://github.com/civicrm/cv) to your Drupal 8 Site with: `composer require civicrm/cv` (**composer installs of cv are currently broken** for now use the [manual install steps](https://github.com/civicrm/cv#download).)
-1. Grab the localisation (*l10n*) files and unpack the `l10n` and `sql` subfolders into `vendor/civicrm/civicrm-core/`
-    * You'll find the l10n files on the [CiviCRM Download](https://civicrm.org/download) page or from `https://download.civicrm.org/civicrm-VERSION-l10n.tar.gz` where `VERSION` is a recent version of CiviCRM.
-
-    **Example:**
-
-    <!-- markdownlint-disable MD046 -->
-    ``` bash
-    wget https://download.civicrm.org/civicrm-5.27.2-l10n.tar.gz
-    tar -zxvf civicrm-5.27.2-l10n.tar.gz
-    cd civicrm/
-    cp -R l10n/ ../vendor/civicrm/civicrm-core/
-    cp -R sql/ ../vendor/civicrm/civicrm-core/
-    cd ..
-    rm -rf civicrm/
-    ```
-    <!-- markdownlint-enable MD046 -->
-
-1. If you've done this correctly, you should end up with `vendor/civicrm/civicrm-core/l10n` and `vendor/civicrm/civicrm-core/sql/`
-    * You can remove any languages you don't need by deleting them before copying the `l10n` and `sql` folders.
-
-Now we move onto [Installing CiviCRM - Command line install](#installing-commandline)
-
-<a name="installing"></a><a name="installing-gui"></a><a name="installing-commandline"></a>
-## Run the installer {:#installer}
-
-The installer verifies requirements, prepares the database, and initializes the configuration file. You may run the installer through the web interface (*which is simpler*) or the command-line interface (*which has more options*).
-
-??? example "Run installer via Drupal 8 web UI"
-
-    ??? warning "Installation options are very limited"
-
-        Currently there is no interactive installer for CiviCRM on Drupal 8, so the installer uses a firm set of defaults, e.g.
-
-        * *English Language Data*: It only installs data for US English. It cannot install data for other languages.
-        * *Shared Database*: It only uses the shared CMS database. It cannot use [a separate MySQL database for CiviCRM](../general/requirements.md#mysql-connection).
-        * *No Sample Data*: It only installs an empty, baseline dataset. It cannot install sample data.
-
-        If you need to configure any of these options, then use the command-line installer.
-
-    ??? warning "Write permissions"
-        It is critical that your web-server user is able to write to the `web/sites/default/` directory in order to create `civicrm.settings.php` and that you have an appropriate value for execution time(s) and memory limit(s) as any interruption to the installer can (and will) result in an unusable install and require remedial steps to correct or a full reinstall! By default on Drupal 8.8+ this directory path is not writable by default, before installing you should ensure you grant write access to your web server user. With, e.g: `sudo chmod u+w web/sites/default`.
-
-        For multisite installations you'll also need to ensure your web server user has write access to additional sites e.g: `sudo chmod u+w web/sites/site2.example.org`.
-
-    1. Login to your Drupal site with *administrator* permissions.
-    2. Navigate to **Manage >> Extend** or point your web browser to the following URL:
-
-        `https://example.org/admin/modules/`
-
-    3. Find "CiviCRM" and enable it.
-    4. At the bottom, click "Save Configuration". (Note: This may take a few moments to execute.)
-
-??? example "Run installer via command-line"
-
-    CiviCRM has a command-line administration tool, `cv`, which can perform installation. For details, see [command-line installer](../general/cli-cv.md).
-
-## Review the permissions {:#permissions}
-
-!!! note ""
-    Drupal will create the `/files/` directory (and make it writeable), but only when saving `admin/settings`. Same holds for `/temp` directory, and a `/uploads/` directory in the CiviCRM module root. On a brand-new Drupal install, this directory may be missing. Even on an existing installation, if file permissions are not set properly, the directory may be missing. If enabling the **CiviCRM** module generates errors regarding the files directory, you must create it (writeable) manually.
-
-* 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 -->
-
-## Synchronize the users {:#contacts-users}
-
-Once installed, CiviCRM keeps your Drupal Users synchronized with corresponding CiviCRM contact records. The 'rule' is that there will be a matched contact record for each Drupal user record. Conversely, only contacts who are authenticated users of your site will have corresponding Drupal user records.
-
-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 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.
-
-## Addenda
-
-### TLS for MySQL
-
-If your MySQL database is hosted on a different machine than your web server, or if your host requires it, you can use TLS to encrypt the connection between the database and the web server.
-
-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.md) 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',
-    ),
-    ```
-
-### Integration modules {:#integration-modules}
-
-__Webform CiviCRM module__
-
-* [Project page on Drupal.org](https://www.drupal.org/project/webform_civicrm)
-* [Documentation on CiviCRM.org](https://docs.civicrm.org/webform-civicrm/en/latest)
-
-__CiviCRM Entity module__
-
-* [Project page on Drupal.org](https://www.drupal.org/project/civicrm_entity)
-
-### Troubleshooting {:#troubleshooting}
-
-* Review the [Troubleshooting](../general/troubleshooting.md) page for help with problems you may encounter during the installation.

docs/general/cli-cv.md

@@ -6,7 +6,7 @@
 
     1. Install a supported CMS
     1. [Review the CiviCRM requirements](../general/requirements.md)
-    1. Download the CiviCRM code. (See "*Get the code*" for [Backdrop](../backdrop/index.md#download), [Drupal 7](../drupal7/index.md#download), [Drupal 8](../drupal8/index.md#download), [Drupal 9](../drupal9/index.md#download), or [WordPress](../wordpress/index.md#download)).
+    1. Download the CiviCRM code. (See "*Get the code*" for [Backdrop](../backdrop/index.md#download), [WordPress](../wordpress/index.md#download) or [Drupal](../drupal/index.md)).
 
 ??? tldr "Limitations"
 
@@ -120,6 +120,17 @@ There are several available options for the installer. Expand the topics below f
 
     __Note__: At time of writing, the sample data is only supported in the default locale, `en_US`.
 
+??? info "Option: Admin User (Standalone)"
+
+    ```
+    cv core:install ... -m extras.adminUser=USERNAME \
+      -m extras.adminPass=SECRET \
+      -m extras.adminEmail=ME@EXAMPLE.COM
+    ```
+
+    When installing CiviCRM Standalone, you should specify the credentials for the first administrative user.
+    If omitted, the credentials will be auto-generated and stored in the CiviCRM log.
+
 ??? info "Option: Verbose output"
 
     ```bash
@@ -158,6 +169,9 @@ The installer may report a problem. Some common ones are:
     The PHP or MySQL configuration may require an update - e.g. to expand the PHP memory limit, to enable a PHP extension, or to enlarge a MySQL buffer.
     Common issues are discussed in the [Requirements](requirements.md).
 
+??? "Error: Call to undefined method Drupal::entityManager"
+    This error appears installing with the `--user` option under Drupal 9. Avoid this error simply by not using the `--user` option.
+
 For common problems, you can simply fix the problem and re-run the installer.
 
 For unusual problems, be sure to enable verbose output (`-v` or `-vv`). It may also help to [inspect the model, plugins, or requirements](https://docs.civicrm.org/dev/en/latest/framework/setup/getting-started/).

docs/general/i18n_l10n.md

-## Coming Soon
+## Using CivCRM in a language other than US-English
+
+CiviCRM uses US English by default but supports translation into a wide range of other languages with varying degrees of completeness.
 
 !!! note ""
-    This page is a placeholder for content being migrated in from the old Wiki.
+    If you want to help out with translations visit the [translation documentation](https://lab.civicrm.org/dev/translation/wikis).
+
+To enable use of CiviCRM in a new language translation you need to
+
+* download the translation files
+* install them in the appropriate directory
+* select the language in the Language settings
+
+The exact instructions on how to download and install the translations files differ between platforms:
+
+* [Backdrop](../backdrop/index.md#i18n)
+* [Drupal 9](../drupal/index.md#drupal9-i18n)
+* [Drupal 7](../drupal/index.md#drupal7-i18n)
+* [Joomla](../joomla/index.md#i18n)
+* [Wordpress](../wordpress/index.md#i18n)
+
+## Changing the default CiviCRM language after installation
+
+Once you have installed the translation files, you can change the language used by CiviCRM:
+
+* Go to **Administer > Localization > Languages, Currency, Location**
+* Select the new default language.
+* Update the default currency, money formatting options, default country, etc.
+
+You will also probably want to update the date and time formats:
+
+* Go to **Administer > Localization > Date Formats**
+
+Finally, you may notice that many other options in CiviCRM will not be correctly translated:
+
+* Individual prefixes (Mrs, M, etc)
+* Gender options (M, F, other)
+* Address Location Types
+* Some fieldsets in the "Edit Contact" screen
+
+These are known in CiviCRM as Option Values, and there are many of these.
+
+To avoid having to change every single setting, you can install the following extension: [fixoptiontranslations](https://lab.civicrm.org/extensions/fixoptiontranslations). Once the extension is enabled, all options will be translated. The extension can then be uninstalled and removed.
+
+## Updating translation files
+
+The easiest way to update your translations regularly is to use the [l10n update](https://github.com/cividesk/com.cividesk.l10n.update/) extension: 
+
+The "l10n update" extension will do a daily check to update the translation files for CiviCRM core, as well as for extensions. Every night, around 2 AM (North American Eastern Time), the CiviCRM website packages updated translation files. These are available at the following address: `https://download.civicrm.org/civicrm-l10n-core/mo/xx_XX/civicrm.mo` where `xx_XX` is an ISO language code corresponding to one CiviCRM has published translations for.
+
+For example, for Spanish CiviCRM core:
+
+```sh
+wget https://download.civicrm.org/civicrm-l10n-core/mo/es_ES/civicrm.mo
+```
+
+For the CDN Tax Receipts extension in Canadian French:
+
+```sh
+wget https://download.civicrm.org/civicrm-l10n-extensions/mo/cdntaxreceipts/fr_CA/cdntaxreceipts.mo
+```
+
+## Storing translation files in another directory
+
+By default, CiviCRM looks in `[civicrm.root]/l10n` for translation files. Since CiviCRM 5.23, there is a new setting available to store those files in another directory. This can be convenient when files are updated regularly, or when using the l10nupdate extension, which requires the files to be web-writable. More information, see [PR15408](https://github.com/civicrm/civicrm-core/pull/15408). As of this writing, this setting only applies to core translations, not extensions.
+
+## Native gettext
+
+`gettext` is the mechanism by which strings are translated. By default, CiviCRM uses the PHP-Gettext implementation. This implementation can cause a 20-30% performance loss.
+
+Since CiviCRM 4.2, it is possible to use native `gettext`. This may require some changes to your hosting environment and is therefore recommended mainly for sites hosted on dedicated environments (VPS or dedicated server, it may not work on shared hosting).
+
+To enable it:
+
+* PHP must have `gettext` support compiled in (it usually is the case, see `phpinfo()` for more information). Debian and Ubuntu include it by default.
+* The operating system must have the locale enabled. For example, on Linux-based systems, this is in `/etc/locale.gen`, or by typing this command:
+
+```sh
+locale -a
+```
+
+Debian/Ubuntu systems can enable locales by typing:
+
+```sh
+dpkg-reconfigure locales
+```
+
+!!! note
+    The "UTF-8" variant of the locale must be enabled. For example: "fr_FR.UTF-8".
+
+Apache or PHP-FPM must be restarted after adding a new locale. Finally, uncomment the following in civicrm.settings.php:
+
+```php
+define('CIVICRM_GETTEXT_NATIVE', 1);
+```

docs/general/troubleshooting.md

@@ -71,14 +71,18 @@ If you get this error on a new Drupal/CiviCRM installation, you may have skipped
 
 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
+### Page doesn't reload and spinner shows when tryibng to re-create triggers, eventually showing "DB Error: unknown error"
 
-Try [rebuilding the WordPress menus](#rebuild-wp-menus).
+There can be multiple reasons for this, but they usually relate to MySQL user or connection issues. Check the MySQL user exists, and that it can log in to the database from the server accessing MySQL with the password in civicrm.settings.php. You may want to check logs then. A solution on some systems with MySQL binary logging is to add log_bin_trust_function_creators = 1 to the mysqld config file.
 
 ### "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.
 
+### WordPress menus are wrong
+
+Try [rebuilding the WordPress menus](#rebuild-wp-menus).
+
 ## Solutions
 
 ### Cleanup Caches and Update Paths {:#clear-cache}

docs/general/unicode_pdf.md

-# Using non-latin characters in PDF output
+# Using your own font or CJK characters in PDF output
 
-(This does not apply to Drupal 8/9.)
+As of CiviCRM 6.0, most unicode characters will output correctly in PDFs. But if you need CJK characters DejaVu does not contain those, so you will need to install another font file such as SimSun using the steps below.
 
-By default there are certain places in CiviCRM where PDF output does not handle non-latin characters because the unicode font files have been removed from the DOMPDF library. For example CiviCRM uses it when producing PDF copies of CiviReports, but by comparison it uses a different library for Mailing Labels.
+If you are still seeing question marks (?) in place of unicode characters, even for non-CJK characters, check that you don't have a `<font>` tag or `style` attribute in the html specifically setting a font that doesn't support unicode.
 
-Note when testing to see if you've succeeded, use letters that are entirely outside the latin alphabet, e.g. use cyrillic letters. Several letters like `ü` will work either way so aren't a good test.
+## Option A: Using web fonts
 
-??? example "Option A: Install the unicode font files for DOMPDF"
+1. In your html template add a `<link>` tag like the following, e.g. for the Noto Sans SC font: `<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Noto+Sans+SC:wght@100..900">`
+1. Specify the font using CSS in the templates where you use the CJK characters. You can use the Source button in CKEditor to do this and type it directly into the HTML: e.g. `<p style="font-family: Noto Sans SC;">的</p>`
 
-    You will need to repeat these steps after each CiviCRM upgrade.
+## Option B: Storing fonts locally
 
-    1. Get the dompdf download zip file from the github repository, e.g. at https://github.com/dompdf/dompdf/releases/tag/v0.8.6.
-      * You might want to use the exact same release (github tag) that core uses. For the font it shouldn't matter, but you can find this number by looking in composer.lock in your civicrm root folder and searching for "dompdf" and look at the "version" field.
-    1. Extract the files and look in the dompdf/lib/fonts folder.
-    1. Copy all the DejaVuSans files over to your `<civicrm_root>/vendor/dompdf/dompdf/lib/fonts` folder.
-    1. Edit the `dompdf_font_family_cache.dist.php` file in the same folder and add these lines:
-    ```php
-    'dejavu sans' =>
-        [
-            'bold' => DOMPDF_DIR . '/lib/fonts/DejaVuSans-Bold',
-            'bold_italic' => DOMPDF_DIR . '/lib/fonts/DejaVuSans-BoldOblique',
-            'italic' => DOMPDF_DIR . '/lib/fonts/DejaVuSans-Oblique',
-            'normal' => DOMPDF_DIR . '/lib/fonts/DejaVuSans'
-        ],
-    'dejavu sans mono' =>
-        [
-            'bold' => DOMPDF_DIR . '/lib/fonts/DejaVuSansMono-Bold',
-            'bold_italic' => DOMPDF_DIR . '/lib/fonts/DejaVuSansMono-BoldOblique',
-            'italic' => DOMPDF_DIR . '/lib/fonts/DejaVuSansMono-Oblique',
-            'normal' => DOMPDF_DIR . '/lib/fonts/DejaVuSansMono'
-        ],
-    'dejavu serif' =>
-        [
-            'bold' => DOMPDF_DIR . '/lib/fonts/DejaVuSerif-Bold',
-            'bold_italic' => DOMPDF_DIR . '/lib/fonts/DejaVuSerif-BoldItalic',
-            'italic' => DOMPDF_DIR . '/lib/fonts/DejaVuSerif-Italic',
-            'normal' => DOMPDF_DIR . '/lib/fonts/DejaVuSerif'
-        ],
+1. While option A will cache a version of the file after the first download, it may not be available on the internet or may be a commercial font.
+1. Create a folder in a location that won't get overwritten when you upgrade, e.g. sites/default/fonts for Drupal.
+1. Copy the .ttf font file you want to use into that folder.
+1. Run `php -r 'require_once "/path/to/civicrm/vendor/autoload.php"; $f = \FontLib\Font::load("/full/path/to/the/ttf/file"); $f->parse(); $f->saveAdobeFontMetrics("/full/path/to/output/ufm/file");'`
+    * e.g. `php -r 'require_once "/var/www/sites/all/modules/civicrm/vendor/autoload.php"; $f = \FontLib\Font::load("/var/www/sites/default/fonts/simsun.ttf"); $f->parse(); $f->saveAdobeFontMetrics("/var/www/sites/default/fonts/simsun.ufm");'`
+1. Create a file in that folder called `installed-fonts.json` that looks like this:
+    ```json
+    {
+        "simsun": {
+            "normal": "simsun"
+        }
+    }
     ```
-
-??? example "Option B: Install wkhtmltopdf instead"
-
-    This may also have an advantage for reports that cause DOMPDF to run out of memory. A possible disadvantage is the output may not be exactly the same or as well tested with CiviCRM as DOMPDF since it is not the default. You only need to do this once.
-
-    1. Your operating system's package manager may already make it available to install. If not then go to https://wkhtmltopdf.org and download the file for your operating system.
-    1. Note the full path to the executable binary.
-    1. In CiviCRM go to Administer - System Settings - Misc.
-    1. A couple lines down there is a setting `Path to wkhtmltopdf executable`.
-    1. Fill it in, e.g. `/usr/local/bin/wkhtmltopdf`
-    1. Click the Save button.
+1. Visit Administer - System Settings - Misc and in the field for DOMPDF Font Folder put the full path to the font folder you created in step 2.
+1. Specify the font using CSS in the templates where you use the CJK characters. You can use the Source button in CKEditor to do this and type it directly into the HTML: e.g. `<p style="font-family: simsun;">的</p>`
+1. Note any fonts you set up here are in addition to the ones distributed with dompdf/CiviCRM. You do not need to copy those core fonts over or add entries in this json file to use them.