Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README and fix code some commentary typos #2608

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

anonhostpi
Copy link

@anonhostpi anonhostpi commented Apr 14, 2024

Update doc to include default value for relative-redirect-url

Based on:

flagSet.Bool("relative-redirect-url", false, "allow relative OAuth Redirect URL.")

Description

Update doc to reflect this line of code:

flagSet.Bool("relative-redirect-url", false, "allow relative OAuth Redirect URL.")

Motivation and Context

I am scrubbing through the source code and documentation to learn how OAuth2-Proxy works internally, as a way for me to learn how each of the configs work in detail.

Since, I am already digging into each in detail, I might as well share any discrepancies I find.

How Has This Been Tested?

N/A

Checklist:

  • My change requires a change to the documentation or CHANGELOG.
  • I have updated the documentation/CHANGELOG accordingly.
  • (N/A) I have created a feature (non-master) branch for my PR.
  • (N/A) I have written tests for my code changes.

@anonhostpi anonhostpi requested a review from a team as a code owner April 14, 2024 05:02
@github-actions github-actions bot added the docs label Apr 14, 2024
@github-actions github-actions bot added the go label Apr 15, 2024
@anonhostpi anonhostpi changed the title Update README.md: relative-redirect-url default value docs: update README and fix code some commentary typos Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant