Go to file
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)
2023-10-19 16:14:46 +08:00
.devcontainer devpod use go1.21 (#26637) 2023-08-21 16:20:50 +00:00
.gitea Use docs.gitea.com instead of docs.gitea.io (#26739) 2023-08-27 11:59:12 +00:00
.github actions/setup-go use go-version-file (#27651) 2023-10-17 10:24:54 +00:00
assets bump go-deps (#27489) 2023-10-07 05:55:08 +00:00
build Use Set[Type] instead of map[Type]bool/struct{}. (#26804) 2023-08-30 06:55:25 +00:00
cmd Final round of db.DefaultContext refactor (#27587) 2023-10-14 08:37:24 +00:00
contrib Replace more db.DefaultContext (#27628) 2023-10-15 17:46:06 +02:00
custom/conf [docs] Add note that PROTOCOL config is case-sensitive (#25685) 2023-10-19 16:14:46 +08:00
docker Expanded minimum RSA Keylength to 3072 (#26604) 2023-08-28 00:53:16 +00:00
docs [docs] Add note that PROTOCOL config is case-sensitive (#25685) 2023-10-19 16:14:46 +08:00
models Add unit tests for action runner token (#27670) 2023-10-19 07:24:24 +00:00
modules Support allowed hosts for webhook to work with proxy (#27655) 2023-10-18 09:44:36 +00:00
options [skip ci] Updated translations via Crowdin 2023-10-19 00:23:11 +00:00
public Update JS and Poetry dependencies and eslint (#27200) 2023-09-22 22:51:48 +02:00
routers Fix typo "GetLatestRunnerToken" (#27680) 2023-10-18 15:52:44 +00:00
services Remove unnecessary parameter (#27671) 2023-10-18 15:03:10 +00:00
snap set version in snapcraft yaml 2023-09-13 23:20:46 -04:00
templates Add link for repositories README file (#27684) 2023-10-18 17:59:46 -05:00
tests Remove unnecessary parameter (#27671) 2023-10-18 15:03:10 +00:00
web_src Clipboard copy enhancements (#27669) 2023-10-18 15:16:06 +00:00
.air.toml
.changelog.yml
.dockerignore
.editorconfig
.eslintrc.yaml Update JS and PY dependencies (#27501) 2023-10-08 00:16:20 +00:00
.gitattributes
.gitignore update snap package (#27021) 2023-09-12 12:47:53 +00:00
.gitpod.yml
.golangci.yml Use Go 1.21 for golangci-lint (#26786) 2023-08-29 16:25:24 +02:00
.ignore Add /public/assets to .ignore (#26232) 2023-07-30 12:34:20 +02:00
.markdownlint.yaml Enable markdownlint no-duplicate-header (#27500) 2023-10-07 15:30:21 +02:00
.npmrc
.spectral.yaml
.stylelintrc.yaml Enable shorthands in declaration-strict-value linter (#27597) 2023-10-13 08:19:21 +00:00
.yamllint.yaml fully replace drone with actions (#27556) 2023-10-11 06:39:32 +00:00
BSDmakefile Fix build errors on BSD (in BSDMakefile) (#27594) 2023-10-13 15:38:27 +00:00
build.go
CHANGELOG.md Add 1.20.5 changelog (#27404) (#27411) 2023-10-03 14:22:03 +00:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Document our new labeling strategy (#27523) 2023-10-09 09:16:05 +08:00
DCO
Dockerfile bump go to 1.21 (#26608) 2023-08-21 00:27:46 +02:00
Dockerfile.rootless bump go to 1.21 (#26608) 2023-08-21 00:27:46 +02:00
go.mod Upgrade go dependencies (#27599) 2023-10-13 16:11:15 +00:00
go.sum Upgrade go dependencies (#27599) 2023-10-13 16:11:15 +00:00
LICENSE
main.go Fix incorrect CLI exit code and duplicate error message (#26346) 2023-08-05 23:36:45 +08:00
MAINTAINERS Apply to become a maintainer (#27522) 2023-10-08 10:36:40 -04:00
Makefile Remove network call on make clean (#27689) 2023-10-19 08:02:22 +00:00
package-lock.json Update JS and PY dependencies (#27501) 2023-10-08 00:16:20 +00:00
package.json Update JS and PY dependencies (#27501) 2023-10-08 00:16:20 +00:00
playwright.config.js
poetry.lock Update JS and PY dependencies (#27501) 2023-10-08 00:16:20 +00:00
poetry.toml
pyproject.toml Update JS and Poetry dependencies and eslint (#27200) 2023-09-22 22:51:48 +02:00
README.md Update readme to remove drone svg (#27624) 2023-10-14 16:11:54 +00:00
README_ZH.md Update readme to remove drone svg (#27624) 2023-10-14 16:11:54 +00:00
SECURITY.md fix wording in SECURITY.md (#27463) 2023-10-06 05:17:29 +08:00
vitest.config.js Use vitest globals (#27102) 2023-09-27 04:37:13 +00:00
webpack.config.js Enable production source maps for index.js, fix CSS sourcemaps (#27291) 2023-09-26 22:05:49 -04:00

Gitea

Gitea - Git with a cup of tea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, the required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater.

Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js.

Parallelism (make -j <num>) is not supported.

More info: https://docs.gitea.com/installation/install-from-source

Using

./gitea web

NOTE: If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

NOTES:

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Translating

Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

https://docs.gitea.com/contributing/localization

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The official Gitea CLI is developed at gitea/tea.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark