Skip to content

readme: add instructions on how to install locally and fix stale telemetry url docs #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stanislavkozlovski wants to merge 4 commits into
base: main
Choose a base branch
from
Open

readme: add instructions on how to install locally and fix stale telemetry url docs #498

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
23a3f9c
Update README with installation instructions
stanislavkozlovski Nov 11, 2025
8a4b8f3
add initdb wording and fix stale docs
stanislavkozlovski Nov 12, 2025
5fe338b
Enhance README with quickstart and local setup
stanislavkozlovski Nov 12, 2025
5867a01
Update README to recommend Docker for quickstart
stanislavkozlovski Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 42 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,24 @@ Tansu is a single statically linked binary containing the following:
- **cat** a CLI to consume or produce Avro, JSON or Protobuf messages to a topic
- **proxy** an Apache Kafka compatible proxy

# Next Steps

## Quickstart

Start quickly by setting up a Tansu broker via:

- **Docker** (recommended)
- [S3-based engine](#s3)
- [PostgreSQL-based engine](#postgresql)
- **Local installation**
- [Build and run locally](#local)

## Learn Tansu

- **[The CLI tools](#cli)

Copy link
Contributor Author

@stanislavkozlovski stanislavkozlovski Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can add Learn the Architecture, etc. when the time comes

# CLI

## broker

The broker subcommand is default if no other command is supplied.
Expand Down Expand Up @@ -60,8 +78,8 @@ Options:
Apache Iceberg Catalog, examples are: http://localhost:8181/ [env: ICEBERG_CATALOG=http://localhost:8181/]
--iceberg-namespace <ICEBERG_NAMESPACE>
Iceberg namespace [env: ICEBERG_NAMESPACE=] [default: tansu]
--prometheus-listener-url <PROMETHEUS_LISTENER_URL>
Broker metrics can be scraped by Prometheus from this URL [env: PROMETHEUS_LISTENER_URL=tcp://0.0.0.0:9100] [default: tcp://[::]:9100]
--otlp-endpoint-url <OTLP_ENDPOINT_URL>
OTEL Exporter OTLP endpoint for pushing metrics and traces [env: OTEL_EXPORTER_OTLP_ENDPOINT=]
-h, --help
Print help
-V, --version
Expand Down Expand Up @@ -152,6 +170,15 @@ Results in the following output:
|-----------+---------+---------------+-------------+---------------|
```

# Install

```shell
git clone https://github.com/tansu-io/tansu
cd tansu
```


## Docker

### s3

Expand Down Expand Up @@ -347,11 +374,22 @@ Consumer:
-b localhost:9092
```

## Feedback
## Local

```shell
cargo install --path tansu --all-features
~/.cargo/bin/tansu -h
```

### Postgres

For now, you have to manually run the [initdb script](etc/initdb.d/010-schema.sql) before starting tansu for the first time.

# Feedback

Please [raise an issue][tansu-issues] if you encounter a problem.

## License
# License

Tansu is licensed under [Apache 2.0][apache-license].

Expand Down