OPENSOLR-Control Panel

Find answers to your questions quickly and easily

Opensolr Basic User Guide

User Guide
Opensolr Basic User Guide
Everything you need to go from zero to production search — create your account, set up your first index, connect your application, and start searching.
SIGN UPCreate accountCREATE INDEXRegion + versionCONFIGURESchema + configCONNECT APPDrupal, WP, customSEARCH IN PRODUCTIONFast, reliable, fully managedFrom signup to live search in under five minutes

1. Create Your Account

Head to opensolr.com and click Sign Up in the top-right corner. Enter your email and choose a password. You'll receive a confirmation email — click the link to activate your account, then log in.

Once logged in, you'll land on your Dashboard — the central hub for managing everything: indexes, clusters, billing, team members, and API keys.

Opensolr Login

2. Create Your First Index

From your Dashboard, go to My Indexes and click Add New. You'll be prompted to:

  1. Select a region — US-East, US-West, EU-Central, EU-West, EU-North, or Asia-Pacific
  2. Choose a Solr version — Solr 5 through Solr 9 available across regions
  3. Name your index — give it a meaningful name (e.g. my_website, product_search) or keep the auto-generated ID

Click Add Index and your index is provisioned in seconds. You'll immediately see your connection details: hostname, port, authentication credentials, and the full Solr URL.

For a detailed visual walkthrough, see Create a New Index — Step by Step.

Select Opensolr Region
Name your index

3. Upload Your Configuration

Click your index name to enter its Index Control Panel, then go to Configuration in the sidebar. Here you can:

  • Edit config files live — schema.xml, solrconfig.xml, synonyms, stopwords, and more, directly in the browser
  • Upload a config zip — download a ready-made config set for your CMS or upload your own custom schema

For most CMS integrations, you'll download the config set from within the CMS module itself (Search API Solr for Drupal generates one automatically). For custom applications, you can start with the default config and adjust fields as needed.

See Solr Configuration Files Dependency Flow for details on how schema.xml, solrconfig.xml, and other config files work together.

Solr Configuration Manager

4. Connect Your Application

Drupal
Install Search API + Search API Opensolr. Add a server in Configuration > Search API, enter your Opensolr hostname, port 443, path /solr/INDEX_NAME. Generate and upload the config set. Create an index, select content types, and start indexing.
WordPress
Install WPSOLR or a similar Solr plugin. Under Settings > Solr Search, enter your Opensolr host (e.g. us-east-solr-8-0.opensolr.com), port 443, path /solr/INDEX_NAME, and your auth credentials. Save settings and reindex.
Custom Application
Connect any app (PHP, Python, Node.js, Java, Ruby) directly to Solr's HTTP API. Use your index URL with HTTP Basic Auth. Index documents via /update, query via /select. Supports JSON, XML, and CSV.
Web Crawler
Don't have an app? Use the Opensolr Web Crawler to crawl any website and build a search index automatically. AI enrichment, NLP, vector search, and an embeddable search UI — all included.

5. Quick API Examples

Once your index is live and configured, you can interact with it directly via HTTP. Replace USER:PASS with your index credentials and CLUSTER.opensolr.com with your cluster hostname.

Search (SELECT)

curl -u USER:PASS "https://CLUSTER.opensolr.com/solr/INDEX_NAME/select?q=laptop&rows=10&wt=json"

Index a Document (UPDATE)

curl -u USER:PASS "https://CLUSTER.opensolr.com/solr/INDEX_NAME/update?commit=true" \
  -H "Content-Type: application/json" \
  -d '[{"id":"1","title":"My First Document","content":"Hello Solr!"}]'

Delete by ID

curl -u USER:PASS "https://CLUSTER.opensolr.com/solr/INDEX_NAME/update?commit=true" \
  -H "Content-Type: application/json" \
  -d '{"delete":{"id":"1"}}'

PHP Example

