Configure the lock provider
First steps
-
Log in to the Magento server as, or switch to, a user with permissions to write to the Magento file system. See switch to the file system owner.
If you use the bash shell, you can use the following syntax to switch to the file system owner and enter the command at the same time:
1
su <file system owner> -s /bin/bash -c <command>
If the file system owner does not allow logins, you can do the following:
1
sudo -u <file system owner> <command>
-
To run Magento commands from any directory, add
<magento_root>/bin
to your systemPATH
.Because shells have differing syntax, consult a reference like unix.stackexchange.com.
Sample bash shell for CentOS:
1
export PATH=$PATH:/var/www/html/magento2/bin
Optionally, you can run the commands in the following ways:
cd <magento_root>/bin
and run them as./magento <command name>
<magento_root>/bin/magento <command name>
<magento_root>
is a subdirectory of your web server docroot.
In addition to the command arguments discussed here, see Common arguments.
Prerequisites
Before you run this command, you must do all of the following or you must install the Magento software:
Completely secure installation
To use Secure Sockets Layer (SSL), also referred to as HTTPS, for both the Commerce Admin and the storefront, you must set all of the following parameters:
--use-secure
: Set to1
--base-url-secure
: Set to a secure URL (that is, starting withhttps://
)--use-secure-admin
Set to1
More details about these parameters can be found later in this topic.
Configure the lock
Configure a lock provider to prevent the launch of duplicate cron jobs and cron groups. (Requires Magento 2.2.5 and later 2.2.x versions or version 2.3.2 and later.)
Magento uses the database to save locks by default. If you have multiple nodes on your servers, we recommend using Zookeeper as the lock provider.
If you are running Adobe Commerce on cloud infrastructure, you do not need to configure lock provider settings. Magento configures the file lock provider for Pro projects during the provisioning process. See Cloud variables.
Command usage
1
bin/magento setup:config:set [--<parameter_name>=<value>, ...]
Parameter descriptions
Name | Value | Required? |
---|---|---|
--lock-provider |
Lock provider name: db , zookeeper , or file .The default lock provider: db |
No |
--lock-db-prefix |
The specific db prefix to avoid lock conflicts when using the db lock provider.The default value: NULL |
No |
--lock-zookeeper-host |
Host and port to connect to the Zookeeper cluster when you use the zookeeper lock provider.For example: 127.0.0.1:2181 |
Yes, if you set --lock-provider=zookeeper |
--lock-zookeeper-path |
The path where Zookeeper saves locks. The default path is: /magento/locks |
No |
--lock-file-path |
The path where file locks are saved. | Yes, if you set --lock-provider=file |