Dashboard and control panel
Two places show you everything: the Dashboard, for your whole account, and the control panel of each Opensolr Index.
01 · The Dashboard
Click Dashboard in the top menu. It shows:
- Account: your plan, with the price and the next renewal on paid plans; Backup Enabled, whether your plan includes backups; your Master REST API Key and the Generate A New API Key button.
- Indexes and Clusters: how many you have, out of what your plan allows.
- Disk and Bandwidth: Overall, Avg and Max per index. Disk space, Bandwidth.
- API Quota: the AI requests used this month, out of your plan's allowance. API Quota.
The master key opens every index and every API call of your account. To give a developer or an app less, create a scoped key in Account > API Keys: API authentication.
02 · The control panel of an index
Open Solr > Index List and click the cog of an index: its control panel opens in a new tab. The Switch Index... list at the top of the left menu jumps to another index. The left menu:
| Item | What it holds |
|---|---|
| Info | Address, documents, bandwidth and disk, explained below. |
| Tools | Delete By Query and the maintenance buttons: Index Tools. |
| Backup | Backups and restores: Backup. |
| Security | Login and IP rules: Security. Not on cluster replicas. |
| Configuration | The configuration files: Configuration. |
| Server Monitor | The health of your own server, for owners of a dedicated server: Server Monitor. |
| Query Analytics | What is searched and how fast: Query Analytics. |
| Live Query Stream | Searches as they arrive: Live Query Stream. |
| Cluster Wide Stats | Clusters only: Clusters and replicas. |
| Bandwidth Usage | Bandwidth month by month: Bandwidth. |
| WebCrawler, Chat Bot | Indexes in a region with site search: Crawl your site, Chat Bot. |
| Error Log | Errors of the index: Error Log. |
| Delete Index | Delete Cluster on a cluster: Delete an index. Not on cluster replicas. |
03 · The Info tab
- Solr Version of the index.
- Port, Path and Host, plus LAN on servers with a private network address: Connect to your index.
- Replica Servers, on clusters only: Clusters and replicas.
- Documents: how many documents the index holds, marked unmetered because their number has no limit, only their disk space. Below it, the date the index was Created.
- Bandwidth and Disk: used out of your plan, with a circle that fills up. The circles keep one colour however full they are, so read the percentage in the middle.
Documents, Bandwidth and Disk are updated every 20 minutes.
04 · Quick Actions
The bar at the top of the control panel: Solr Query, Solr Admin, Drupal, WordPress, Auth, CORS and Best Practices. Quick Actions.