Development Environment #

The author uses docker-compose for development but this is not required. Typesense works with a number of different development environments.

Docker Compose #

version: "3"

services:
  webserver:
    image: php:8.3
    ...
  database:
    image: mysql:8
    ...
  typesense:
    image: typesense/typesense:26.0
    restart: on-failure
    ports:
      - "28108:8108"
    volumes:
      - ./typesense-data:/data
    command: '--data-dir /data --api-key=${TYPESENSE_API_KEY} --enable-cors'
    environment:
      TYPESENSE_API_KEY: ${TYPESENSE_API_KEY}
  typesense-dashboard:
    image: ghcr.io/bfritscher/typesense-dashboard:latest
    ports:
      - '${HOST_MACHINE_TYPESENSE_DASHBOARD_PORT}:80'

DDEV #

ddev get kevinquillen/ddev-typesense

ddev restart

You are now ready to configure your application as per the configuration, using the hostname found by running ddev describe.

Lando #

services:
  appserver:
    ...
  database:
    ...
  search:
    type: lando
    api: 3
    services:
      image: typesense/typesense:26.0
      restart: on-failure
      ports:
        - "8108:8108"
      volumes:
        - ./config/typesense:/data
      #very important: include the entrypoint command from the upstream Dockerfile
      command: '/opt/typesense-server --data-dir /data --api-key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx --enable-cors --enable-search-analytics=true --analytics-flush-interval=60'
      environment:
        TYPESENSE_API_KEY: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  search-dashboard:
    type: lando
    api: 3
    services:
      image: ghcr.io/bfritscher/typesense-dashboard:latest
      ports:
        - '18108:80'
      #very important: include the entrypoint command from the upstream Dockerfile
      command: 'caddy file-server'

# optional: expose endpoints to frontend for testing
proxy:
  search:
    - search.yoursite.lndo.site:8108
  search-dashboard:
    - search-dashboard.yoursite.lndo.site

#optional: do a sync with `lando search/sync`
tooling:
  search/sync:
    service: appserver
    description: Sync Typesense collections and index with server
    cmd: ./vendor/bin/sake dev/tasks/TypesenseSyncTask

The two local Typesense images are not actually necessary: you can develop against an externally hosted Typesense installation if that suits your needs better. Typesense Cloud, for example, can provide a dev and uat instance to avoid interfering with your production loads.

The dashboard application is available publicly at https://bfritscher.github.io/typesense-dashboard as an alternative to running it in a container. It is an “offline” application in that it can be saved offline and run inside a private network without an external internet connection. It can also be used to connect to any Typesense installation in the world, as long as that installation has CORS enabled and the domain has been whitelisted.