Typesense Homebrew Tap

This repo contains Typesense's Homebrew Tap.

Compatibility

As of Typesense v26.0, we only recommend using homebrew for macOS Ventura (13.x) or above.

For older versions of macOS, we recommend using the Docker or Docker Compose installation method for compatibility and performance reasons.

Installation

To install the latest version of Typesense:

brew install typesense/tap/typesense-server

To install a specific version of Typesense:

brew install typesense/tap/[email protected]

Documentation

For brew docs: brew help, man brew or check Homebrew's documentation.

Defaults

• Configuration files are under: ${HOMEBREW_PREFIX}/etc/typesense/
• Logs are under: ${HOMEBREW_PREFIX}/var/log/typesense/
• Data dir is under: ${HOMEBREW_PREFIX}/var/lib/typesense/
• The default admin api-key is xyz.
• The default API port is 8108

where ${HOMEBREW_PREFIX} is usually /usr/local.

Start service

To start the typesense-server service:

brew services start typesense-server

Now check the health of the server:

curl http://localhost:8108/health
{"ok":true}

If you don't see {"ok": true}, check the logs under ${HOMEBREW_PREFIX}/var/log/typesense/ for any issues or progress.

${HOMEBREW_PREFIX} is usually /usr/local.

Restart service

To restart the typesense-server service:

brew services restart typesense-server

Stop service

To stop the typesense-server service:

brew services stop typesense-server

Standalone

You can also run typesense-server from any path:

mkdir typesense-data
typesense-server --api-key=xyz --data-dir=./typesense-data

Typesense Docs

For Typesense docs, see: https://typesense.org/docs/api/

Tap Developer Workflow

This section is only applicable if you're adding a new version to this tap.

Dependencies

brew install curl sha2 (curl is keg-only, so make sure it is available in PATH following the post-install instructions)

Add a new version

1. Copy previous version to a new file called ./Formula/[email protected]
2. Calculate SHA of ARM and x86_64 builds: curl -sL https://dl.typesense.org/releases/26.0/typesense-server-26.0-darwin-<amd64|arm64>.tar.gz | shasum -a 256
3. Update the SHA and URLs in the SHA
4. Run brew style . --fix
5. Test locally brew install ./Formula/[email protected] --debug