$url = 'https://CLUSTER.opensolr.com/solr/INDEX_NAME/select?q=laptop&wt=json';
$context = stream_context_create(['http' => [
    'header' => 'Authorization: Basic ' . base64_encode('USER:PASS')
]]);
$response = file_get_contents($url, false, $context);
$data = json_decode($response, true);
print_r($data['response']['docs']);

JavaScript (Fetch)

const response = await fetch(
  'https://CLUSTER.opensolr.com/solr/INDEX_NAME/select?q=laptop&wt=json',
  { headers: { 'Authorization': 'Basic ' + btoa('USER:PASS') } }
);
const data = await response.json();
console.log(data.response.docs);

For a complete reference of all search parameters (q, fq, sort, fl, facet, etc.), see Querying the Solr API: Search Parameters Explained.


6. Your Control Panel

Your Index Control Panel gives you full visibility and control over every aspect of your Solr index — from live analytics and query monitoring to configuration, security, backups, and index tools.
Analytics & Monitoring
Query analytics, bandwidth, disk usage, live query stream, error logs
Security
HTTPS, HTTP Auth credentials, IP whitelisting, access control
Config & Schema
Live editor, zip upload, schema.xml, solrconfig.xml, synonyms, stopwords
Tools & Utilities
Delete by query, reload, reset, commit, optimize, restart Solr
Backup & Restore
One-click backups, instant restore, downloadable archives
REST API
Automate everything — create, delete, backup, config, security, and more
Opensolr Analytics Dashboard
Opensolr Index Overview

For a full overview, see What is the Opensolr Control Panel?


7. Troubleshooting

Issue Likely Cause Fix
Can't connect to Solr Wrong hostname, port, or credentials Double-check your Index Control Panel for the correct URL. Use port 443 for HTTPS.
No search results Content not indexed or schema mismatch Reindex your content. Ensure your schema fields match what your CMS sends.
Drupal: "Server could not be reached" Config set not uploaded or wrong Solr version Upload the config set generated by Search API Solr. Check Solr version matches.
WordPress plugin error Plugin version incompatibility Update WPSOLR to the latest version. Verify connection details.
Slow queries Unoptimized index or expensive queries Run Optimize from Tools, check Query Debugging.

8. Helpful Resources


Ready to get started?
Sign up for free and have your first Solr index running in minutes.
Read Full Answer

Real-Time Solr Monitoring & Analytics

Real-Time Solr Monitoring & Analytics

Monitor Your Search Performance Like Never Before

OpenSolr brings enterprise-grade monitoring directly into your dashboard. No setup, no configuration, no external tools - just powerful real-time insights into your Solr infrastructure the moment you need them.


📈 Live Query Volume Tracking

Solr Query Volume Chart

See your search traffic as it happens. Our real-time query volume chart updates every second, giving you instant visibility into traffic patterns, usage spikes, and query trends.

Perfect for:

  • Identifying traffic patterns and peak usage times
  • Capacity planning and scaling decisions
  • Detecting unusual activity or traffic spikes
  • Understanding user behavior in real-time

🔍 Complete Query Stream Analysis

Query Stream Table

Every query that hits your Solr index is captured and displayed in real-time. See exactly what your users are searching for, how long queries take, and which searches are performing well.

What You Get:

  • Timestamp Precision - Track when every query executed
  • Full Query Details - See paths, parameters, and search terms
  • Performance Metrics - Response times displayed to the millisecond
  • Result Counts - Understand how many hits each query returns
  • Status Monitoring - Catch errors and issues instantly

Smart Filtering lets you search through thousands of queries using regex patterns on paths and parameters. Find exactly what you're looking for in seconds.


🔬 Deep Query Inspection

Query Parameters Modal

Click any query to see the complete breakdown. Every parameter, every filter, every detail - presented clearly and ready to analyze or test.

See Everything:

  • Complete query string ready to copy and test
  • All parameters displayed in an easy-to-read table
  • Multi-value parameters (like filter queries) shown properly
  • Clean formatting - no URL encoding clutter

Perfect for debugging, optimization, and understanding exactly what your application is sending to Solr.


⚡ Smart Slow Query Detection

Slow Queries Table

Slow queries hurt user experience and waste resources. Our intelligent slow query monitor automatically identifies and tracks queries that need attention.

Customizable Thresholds: Set your own definition of "slow" - from 0.2 seconds to 1.0 seconds - and let OpenSolr automatically flag queries that exceed your threshold.

Why It Matters:

  • Identify optimization opportunities
  • Find queries that need better indexing
  • Track performance improvements over time
  • Proactively address issues before users complain

Queries are sorted by response time, putting your slowest queries front and center where they belong.


🖥️ Real-Time Server Health Monitoring

Server Stats Dashboard

Your Solr server's vital signs, updated live. Monitor CPU, memory, disk usage, and load averages - all in one beautiful dashboard.

System Metrics Include:

  • CPU Usage - Real-time processor utilization with trend graphs
  • Memory Consumption - RAM usage tracking over time
  • System Load - 1, 5, and 15-minute load averages
  • Disk Capacity - Visual indicators show available space at a glance

Everything updates automatically - no refreshing needed. Just watch your infrastructure perform.


🎯 Getting Started

Accessing your monitoring dashboard is simple:

  1. Log into your OpenSolr Control Panel
  2. Select any of your Solr indexes
  3. Find the monitoring options in the left sidebar:
    • "Solr Log" for real-time query monitoring
    • "Server Monitor" for system health metrics

That's it. Your monitoring is already running, already collecting data, already ready to use.


✨ Why OpenSolr Monitoring Stands Out

Built for the way you work:

  • Zero Setup - Start monitoring the moment you create an index
  • Real-Time Updates - See changes as they happen, not minutes later
  • Millisecond Precision - Accurate performance metrics you can trust
  • Intelligent Filtering - Find the queries that matter
  • Always Included - No extra fees, no add-ons, no hidden costs

Professional tools at your fingertips: Every OpenSolr account includes full monitoring capabilities. Whether you're running a small blog or a high-traffic e-commerce platform, you get the same powerful insights.


💡 Real-World Benefits

For Developers: Debug issues faster, optimize queries with confidence, and understand exactly how your search is performing in production.

For Operations: Monitor server health, plan capacity needs, and catch problems before they impact users.

For Business: Understand search usage patterns, improve user experience, and make data-driven decisions about your search infrastructure.


🚀 The OpenSolr Advantage

Professional search infrastructure shouldn't require enterprise budgets or DevOps teams. OpenSolr delivers powerful, production-ready monitoring as part of every account.

This is what modern search infrastructure looks like.


Monitoring is included with all OpenSolr plans. Log in now to start exploring your data.

Need help? Our team is here: support@opensolr.com | Documentation

Read Full Answer

Create a New Opensolr Index via the Control Panel

Control Panel
Create a New Opensolr Index
From login to a fully configured, production-ready Solr index in under two minutes. Use the Control Panel or automate everything with the REST API.
LOGINYour accountADD NEWDashboard menuSELECT REGIONVersion + locationNAME + CREATEClick Add IndexCONFIGUREUpload schema, go!Five steps from zero to a fully operational Solr index

Step-by-Step Walkthrough

1
Log in to your Opensolr account
Head to opensolr.com/login and sign in with your email and password.
Login to Opensolr Account
2
Open the Control Panel
Click your username in the top-right corner and select Control Panel from the dropdown menu.
Opensolr Control Panel menu
3
Click "Add New"
Inside your Dashboard, open the My Indexes menu and click Add New to start creating a new index.
Add New Opensolr Index
4
Choose your region and Solr version
Use the filter dropdowns to select a Region, Solr Version, and optionally a Country. Clusters are available across US-East, US-West, EU-Central, EU-West, EU-North, and Asia-Pacific.
Select Opensolr Region
Click the region card that matches your needs — or use Request Env. to request a custom dedicated environment.
Select Solr Cloud Region
5
Name your index and create it
Give your index a meaningful name or keep the auto-generated unique ID. Click Add Index and your index will be provisioned in seconds.
Name Opensolr Index
6
Open your Index Control Panel
Back on the My Indexes page, click your index name to enter its dedicated Control Panel — where you manage configuration, security, analytics, and more.
Opensolr Index Control Panel
7
Upload your Solr configuration
Go to Configuration in the sidebar. Edit config files live, or upload a ready-made Solr Config Zip (e.g. for Drupal, WordPress, or your own custom setup). Your index is now ready to receive data.
Solr Configuration Files Manager

What You Get

Real-Time Analytics
Query analytics, bandwidth stats, live query streams, and exportable PDF reports — all from your dashboard.
Security & Auth
HTTPS by default, HTTP Auth credentials, IP whitelisting, and per-index access control — managed from one panel.
Backup & Restore
One-click backups with instant restore. Automated replication across regions for maximum durability.
Live Config Editor
Edit schema.xml, solrconfig.xml, and all config files directly in the browser — or upload a zip archive.
REST API Automation
Automate index creation, config uploads, backups, and more via the Automation REST API.
Team Management
Invite team members, assign roles, and manage access across all your indexes from a single account.

Your Dashboard

Once your index is live, the Control Panel gives you full visibility and control — query analytics with visualizations, document counts, disk and bandwidth usage, server monitoring, and direct Solr Admin access.
Opensolr Analytics Dashboard
Opensolr Index Overview

Ready to get started?
Create your first index in under two minutes — or talk to us about a custom setup.
Read Full Answer

What is the Opensolr Control Panel?

Control Panel
The Opensolr Control Panel
A single web-based dashboard for managing every aspect of your Solr indexes — configuration, security, analytics, backups, team access, and full REST API automation.
LOGINYour accountDASHBOARDIndex overviewCONFIGURESchema + configSECUREAuth + IP rulesMONITORAnalytics + logsPRODUCTIONQuery, scale, automateFull lifecycle management from a single dashboard

What You Can Do

Index Management
Create, delete, start, and stop Solr indexes. Choose from global regions, pick your Solr version, and provision in seconds.
Schema & Config
Edit schema.xml, solrconfig.xml, and all config files in the browser. Upload config zips for Drupal, WordPress, or custom setups.
Query Interface
Run raw Solr queries directly from the panel. See real-time results, inspect response payloads, and debug queries without leaving the browser.
Analytics & Monitoring
Query analytics with charts, bandwidth and disk usage, document counts, live query stream, and exportable PDF reports.
Security
HTTPS enforced by default. Manage HTTP Auth credentials, set up IP whitelisting rules, and control per-index access.
Backup & Restore
One-click backups with instant restore. Your data is replicated automatically across regions for durability.
Tools
Delete by query, reload index, reset, commit, optimize, schedule automatic optimize, and restart Solr — all from the toolbar.
Team Management
Invite team members, assign roles, and manage shared access across all indexes from your account.
REST API Automation
Every action in the Control Panel is available via the REST API. Automate index creation, config uploads, backups, and more.

Dashboard at a Glance

The Control Panel gives you full visibility into every index — query analytics with visualizations, document counts, disk and bandwidth usage, server health, and direct Solr Admin access.
Opensolr Analytics Dashboard
Opensolr Index Overview

Getting Started

New to Opensolr? Follow the step-by-step guide to creating your first index — from login to a production-ready Solr index in under two minutes.


Ready to get started?
Create your first index in under two minutes, explore the API, or talk to us about a custom setup.
Read Full Answer

Index Tools — Delete by Query & Utilities

Index Tools
Delete by Query & Index Utilities
The Tools panel in your Opensolr Control Panel gives you direct control over your index data and health — from targeted document deletion to full index maintenance and optimization.
WRITE QUERYid:123 or *:*PREVIEWVerify matchesDELETERemove matched docsCOMMITFlush to diskDONEChanges liveWrite a query, preview the results, delete, commit, done.

Delete by Query

