gate is a static file server and reverse proxy integrated with OAuth2 account authentication.
With gate, you can safely serve your private resources based on whether or not request user is a member of your company's Google Apps or GitHub organizations.
- Download binary or
go get - rename
config_sample.ymltoconfig.yml - edit
config.ymlto fit your environment - run
gate
# address to bind
address: :9999
# # ssl keys (optional)
# ssl:
# cert: ./ssl/ssl.cer
# key: ./ssl/ssl.key
auth:
session:
# authentication key for cookie store
key: secret123
info:
# oauth2 provider name (`google` or `github`)
service: google
# your app keys for the service
client_id: your client id
client_secret: your client secret
# your app redirect_url for the service: if the service is Google, path is always "/oauth2callback"
redirect_url: https://yourapp.example.com/oauth2callback
# # restrict user request. (optional)
# restrictions:
# - yourdomain.com # domain of your Google App (Google)
# - example@gmail.com # specific email address (same as above)
# - your_company_org # organization name (GitHub)
# document root for static files
htdocs: ./
# proxy definitions
proxy:
- path: /elasticsearch
dest: http://127.0.0.1:9200
strip_path: yes
- path: /influxdb
dest: http://127.0.0.1:8086
strip_path: yesgate now supports Google Apps and GitHub to authenticate users.
auth:
info:
service: google
client_id: your client id
client_secret: your client secret
redirect_url: https://yourapp.example.com/oauth2callback
# restrict user request. (optional)
restrictions:
- yourdomain.com # domain of your Google App
- example@gmail.com # specific email addressUnlike the example of Google Apps above, if the service is GitHub, gate uses whether request user is a member of organization designated like below:
auth:
info:
service: github
client_id: your client id
client_secret: your client secret
redirect_url: https://yourapp.example.com/oauth2callback
# restrict user request. (optional)
restrictions:
- foo_organization
- bar_organizationGitHub Enterprise is also supported. To authenticate via github enterprise, add api endpoint information to config like following:
auth:
info:
service: github
client_id: your client id
client_secret: your client secret
redirect_url: https://yourapp.example.com/oauth2callback
endpoint: https://github.yourcompany.com
api_endpoint: https://github.yourcompany.com/apiAn example of "Name Based Viatual Host" setting.
auth:
session:
# authentication key for cookie store
key: secret123
# domain of virtual hosts base host
cookie_domain: gate.example.com
# proxy definitions
proxy:
- path: /
host: elasticsearch.gate.example.com
dest: http://127.0.0.1:9200
- path: /
host: influxdb.gate.example.com
dest: http://127.0.0.1:8086MIT