3d203a1a03
* Home: Add a brief description of the behavior I could not find this information anywhere and think it is quite important for understanding how to use and configure the proxy for different use cases. (Especially the Ajax part is not mentioned anywhere else I believe.) I tried to keep it general enough so that it won't need updating often yet useful enough to have good value :) * Update docs/0_index.md Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk> |
||
|---|---|---|
| .. | ||
| assets/js | ||
| configuration | ||
| logos | ||
| .gitignore | ||
| 0_index.md | ||
| 1_installation.md | ||
| 2_auth.md | ||
| 4_tls.md | ||
| 5_endpoints.md | ||
| 6_request_signatures.md | ||
| 404.html | ||
| Gemfile | ||
| Gemfile.lock | ||
| Makefile | ||
| README.md | ||
| _config.yml | ||
README.md
Docs
This folder contains our Jekyll based docs site which is hosted at https://oauth2-proxy.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.5.0 or
higher and bundle (gem install bundler if you already have Ruby).