Delete by Query lets you remove documents from your Opensolr index that match a specific Solr query. Instead of wiping your entire index and re-indexing from scratch, you can surgically target exactly the documents you want to remove — whether that is a single document by ID, an entire category, URLs matching a pattern, or records older than a certain date.

How to Access It

1
Open your Control Panel and click on your index name
Navigate to My Indexes, then click the name of the index you want to manage.
2
Click "Tools" in the sidebar menu
The Tools panel appears on the right side of the index Control Panel. It contains the Delete by Query form at the top, and the index utility buttons below.
3
Enter your delete query and click Delete
Type a valid Solr query into the text field, then click the red Delete button. Follow up with a Commit to make the changes visible in search results.

Query Syntax Examples

*:* — Deletes ALL documents in the index. Use with extreme caution. This is equivalent to a full wipe without resetting configuration.
id:12345 — Deletes a single, specific document by its unique ID. The safest and most precise way to remove one record.
uri:*site.com/path — Deletes all documents whose URI field contains "site.com/path". Useful for removing all pages under a specific path or domain.
category:news — Deletes all documents in the "news" category. Works with any indexed field — just replace "category" and "news" with your field name and value.
timestamp:[* TO 2024-01-01T00:00:00Z] — Deletes all documents with a timestamp before January 1, 2024. Range queries are perfect for cleaning up old or stale data.

After executing a delete query, always click Commit (or use the Commit utility button below) to flush the changes to disk and make the deletions visible in search results.


The Tools Panel

Here is what the Tools panel looks like in your index Control Panel. The Delete by Query form is at the top, followed by the utility buttons for index management operations.
Opensolr Index Tools Panel with Delete by Query and Utilities

Index Utilities

The utility buttons below the Delete by Query form give you full control over your index lifecycle — from reloading configuration to restarting the Solr process itself.

Reload
Reloads the Solr index configuration without restarting the Solr process. Use this after uploading new configuration files (schema.xml, solrconfig.xml, synonyms, stopwords, etc.). Changes take effect immediately and search remains available throughout — there is no downtime.
Reset
Wipes ALL data from your index completely. This is a destructive, irreversible operation — every document is permanently removed. Your configuration files (schema, solrconfig, etc.) remain intact. Use this when you need a completely fresh start, for example after changing your schema significantly and needing to re-index everything from scratch.
Commit
Forces Solr to flush all pending changes to disk and make them searchable. Solr normally auto-commits on a schedule, but after running a Delete by Query or bulk document update, use Commit to see the changes reflected in search results immediately rather than waiting for the next auto-commit cycle.
Optimize
Merges internal Solr index segments into fewer, larger segments. This improves query performance and reduces the disk footprint of your index. Optimization can be CPU-intensive on large indexes, so it is best to run it during low-traffic periods rather than during peak query load.
Schedule Optimize
Set up a recurring optimization schedule — daily, weekly, or at whatever interval suits your workload. This keeps your index segments merged and query performance optimal without requiring you to remember to run it manually. Set it once and your index stays fast automatically.
Restart Solr Service
Fully restarts the Solr process on your cluster node. This is a last-resort operation — use it if Solr becomes unresponsive, or after major configuration changes that require a full process restart rather than just a config reload. Your index will be briefly unavailable during the restart.

Pro Tips

Always commit after Delete by Query
Deletions are not visible in search results until you commit. After running a delete query, click the Commit button to flush the changes to disk immediately.
Test with SELECT before you DELETE
Before running a delete query, test it first by running the same query as a SELECT in the Solr Admin or via the API. This shows you exactly which documents will be affected, so you can verify before making any irreversible changes.
Reset is permanent — use it wisely
Reset wipes every document from your index. Only use it when you truly need to start from scratch — such as after a major schema redesign. For partial cleanup, Delete by Query is the better choice.
Schedule Optimize instead of running it manually
Rather than remembering to run Optimize periodically, use Schedule Optimize to automate it. Pick an off-peak time window and let Opensolr handle index maintenance in the background.

Explore More of the Control Panel
Learn how to create indexes, automate with the API, or reach out for help with your setup.
Read Full Answer