oauth2-proxy/docs
Charley Wu 5e8956b52f
Improve the Nginx `auth_request` example (#2278)
* The `X-Forwarded-Uri` was required to bypass authentication

- Fix the `skip_auth_routes` option not working in Nginx

* Add tests for allowed requests with proxied `X-Forwarded-Uri` header

* Avoid nginx startup failure: host not found in upstream "oauth2-proxy"

* The `--reverse-proxy` option is required for nginx

* Update the change logs

* Use the authOnlyPath constant

* Remove the unused header `X-Scheme`
2023-11-02 22:57:21 +00:00
..
docs Improve the Nginx `auth_request` example (#2278) 2023-11-02 22:57:21 +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 Fix oidc-issuer-url in example (#2245) 2023-10-24 20:01:36 +01:00
versioned_sidebars Create versioned docs for release v7.5.x 2023-09-04 12:28:42 +02: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 Refactored docs (#2284) 2023-10-31 19:32:59 +00:00
package-lock.json Refactored docs (#2284) 2023-10-31 19:32:59 +00:00
package.json Refactored docs (#2284) 2023-10-31 19:32:59 +00:00
sidebars.js Refactored docs (#2284) 2023-10-31 19:32:59 +00:00
versions.json Create versioned docs for release v7.5.x 2023-09-04 12:28:42 +02: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.