HowTo: Add a server

Last updated on
3 April 2017

Drupal 7 will no longer be supported after January 5, 2025. Learn more and find resources for Drupal 7 sites

Go to Search API's administration page at Administration > Configuration > Search and metadata > Search API (or http://example.com/admin/config/search/search_api).

Click Add server to go to the server creation form. Here, you have to enter some information for your new server:

Server name
Any human-readable name by which your server will be future referenced. Specifying the service class the server uses is usually sufficient—e.g., Database server, Solr server, etc. This name can later be changed and is only used internally, so mistakes don't matter much.
Machine-readable name
This name will be used as a unique internal identifier for the server (e.g., in administration paths) and cannot be changed afterwards. It is usually automatically created based on the human-readable name you choose, but you can also manually edit it by clicking Edit next to the created name (once you entered something in the Server name field). It is usually only used internally.
Enabled
Here you can select whether the server will initially be enabled. Nothing will be written to or read from disabled servers. Also, indexes lying on a disabled server will automatically be disabled as well.
Server description
This can help you make some notes on the server's purpose, e.g., for other administrators or for future reference. It will only be displayed on the server's main page and can also be left empty.
Service class
This is the most important setting, as it decides how data indexed with the new server will really be stored. The Search API module itself doesn't provide any service classes—if you don't see any options here, you will have to install some module providing a service class. The currently known service classes are listed under Service classes and features.
Once you select a service class, an additional fieldset will appear, containing both the service class with detailed description and additional service class-specific settings.

Click Create server to finish the process and create the new server. You can now move indexes onto it.

Help improve this page

Page status: No known problems

You can: