code.gitea.io/gitea@v1.22.3/README.md (about) 1 # Gitea 2 3 [](https://github.com/go-gitea/gitea/actions/workflows/release-nightly.yml?query=branch%3Amain "Release Nightly") 4 [](https://discord.gg/Gitea "Join the Discord chat at https://discord.gg/Gitea") 5 [](https://goreportcard.com/report/code.gitea.io/gitea "Go Report Card") 6 [](https://pkg.go.dev/code.gitea.io/gitea "GoDoc") 7 [](https://github.com/go-gitea/gitea/releases/latest "GitHub release") 8 [](https://www.codetriage.com/go-gitea/gitea "Help Contribute to Open Source") 9 [](https://opencollective.com/gitea "Become a backer/sponsor of gitea") 10 [](https://opensource.org/licenses/MIT "License: MIT") 11 [](https://gitpod.io/#https://github.com/go-gitea/gitea) 12 [](https://crowdin.com/project/gitea "Crowdin") 13 [](https://www.tickgit.com/browse?repo=github.com/go-gitea/gitea&branch=main "TODOs") 14 15 [View this document in Chinese](./README_ZH.md) 16 17 ## Purpose 18 19 The goal of this project is to make the easiest, fastest, and most 20 painless way of setting up a self-hosted Git service. 21 22 As Gitea is written in Go, it works across **all** the platforms and 23 architectures that are supported by Go, including Linux, macOS, and 24 Windows on x86, amd64, ARM and PowerPC architectures. 25 This project has been 26 [forked](https://blog.gitea.com/welcome-to-gitea/) from 27 [Gogs](https://gogs.io) since November of 2016, but a lot has changed. 28 29 For online demonstrations, you can visit [demo.gitea.com](https://demo.gitea.com). 30 31 For accessing free Gitea service (with a limited number of repositories), you can visit [gitea.com](https://gitea.com/user/login). 32 33 To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at [cloud.gitea.com](https://cloud.gitea.com). 34 35 ## Building 36 37 From the root of the source tree, run: 38 39 TAGS="bindata" make build 40 41 or if SQLite support is required: 42 43 TAGS="bindata sqlite sqlite_unlock_notify" make build 44 45 The `build` target is split into two sub-targets: 46 47 - `make backend` which requires [Go Stable](https://go.dev/dl/), the required version is defined in [go.mod](/go.mod). 48 - `make frontend` which requires [Node.js LTS](https://nodejs.org/en/download/) or greater. 49 50 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. 51 52 More info: https://docs.gitea.com/installation/install-from-source 53 54 ## Using 55 56 ./gitea web 57 58 > [!NOTE] 59 > If you're interested in using our APIs, we have experimental support with [documentation](https://docs.gitea.com/api). 60 61 ## Contributing 62 63 Expected workflow is: Fork -> Patch -> Push -> Pull Request 64 65 > [!NOTE] 66 > 67 > 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.** 68 > 2. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks! 69 70 ## Translating 71 72 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. 73 74 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. 75 76 https://docs.gitea.com/contributing/localization 77 78 [](https://crowdin.com/project/gitea) 79 80 ## Further information 81 82 For more information and instructions about how to install Gitea, please look at our [documentation](https://docs.gitea.com/). 83 If you have questions that are not covered by the documentation, you can get in contact with us on our [Discord server](https://discord.gg/Gitea) or create a post in the [discourse forum](https://forum.gitea.com/). 84 85 We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea). 86 87 The official Gitea CLI is developed at [gitea/tea](https://gitea.com/gitea/tea). 88 89 ## Authors 90 91 - [Maintainers](https://github.com/orgs/go-gitea/people) 92 - [Contributors](https://github.com/go-gitea/gitea/graphs/contributors) 93 - [Translators](options/locale/TRANSLATORS) 94 95 ## Backers 96 97 Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)] 98 99 <a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a> 100 101 ## Sponsors 102 103 Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/gitea#sponsor)] 104 105 <a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a> 106 <a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a> 107 <a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a> 108 <a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a> 109 <a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a> 110 <a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a> 111 <a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a> 112 <a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a> 113 <a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a> 114 <a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a> 115 116 ## FAQ 117 118 **How do you pronounce Gitea?** 119 120 Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g. 121 122 **Why is this not hosted on a Gitea instance?** 123 124 We're [working on it](https://github.com/go-gitea/gitea/issues/1029). 125 126 ## License 127 128 This project is licensed under the MIT License. 129 See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file 130 for the full license text. 131 132 ## Screenshots 133 134 Looking for an overview of the interface? Check it out! 135 136 |||| 137 |:---:|:---:|:---:| 138 |||| 139 |||| 140 ||||