Files Restriction

Files Restriction Add-On allows you to restrict access to files in the WordPress Media Library and to files uploaded through Profile Builder’s Upload Field, based on user roles and login status. This ensures that sensitive files are only accessible to authorized users.

Activating the Files Restriction Add-on

Files Restriction Add-on is available only with a Profile Builder Pro, or Agency license.

After purchasing a premium version of Profile Builder, you can check the following guide on how to install Profile Builder.

Settings

After you install and activate the Files Restriction add-on, you will have two major functionalities:

1. You can protect your files within your Media Library.
2. You can protect files uploaded through Profile Builder upload fields.

Restricting files

Files Restriction Settings are available under Profile Builder → Settings → Content Restriction.

These settings allow you to choose to protect all files in the Media Library, regardless of their type, or only specific file types.

• Web Server – displays the web server in use
• Protect ALL File Types – restricts all files in the Media Library, regardless of their type
• Protected File Types – select the file types you want to restrict
• Nginx Configuration – provides the directive to include in the server Nginx configuration file

Web Server

This is an informational field only. It displays the current web server in use.

Protect All File Types

When enabled, all files in the WordPress Media Library, regardless of their type, will be subject to access restrictions based on the Content Restriction settings on the file attachment page.

Additionally, the Protected File Types field will be disabled, and the options specified there will not be taken into account.

When disabled, only the file types specified in Protected File Types will be subject to access restrictions. Any other file type not included in the selected types will not be subject to these restrictions.

Protected File Types

You can use this option to specify which types of files from the WordPress Media Library will be subject to access restrictions based on the Content Restriction settings on their respective file attachment pages.

There is a list of file types selected by default. You can change this selection by removing a file type from the list or choosing a new one from the drop-down menu. If you want to add a file type to the restricted list but can’t find it in the drop-down, you can type the desired file extension and press Enter key.

Nginx Configuration

This option is visible only when Nginx web server is in use.

You’ll notice an Nginx include directive and a brief description of the steps required for the file restriction rules to take effect, ensuring this feature works properly.

How to restrict access to files

After you have selected which file types to protect, you will need to establish Content Restriction rules that determine whether files can or cannot be accessed.

You can manage the Content Restriction rules by navigating to Media -> Library, opening the desired file, clicking on “Edit more details” in the sidebar on the right, and scrolling down to the Profile Builder Content Restriction meta-box where you can set restrictions as needed.

Upload Field Restriction Settings

Upload Field Restriction Settings are available under Profile Builder → Settings → Advanced Settings → Fields.

• Restrict Uploaded Files – enables the feature and restricts uploaded files, through Profile Builder Forms, to logged-in users
• Restricted Upload Fields – select the Upload Fields which apply restrictions to the uploaded files
• Restrict Files to User Roles – restrict uploaded files to selected user roles

These settings allow you to restrict access to files uploaded through Profile Builder Forms based on user roles and login status.

Restrict Uploaded Files

By enabling this option, files uploaded through the Upload Fields in Profile Builder forms will be accessible only to logged-in users.

Also, when this option is enabled, you will see that the Restricted Upload Fields and Restrict Files to User Roles options become available.

Restricted Upload Fields

This option allows you to select which Upload Fields will be used for applying the restriction settings when the file is uploaded.

Restriction settings apply only to files uploaded via selected fields. If a field is not in the selected list, restriction settings will not apply.

If the Restricted Upload Fields option is left empty, restriction settings will apply to files uploaded via any Upload Field used in Profile Builder forms.

Restrict Files to User Roles

This option allows you to specify which User Roles will have access to the uploaded files.

Access to the uploaded files will be restricted to users assigned one or more of the specified User Roles from the list. Users not assigned any of these roles will be unable to access the uploaded file.

If the Restrict Files to User Roles option is left empty, users only need to be logged in to access the file. No specific user role is required.

Server Side Configurations

To ensure the File Restriction Add-on functions correctly and updates the restriction rules accurately, additional steps may be necessary based on the web server being used (Apache or Nginx).

Apache

When the Apache web server is in use, no additional setup or configuration is required.

The necessary directive is automatically inserted into the .htaccess file and updated whenever the File Restriction Settings are changed or the File Restriction Add-on is activated or deactivated.

Nginx

When the Nginx web server is in use, additional steps are required to ensure proper functionality of the File Restriction Add-on.

1. Insert Nginx Directive

• The Nginx include directive needs to be added to the Nginx configuration file on your server.
• You can find this directive in Profile Builder → Settings → Content Restriction → Nginx Configuration.

2. Restart Nginx Web Server

• After the directive has been successfully inserted into the server configuration file, the Nginx web server must be restarted for the changes to take effect.

A notification will appear on the WordPress Dashboard whenever the Nginx web server requires a restart. If this notification is dismissed without restarting the web server, it will not reappear until necessary changes are made and the web server needs to be restarted again.

Using Web-based Control Panels

1. Access the Control Panel

Log in to your server’s control panel. Common control panels include:

• cPanel: Provides a web interface for managing Apache configurations. Nginx configurations may require command-line or custom plugins.
• Plesk: Offers a comprehensive interface for managing both Apache and Nginx configurations.
• Webmin: Provides a GUI for server administration tasks, including Nginx configuration management.
• ISPConfig: Allows for Nginx configuration management and server settings via its web interface.

2. Edit Nginx Configurations

Navigate to the appropriate section or menu within the control panel to edit Nginx configurations. Typically found under domain or server settings.

Look for options labeled Nginx Settings or Web Server Configuration.

Add or modify directives as needed directly within the interface.

3. Save Changes

After adding directives, save the changes through the control panel’s interface. Usually involves clicking a Save or Apply Changes button.

4. Restart Nginx

Some control panels offer the ability to restart Nginx directly from the interface.

Look for a button labeled Restart Server or Apply Configuration. Clicking this will restart Nginx and apply your new configuration.

Using the Terminal

1. Access the Terminal

SSH Access: Open a terminal on your local machine (Windows users may use tools like PuTTY or Windows Subsystem for Linux).

• <em>ssh username@server_ip_address</em>

Replace username with your server username and server_ip_address with your server’s IP address or domain name.

2. Edit Nginx Configurations

Navigate to the Nginx configuration directory. For example:

• <em>cd /etc/nginx/</em>

Use a text editor like nano, vim, or emacs to edit the Nginx configuration file (nginx.conf or other relevant files).

• <em>sudo nano nginx.conf</em>

Add your directive in the appropriate location within the configuration file. For example:

# Profile Builder PRO: File Restriction 
                    include /mnt/supserv_sites_folder/sites/yourwebiste.com/files/wp-content/plugins/profile-builder-pro/add-ons-advanced/file-restriction/includes/file-restriction-nginx.conf;

3. Save Changes

Save the file and exit the text editor (Ctrl+X, then Y to confirm changes in nano).

4. Check Configuration

Validate the Nginx configuration for syntax errors before restarting:

• <em>sudo nginx -t</em>

If errors are found, correct them in the configuration file.

5. Restart Nginx

Once the configuration is validated, restart Nginx to apply the changes:

• <em>sudo systemctl restart nginx</em>

On some systems, you may use service instead of systemctl:

• <em>sudo service nginx restart</em>