INTRODUCTION
------------

ACSF modules listing module allows you to check
the usage of custom and contribution modules on
a website. It can help you detect websites where
a specified module is used or optimize performance.

REQUIREMENTS
------------

This module requires the following PHP extensions:

 * SSH2 https://www.php.net/manual/en/book.ssh2.php

INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module.

CONFIGURATION
-------------

The configuration page is in "Administation->Configuration->Web services"
menu. The path is `/admin/config/services/modules-usage/configuration`.

Global configuration includes cache lifetime in seconds field. The default value is 3600.

The environments configuration page is in "Administation->Structure->ACSF Environment Entities"

Each environment configuration form has the next options:

- "Label" simple name of the environment
- "SSH Server User" textfield.
- "SSH Server URL" textfield.
- "Drush Path" textfield. You need to specify a server absolute path where drush command can be executed.
- "ACSF Environment URL" URL of the ACSF environment like https://www.dev.acquia.com.
- "ACSF username" username from the https://www.dev.acquia.com user.
- "ACSF API Key" API key value from the https://www.dev.acquia.com user.
- "Public key path" absolute path of a public key with access to SSH Server URL.
- "Private key path" absolute path of a private key with access to SSH Server URL.
- "SSH Key Pass Phrase" pass phrase to use your keys. Only if specified. Leave empty otherwise.
- "Description" text area to make some notes regarding this environment.

USAGE
-------------
1. Login to your ACSF website and collect your username and API key in the profile.
2. Login to your Acquia Cloud environment and collect your SSH user@url string.
3. Upload ssh key to Acquia Cloud or confirm it's already uploaded.
4. Make your SSH keys available for Drupal to use.
5. Using creadentials collected above, create new ACSF environment entity.
6. Usign "Search" tab, search a module you want to check.

MAINTAINERS
-----------

Current maintainers:
 * Denis Pelyukhow <denis.pelyukhow@gmail.com> - https://www.drupal.org/u/denispelyukhow

This project has been sponsored by:
 * EPAM Systems <https://www.epam.com/>
