Skip to content

[docs] Add note that PROTOCOL config is case-sensitive #25685

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 19, 2023
Merged

[docs] Add note that PROTOCOL config is case-sensitive #25685

merged 3 commits into from
Oct 19, 2023

Conversation

MiloCubed
Copy link
Contributor

See issue on gitea.com, copied below for convenience:

Hello, may I first confirm that the app.ini PROTOCOL config is case sensitive (must be lowercase)?

If so, I'd like to suggest for it to be highlighted in the HTTPS Setup page.
Perhaps something like:
For the PROTOCOL=https field, make sure https is lowercase. Writing PROTOCOL=HTTPS may result in a SSL_ERROR_RX_RECORD_TOO_LONG error on Firefox or ERR_SSL_PROTOCOL_ERROR on Chrome and Edge.

Background
At first I carelessly wrote PROTOCOL=HTTPS in my app.ini, and Firefox didn't allow me to connect because:
Secure Connection Failed
An error occurred during a connection to gitea.local.lan. SSL received a record that exceeded the maximum permissible length.
Error code: SSL_ERROR_RX_RECORD_TOO_LONG
I spent maybe half an hour troubleshooting my certs, ports, and other configs before backtracking to the start and realizing the capitalization difference there 😅. When I changed that config to lowercase, it worked.

For this PR I added the note in the Config Cheat Sheet page and fixed the links to it from the HTTPS Setup page.

Was originally thinking to put the note in the HTTPS Setup page itself, but since there are 2 sections referencing the PROTOCOL config, I was thinking it'd be neater and more concise to put it in the Config Cheat Sheet page instead. Especially since both sections already link to it, and I actually tried to check that link quite early on in my troubleshooting (but didn't pay much attention to it since the link was broken).

Before/After screenshots as per this repo's docs

Before - links
image
Note: For this the links weren't broken, the links fix is because they were broken on gitea.com's docs (see below).

After - links
image

Before - config cheat sheet
image

After - config cheat sheet
image

Before/After screenshots as per gitea.com's docs

Before - links
image

After - links
image

Before - config cheat sheet
image

After - config cheat sheet
image

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jul 4, 2023
@MiloCubed MiloCubed marked this pull request as ready for review July 4, 2023 15:29
@silverwind silverwind added the type/docs This PR mainly updates/creates documentation label Jul 4, 2023
delvh
delvh approved these changes Jul 5, 2023
View reviewed changes
Copy link
Member

@delvh delvh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current state seems acceptable to me, especially if relref supports URL fragments.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jul 5, 2023
@github-actions github-actions bot added modifies/translation modifies/api This PR adds API routes or modifies them modifies/cli PR changes something on the CLI, i.e. gitea doctor or gitea admin modifies/frontend modifies/docs modifies/migrations modifies/internal labels Oct 19, 2023
@lunny lunny force-pushed the MiloCubed-docs-protocol-lowercase branch from 07c8b97 to 7bbb0e0 Compare October 19, 2023 08:13
@github-actions github-actions bot removed modifies/translation modifies/api This PR adds API routes or modifies them modifies/cli PR changes something on the CLI, i.e. gitea doctor or gitea admin modifies/frontend modifies/migrations modifies/internal labels Oct 19, 2023
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Oct 19, 2023
@lunny lunny enabled auto-merge (squash) October 19, 2023 08:14
@lunny lunny disabled auto-merge October 19, 2023 08:14
@lunny lunny merged commit 2f2ca8c into go-gitea:main Oct 19, 2023
@GiteaBot GiteaBot added this to the 1.22.0 milestone Oct 19, 2023
zjjhot added a commit to zjjhot/gitea that referenced this pull request Oct 20, 2023
@zjjhot
Merge remote-tracking branch 'upstream/main'
8879756 
* upstream/main:
  Adapt `.changelog.yml` to new labeling system (go-gitea#27701)
  Update and add new eslint plugins (go-gitea#27698)
  Show total TrackedTime on issue/pull/milestone lists (go-gitea#26672)
  Add doctor dbconsistency fix to delete repos with no owner (go-gitea#27290)
  Delete repos of org when purge delete user (go-gitea#27273)
  Fix required checkboxes in issue forms (go-gitea#27592)
  Upgrade xorm (go-gitea#27673)
  [docs] Add note that PROTOCOL config is case-sensitive (go-gitea#25685)
  Remove network call on `make clean` (go-gitea#27689)
  Add unit tests for action runner token (go-gitea#27670)
  Typos fixed in documentation files (go-gitea#27687)
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Jan 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@silverwind silverwind silverwind left review comments

@wxiaoguang wxiaoguang wxiaoguang left review comments

@lunny lunny lunny approved these changes

@delvh delvh delvh approved these changes

Assignees
No one assigned
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs type/docs This PR mainly updates/creates documentation
Projects
None yet
Milestone
1.22.0
Development

Successfully merging this pull request may close these issues.
6 participants
@MiloCubed @lunny @silverwind @wxiaoguang @delvh @GiteaBot