From 18adfa2d11e166afddc657ad992a8a858b0699b7 Mon Sep 17 00:00:00 2001 From: tedbow <tedbow@240860.no-reply.drupal.org> Date: Fri, 8 Jul 2022 16:50:47 +0000 Subject: [PATCH] Issue #3294335 by tedbow, phenaproxima: Add requirements and limitations to the README --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e101fd2f6c..6c1ba42f71 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ Automatic Updates --------------- +### Requirements +- The Drupal project's codebase must be writable in order to use Automatic Updates. This includes Drupal, modules, themes and the Composer dependencies in the vendor directory. This makes Automatic Updates incompatible with some hosting platforms. +- The Composer executable must be in the PATH of the web server. If the Composer executable cannot be found the location can be set by adding + `$config['package_manager.settings']['executables']['composer'] = '/path/to/composer';` in `settings.php` + +### Limitations +- Drupal multi-site installations are not supported. +- Automatic Updates does not support version control such as Git. It is the responsibility of site administrators to commit any updates to version control if needed. + ### Automatic Updates Initiative - Follow and read up on [Ideas queue - Automatic Updates initiative](https://www.drupal.org/project/ideas/issues/2940731) - - -### Manual Testing instructions: - -See the [beta testing instructions](https://www.drupal.org/i/3275810). -- GitLab