Go to file
Lunny Xiao 6433ba0ec3
Move macaron to chi (#14293)
Use [chi](https://github.com/go-chi/chi) instead of the forked [macaron](https://gitea.com/macaron/macaron). Since macaron and chi have conflicts with session share, this big PR becomes a have-to thing. According my previous idea, we can replace macaron step by step but I'm wrong. :( Below is a list of big changes on this PR.

- [x] Define `context.ResponseWriter` interface with an implementation `context.Response`.
- [x] Use chi instead of macaron, and also a customize `Route` to wrap chi so that the router usage is similar as before.
- [x] Create different routers for `web`, `api`, `internal` and `install` so that the codes will be more clear and no magic .
- [x] Use https://github.com/unrolled/render instead of macaron's internal render
- [x] Use https://github.com/NYTimes/gziphandler instead of https://gitea.com/macaron/gzip
- [x] Use https://gitea.com/go-chi/session which is a modified version of https://gitea.com/macaron/session and removed `nodb` support since it will not be maintained. **BREAK**
- [x] Use https://gitea.com/go-chi/captcha which is a modified version of https://gitea.com/macaron/captcha
- [x] Use https://gitea.com/go-chi/cache which is a modified version of https://gitea.com/macaron/cache
- [x] Use https://gitea.com/go-chi/binding which is a modified version of https://gitea.com/macaron/binding
- [x] Use https://github.com/go-chi/cors instead of https://gitea.com/macaron/cors
- [x] Dropped https://gitea.com/macaron/i18n and make a new one in `code.gitea.io/gitea/modules/translation`
- [x] Move validation form structs from `code.gitea.io/gitea/modules/auth` to `code.gitea.io/gitea/modules/forms` to avoid dependency cycle.
- [x] Removed macaron log service because it's not need any more. **BREAK**
- [x] All form structs have to be get by `web.GetForm(ctx)` in the route function but not as a function parameter on routes definition.
- [x] Move Git HTTP protocol implementation to use routers directly.
- [x] Fix the problem that chi routes don't support trailing slash but macaron did.
- [x] `/api/v1/swagger` now will be redirect to `/api/swagger` but not render directly so that `APIContext` will not create a html render. 

Notices:
- Chi router don't support request with trailing slash
- Integration test `TestUserHeatmap` maybe mysql version related. It's failed on my macOS(mysql 5.7.29 installed via brew) but succeed on CI.

Co-authored-by: 6543 <6543@obermui.de>
2021-01-26 16:36:53 +01:00
.github Kd/add bountysource (#14323) 2021-01-13 10:53:17 -05:00
assets Clean up SVG (#13680) 2020-12-17 16:33:53 -05:00
build Consolidate Logos and update README header (#14136) 2021-01-01 14:04:35 -05:00
cmd Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
contrib Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
custom/conf Enhance Ghost comment mitigation Settings (#14392) 2021-01-21 21:56:19 -05:00
docker Set RUN_MODE prod by default (#13765) 2020-11-30 14:52:04 -05:00
docs Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
integrations Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
models Redirect on changed user and org name (#11649) 2021-01-24 16:23:05 +01:00
modules Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
options Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
public Add support to migrate from gogs (#14342) 2021-01-21 20:33:58 +01:00
routers Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
services Enhance Ghost comment mitigation Settings (#14392) 2021-01-21 21:56:19 -05:00
snap Consolidate Logos and update README header (#14136) 2021-01-01 14:04:35 -05:00
templates Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
tools Added 2 fuzzers (#13818) 2020-12-10 20:43:11 +01:00
vendor Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
web_src Redirect on changed user and org name (#11649) 2021-01-24 16:23:05 +01:00
.air.conf Add 'watch-backend' (#12330) 2020-07-27 14:05:42 -04:00
.changelog.yml Add API Section to Changelog (#13125) 2020-10-13 01:39:17 -04:00
.drone.yml Use caddy's certmagic library for extensible/robust ACME handling (#14177) 2021-01-25 01:37:35 +02:00
.editorconfig Fix .editorconfig (#13735) 2020-11-28 20:29:46 +02:00
.eslintrc Update JS dependencies and webpack (#14118) 2020-12-27 15:24:27 +01:00
.gitattributes Update JS dependencies and misc tweaks (#13741) 2020-11-29 16:39:36 -05:00
.gitignore Precompile fomantic-ui files (#13332) 2020-10-27 19:44:06 -04:00
.golangci.yml Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
.ignore Fonts rework (#12114) 2020-07-06 11:56:54 +03:00
.lgtm refactor: ignore LGTM from author of pull request. (#3283) 2018-01-02 06:13:49 -06:00
.npmrc Update JS dependencies and misc tweaks (#13741) 2020-11-29 16:39:36 -05:00
.revive.toml refactor: replace lint to revive (#5422) 2018-12-03 09:28:46 -05:00
.stylelintrc Fix tooltips and issue dependency styles (#13458) 2020-11-10 20:28:07 +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 update revive lint to latest commit (#12921) 2020-09-22 20:02:16 +03:00
CHANGELOG.md frontport 1.13.1 changelog (#14175) 2020-12-28 19:38:44 -05:00
CONTRIBUTING.md Update owners for 2021 (#14206) 2021-01-01 01:41:03 +02:00
DCO follow the advisor: add DCO and some improvements 2016-11-04 16:43:41 +08:00
Dockerfile upgrade to alpine 3.13 (#14343) 2021-01-20 05:21:01 +01:00
Dockerfile.rootless upgrade to alpine 3.13 (#14343) 2021-01-20 05:21:01 +01:00
go.mod Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
go.sum Move macaron to chi (#14293) 2021-01-26 16:36:53 +01:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Dump github/gitlab/gitea repository data to a local directory and restore to gitea (#12244) 2020-12-27 11:34:19 +08:00
MAINTAINERS Remove self from MAINTAINERS (#14286) 2021-01-09 01:53:19 -05:00
Makefile Use caddy's certmagic library for extensible/robust ACME handling (#14177) 2021-01-25 01:37:35 +02:00
package-lock.json Bump gsap from 3.5.1 to 3.6.0 (#14410) 2021-01-22 02:21:45 -05:00
package.json Display current stopwatch in navbar (#14122) 2021-01-21 15:51:52 +01:00
README_ZH.md Kd/add bountysource (#14323) 2021-01-13 10:53:17 -05:00
README.md Update Link 2021-01-13 10:55:52 -05:00
SECURITY.md Add security policy to repo (#12536) 2020-08-19 17:15:55 +01:00
semantic.json Update JS dependencies (#12782) 2020-09-10 12:16:40 +08:00
webpack.config.js Update JS dependencies and webpack (#14118) 2020-12-27 15:24:27 +01:00

Gitea

Gitea - Git with a cup of tea

View the chinese version of this document

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. Using Go, this can be done with an independent binary distribution across all platforms which Go supports, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. Want to try it before doing anything else? Do it with the online demo! This project has been forked from Gogs since 2016.11 but changed a lot.

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 1.13 or greater.
  • make frontend which requires Node.js 10.13 or greater.

If pre-built frontend files are present it is possible to only build the backend:

TAGS="bindata" make backend

Parallelism is not supported for these targets, so please don't include -j <num>.

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!

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