README

简体中文

logo Gitea - Git with a cup of tea

Build Status codecov Go Report Card GoDoc GitHub release Help Contribute to Open Source Become a backer/sponsor of gitea Crowdin TODOs

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 forum!

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
Expand ▾ Collapse ▴

Documentation

Overview

Gitea (git with a cup of tea) is a painless self-hosted Git Service.

Source Files

Directories

Path Synopsis
cmd Package cmd provides subcommands to the gitea binary - such as "web" or "admin".
contrib/environment-to-ini
contrib/fixtures
contrib/pr
integrations
models
models/migrations
modules/analyze
modules/auth
modules/auth/ldap Package ldap provide functions & structure to query a LDAP ldap directory For now, it's mainly tested again an MS Active Directory service, see README.md for more information
modules/auth/oauth2
modules/auth/openid
modules/auth/pam
modules/auth/sso
modules/avatar
modules/base
modules/cache
modules/charset
modules/context
modules/convert
modules/cron
modules/emoji
modules/eventsource
modules/generate
modules/git
modules/git/pipeline
modules/gitgraph
modules/graceful
modules/hcaptcha
modules/highlight
modules/httplib
modules/indexer/code
modules/indexer/issues
modules/indexer/stats
modules/lfs
modules/log
modules/markup
modules/markup/common
modules/markup/csv
modules/markup/external
modules/markup/markdown
modules/markup/mdstripper
modules/markup/orgmode
modules/matchlist
modules/metrics
modules/migrations
modules/migrations/base
modules/nosql
modules/notification
modules/notification/action
modules/notification/base
modules/notification/indexer
modules/notification/mail
modules/notification/ui
modules/notification/webhook
modules/options
modules/password
modules/pprof
modules/private
modules/process
modules/public
modules/queue
modules/recaptcha
modules/references
modules/repofiles
modules/repository
modules/secret
modules/session
modules/setting
modules/ssh
modules/storage
modules/structs
modules/svg
modules/sync
modules/task
modules/templates
modules/test
modules/timeutil
modules/upload
modules/user
modules/util
modules/validation
modules/webhook
routers
routers/admin
routers/api/v1 Package v1 Gitea API.
routers/api/v1/admin
routers/api/v1/misc
routers/api/v1/notify
routers/api/v1/org
routers/api/v1/repo
routers/api/v1/settings
routers/api/v1/swagger
routers/api/v1/user
routers/api/v1/utils
routers/dev
routers/events
routers/org
routers/private Package private includes all internal routes.
routers/repo
routers/routes
routers/user
routers/user/setting
routers/utils
services/comments
services/externalaccount
services/gitdiff
services/issue
services/mailer
services/mirror
services/pull
services/release
services/repository
services/wiki