acquia/acquia-search-proxy

A web service proxy for the Acquia Search service

0.1.1 2014-11-24 18:27 UTC

README

Build Status Scrutinizer Code Quality Latest Stable Version License

This project is a web service proxy to the Acquia Search Service. It allows developers to expose a RESTful API to end users, build administrative interfaces for their Acquia Search indexes, etc.

Installation

NOTE: This project requires PHP >= 5.3.3

  • Run php composer.phar install in the project's root directory
  • Choose a configuration file directory (referred to as CONF_DIR below)
    • The ./conf directory in the project's root can be used
  • Run the command line tool to authenticate the indexes you want to use
    • ./bin/acquia-search-proxy indexes:auth CONF_DIR/indexes.json
  • Copy ./conf/conf.yml.dist to CONF_DIR/conf.yml and modify accordingly
    • Set acquia.search.proxy.auth_file to CONF_DIR/indexes.json
  • Copy docroot/index.php.exampleto docroot/index.php and modify accordingly

For development, run php -S localhost:3000 -t docroot/ to start the service, and visit http://localhost:3000 to consume it.

Acquia Search Proxy is build with the Silex micro framework, so the documentation applies here.

Refer to the Acquia SDK for PHP and PSolr projects for code examples.