Skip to content

Commit 0d172eb

Browse files
authored
Add Docker section to README with container usage and environment variables
1 parent 0603e11 commit 0d172eb

1 file changed

Lines changed: 103 additions & 0 deletions

File tree

README.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,109 @@
2929
* Setup & Deploy **gigapipe** _opensource_ using the [documentation](https://gigapipe.com/docs/oss) and get help in our [Matrix room](https://matrix.to/#/#qryn:matrix.org) :octocat:
3030
* Looking for a quick test before installing? Signup for a free trial at [gigapipe.com](https://gigapipe.com)
3131

32+
## 🐳 Docker
33+
34+
Run **gigapipe** using Docker containers with support for multiple architectures (linux/amd64, linux/arm64).
35+
36+
### Quick Start
37+
38+
Pull and run the latest gigapipe container:
39+
40+
```bash
41+
docker run -p 3100:3100 ghcr.io/metrico/gigapipe:latest
42+
```
43+
44+
### With ClickHouse Backend
45+
46+
Connect gigapipe to a ClickHouse database:
47+
48+
```bash
49+
docker run -p 3100:3100 \
50+
-e CLICKHOUSE_SERVER=your-clickhouse-host \
51+
-e CLICKHOUSE_PORT=9000 \
52+
-e CLICKHOUSE_DB=cloki \
53+
-e CLICKHOUSE_AUTH=username:password \
54+
ghcr.io/metrico/gigapipe:latest
55+
```
56+
57+
### With Authentication
58+
59+
Enable basic authentication:
60+
61+
```bash
62+
docker run -p 3100:3100 \
63+
-e QRYN_LOGIN=admin \
64+
-e QRYN_PASSWORD=your-secure-password \
65+
ghcr.io/metrico/gigapipe:latest
66+
```
67+
68+
### Environment Variables
69+
70+
Configure gigapipe using environment variables:
71+
72+
#### Database Configuration
73+
74+
| Variable | Description | Default |
75+
|----------|-------------|----------|
76+
| `CLICKHOUSE_SERVER` | ClickHouse server address | `localhost` |
77+
| `CLICKHOUSE_PORT` | ClickHouse port | `9000` |
78+
| `CLICKHOUSE_DB` | Database name | `cloki` |
79+
| `CLICKHOUSE_AUTH` | Authentication (format: `username:password`) | - |
80+
| `CLICKHOUSE_PROTO` | Protocol (`http`, `https`, `tls`) | - |
81+
| `SELF_SIGNED_CERT` | Allow self-signed certificates (`true`/`false`) | `false` |
82+
| `SAMPLES_DAYS` | TTL for samples in days | `7` |
83+
| `STORAGE_POLICY` | ClickHouse storage policy | - |
84+
| `OMIT_CREATE_TABLES` | Skip table creation (`true`/`false`) | `false` |
85+
| `ADVANCED_SAMPLES_ORDERING` | Samples ordering strategy | - |
86+
87+
#### HTTP Server
88+
89+
| Variable | Description | Default |
90+
|----------|-------------|----------|
91+
| `PORT` | HTTP port | `3100` |
92+
| `HOST` | HTTP host | `0.0.0.0` |
93+
| `CORS_ALLOW_ORIGIN` | CORS origin for cross-origin requests | - |
94+
95+
#### Authentication
96+
97+
| Variable | Description | Default |
98+
|----------|-------------|----------|
99+
| `QRYN_LOGIN` / `CLOKI_LOGIN` | Basic auth username | - |
100+
| `QRYN_PASSWORD` / `CLOKI_PASSWORD` | Basic auth password | - |
101+
102+
#### System Settings
103+
104+
| Variable | Description | Default |
105+
|----------|-------------|----------|
106+
| `MODE` | Operation mode (`all`, `reader`, `writer`, `init_only`) | `all` |
107+
| `READONLY` | Set to `true` for read-only mode | `false` |
108+
| `BULK_MAX_SIZE_BYTES` | Maximum bulk size in bytes | - |
109+
| `BULK_MAX_AGE_MS` | Maximum bulk age in milliseconds | `100` |
110+
| `ADVANCED_PROMETHEUS_MAX_SAMPLES` | Max samples for Prometheus queries | - |
111+
| `ADVANCED_OMIT_EMPTY_VALUES` | Omit empty values in queries (`true`/`false`) | `false` |
112+
113+
#### Log Drilldown
114+
115+
| Variable | Description | Default |
116+
|----------|-------------|----------|
117+
| `LOG_DRILLDOWN` | Enable log drilldown feature (`true`/`false`) | `false` |
118+
| `LOG_PATTERN_SIMILARITY` | Pattern similarity threshold (0-1) | `0.7` |
119+
| `LOG_PATTERN_READ_LIMIT` | Number of patterns to read | `300` |
120+
121+
#### Compatibility & Logging
122+
123+
| Variable | Description | Default |
124+
|----------|-------------|----------|
125+
| `COMPAT_4_0_19` | Enable Loki 4.0.19 compatibility (`true`/`false`) | `false` |
126+
| `LOG_LEVEL` | Log level | - |
127+
128+
#### Pyroscope Profiling
129+
130+
| Variable | Description | Default |
131+
|----------|-------------|----------|
132+
| `PYROSCOPE_SERVER_ADDRESS` | Pyroscope server address | - |
133+
| `PYROSCOPE_APPLICATION_NAME` | Application name for profiling | `gigapipe` |
134+
32135
## Features
33136
💡 _**gigapipe** independently implements popular observability standards, protocols and query languages_
34137

0 commit comments

Comments
 (0)