Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Dashboard for Solr replication

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 soldash
Octocat-spinner-32 .gitignore
Octocat-spinner-32 CHANGELOG
Octocat-spinner-32 LICENSE
Octocat-spinner-32 NOTICE
Octocat-spinner-32 README.md
Octocat-spinner-32 requirements.txt
Octocat-spinner-32 runserver.py
README.md

Soldash

Soldash is a small web application that provides an overview of multiple Solr instances.

It aims to be a fully functional dashboard, providing full control over your Solr architecture.

Features

  • See an up-to-date overview of the state of all configured Solr instances, with attention drawn to slaves whose indexes are out of sync.
  • Issue commands to fetch indexes, view file lists of index, restart solr instances and enable/disable polling and replication.
  • Support for multi-core Solr clusters.

It is still very young software and may contain bugs. Any feedback should be sent to opensource at edelight dot de and would be greatly appreciated.

Getting Started

  • Clone this git repository
  • Install the necessary dependencies:
    • pip install -r requirements.txt
  • Edit settings.py according to your Solr setup. More details are provided below.
  • Start the server:
    • python runserver.py
  • Connect to http://localhost:5000 with a web browser

settings.py configuration

settings.py contains a settings dictionary used by both the backend and frontend of Soldash.

The individual settings you may need to configure are listed below.

HOSTS

The HOSTS value is a list of hosts, each defined in a dictionary. An example entry for an instance of Solr running locally without HTTP authentication required would be:

'HOSTS': {'hostname': 'localhost', 
          'port': 8983, 
          'auth': {}}

If HTTP authentication were required by the Solr instance in the last example, the entry would look like this:

'HOSTS': {'hostname': 'localhost', 
          'port': 8983, 
          'auth': {'username': 'test', 'password': 'test'}}

CORES

CORES is a list of the cores available on the Solr instances. At the moment, due to the primary requirements of this project, Soldash presumes that all Solr instances have the same cores.

If you do not have a multi-core set up, CORES should be defined so:

'CORES': [None]

If you have a default index and two additional cores, CORES should be defined so:

'CORES': [None, 'core1', 'core2']

TIMEOUT

TIMEOUT is the timeout (in seconds) for queries to a Solr instance. It is best to keep this number relatively low as requests are (not yet) parallelized.

DEBUG

If enabled, the web application will be started in Flask's debug mode (allowing access to traceroutes, etc).

DEFAULTCORENAME

This is the name of your default core in a single-core setup. You can find out what this is from your solr.xml file.

As it must be set, in a multi-core setup you can simply set it to any arbitrary core name.

Mako config values

There are a few config values used by flask-mako to render pages. You shouldn't need to modify these, however, if you do, they're documented in the settings.py file itself.

Something went wrong with that request. Please try again.