Confluence Awesome Search Setup Guide: Configure, Customize, Succeed
Overview
Confluence Awesome Search is an add-on that enhances Confluence’s native search by offering better indexing, advanced filters, custom ranking, and saved searches to help teams find content faster. This guide covers installation, key configuration steps, customization options, and tips to maintain search quality.
Prerequisites
- Confluence (Server/Data Center or Cloud) compatible with the add-on version.
- Admin privileges in Confluence.
- Backup of Confluence instance before installing apps (recommended).
- For advanced features: access to Elasticsearch settings or external search service if the add-on integrates with one.
Installation
- As Confluence admin, go to the app marketplace (Manage apps/Add-ons).
- Search for “Confluence Awesome Search” and choose the correct listing for your Confluence deployment (Server/Data Center/Cloud).
- Install the app and follow any prompts to grant permissions.
- Restart Confluence if required.
Initial Configuration
- Open the Awesome Search admin panel from Confluence administration.
- Run the initial indexing: allow the app to crawl and index spaces, pages, attachments, and blog posts.
- Configure indexing schedules (real-time, hourly, daily) depending on content change frequency and server load.
- Set permissions for which user groups can access advanced search features.
Search Scopes & Filters
- Define default search scopes (entire site, selected spaces, or personal spaces).
- Create and expose custom filters: content type, label, author, date ranges, space, attachments, and page status.
- Configure a “Global” filter set and space-specific presets for large instances.
Relevance & Ranking
- Adjust ranking weights for title, page body, labels, and attachments.
- Promote recent or frequently viewed pages by boosting their score.
- Use synonym and stop-word lists to improve recall.
- Configure stemming and language support if available.
UI Customization
- Add the Awesome Search widget to the Confluence header or sidebar.
- Customize placeholder text, default filters, and number of results per page.
- Enable preview snippets and attachment thumbnails.
- Localize UI strings if you have multilingual teams.
Saved Searches & Alerts
- Enable saved searches for users and groups.
- Configure email or in-app alerts for new results matching saved searches.
- Provide templates for common saved searches (e.g., team docs, release notes).
Performance & Scaling
- Monitor indexing queue, response times, and resource usage.
- For large instances, offload search to external Elasticsearch clusters if supported.
- Tune JVM, database, and search index settings per vendor recommendations.
- Use incremental indexing to reduce full re-index frequency.
Security & Permissions
- Ensure search respects Confluence permissions: users should only see results they can access.
- Exclude sensitive spaces or pages from indexing where necessary.
- Audit access logs for search-related requests if compliance requires.
Troubleshooting
- Missing results: re-run indexing for affected spaces; check permissions and exclude rules.
- Slow searches: check server load, index size, and consider upgrading resources or external search.
- Incorrect relevancy: adjust ranking weights, synonyms, and stop-words; rebuild index if needed.
- Plugin errors: review logs, check compatibility matrix, and update the plugin.
Maintenance Best Practices
- Schedule regular re-indexing (weekly or monthly) depending on change rate.
- Review and update synonyms and stop-words quarterly.
- Archive or delete obsolete content to keep the index lean.
- Train users on saved searches and filters.
Quick Checklist
- Backup Confluence
- Install app and run initial index
- Set indexing schedule & permissions
- Configure filters and ranking
- Add UI widgets and saved searches
- Monitor performance and audit logs
- Schedule ongoing maintenance
If you want, I can produce step-by-step admin console instructions tailored to Confluence Cloud or Server/Data Center—tell me which environment to target.