An http proxy that uses the DiscourseConnect protocol to authenticate users

Go to file

Saj Goonatilleke 6fa4ba03da Remove log noise written on the common path Implement analogous functionality in the `logHandler` if you care about this information. That middleware can at least be toggled on and off.		2019-07-13 07:42:17 +10:00
internal/httpproxy	Optionally use DNS SRV records for origin discovery	2019-05-07 04:48:50 +10:00
.gitignore	Initial commit	2015-04-15 13:18:18 +10:00
Dockerfile	Move all this config gubbins out of the way	2019-05-15 21:26:02 +10:00
Makefile	new build regime	2018-09-21 15:01:58 +08:00
README.md	FIX: we moved the image	2019-07-03 12:49:57 -04:00
config.go	Allow SRV deadline to be configured at runtime	2019-05-15 23:34:49 +10:00
logging.go	Add support for optional request logging	2019-05-15 21:26:35 +10:00
main.go	Remove log noise written on the common path	2019-07-13 07:42:17 +10:00
main_test.go	Fix tests	2019-05-15 17:44:44 +10:00
start.sh	new build regime	2018-09-21 15:01:58 +08:00

README.md

Discourse Auth Proxy

This package allows you to use Discourse as an SSO endpoint for an arbitrary site.

Discourse SSO is invoked prior to serving the proxied site. This allows you to reuse Discourse Auth in a site that ships with no auth.

Usage:

Usage of ./discourse-auth-proxy:
  -listen-url="": uri to listen on eg: localhost:2001. leave blank to set equal to proxy-url
  -origin-url="": origin to proxy eg: http://localhost:2002
  -proxy-url="": outer url of this host eg: http://secrets.example.com
  -sso-secret="": SSO secret for origin
  -sso-url="": SSO endpoint eg: http://discourse.forum.com
  -allow-all: don't restrict access to "admin" users on the SSO endpoint
  -timeout="10": Read/Write timeout

+--------+    proxy-url   +---------+    listen-url    +----------------------+
|  User  |  ============> |  Nginx  |  ==============> | discourse-auth-proxy |
+--------+                +---------+                  +----------------------+
    |                                                             |
    | sso-url                                          origin-url |
    |                                                             |
    v                                                             v
+-----------+                                          +----------------------+
| Discourse |                                          | Protected web server |
+-----------+                                          +----------------------+

Environment variables may be used as a substitute for command-line flags, e.g.:

ORIGIN_URL='http://somesite.com' \
PROXY_URL='http://listen.com' \
SSO_SECRET='somesecret' \
SSO_URL='http://somediscourse.com' \
./discourse-auth-proxy

-origin-url may specify a name equipped with RFC 2782 DNS SRV records, such as http://_foo._tcp.example.com. If SRV records are found in the DNS, each request is proxied to a host and port taken from these records.

Docker Image

You may run using docker using

docker run discourse/auth-proxy

Running will display configuration instructions