Git with a cup of tea! Painless self-hosted all-in-one software development service, includes Git hosting, code review, team collaboration, package registry and CI/CD
Go to file
zeripath fda5b9fc3e
Add warning to set SENDMAIL_ARGS to -- (#19102)
Even with #17688 email addresses that contain an initial `-` may still be present in the db and it may in future still be possible to imagine a situation whereby initial `-` are repermitted.

This PR simply updates the documentation to warn users to set their SENDMAIL_ARGS with a terminal `--` to prevent this possibility email addresses being interpreted as options.

Signed-off-by: Andrew Thornton <art27@cantab.net>
2022-03-18 15:19:02 +01:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github Make the proformas clearer that we need DEBUG logs (#18700) 2022-02-10 17:11:58 +00:00
assets Clean up SVG (#13680) 2020-12-17 16:33:53 -05:00
build Use `go run` for tool dependencies, require go 1.17 (#18874) 2022-03-15 22:50:26 -04:00
cmd Fix flag validation (#19046) 2022-03-10 10:11:26 +00:00
contrib Fix script compatiable with OpenWrt (#19000) 2022-03-08 17:58:14 -05:00
custom/conf Add warning to set SENDMAIL_ARGS to -- (#19102) 2022-03-18 15:19:02 +01:00
docker Fix issue with docker-rootless shimming script (#18690) 2022-02-10 01:15:06 -05:00
docs Add warning to set SENDMAIL_ARGS to -- (#19102) 2022-03-18 15:19:02 +01:00
integrations rm .sample hooks which aren't used (#19101) 2022-03-16 10:33:07 +00:00
models Delete related notifications on issue deletion too (#18953) 2022-03-17 23:04:09 +01:00
modules nit fix (#19116) 2022-03-17 20:04:36 +02:00
options Do not send activation email if manual confirm is set (#19119) 2022-03-18 17:57:07 +08:00
public Remove CodeMirror dependencies (#18911) 2022-02-26 23:47:52 +08:00
routers Do not send activation email if manual confirm is set (#19119) 2022-03-18 17:57:07 +08:00
services Store the foreign ID of issues during migration (#18446) 2022-03-17 18:08:35 +01:00
snap revert to node14 for snapcraft 2022-02-01 15:10:55 -05:00
templates Do not send activation email if manual confirm is set (#19119) 2022-03-18 17:57:07 +08:00
tools format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
web_src Feature: show issue assignee on project board (#15232) 2022-03-09 00:42:28 +08:00
.air.toml Exclude from watching tests (#17744) 2021-11-22 05:17:21 -05:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.drone.yml use go1.18 to build gitea (#19099) 2022-03-16 00:08:31 -04:00
.editorconfig add well-known config for OIDC (#15355) 2021-04-15 22:32:00 -04:00
.eslintrc Update JS dependencies (#18898) 2022-02-25 15:08:35 -05:00
.gitattributes Update .gitattributes for .tmpl files (#18576) 2022-02-03 15:30:26 +00:00
.gitignore Validate migration files (#18203) 2022-01-26 10:45:51 +01:00
.golangci.yml use go1.18 to build gitea (#19099) 2022-03-16 00:08:31 -04:00
.ignore Add some .ignore entries (#18296) 2022-01-16 17:26:15 +00: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
.stylelintrc Update JS dependencies (#18898) 2022-02-25 15:08:35 -05:00
BSDmakefile Add BSDmakefile to prevent errors when `make` is called under FreeBSD (#4446) 2018-07-16 20:45:51 +02:00
CHANGELOG.md Frontport Changelogs (#19088) 2022-03-14 23:18:01 +01:00
CONTRIBUTING.md homebrew updates via cron 2022-03-03 15:59:26 -05:00
DCO follow the advisor: add DCO and some improvements 2016-11-04 16:43:41 +08:00
Dockerfile use go1.18 to build gitea (#19099) 2022-03-16 00:08:31 -04:00
Dockerfile.rootless use go1.18 to build gitea (#19099) 2022-03-16 00:08:31 -04:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Add singuliere to MAINTAINERS (#18148) 2022-01-02 02:12:13 +01:00
Makefile Update tool dependencies (#19120) 2022-03-18 10:17:56 +08:00
README.md use go1.18 to build gitea (#19099) 2022-03-16 00:08:31 -04:00
README_ZH.md Update `TODOs` badge to reflect new default branch (#18182) 2022-01-04 10:46:32 -06:00
SECURITY.md Add security policy to repo (#12536) 2020-08-19 17:15:55 +01:00
build.go Add bundle download for repository (#14538) 2021-08-24 11:47:09 -05:00
go.mod use go1.18 to build gitea (#19099) 2022-03-16 00:08:31 -04:00
go.sum Update golang.org/x/crypto (#19097) 2022-03-16 02:59:53 +01:00
jest.config.js Add copy button to markdown code blocks (#17638) 2021-11-16 16:16:05 +08:00
main.go format with gofumpt (#18184) 2022-01-20 18:46:10 +01:00
package-lock.json Remove CodeMirror dependencies (#18911) 2022-02-26 23:47:52 +08:00
package.json Remove CodeMirror dependencies (#18911) 2022-02-26 23:47:52 +08:00
webpack.config.js Support webauthn (#17957) 2022-01-14 16:03:31 +01:00

README.md

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.17 or greater.
  • 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 fo 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