Skip to content

Typesense is a modern, privacy-friendly, open source search engine meticulously engineered for performance & ease-of-use. This is an add on for DDEV so you can run and develop integrations for Typesense locally.

License

Notifications You must be signed in to change notification settings

lussoluca/ddev-typesense

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tests

Installation

Uses the current stable release of the Typesense Docker image.

With DDEV installed, run this command:

ddev get lussoluca/ddev-typesense

Configuration

The Typesense container is reached at hostname: https://(DDEV_HOSTNAME), port: 8109.

The default API key for Typesense is ddev. You can provide your own by adding to .ddev/.env in your project, and adding the TYPESENSE_API_KEY variable:

TYPESENSE_API_KEY=my_api_key_value

Admin Dashboard

This DDEV addon also includes the admin dashboard by bfritscher:

https://github.com/bfritscher/typesense-dashboard

The admin dashboard is useful to navigate your collections and schema and debug your search.

You can access the admin dashboard by navigating to this URL in your browser:

https://(DDEV_HOSTNAME):8111

Drupal and Search API

If you are using Drupal, you can use Search API and the Search API Typesense modules to connect to the running Typesense instance.

Originally Contributed by kevinquillen, then adapted to work with latest Typesense server over HTTPS.

About

Typesense is a modern, privacy-friendly, open source search engine meticulously engineered for performance & ease-of-use. This is an add on for DDEV so you can run and develop integrations for Typesense locally.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages