https://github.com/typesense/homebrew-tap
Homebrew Formulae for Typesense
https://github.com/typesense/homebrew-tap
Last synced: about 1 year ago
JSON representation
Homebrew Formulae for Typesense
- Host: GitHub
- URL: https://github.com/typesense/homebrew-tap
- Owner: typesense
- License: apache-2.0
- Created: 2022-05-31T03:29:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-22T04:10:01.000Z (over 1 year ago)
- Last Synced: 2025-04-17T07:17:30.569Z (about 1 year ago)
- Language: Ruby
- Size: 50.8 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://typesense.org/docs/guide/install-typesense.html#docker) or [Docker Compose](https://typesense.org/docs/guide/install-typesense.html#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/typesense-server@28.0
```
## Documentation
For brew docs: `brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).
### 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/](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/typesense-server@28.0.rb`
2. Calculate SHA of ARM and x86_64 builds: `curl -sL https://dl.typesense.org/releases/28.0/typesense-server-28.0-darwin-.tar.gz | shasum -a 256`
3. Update the SHA and URLs in the SHA, update the class name
4. Run `cd Aliases; ln -sfn ../Formula/typesense-server@28.0.rb typesense-server`
5. Run `brew style . --fix`
6. Test locally `brew install ./Formula/typesense-server@28.0.rb --debug`