Skip to content

Commit eae3c4e

Browse files
committed
update README
1 parent 9c08f65 commit eae3c4e

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ The following environment variables can be used to configure gitmproxy:
1818
| `ENTRY_MAX_SIZE` | Maximum size for a single cached response (e.g., 500MB) | `500MB` |
1919
| `ENTRY_TTL` | Time-to-live for each cache entry (e.g., 1h, 0 = none) | `1h` |
2020
| `ENABLE_LOGGING` | Enable logging of cache operations (`true`/`false`) | `true` |
21+
| `IGNORE_SERVER_CACHE_CONTROL` | Ignore cache control headers from the server (`true`/`false`) | `false` |
2122

2223
## Getting Started
2324

@@ -36,8 +37,17 @@ services:
3637
ENTRY_MAX_SIZE: "500MB"
3738
ENTRY_TTL: "1h"
3839
ENABLE_LOGGING: "true"
40+
IGNORE_SERVER_CACHE_CONTROL: "false"
3941
volumes:
4042
- ./cache:/cache
4143
```
4244
4345
This will start gitmproxy on port 8090 with a persistent cache directory. Adjust environment variables and volume paths as needed for your setup.
46+
47+
## Prometheus Metrics Endpoint
48+
49+
gitmproxy exposes a Prometheus-compatible metrics endpoint at `/_gitmproxy_metrics`.
50+
51+
- You can access metrics by visiting `http://<proxy_host>:<proxy_port>/_gitmproxy_metrics`.
52+
- This endpoint provides statistics such as HTTP request counts and cache performance.
53+
- Integrate this endpoint with your Prometheus server for monitoring.

0 commit comments

Comments
 (0)