oauth2-proxy/docs
Jakub Holy 0fc4131c72
configuration.md: clarify CLI -> config options (#442)
Clarify how to rename CLI options to be able to set them in the config file. I have just spent an hour trying to find out why `whitelist_domain="..."` does not work :-)

Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>
2020-03-13 20:21:15 +00:00
..
assets/js Initialise Jekyll site 2019-05-09 10:48:35 +01:00
configuration configuration.md: clarify CLI -> config options (#442) 2020-03-13 20:21:15 +00:00
logos Add logos to docs folder 2019-10-30 09:57:24 +00:00
.gitignore Initialise Jekyll site 2019-05-09 10:48:35 +01:00
0_index.md Add logo to docs site 2019-10-30 10:04:29 +00:00
1_installation.md Rewrite dist script (#302) 2019-10-29 17:27:08 +00:00
2_auth.md Add preferred_username support (OIDC provider) (#420) 2020-03-01 15:02:51 +00:00
4_tls.md Add reverse proxy setting (#331) 2020-01-24 17:54:13 +00:00
5_endpoints.md Add sign_out endpoint to endpoint documentation page (#383) 2020-02-05 16:28:51 +00:00
6_request_signatures.md Fix links in docs 2019-08-11 16:07:03 +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 Bump nokogiri from 1.10.4 to 1.10.8 in /docs (#422) 2020-02-28 18:26:40 +00:00
Makefile Add make targets for serving docs locally 2019-05-10 12:07:16 +01:00
README.md Fix #384 - link to sessions.md (#391) 2020-02-15 14:41:35 +00:00
_config.yml Add logo to docs site 2019-10-30 10:04:29 +00:00

README.md

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:

docs$ 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).