oauth2-proxy/docs
Sean Jones a7c8a233ba
Add Prometheus metrics endpoint
Add the Prometheus http.Handler to serve metrics at MetricsPath ("/metrics"
by default). This allows Prometheus to scrape metrics from OAuth2 Proxy.

Add a new middleware NewRequestMetrics and attach it to the preAuth
chain. This will collect metrics on all requests made to OAuth2 Proxy

Collapse some calls to Prinf() and os.Exit(1) to Fatalf as they are
equivalent. main() has a strict 50 lines limit so brevity in these
calls appreciated
2021-02-15 13:45:26 +00:00
..
docs Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
src Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
static Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
versioned_docs Prepare for release v7.0.1 2021-02-10 18:25:39 +00:00
versioned_sidebars Create v7.0.x versioned docs 2021-02-01 18:05:47 +00:00
.gitignore Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
README.md Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
babel.config.js Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
docusaurus.config.js Add version dropdown to docs header 2020-11-08 19:37:46 +00:00
package-lock.json Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
package.json Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
sidebars.js Generate reference page in configuration 2021-01-18 09:57:44 +00:00
versions.json Create v7.0.x versioned docs 2021-02-01 18:05:47 +00:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.