Beyond coding. We forge.
Find a file
Peter Gardfjäll 4562d40fce
fix hard-coded timeout and error panic in API archive download endpoint (#20925)
* fix hard-coded timeout and error panic in API archive download endpoint

This commit updates the `GET /api/v1/repos/{owner}/{repo}/archive/{archive}`
endpoint which prior to this PR had a couple of issues.

1. The endpoint had a hard-coded 20s timeout for the archiver to complete after
   which a 500 (Internal Server Error) was returned to client. For a scripted
   API client there was no clear way of telling that the operation timed out and
   that it should retry.

2. Whenever the timeout _did occur_, the code used to panic. This was caused by
   the API endpoint "delegating" to the same call path as the web, which uses a
   slightly different way of reporting errors (HTML rather than JSON for
   example).

   More specifically, `api/v1/repo/file.go#GetArchive` just called through to
   `web/repo/repo.go#Download`, which expects the `Context` to have a `Render`
   field set, but which is `nil` for API calls. Hence, a `nil` pointer error.

The code addresses (1) by dropping the hard-coded timeout. Instead, any
timeout/cancelation on the incoming `Context` is used.

The code addresses (2) by updating the API endpoint to use a separate call path
for the API-triggered archive download. This avoids producing HTML-errors on
errors (it now produces JSON errors).

Signed-off-by: Peter Gardfjäll <peter.gardfjall.work@gmail.com>
2022-08-29 11:45:20 +02:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github update discord invite (#19907) 2022-06-07 11:40:27 -04:00
assets Add the possibility to allow the user to have a favicon which differs from the main logo (#18542) 2022-05-23 23:54:48 +08:00
build chore: remove broken gitea-format-imports (#20952) 2022-08-25 16:53:48 +08:00
cmd fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
contrib Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
custom/conf Only show relevant repositories on explore page (#19361) 2022-08-25 20:38:41 +02:00
docker Fix the mode of custom dir to 0700 in docker-rootless (#20861) 2022-08-19 11:05:07 -04:00
docs Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
integrations Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
models fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
modules Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
options Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
public Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
routers fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
services fix hard-coded timeout and error panic in API archive download endpoint (#20925) 2022-08-29 11:45:20 +02:00
snap switch to node18 for snapcraft 2022-08-18 12:25:50 -04:00
templates Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
tools Remove legacy +build: constraint (#19582) 2022-05-02 23:22:45 +08:00
web_src Add support for Vagrant packages (#20930) 2022-08-29 15:04:45 +08:00
.air.toml Fix make watch for generated files (#20794) 2022-08-14 22:22:09 +01:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.drone.yml Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies, adjust eslint (#20659) 2022-08-06 18:30:13 +03:00
.gitattributes Move eslintrc/stylelintrc to non-deprecated extensions (#20110) 2022-06-24 14:09:53 +02:00
.gitignore Validate migration files (#18203) 2022-01-26 10:45:51 +01:00
.golangci.yml Add badge capabilities to users (#20607) 2022-08-18 02:25:25 +03:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00:00
.lgtm
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Move eslintrc/stylelintrc to non-deprecated extensions (#20110) 2022-06-24 14:09:53 +02:00
BSDmakefile Add BSDmakefile to prevent errors when make is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
build.go Remove legacy +build: constraint (#19582) 2022-05-02 23:22:45 +08:00
CHANGELOG.md Changelog 1.17.1 (#20833) (#20919) 2022-08-23 10:02:16 +08:00
CONTRIBUTING.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
DCO
Dockerfile Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
Dockerfile.rootless Switch to building with go1.19 (#20695) 2022-08-07 12:25:03 -04:00
go.mod Share HTML template renderers and create a watcher framework (#20218) 2022-08-28 10:43:25 +01:00
go.sum Add support mCaptcha as captcha provider (#20458) 2022-08-10 15:20:10 +02:00
jest.config.js Enable contenthash in filename for dynamic assets (#20813) 2022-08-23 20:58:04 +08:00
LICENSE
main.go Fix typo overrided -> overridden (#20687) 2022-08-06 20:54:26 -04:00
MAINTAINERS Add myself to MAINTAINERS (#20786) 2022-08-14 13:08:53 +03:00
Makefile Add whitespace removal inside template curly brackes (#20853) 2022-08-25 17:55:52 -04:00
package-lock.json Update JS dependencies (#20950) 2022-08-25 16:11:12 +02:00
package.json Update JS dependencies (#20950) 2022-08-25 16:11:12 +02:00
README.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
README_ZH.md Fix English mistakes in some Markdown documents (#20274) 2022-07-14 19:15:35 +08:00
SECURITY.md Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
webpack.config.js Enable contenthash in filename for dynamic assets (#20813) 2022-08-23 20:58:04 +08:00

Gitea

Gitea - Git with a cup of tea

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, required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater and Internet connectivity to download npm dependencies.

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 and Internet connectivity.

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

More info: https://docs.gitea.io/en-us/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.io/en-us/translation-guidelines/

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 Hugo-based documentation theme is hosted at gitea/theme.

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