1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2024-12-10 11:10:27 +02:00
oauth2-proxy/docs
Karl Skewes c4f20fff3d Add exclude logging path option
Useful for excluding /ping endpoint to reduce log volume.
This is somewhat more verbose than a simple bool to disable logging of
the `/ping` endpoint.

Perhaps better to add `-silence-ping-logging` bool flag to `options.go` and
pass in the `/ping` endpoint as part of `logger` declaration in `options.go`.

Could be extended into a slice of paths similar to go-gin's `SkipPaths`:
https://github.com/gin-gonic/gin/blob/master/logger.go#L46
2019-07-16 09:43:47 +12:00
..
assets/js Initialise Jekyll site 2019-05-09 10:48:35 +01:00
configuration Add exclude logging path option 2019-07-16 09:43:47 +12:00
_config.yml Set Jekyll URL to https://pusher.github.io/oauth2_proxy 2019-05-09 11:52:11 +01:00
.gitignore Initialise Jekyll site 2019-05-09 10:48:35 +01:00
0_index.md split README.MD into pages 2019-05-09 11:06:32 +01:00
1_installation.md Shorten README.md (#154) 2019-05-10 12:25:05 +01:00
2_auth.md split README.MD into pages 2019-05-09 11:06:32 +01:00
4_tls.md split README.MD into pages 2019-05-09 11:06:32 +01:00
5_endpoints.md split README.MD into pages 2019-05-09 11:06:32 +01:00
6_request_signatures.md split README.MD into pages 2019-05-09 11:06:32 +01:00
404.html Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Gemfile Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Gemfile.lock Initialise Jekyll site 2019-05-09 10:48:35 +01:00
Makefile Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00
README.md Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00

Docs

This folder contains our Jekyll based docs site which is hosted at https://pusher.github.io/oauth2_proxy.

When making changes to this docs site, please test your changes locally:

make serve

To run the docs site locally you will need Ruby at version 2.1.0 or higher and bundle (gem install bundler if you already have Ruby).