-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #71 from ClickHouse/deprecate-repo
Deprecate this repository
- Loading branch information
Showing
1 changed file
with
3 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,124 +1,5 @@ | ||
| # Homebrew Tap for ClickHouse | ||
| # (Deprecated) Homebrew Tap for ClickHouse | ||
|
|
||
| ## Available formulae | ||
| This repository is deprecated and no more work will be done on this. You can continue to use this and it should work as-is but any future issues will not be fixed. | ||
|
|
||
| ```text | ||
| clickhouse - alias, points to the latest release (clickhouse@23.5) | ||
| clickhouse@lts - alias, points to the latest LTS release (clickhouse@22.3) | ||
| clickhouse@23.5 - the latest release, version: 23.5.3.24-stable | ||
| clickhouse@22.7 - keg-only, version: 22.7.2.15-stable | ||
| clickhouse@22.6 - keg-only, version: 22.6.4.35-stable | ||
| clickhouse@22.5 - keg-only, version: 22.5.3.21-stable | ||
| clickhouse@22.4 - keg-only, version: 22.4.6.53-stable | ||
| clickhouse@22.3 - keg-only, version: 22.3.9.19-lts | ||
| clickhouse@22.2 - keg-only, version: 22.2.3.5-stable | ||
| clickhouse@22.1 - keg-only, version: 22.1.4.30-stable | ||
| ``` | ||
|
|
||
| ## Quick start: one-liner | ||
|
|
||
| ```sh | ||
| brew install clickhouse/clickhouse/clickhouse | ||
| ``` | ||
|
|
||
| ## Quick start: fine control | ||
|
|
||
| First, register the tap (needs to be done only once): | ||
|
|
||
| ```sh | ||
| brew tap clickhouse/clickhouse | ||
| ``` | ||
|
|
||
| Then, install the formula: | ||
|
|
||
| ```sh | ||
| brew install clickhouse | ||
| # ..or | ||
| brew install clickhouse@23.5 | ||
| # ...and so on. | ||
| ``` | ||
|
|
||
| Please always read the `Caveats` sections displayed after installation carefully. | ||
|
|
||
| Note that the installation doesn't require `sudo` and will deploy ClickHouse under the standard Homebrew prefix. | ||
|
|
||
| ## Running ClickHouse server | ||
|
|
||
| Do not use `sudo`, ever. Do not start the ClickHouse server manually, instead use `brew services`: | ||
|
|
||
| ```sh | ||
| brew services start clickhouse | ||
| # ..or | ||
| brew services start clickhouse@23.5 | ||
| # ...and so on. | ||
| ``` | ||
|
|
||
| ClickHouse is deployed under the standard Homebrew prefix. The relevant directories are: | ||
|
|
||
| ```text | ||
| Config: $(brew --prefix)/etc/clickhouse-server/ | ||
| Data: $(brew --prefix)/var/lib/clickhouse/ | ||
| Logs: $(brew --prefix)/var/log/clickhouse-server/ | ||
| PID file: $(brew --prefix)/var/run/clickhouse-server/ | ||
| ``` | ||
|
|
||
| These files and directories will be preserved between installations. | ||
|
|
||
| Make sure you stop the server, when upgrading the formula. | ||
|
|
||
| If you absolutely need to run ClickHouse server manually, the command that corresponds to `brew services start clickhouse` would be: | ||
|
|
||
| ```sh | ||
| $(brew --prefix clickhouse)/bin/clickhouse server --config-file $(brew --prefix)/etc/clickhouse-server/config.xml --pid-file $(brew --prefix)/var/run/clickhouse-server/clickhouse-server.pid | ||
| ``` | ||
|
|
||
| ## Versioned formulae | ||
|
|
||
| All except the latest versioned ClickHouse formulae are configured as [keg-only](https://docs.brew.sh/FAQ#what-does-keg-only-mean), so in order to refer to an executable from such formula you have to provide the full path to it, e.g.: | ||
|
|
||
| ```sh | ||
| $(brew --prefix clickhouse@21.11)/bin/clickhouse client | ||
| ``` | ||
|
|
||
| ## Pre-built binary packages (bottles) | ||
|
|
||
| Bottles for the following platforms are available: | ||
|
|
||
| ```text | ||
| macOS Monterey (version 12) on Intel | ||
| macOS Monterey (version 12) on Apple silicon | ||
| ``` | ||
|
|
||
| Eventually, this list will be extended to also contain some of the previous versions of macOS. | ||
|
|
||
| ## Building (the latest versions) from sources | ||
|
|
||
| Formulae will be built from sources automatically if the corresponding bottles are not available for your platform. | ||
|
|
||
| It could take several hours to build ClickHouse from sources, so you will probably want to monitor the progress. To enable verbose output for that scenario, add `--verbose` to `brew install ...`: | ||
|
|
||
| ```sh | ||
| brew install --verbose clickhouse | ||
| ``` | ||
|
|
||
| You can also build the latest version (`HEAD`) of the sources for a formula: | ||
|
|
||
| ```sh | ||
| brew install --HEAD --verbose clickhouse | ||
| ``` | ||
|
|
||
| The above command will check out the tip of the branch that corresponds to that specific version (e.g., branch [21.11](https://github.com/ClickHouse/ClickHouse/tree/21.11) for `clickhouse@21.11` and so on) and build it from sources. | ||
|
|
||
| ## Homebrew on Linux (Linuxbrew) | ||
|
|
||
| Building the formulae from this tap is not tested in Linux, and bottles are not available, but there are no known conceptual problems, and they should generally work. Feel free to experiment and report any [issues](https://github.com/clickhouse/homebrew-clickhouse/issues). | ||
|
|
||
| ## Adding or updating formulae in this tap (for maintainers only) | ||
|
|
||
| Refer to [Maintenance](MAINTENANCE.md) for instructions. | ||
|
|
||
| ## Useful links | ||
|
|
||
| - [ClickHouse](https://clickhouse.com/) | ||
| - [Homebrew](https://brew.sh) | ||
| Please use the community-maintained [ClickHouse brew formula](https://formulae.brew.sh/cask/clickhouse) ([sources](https://github.com/Homebrew/homebrew-cask/blob/master/Casks/c/clickhouse.rb)). |