You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
forgejo/docs/content/administration
MiloCubed 2f2ca8c940
[docs] Add note that PROTOCOL config is case-sensitive (#25685)
See [issue on
gitea.com](https://gitea.com/gitea/gitea-docusaurus/issues/38), 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](https://docs.gitea.com/administration/https-setup#using-the-built-in-server)
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](https://github.com/go-gitea/gitea/tree/main/docs)

Before - links

![image](https://github.com/go-gitea/gitea/assets/135522693/e0745077-f6a9-4178-aa78-2155ccb58fd6)
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](https://github.com/go-gitea/gitea/assets/135522693/748b3759-aa13-4ad0-9811-c6664b6cdd35)

Before - config cheat sheet

![image](https://github.com/go-gitea/gitea/assets/135522693/4ff2e4e6-3528-4cea-a7a6-64a75854eb99)

After - config cheat sheet

![image](https://github.com/go-gitea/gitea/assets/135522693/c8e07ab6-5a26-4582-a4d0-b83d1f11a30e)


## Before/After screenshots as per [gitea.com's
docs](https://gitea.com/gitea/gitea-docusaurus)

Before - links

![image](https://github.com/go-gitea/gitea/assets/135522693/4d26ea67-b987-4b91-810b-c53852a13078)

After - links

![image](https://github.com/go-gitea/gitea/assets/135522693/24d02907-7f9e-4228-a190-7696623c00f7)

Before - config cheat sheet

![image](https://github.com/go-gitea/gitea/assets/135522693/978eedfd-ce05-488d-ab54-9d7f3c9f233d)

After - config cheat sheet

![image](https://github.com/go-gitea/gitea/assets/135522693/12d22566-a2b0-45ec-8302-a88eae9365d8)
9 months ago
..
_index.en-us.md Docusaurus-ify (#26051) 12 months ago
_index.zh-cn.md Docusaurus-ify (#26051) 12 months ago
adding-legal-pages.en-us.md Docusaurus-ify (#26051) 12 months ago
adding-legal-pages.zh-cn.md Docusaurus-ify (#26051) 12 months ago
backup-and-restore.en-us.md Update backup instructions to align with archive structure (#26902) 10 months ago
backup-and-restore.zh-cn.md Docusaurus-ify (#26051) 12 months ago
cmd-embedded.en-us.md Enable markdownlint `no-duplicate-header` (#27500) 9 months ago
cmd-embedded.zh-cn.md Enable markdownlint `no-duplicate-header` (#27500) 9 months ago
command-line.en-us.md clarify aspects of the dump command (#26887) 10 months ago
command-line.zh-cn.md Expanded minimum RSA Keylength to 3072 (#26604) 11 months ago
config-cheat-sheet.en-us.md [docs] Add note that PROTOCOL config is case-sensitive (#25685) 9 months ago
config-cheat-sheet.zh-cn.md Enhanced auth token / remember me (#27606) 9 months ago
customizing-gitea.en-us.md Rename the default themes to gitea-light, gitea-dark, gitea-auto (#27419) 9 months ago
customizing-gitea.zh-cn.md Rename the default themes to gitea-light, gitea-dark, gitea-auto (#27419) 9 months ago
email-setup.en-us.md Update Gmail example (#26302) 11 months ago
email-setup.zh-cn.md Update email-setup.en-us.md (#26068) 12 months ago
environment-variables.en-us.md Docusaurus-ify (#26051) 12 months ago
environment-variables.zh-cn.md Docusaurus-ify (#26051) 12 months ago
external-renderers.en-us.md Update documents to fix some links (#26885) 10 months ago
external-renderers.zh-cn.md Docusaurus-ify (#26051) 12 months ago
fail2ban-setup.en-us.md Use docs.gitea.com instead of docs.gitea.io (#26739) 11 months ago
fail2ban-setup.zh-cn.md Use docs.gitea.com instead of docs.gitea.io (#26739) 11 months ago
git-lfs-support.en-us.md Docusaurus-ify (#26051) 12 months ago
git-lfs-support.zh-cn.md Docusaurus-ify (#26051) 12 months ago
https-support.en-us.md Update documents to fix some links (#26885) 10 months ago
https-support.zh-cn.md Update documents to fix some links (#26885) 10 months ago
logging-config.en-us.md Clarify the logger's MODE config option (#26267) 11 months ago
logging-config.zh-cn.md Docusaurus-ify (#26051) 12 months ago
mail-templates.en-us.md Use docs.gitea.com instead of docs.gitea.io (#26739) 11 months ago
mail-templates.zh-cn.md Use docs.gitea.com instead of docs.gitea.io (#26739) 11 months ago
repo-indexer.en-us.md Use docs.gitea.com instead of docs.gitea.io (#26739) 11 months ago
repo-indexer.zh-cn.md Use docs.gitea.com instead of docs.gitea.io (#26739) 11 months ago
reverse-proxies.en-us.md Add docs section for sub-paths with the container registry (#27505) 9 months ago
reverse-proxies.zh-cn.md Docusaurus-ify (#26051) 12 months ago
search-engines-indexation.en-us.md Fix the robots.txt path 9 months ago
search-engines-indexation.zh-cn.md Fix the robots.txt path 9 months ago
signing.en-us.md Docusaurus-ify (#26051) 12 months ago
signing.zh-cn.md Docusaurus-ify (#26051) 12 months ago