Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

solr.ini [SolrSettings]

The settings of [SolrSettings] in solr.ini: Enabled, Url, BinaryPath, Host, Port, DataDir, RunDir, LogDir ...

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/solr/SolrSettings.md

On this page

solr.ini [SolrSettings]

The block [SolrSettings] of settings/solr.ini, with 9 setting(s).

Never edit settings/solr.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

  • settings/override/solr.ini.append.php for every siteaccess,
  • settings/siteaccess/<siteaccess>/solr.ini.append.php for one siteaccess,
  • extension/<extension>/settings/solr.ini.append.php in an extension (read when the extension is active).

Enabled

Master switch. While false, exp:solr reports "not configured" and refuses to
start, whatever else is set below.

Default: false.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
Enabled=false
*/ ?>

Url

A running Solr to talk to, base URL including scheme and port, no trailing
path, e.g. http://127.0.0.1:8983 . When set, exp:solr status pings it and
start/stop report that the instance is managed externally (a remote Solr is
not this command's to start or stop).

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
Url=
*/ ?>

BinaryPath

The Solr control binary for a Solr installed on THIS machine, e.g.
/opt/solr/bin/solr . When set (and Url is empty) exp:solr start/stop/restart
manage that local process with its own start/stop subcommands.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
BinaryPath=
*/ ?>

Host

The local instance's bind host and port (used with BinaryPath, and to build a
ping URL when Url is empty).

Default: 127.0.0.1.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
Host=127.0.0.1
*/ ?>

Port

Default: 8983.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
Port=8983
*/ ?>

DataDir

Solr home / data directory for the local instance. Left empty, Solr's own
default applies.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
DataDir=
*/ ?>

RunDir

Where exp:solr keeps this installation's Solr pid, logs and (optional) data,
mirroring the Velocity on-disk layout (var/vc/<engine>/...).

Default: var/vc/solr/run.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
RunDir=var/vc/solr/run
*/ ?>

LogDir

Default: var/vc/solr/log.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
LogDir=var/vc/solr/log
*/ ?>

StartTimeout

How long to wait (seconds) for the port to answer after a start.

Default: 60.

<?php /* #?ini charset="utf-8"?
# settings/override/solr.ini.append.php
[SolrSettings]
StartTimeout=60
*/ ?>

Generated by ./console exp:help:examples from settings/solr.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x