Skip to content

Install the PHP OAuth extension

The OAuth extension provides OAuth consumer and provider bindings. OAuth is an authorization protocol built on top of HTTP which allows applications to securely access data without having to store usernames and passwords.

The OAuth extension supports PHP 5.6+.

Install the OAuth extension

Installing the extension involves the following steps:

  1. Install build dependencies (packages that are required to build the extension).
  2. Build the extension’s library file.
  3. Enable the extension in the PHP configuration.

Install build dependencies

Set environment variables for the package manager.

Terminal window
export DEBIAN_FRONTEND=noninteractive

Install a compiler and other packages that are required for building PHP extensions.

Terminal window
sudo apt-get -y install gcc g++ make autoconf libc-dev pkg-config

Build the extension

The PECL install command compiles the extension’s .so library file.

Terminal window
yes '' | sudo pecl8.4-sp install oauth

Enable the extension

Configure PHP to load the extension.

Terminal window
sudo bash -c "echo extension=oauth.so > /etc/php8.4-sp/conf.d/oauth.ini"

Restart PHP-FPM.

Terminal window
sudo service php8.4-fpm-sp restart

Verify the extension is enabled in PHP.

Terminal window
php8.4-sp -i | grep oauth

If the extension is enabled, you will see output like the following.

/etc/phpX.Y-sp/conf.d/oauth.ini,

Uninstall the OAuth extension

Uninstalling the extension involves the following steps:

  1. Disable the extension in the PHP configuration.
  2. Remove the extension’s library file.

Disable the extension

Remove the extension’s configuration from PHP.

Terminal window
sudo rm /etc/php8.4-sp/conf.d/oauth.ini

Restart PHP-FPM.

Terminal window
sudo service php8.4-fpm-sp restart

Remove the extension

The PECL uninstall command removes the extension’s .so library file.

Terminal window
sudo pecl8.4-sp uninstall oauth