profile.cfg

Name

profile.cfg

Location

~/conf/collection/profile/

Description

Controls profile-specific settings and defines services within a collection The profile.cfg configuration file is created when a profile within a collection is created (though it is permitted to be empty or absent). The profile.cfg configuration file can be edited by navigating from the administrator home page’s through the Administer > Edit profile configuration.

Since

v15.0

Format

The format of the file is a set of key=value pairs, one per line.

Background

Profiles can be used to support different templates, analytics and ranking behaviours within a given collection. A subset of options controlled by collection.cfg are also available for profiles.

Settings

service.title

Sets a display title to describe the service. Note: this is not the same as the 'collection title' setting known as service_name.

service.thumbnail

Warning, this option is deprecated. Use the thumbnail api instead, documented in the Swagger UI in

GET/DELETE/PUT /service/v1/services/{service}/thumbnail

Sets an image file (relative to the $SEARCH_HOME/conf/COLLECTION/PROFILE/ directory) to be shown as the service thumbnail. This may be any image file the browser is capable of rendering, and will be resized on the client. To avoid unnecessary bandwidth usage, the image should not normally be larger than 500x500px.

Example

The example profile.cfg file below will set the service title and logo for the Funnelback commercial website search service and source auto completion solely from this profile’s auto-completion.csv file:

service=true
service.title=Funnelback Commercial Website
service.thumbnail=funnelback-logo-500x500.png
auto-completion.source=csv

© 2015- Squiz Pty Ltd