# Running Typesense in Production

In addition to performance and ease-of-use, Typesense is also designed to have low operational overhead in Production.

Typesense is a single self-contained binary with no runtime dependencies.

Running Typesense in Production is as simple as installing Typesense and starting the Typesense process as a daemon, either via Docker or a process manager.

When you install our Debian or RPM packages, they will automatically set up a systemctl service (typesense-server.service) and a templated configuration file for you (/etc/typesense/typesense-server.ini).

# Production Best Practices

Here are a couple of pointers to ensure that you get an optimal experience from Typesense in Production.

TIP

Most of the server infrastructure related items are not applicable to Typesense Cloud clusters, since we manage the infrastructure for you.

# Configuration

# Monitoring

  • Monitor the /health API endpoint for uptime.
  • Monitor RAM usage to ensure that it is below 85% of total RAM - you want to ensure that the OS has sufficient RAM to do its thing.
  • Monitor the /stats.json API endpoint for request rate and latency.
  • Monitor CPU usage to ensure that it is below 90% on average. If it spikes beyond that, you might need to upgrade to higher CPU capacity.
  • When using the import API with large batches of data, make sure that you have configured a sufficiently high timeout value to let your large imports complete, since all write operations are synchronous in Typesense.

# Search Relevance

  • Setup search analytics.
    • Monitor the search terms users are using, and setup synonyms as appropriate.
    • Monitor the search terms users are using, and curate results as needed.
  • While Typesense's default relevance parameters work out-of-the-box for majority of use cases, you can also fine-tune search relevance parameters as needed.
    • While default_sorting_order is optional, it is highly recommended especially if you have a field in your documents that is a proxy for how popular a document is within your dataset.

# Security

  • Set --api-port server parameter to 443 and use HTTPS in production.
    • Ensure that your firewall only allows inbound public traffic via this port.
    • Configure your SSL certificate and key using the --ssl-certificate and --ssl-certificate-key parameters.
  • When running a Highly-Available cluster, ensure that the --peering-address parameter is an IP Address on your INTERNAL private network.
  • Ensure that you have a strategy for expiring and rotating API keys regularly, using the expires_at parameter.
  • If you are storing multi-tenant data in a single collection, ensure that you have configured your Scoped Search API Keys correctly, to include the logged-in user's ID in the embedded filter.
    • Scoped Search API Keys need to be generated in your backend stack, and passed on to the frontend which should then send that to Typesense in API Calls.
    • Be sure to never expose your parent Search API Key to users, since that key has unrestricted access to all records.

# Schema Management

  • Set up a collection alias and use the alias to access the collection and documents from your application.
    • This is especially helpful when you need to update the schema of a collection. You'd create a new timestamped collection, re-index your data in it and then swap the alias to point to it.
  • Prefer a pre-defined schema when possible. But you can also use Regex fields name and auto schema detection especially when field names are dynamic.

# Staying Up-To-Date

# Support

While we strive to help via Github Issues (opens new window), for prioritized production-grade support with guaranteed response SLAs from the core team, we'd ask that you sign up for one of our support plans (opens new window) or sponsor us on Github (opens new window).

Paid Support is one of the key ways we use to financially support our lean bootstrapped team, so purchasing our support plans helps us improve our core product for everyone in the community, while also providing you peace of mind when running Typesense in production.

Last Updated: 7/21/2021, 11:27:02 AM