From 50a5bb60af17de9c88153ee436f2d83de9a0a180 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Tue, 18 Apr 2017 17:30:53 -0700 Subject: [PATCH] Add a note about official docker images --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 2433a4448..555242bf6 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,32 @@ variables. Example: ## Docker +### Running pre-build docker image + +Official docker images are built and hosted on +[hub.docker.com](https://hub.docker.com/r/cloudflare/unsee/). + +Images are built automatically for: + + * release tags in git - `cloudflare/unsee:vX.Y.Z` + * master branch commits - `cloudflare/unsee:latest` + +#### Examples + +To start a release image run: + + docker run -e ALERTMANAGER_URI=https://alertmanager.example.com cloudflare/unsee:vX.Y.Z + +Latest release details can be found on +[GitHub](https://github.com/cloudflare/unsee/releases). + +To start docker image build from lastet master branch run: + + docker run -e ALERTMANAGER_URI=https://alertmanager.example.com cloudflare/unsee:latest + +Note that latest master branch might have bugs or breaking changes. Using +release images is strongly recommended for any production use. + ### Building a Docker image make docker-image