Hudu now integrates with Typesense, a fast, open-source search engine that allows for customizable, powerful search experiences. This integration gives you more control over how search behaves in your Hudu environment, especially for teams with advanced search needs or those already using Typesense elsewhere in their stack.
This article walks through how the integration works, how to set it up, and what to expect.
Why Use the Typesense Integration?
While Hudu continues to actively improve our built-in search engine, the Typesense integration is designed for users who want more flexibility or customization options, particularly around synonyms and indexing behavior.
Key Benefits:
- Custom Synonyms: Define search term synonyms (e.g., “O365”, “Office365”, and “M365”) to surface more relevant results.
- Faster Search: Depending on your data size and configuration, Typesense can offer faster performance.
- More Control: Fine-tune how your Hudu data is indexed and queried.
Note: You’ll need a separate, paid Typesense account to use this integration. It’s not included in your Hudu subscription.
What Gets Indexed?
Once configured, Typesense powers search for these record types:
- Companies
- Passwords
- Knowledge Base Articles
- Processes
- Assets
- Websites
These areas will use Typesense in the search bar on their respective pages and in the global/top navigation search (including keyboard shortcuts like /).
Search bars for other record types will continue to use Hudu’s built-in search.
Getting Started
Step 1. Create a Typesense Account
To use the integration, you’ll need access to a hosted Typesense cluster. You can:
- Self-host Typesense
- Use Typesense Cloud, their managed hosting option
Make sure you have:
- Host URL
- API Key (with write/search access)
Step 2. Enable the Integration in Hudu
- Go to Admin → Integrations
- Click on Typesense
- Enter your:
-
Typesense Host URL (Be sure to enter the full URL, including
https://) - API Key
-
Typesense Host URL (Be sure to enter the full URL, including
- Click Save
Once connected, Hudu will automatically begin syncing the supported records to your Typesense instance.
Note: Syncing is automatic and ongoing. Changes made to supported records will be reflected in your Typesense index shortly after they're made in Hudu.
If a user is an admin in Typesense but not an admin in Hudu, configuring the Hudu + Typesense integration could lead to those users having access to information they may not have had access to otherwise. For example, if the Typesense integration is configured, a Typesense admin will be able to see the total # of passwords in the Hudu instance. The passwords and OTPs are NOT shown in Typesense, but username/URL/password entry is. Typesense does not and will never index My Vault passwords.
Tips & Caveats
- Data Sync Delay: Indexing may take a few minutes after enabling the integration or making changes.
- Custom Fields: Some custom fields may not be searchable depending on their type or how they are stored. Future updates may expand this.
- Search Behavior Differences: Because Typesense supports features like typo tolerance and synonyms, search results may differ slightly from Hudu’s built-in search.
-
Manual Reindex: If connection is lost between Hudu and Typesense, a manual reindex can be triggered.
- Please note, the integration will automatically test the connection as well as reindex automatically when the integration is set up.
FAQ
Answer: No — Typesense is a separate product with its own pricing.
Answer: Yes. This integration is optional and aimed at users who want extra control or performance. We’re actively working on making our built-in search better too.
Answer: Not at this time — all supported record types listed above will automatically use Typesense if the integration is active.
Answer: Search will default back to the default search when something breaks or the connection to the node is lost. The best way to test if Hudu is using Typesense search is if synonyms are working.
Need Help?
If you run into issues or need help configuring Typesense, feel free to reach out to our support team or refer to the Typesense Documentation.