DocumentationCommerceInstallation Guide

File ownership and permissions

Last update: Tue Apr 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin
  • Developer

It is important to secure your Adobe Commerce or Magento Open Source installation in a development environment to help prevent issues related to unauthorized people or processes accessing—and potentially harming—your system. Use the following file system ownership and permissions guidelines to protect your installation.

File system owner

The file system owner is a user that owns and holds write permissions to files in the file system.

There are two types of file system owners:

  • Shared hosting with a single user

    Shared hosting providers enable you to log in to the application server as one user. As a single user, you can log in, transfer files using FTP, and run the web server. You have the option of setting a umask to further restrict access, particularly in a production environment.

  • Private hosting with two users

    Private hosting is useful if you manage an application server. Each user has a specific responsibility:

    • The web server user runs the Admin and storefront.

    • The command-line user runs cron jobs and command-line utilities.

    Both users require the same permissions to the file system, so it is best to use a shared group and set a umask.

Restrict access with a umask

To tighten security, particularly in a production environment on a shared hosting system, you can use umask to restrict access. A umask—also referred to as a file system creation mask—is a set of bits that controls how the file permissions are set for newly created files.

WARNING
File system security is complex and important. We strongly recommend that you consult an experienced system administrator or network administrator before you decide the level of permissions to set. We provide a mechanism for you to use, but creating a permissions strategy is your responsibility.

Adobe Commerce uses a three-bit, default mask: 002. Subtract the default mask from the UNIX defaults of 666 for files and 777 for directories.

For example:

  • 775 for directories—Full control by the user, full control by the group, and enables everyone to traverse the directory. These permissions are typically required by shared hosting providers.

  • 664 for files—Writable by the user, writable by the group, and read-only for everyone else.

For more information about creating a magento_umask file, see Set a umask.

Permissions, ownership, and application modes

We recommend different permissions and ownership when you use the different Adobe Commerce application modes:

  • Default
  • Developer
  • Production

See About modes in the Configuration guide.

We further discuss permissions recommendations in File systems access permissions in the Configuration guide.

TIP
Before you install Adobe Commerce or Magento Open Source, review Configure file ownership and permissions.
recommendation-more-help
0f8e7db5-0e9c-4002-a5b8-a0088077d995