Skip to content

Commit 53222b2

Browse files
committed
doc: Update README with installation from releases.
1 parent 7feb6b2 commit 53222b2

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,28 @@ Blobasaur is a high-performance, sharded blob storage server written in Rust. It
6262

6363
## Installation
6464

65+
### From GitHub Releases
66+
67+
You can download pre-compiled binaries for Linux from the [GitHub Releases page](https://github.com/iamd3vil/blobasaur/releases).
68+
69+
1. **Download the latest release:**
70+
71+
For example, to download version `v0.1.0`:
72+
```bash
73+
wget https://github.com/iamd3vil/blobasaur/releases/download/v0.1.0/blobasaur-Linux-musl-x86_64.tar.gz
74+
```
75+
76+
2. **Extract the archive:**
77+
```bash
78+
tar -xvf blobasaur-Linux-musl-x86_64.tar.gz
79+
```
80+
81+
3. **Run the binary:**
82+
The binary inside the archive is named `blobasaur`. You can run it directly:
83+
```bash
84+
./blobasaur
85+
```
86+
6587
### Prerequisites
6688

6789
- **Rust toolchain** (latest stable recommended) - [Install Rust](https://rustup.rs/)
@@ -167,6 +189,20 @@ blobasaur --help
167189
- `--config, -c`: Path to configuration file (default: `config.toml`)
168190
- `--help`: Display help information
169191
192+
## Metrics
193+
194+
Blobasaur exposes a wide range of metrics for monitoring, compatible with Prometheus. You can track command latency, connection counts, cache performance, and much more.
195+
196+
To enable the metrics server, add the following to your `config.toml`:
197+
198+
```toml
199+
[metrics]
200+
enabled = true
201+
addr = "0.0.0.0:9090"
202+
```
203+
204+
For a complete list of available metrics and example usage with Prometheus and Grafana, please see the [METRICS.md](METRICS.md) documentation.
205+
170206
## Configuration
171207
172208
### Basic Configuration

0 commit comments

Comments
 (0)