acquia / acquia-search-proxy
A web service proxy for the Acquia Search service
Installs: 27
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 35
Forks: 3
Open Issues: 14
Type:project
Requires
- php: >=5.3.3
- acquia/acquia-sdk-php-network: >=0.7.0,<0.8.0
- acquia/acquia-sdk-php-search: >=0.7.0,<0.8.0
- igorw/config-service-provider: ~1.0
- monolog/monolog: ~1.0
- silex/silex: ~1.1
- symfony/console: ~2.0
- symfony/yaml: ~2.0
Requires (Dev)
- pdepend/pdepend: ~1.0
- phploc/phploc: ~2.0
- phpmd/phpmd: ~1.0
- phpunit/phpunit: ~3.0
- satooshi/php-coveralls: *
- sebastian/phpcpd: ~2.0
This package is not auto-updated.
Last update: 2023-03-14 08:51:55 UTC
README
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- Refer to Composer's documentation for more details.
- Choose a configuration file directory (referred to as
CONF_DIR
below)- The
./conf
directory in the project's root can be used
- The
- 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
toCONF_DIR/conf.yml
and modify accordingly- Set
acquia.search.proxy.auth_file
toCONF_DIR/indexes.json
- Set
- Copy
docroot/index.php.example
todocroot/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.