From a2a139cdcb99699af8391ee0cb3b6eef35399dc3 Mon Sep 17 00:00:00 2001 From: Peter Gundel Date: Sun, 26 May 2019 14:36:33 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20usage=20and=20quay.io=20re?= =?UTF-8?q?ference?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 3 --- README.md | 8 ++++++++ 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 39d6b55..7000a08 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,5 @@ # Changelog -(see http://keepachangelog.com http://semver.org) -(critical comment about semver: https://gist.github.com/jashkenas/cbd2b088e20279ae2c8e) - ## Unreleased ## [0.1] - 2019-05-26 diff --git a/README.md b/README.md index 882528c..e3c7652 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ This Docker image provides a simple Nginx reverse proxy that can be used to prox The purpose of this simple proxy is to be used in Kubernetes to proxy requests to an external service. Kubernetes has a service type `ExternalName` but there you can't have any advanced configuration like setting headers. Also the annotations on an `Ingress` are very limited for now. +## Usage + +```bash +docker run -p 80:80 --rm -e PROXY_URL=example.com quay.io/store2be/nginx-reverse-proxy +``` + +Find the available versions on [quay.io](https://quay.io/repository/store2be/nginx-reverse-proxy?tab=tags) ([Changelog](CHANGELOG.md)). + ## Environment variables Have a look at [entrypoint.sh](entrypoint.sh) for how the environment variables change the Nginx config.