From 5f3d54948c268753bd0d728e07f24daa22203b64 Mon Sep 17 00:00:00 2001
From: SeanOMik <seanomik@gmail.com>
Date: Sat, 29 Apr 2023 16:58:03 -0400
Subject: [PATCH] Add docker instructions to readme.md

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 443dfe6..cee0132 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,14 @@ Options:
   -V, --version                      Print version
 ```
 
+### Docker
+The docker image is a multi-stage build, so its pretty small. You can either build it yourself, or just pull it from GitHub container registry. The image does need to run as privileged so it can collect zfs pool metrics. I'm not sure if there's a way to get it to scrape host zfs pool info without it being privileged.
+
+```shell
+$ docker pull ghcr.io/seanomik/zfs_promexporter:latest
+$ docker run --rm -d --privileged -p 8080:8080 --name zfs_exporter ghcr.io/seanomik/zfs_promexporter:latest
+```
+
 ## What Metrics Are Exported?
 * `zfs_health` (`enum`): Represents the device's health, can be `online`, `degraded`, `faulted`, `offline`, `available`, `unavailable` and `removed`. The state is stored in the `state` label, and the value is `0` for not-in-state, and `1` for in-state.
 * `zfs_read_errors` (int counter): The amount of read errors for this device.