Metadata-Version: 1.0
Name: collective.recipe.solrinstance
Version: 0.1
Summary: zc.buildout to configure a solr instance
Home-page: UNKNOWN
Author: Kai Lautaportti
Author-email: kai.lautaportti@hexagonit.fi
License: ZPL
Description: **************************************
        Recipe for configuring a Solr instance
        **************************************
        
        .. contents::
        
        The recipe configures an instance of the Solr_ indexing server. Solr
        is an open source enterprise search server based on the Lucene_ Java
        search library, with XML/HTTP and JSON APIs, hit highlighting, faceted
        search, caching, replication, and a web administration interface
        
        SVN Repository: http://svn.plone.org/svn/collective/buildout/collective.recipe.solrinstance/
        
        .. _Solr : http://lucene.apache.org/solr/
        .. _Lucene : http://lucene.apache.org/java/docs/index.html
        
        
        Supported options
        =================
        
        The recipe supports the following options:
        
        solr-location
        Path to the location of the Solr installation. This should be
        the top-level installation directory.
        
        host
        Name or IP address of the Solr server, e.g. some.server.com.
        Defaults to 'localhost'.
        
        port
        Server port. Defaults to 8983.
        
        basepath
        Base path to the Solr service on the server. The final URL to the
        Solr service will be made of
        
        ``$host:$port/$basepath``
        
        to which the actual commands will be appended. Defaults to '/solr'.
        
        config-destination
        Optional override for the directory where the ``solrconfig.xml``
        file will be generated. Defaults to the Solr default location.
        
        schema-destination
        Optional override for the directory where the ``schema.xml`` file
        will be generated. Defaults to the Solr default location.
        
        schema-template
        Optional override for the template used to generate the ``schema.xml``
        file. Defaults to the template contained in the recipe, i.e.
        ``templates/schema.xml.tmpl``.
        
        jetty-destination
        Optional override for the directory where the ``jetty.xml`` file
        will be generated. Defaults to the Solr default location.
        
        index
        Configures the different types of index fields provided by the
        Solr instance. Each field is configured on a separated line. Each
        line contains a white-space separated list of ``[key]:[value]``
        pairs which define the index.
        
        filter
        Configure the additional filters for each index type. Each filter
        is configured on a separated line. Each line contains
        a ``index params`` pair, where ``index`` is one of the existing
        index types and ``params`` contains ``[key]:[value]`` items to
        configure the filter. Check the available filters in Solr's
        docs: http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters
        
        unique-key
        Optional override for declaring a field to be unique for all documents.
        See http://wiki.apache.org/solr/SchemaXml for more information
        Defaults to 'uid'.
        
        default-search-field
        Configure a default search field, which is used when no field was
        explicitly given. See http://wiki.apache.org/solr/SchemaXml.
        
        max-num-results
        The maximum number of results the Solr server returns. Defaults to 10.
        
        section-name
        Name of the product-config section to be generated for ``zope.conf``.
        Defaults to 'solr'.
        
        zope-conf
        Optional override for the configuration snippet that is generated to
        be included in ``zope.conf`` by other recipes. Defaults to::
        
        <product-config ${part:section-name}>
        address ${part:host}:${part:port}
        basepath ${part:basepath}
        </product-config>
        
        
        Change History
        **************
        
        0.1 (2008-07-07)
        ================
        
        - First public release.
        
        Contributors
        ***********************
        
        
        Download
        ***********************
        
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
