No description
Find a file
Nathan Zook 2242f381e6
Added OpenAPI document link to usage (#15535)
* Added OpenAPI document link to usage

The OpenAPI document at /api/swagger.v1.json needs an obvious reference.  Sadly, I am English monolingual, so someone else is going to have to do the other languages.  In the mean time, this PR should help anyone looking for the file.

* Update docs/content/doc/developers/api-usage.en-us.md

Co-authored-by: a1012112796 <1012112796@qq.com>

Co-authored-by: techknowlogick <matti@mdranta.net>
Co-authored-by: a1012112796 <1012112796@qq.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2021-04-19 23:29:08 -04:00
.github Issue template addition: Are you using Gitea behind CloudFlare? (#14098) 2021-02-18 12:28:07 +01:00
assets Clean up SVG (#13680) 2020-12-17 16:33:53 -05:00
build Make build scripts compatible with node 12 (#15479) 2021-04-15 12:02:34 +01:00
cmd dump: Add option to skip LFS/attachment files (#15407) 2021-04-12 17:33:32 +08:00
contrib Refactor renders (#15175) 2021-04-19 18:25:08 -04:00
custom/conf Disable Stars config option (#14653) 2021-04-15 18:53:57 +02:00
docker Add reverse proxy configuration support for remote IP address (#14959) 2021-03-16 00:27:28 +02:00
docs Added OpenAPI document link to usage (#15535) 2021-04-19 23:29:08 -04:00
integrations Add tests for clone from wiki (#15513) 2021-04-16 17:39:21 -04:00
models Refactor renders (#15175) 2021-04-19 18:25:08 -04:00
modules Refactor renders (#15175) 2021-04-19 18:25:08 -04:00
options [skip ci] Updated translations via Crowdin 2021-04-20 00:12:27 +00:00
public Update JS dependencies (#15033) 2021-03-22 05:04:19 +01:00
routers Refactor renders (#15175) 2021-04-19 18:25:08 -04:00
services Refactor renders (#15175) 2021-04-19 18:25:08 -04:00
snap Consolidate Logos and update README header (#14136) 2021-01-01 14:04:35 -05:00
templates add well-known config for OIDC (#15355) 2021-04-15 22:32:00 -04:00
tools Added 2 fuzzers (#13818) 2020-12-10 20:43:11 +01:00
vendor Upgrade to bluemonday 1.0.7 (#15379) 2021-04-09 19:13:06 -04:00
web_src Fix repository search (#15428) 2021-04-12 22:09:46 -04: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 Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
.editorconfig add well-known config for OIDC (#15355) 2021-04-15 22:32:00 -04:00
.eslintrc Add frontend testing, require node 12 (#15315) 2021-04-08 12:41:57 +02:00
.gitattributes Update JS dependencies and misc tweaks (#13741) 2020-11-29 16:39:36 -05:00
.gitignore Fix Benchmark tests, remove a broken one & add two new (#15250) 2021-04-16 20:30:16 +02:00
.golangci.yml Fix typo in .golangci.yml (#14933) 2021-03-09 03:38:18 -05: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 Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04: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.14.1 changelog (#15503) 2021-04-16 00:06:02 -04: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 go1.16 (#14783) 2021-02-28 18:08:33 -05:00
Dockerfile.rootless go1.16 (#14783) 2021-02-28 18:08:33 -05:00
go.mod Upgrade to bluemonday 1.0.7 (#15379) 2021-04-09 19:13:06 -04:00
go.sum Upgrade to bluemonday 1.0.7 (#15379) 2021-04-09 19:13:06 -04:00
jest.config.js Add frontend testing, require node 12 (#15315) 2021-04-08 12:41:57 +02: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 Update MAINTAINERS (#15382) 2021-04-09 19:11:31 -04:00
Makefile Make build scripts compatible with node 12 (#15479) 2021-04-15 12:02:34 +01:00
package-lock.json Enforce tab indentation in templates (#15289) 2021-04-10 23:46:37 -04:00
package.json Enforce tab indentation in templates (#15289) 2021-04-10 23:46:37 -04:00
README.md Stop packaging node_modules in release tarballs (#15273) 2021-04-09 01:08:14 -04:00
README_ZH.md Kd/add bountysource (#14323) 2021-01-13 10:53:17 -05:00
SECURITY.md Add security policy to repo (#12536) 2020-08-19 17:15:55 +01:00
webpack.config.js Fix missing icons and colorpicker when mounted on suburl (#15501) 2021-04-16 01:15:51 +03: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 12.17 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!

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