grim/containers/oauth-kludge

Add a basic README.md

2020-11-22, Gary Kramlich
cfb3a5d491b7
Parents dcbfc4fd58e8
Children ff4a8174d97b
Add a basic README.md
1 files changed, 20 insertions(+), 0 deletions(-)
  • +20 -0
    README.md
    • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/README.md Sun Nov 22 03:49:26 2020 -0600
    @@ -0,0 +1,20 @@
    +# oauth-kludge
    +
    +This kludge is to tack a scope onto a Resource Owner Password Credentials Grant
    +because some OAuth2 providers, namely JetBrains Hub require the Scope even
    +thought it is optional according to
    +[RFC 6749](https://tools.ietf.org/html/rfc6749#section-4.3.2).
    +
    +## Configuration
    +
    +This service supports a few configuration arguments that must be specified via
    +environment variables.
    +
    +`OAUTH_KLUDGE_LISTEN_ADDR`: The address to listen on. Defaults to `:8080`
    +
    +`OAUTH_KLUDGE_SCOPE`: The value of the scope field to add to the requests. This
    +is implementation specific and is **required**.
    +
    +`OAUTH_KLUDGE_TOKEN_ENDPOINT`: The actual URL that the kludged request should
    +be proxied to. This is implementation specific and is **required**.
    +