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 5d2e11eedb
Refactor: Move login out of models (#16199)
`models` does far too much. In particular it handles all `UserSignin`.

It shouldn't be responsible for calling LDAP, SMTP or PAM for signing in.

Therefore we should move this code out of `models`.

This code has to depend on `models` - therefore it belongs in `services`.

There is a package in `services` called `auth` and clearly this functionality belongs in there.

Plan:

- [x] Change `auth.Auth` to `auth.Method` - as they represent methods of authentication.
- [x] Move `models.UserSignIn` into `auth`
- [x] Move `models.ExternalUserLogin`
- [x] Move most of the `LoginVia*` methods to `auth` or subpackages
- [x] Move Resynchronize functionality to `auth`
  - Involved some restructuring of `models/ssh_key.go` to reduce the size of this massive file and simplify its files.
- [x] Move the rest of the LDAP functionality in to the ldap subpackage
- [x] Re-factor the login sources to express an interfaces `auth.Source`?
  - I've done this through some smaller interfaces Authenticator and Synchronizable - which would allow us to extend things in future
- [x] Now LDAP is out of models - need to think about modules/auth/ldap and I think all of that functionality might just be moveable
- [x] Similarly a lot Oauth2 functionality need not be in models too and should be moved to services/auth/source/oauth2
  - [x] modules/auth/oauth2/oauth2.go uses xorm... This is naughty - probably need to move this into models.
  - [x] models/oauth2.go - mostly should be in modules/auth/oauth2 or services/auth/source/oauth2 
- [x] More simplifications of login_source.go may need to be done
- Allow wiring in of notify registration -  *this can now easily be done - but I think we should do it in another PR*  - see #16178 
- More refactors...?
  - OpenID should probably become an auth Method but I think that can be left for another PR
  - Methods should also probably be cleaned up  - again another PR I think.
  - SSPI still needs more refactors.* Rename auth.Auth auth.Method
* Restructure ssh_key.go

- move functions from models/user.go that relate to ssh_key to ssh_key
- split ssh_key.go to try create clearer function domains for allow for
future refactors here.

Signed-off-by: Andrew Thornton <art27@cantab.net>
2021-07-24 11:16:34 +01:00
.github Update pull_request_template.md (#15948) 2021-05-22 10:46:33 -04:00
assets Clean up SVG (#13680) 2020-12-17 16:33:53 -05:00
build Use binary version of revive linter (#15739) 2021-05-09 13:08:02 +02:00
cmd Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
contrib Update bluemonday to v1.0.15 (#16379) 2021-07-09 03:30:31 +02:00
custom/conf Make Mermaid.js limit configurable (#16519) 2021-07-24 00:21:51 -04:00
docker Change docker tag logic (#16421) 2021-07-14 18:08:43 +01:00
docs Make Mermaid.js limit configurable (#16519) 2021-07-24 00:21:51 -04:00
integrations Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
models Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
modules Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
options [skip ci] Updated translations via Crowdin 2021-07-24 00:07:49 +00:00
public Add support for corporate WeChat webhooks (#15910) 2021-07-23 12:41:27 +08:00
routers Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
services Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
snap Removable media support (#16136) 2021-06-11 14:51:05 -04:00
templates Refactor: Move login out of models (#16199) 2021-07-24 11:16:34 +01:00
tools Fuzzer finds an NPE due to incorrect URLPrefix (#16249) 2021-06-25 14:14:49 -04:00
vendor Update bluemonday to v1.0.15 (#16379) 2021-07-09 03:30:31 +02:00
web_src Make Mermaid.js limit configurable (#16519) 2021-07-24 00:21:51 -04:00
.air.conf Add 'watch-backend' (#12330) 2020-07-27 14:05:42 -04:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.drone.yml CI: Add unit-test-race (#16470) 2021-07-17 22:46:20 +02:00
.editorconfig add well-known config for OIDC (#15355) 2021-04-15 22:32:00 -04:00
.eslintrc Update JS dependencies, use Node 16 (#15804) 2021-05-13 11:12:36 -04:00
.gitattributes Update JS dependencies and misc tweaks (#13741) 2020-11-29 16:39:36 -05:00
.gitignore Update JS dependencies, use Node 16 (#15804) 2021-05-13 11:12:36 -04:00
.golangci.yml Refactor routers directory (#15800) 2021-06-09 01:33:54 +02: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
CHANGELOG.md Changelog for 1.15.0-rc2 (#16511) (#16515) 2021-07-22 20:20:21 +02:00
CONTRIBUTING.md Change the release cycle to match actual situations (#16430) 2021-07-14 14:03:00 -04:00
DCO follow the advisor: add DCO and some improvements 2016-11-04 16:43:41 +08:00
Dockerfile revert to use alpine 3.13 (#16451) 2021-07-16 09:54:39 +08:00
Dockerfile.rootless revert to use alpine 3.13 (#16451) 2021-07-16 09:54:39 +08:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
MAINTAINERS Add jpraet to MAINTAINERS (#16274) 2021-06-27 18:35:31 +01:00
Makefile Prevent race in TestPersistableChannelQueue (#16468) 2021-07-17 19:09:56 +02:00
README.md microbadger is no more, rm from readme (#16440) 2021-07-15 13:08:20 -04:00
README_ZH.md microbadger is no more, rm from readme (#16440) 2021-07-15 13:08:20 -04:00
SECURITY.md Add security policy to repo (#12536) 2020-08-19 17:15:55 +01:00
build.go Use binary version of revive linter (#15739) 2021-05-09 13:08:02 +02:00
go.mod Update bluemonday to v1.0.15 (#16379) 2021-07-09 03:30:31 +02:00
go.sum Update bluemonday to v1.0.15 (#16379) 2021-07-09 03:30:31 +02:00
jest.config.js Add jest rootDir and test-frontend dependency (#15860) 2021-05-14 07:28:51 +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
package-lock.json Replace clipboard.js with async clipboard api (#15899) 2021-05-30 20:15:57 +01:00
package.json Replace clipboard.js with async clipboard api (#15899) 2021-05-30 20:15:57 +01:00
webpack.config.js Disable legal comments in esbuild (#15929) 2021-05-19 22:46:30 +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.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!

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