diff --git a/README.md b/README.md index d234e65457..b879363493 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,17 @@ https://github.com/timeplus-io/proton/assets/5076438/8ceca355-d992-4798-b861-1e0 ```shell curl https://install.timeplus.com/oss | sh ``` +Once the `proton` binary is available, you can run Timeplus Proton in different modes: + +- **Local Mode.** You run `proton local` to start it for fast processing on local and remote files using SQL without having to install a full server +- **Config-less Mode.** You run `proton server` to start the server and put the config/logs/data in the current folder `proton-data`. Then use `proton client` in the other terminal to start the SQL client. +- **Server Mode.** You run `sudo proton install` to install the server in predefined path and a default configuration file. Then you can run `sudo proton server -C /etc/proton-server/config.yaml` to start the server and use `proton client` in the other terminal to start the SQL client. + +For Mac users, you can also use [Homebrew](https://brew.sh/) to manage the install/upgrade/uninstall: + +```shell +brew install timeplus-io/timeplus/proton +``` ### Docker: @@ -58,6 +69,12 @@ docker run -d --pull always --name proton ghcr.io/timeplus-io/proton:latest ``` In case you cannot access ghcr, you can pull the image from `public.ecr.aws/timeplus/proton` +You may need to expose ports from the Proton container so that other tools can connect to it, such as DBeaver. Please check [Server Ports](https://docs.timeplus.com/proton-ports) for each port to expose. For example: + +```shell +docker run -d --pull always -p 8123:8123 -p 8463:8463 --name proton ghcr.io/timeplus-io/proton:latest +``` + ### Docker Compose: The [Docker Compose stack](https://github.com/timeplus-io/proton/tree/develop/examples/ecommerce) demonstrates how to read/write data in Kafka/Redpanda with external streams. @@ -68,7 +85,9 @@ One step to try Timeplus Proton in [Timeplus Cloud](https://us.timeplus.cloud/) ### 🔎 Usage -You can start the server via `proton server` and start a new terminal window with `proton client` to start the SQL shell. +SQL is the main interface. You can start a new terminal window with `proton client` to start the SQL shell. +> [!NOTE] +> You can also integrate Timeplus Proton with Python/Java/Go SDK, REST API, or BI plugins. Please check Integrations From `proton client`, run the following SQL to create a stream of random data: @@ -104,8 +123,8 @@ What features are available with Timeplus Proton versus Timeplus Enterprise? | | **Timeplus Proton** | **Timeplus Enterprise** | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Deployment** | | | -| **Data sources** | | | +| **Deployment** | | | +| **Data sources** | | | | **Data destinations (sinks)** | | | | **Support** | | | @@ -119,6 +138,7 @@ The following drivers are available: Integrations with other systems: * ClickHouse https://docs.timeplus.com/proton-clickhouse-external-table +* Sling https://docs.timeplus.com/sling * Grafana https://github.com/timeplus-io/proton-grafana-source * Metabase https://github.com/timeplus-io/metabase-proton-driver * Pulse UI https://github.com/timeplus-io/pulseui/tree/proton