Skip to content

Commit

Permalink
MINOR: Update sphinx.md to add basic windows service documentation, a…
Browse files Browse the repository at this point in the history
…nd to note the existance of the fulltext search module
  • Loading branch information
Hamish Friedlander committed May 5, 2011
1 parent c52e821 commit 27a40e6
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/sphinx.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,23 @@
* Mark Stephens
<mark (at) silverstripe (dot) com>

## Requirementsld
## Requirements

* SilverStripe 2.4 or newer
* sphinx binary installation 0.9.9-rc2 or greater with 64-bit document id

## Alternative fulltext search modules

This module may in the future be replaced by the fulltext search module, currently in development at
https://github.com/silverstripe-labs/silverstripe-fulltextsearch

In particular, for projects with very large amounts of data to be stored in the index or projects that will
be hosted in windows environments, the fulltext search module with it's Solr connector is likely to be a better
solution.

The sphinx connector for the fulltext search module is not yet developed as of this writing, but once that has happened
this module is likely to be deprecated.

## Licensing

The file sphinxapi.php is the official php client for Sphinx, and is distributed
Expand Down Expand Up @@ -70,6 +82,11 @@ If you are using MAMP:
* Make sure your database string in _ss_environment has the port number included
i.e. define('SS_DATABASE_SERVER', 'localhost:8889');

If you are using Windows:
Sphinx runs as a service on windows. This service needs to be controllable by the user the webserver acts as.
This module provides a Sphinx/install task which will install & adjust the permissions of a sphinx service
as required by the most common configuration under windows.

## Refresh Configuration and Reindex

/dev/build the project. This will update the database structure, but also
Expand Down

0 comments on commit 27a40e6

Please sign in to comment.