mirror of
https://github.com/go-gitea/gitea.git
synced 2026-06-17 19:10:22 +03:00
bircni
c68925152b
Moves the "Hacking on Gitea" page out of the documentation website and into the repository as `docs/development.md`, so contributors find build and test instructions next to the code. The content has been cleaned up and corrected for in-repo use. --------- Signed-off-by: bircni <bircni@icloud.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
200 lines
10 KiB
Markdown
200 lines
10 KiB
Markdown
# Gitea
|
|
|
|
[](https://github.com/go-gitea/gitea/actions/workflows/release-nightly.yml?query=branch%3Amain "Release Nightly")
|
|
[](https://discord.gg/Gitea "Join the Discord chat at https://discord.gg/Gitea")
|
|
[](https://goreportcard.com/report/gitea.dev "Go Report Card")
|
|
[](https://pkg.go.dev/gitea.dev "GoDoc")
|
|
[](https://github.com/go-gitea/gitea/releases/latest "GitHub release")
|
|
[](https://www.codetriage.com/go-gitea/gitea "Help Contribute to Open Source")
|
|
[](https://opencollective.com/gitea "Become a backer/sponsor of gitea")
|
|
[](https://opensource.org/licenses/MIT "License: MIT")
|
|
[](https://translate.gitea.com "Crowdin")
|
|
|
|
[繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
|
|
|
|
## Purpose
|
|
|
|
The goal of Gitea is to make the easiest, fastest, and most painless way of
|
|
setting up a self-hosted all-in-one software development service,
|
|
including Git hosting, code management, code review, issue tracking, project kanban, wiki,
|
|
team collaboration, package registry and CI/CD which can reuse GitHub Actions.
|
|
|
|
As Gitea is written in Go, it works across **all** the platforms and
|
|
architectures that are supported by Go, including Linux, macOS, FreeBSD/OpenBSD and Windows
|
|
on x86, amd64, ARM, RISC-V 64 and PowerPC architectures.
|
|
|
|
For online demonstrations, you can visit [demo.gitea.com](https://demo.gitea.com).
|
|
|
|
For accessing free Gitea service (with a limited number of repositories), you can visit [gitea.com](https://gitea.com/user/login).
|
|
|
|
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),
|
|
or use container (docker/podman/etc) to deploy on your own server with the [official image](https://hub.docker.com/r/gitea/gitea).
|
|
|
|
## Documentation
|
|
|
|
You can find comprehensive documentation on our official [documentation website](https://docs.gitea.com/).
|
|
|
|
It includes installation, administration, usage, development, contributing guides, and more to help you get started and explore all features effectively.
|
|
|
|
If you have any suggestions or would like to contribute to it, you can visit the [documentation repository](https://gitea.com/gitea/docs)
|
|
|
|
## Building
|
|
|
|
See [docs/build-setup.md](docs/build-setup.md) for prerequisites
|
|
and [docs/development.md](docs/development.md) for setting up a local development environment, linting, and testing.
|
|
|
|
If you'd like to build from source or make a distribution package, see [docs/build-source.md](docs/build-source.md) for more information.
|
|
|
|
After building, you can run `./gitea web` to start the server, or `./gitea help` to see all available commands.
|
|
|
|
## Contributing
|
|
|
|
Expected workflow is: Fork -> Patch -> Push -> Pull Request
|
|
|
|
> [!NOTE]
|
|
>
|
|
> 1. **YOU MUST READ THE [CONTRIBUTORS GUIDE](CONTRIBUTING.md) BEFORE STARTING TO WORK ON A PULL REQUEST.**
|
|
> 2. New to the codebase? The [development guide](docs/development.md) walks through setting up a local environment and building from source.
|
|
> 3. If you have found a vulnerability in the project, please write privately to **security@gitea.io**. Thanks!
|
|
|
|
## Translating
|
|
|
|
[](https://translate.gitea.com)
|
|
|
|
Translations are done through [Crowdin](https://translate.gitea.com). 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.
|
|
|
|
Get more information from [documentation](https://docs.gitea.com/contributing/localization).
|
|
|
|
## Official and Third-Party Projects
|
|
|
|
We provide an official [go-sdk](https://gitea.com/gitea/go-sdk), a CLI tool called [tea](https://gitea.com/gitea/tea) and an [action runner](https://gitea.com/gitea/act_runner) for Gitea Action.
|
|
|
|
We maintain a list of Gitea-related projects at [gitea/awesome-gitea](https://gitea.com/gitea/awesome-gitea), where you can discover more third-party projects, including SDKs, plugins, themes, and more.
|
|
|
|
## Communication
|
|
|
|
[](https://discord.gg/Gitea "Join the Discord chat at https://discord.gg/Gitea")
|
|
|
|
If you have questions that are not covered by the [documentation](https://docs.gitea.com/), 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/).
|
|
|
|
## Authors
|
|
|
|
- [Maintainers](https://github.com/orgs/go-gitea/people)
|
|
- [Contributors](https://github.com/go-gitea/gitea/graphs/contributors)
|
|
- [Translators](options/locale/TRANSLATORS)
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/gitea#backer)]
|
|
|
|
<a href="https://opencollective.com/gitea#backers" target="_blank"><img src="https://opencollective.com/gitea/backers.svg?width=890"></a>
|
|
|
|
## Sponsors
|
|
|
|
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)]
|
|
|
|
<a href="https://opencollective.com/gitea/sponsor/0/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/1/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/2/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/3/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/4/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/5/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/6/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/7/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/gitea/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitea/sponsor/9/avatar.svg"></a>
|
|
|
|
## FAQ
|
|
|
|
**How do you pronounce Gitea?**
|
|
|
|
Gitea is pronounced [/ɡɪ’ti:/](https://youtu.be/EM71-2uDAoY) as in "gi-tea" with a hard g.
|
|
|
|
**How do I configure Gitea?**
|
|
|
|
For dynamic config options, you can change it on your admin panel's configuration section.
|
|
|
|
For static config options, you can edit your `app.ini` file and resart the instance.
|
|
See [app.example.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) or [configuration documentation](https://docs.gitea.com/administration/config-cheat-sheet) for more details.
|
|
|
|
**Where can I find the security patches?**
|
|
|
|
In the [release log](https://github.com/go-gitea/gitea/releases) or the [change log](https://github.com/go-gitea/gitea/blob/main/CHANGELOG.md), search for the keyword `SECURITY` to find the security patches.
|
|
|
|
(more FAQs are listed in [FAQ documentation](https://docs.gitea.com/help/faq))
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License.
|
|
See the [LICENSE](https://github.com/go-gitea/gitea/blob/main/LICENSE) file
|
|
for the full license text.
|
|
|
|
## Further information
|
|
|
|
<details>
|
|
<summary>Looking for an overview of the interface? Check it out the screenshots!</summary>
|
|
|
|
### Login/Register Page
|
|
|
|
|
|
|
|
|
|
### User Dashboard
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### User Profile
|
|
|
|
|
|
|
|
### Explore
|
|
|
|
|
|
|
|
|
|
|
|
### Repository
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Repository Issue
|
|
|
|
|
|
|
|
|
|
#### Repository Pull Requests
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### Repository Actions
|
|
|
|
|
|
|
|
|
|
#### Repository Activity
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Organization
|
|
|
|
|
|
|
|
</details>
|