oauth2_proxy/docs
Karl Skewes ec97000169 Add silence ping logging flag
Add ability to silence logging of requests to /ping endpoint, reducing
log clutter

Pros:
- Don't have to change all handlers to set/not set silent ping logging
- Don't have to duplicate `loggingHandler` (this could be preferable yet)

Cons:
- Leaking oauth2proxy logic into `package logger`
- Defining default pingPath in two locations

Alternative:
- Add generic exclude path to `logger.go` and pass in `/ping`.
2019-07-16 09:42:24 +12:00
..
assets/js Initialise Jekyll site 2019-05-09 10:48:35 +01:00
configuration Add silence ping logging flag 2019-07-16 09:42:24 +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).