1
1
mirror of https://github.com/go-gitea/gitea synced 2024-11-07 10:44:26 +00:00
Git with a cup of tea, painless self-hosted git service https://gitea.io
Go to file
idk cdd3d4b8d8
Allow the use of alternative net.Listener implementations by downstreams (#25855)
This is a simple PR which moves the `GetListener` function to a
`DefaultGetListener` function, and changes `GetListener` to be a
variable which by default points to the `DefaultGetListener` function.
This allows people who may exist quasi-downstream of Gitea to create
alternate "GetListener" functions, with identical signatures, which
return different implementations of the `net.Listener` interface. This
approach is expressly intended to be non-invasive and have the least
possible impact on the gitea codebase. A previous version of this idea
was rejected before: https://github.com/go-gitea/gitea/issues/15544 but
because of issues like: https://github.com/go-gitea/gitea/issues/22335 I
**really** think that recommending people configure proxies by hand is
exactly the wrong way to do things(This is why there is a Tor Browser.).
This tiny change lets me put proper hidden service configuration into
single `i2p.go` file which lives in `modules/graceful/` and which never
has to be checked in to your codebase or affect your dependencies or
bloat your project in any way, it can live on a branch in my fork and
I'll fast-forward every release and never the twain shall meet.

The main use-case for this is to listen on Peer-to-Peer networks and
Hidden Services directly without error-prone and cumbersome
port-forwarding configuration. For instance, I might implement an
"I2PGetListener" as follows:

```Go
// adapted from i2p.go which is unchecked-in in my modules/graceful/ directory
import "github.com/eyedeekay/onramp"

var garlic = &onramp.Garlic{}

func I2PGetListener(network, address string) (net.Listener, error) {
	// Add a deferral to say that we've tried to grab a listener
	defer GetManager().InformCleanup()
	switch network {
	case "tcp", "tcp4", "tcp6", "i2p", "i2pt":
		return garlic.Listen()
	case "unix", "unixpacket":
// I2P isn't really a replacement for the stuff you use Unix sockets for and it's also not an anonymity risk, so treat them normally
		unixAddr, err := net.ResolveUnixAddr(network, address)
		if err != nil {
			return nil, err
		}
		return GetListenerUnix(network, unixAddr)
	default:
		return nil, net.UnknownNetworkError(network)
	}
}
```

I could then substitute that GetListener function and be 50% of the way
to having a fully-functioning gitea-over-hidden-services instance
without any additional configuration(The other 50% doesn't require any
code-changes on gitea's part).

There are 2 advantages here, one being convenience, first this turns
hidden services into a zero-configuration option for self-hosting gitea,
and second safety, these Go libraries are passing around
hidden-service-only versions of the net.Addr struct, they're using
hidden-service-only versions of the sockets, which are both expressly
designed to never require access to any information outside the hidden
service network, manipulating the application so it reveals information
about the host becomes much more difficult, and some attacks become
nearly impossible. It also opens up TLS-over-Hidden Services support
which is niche right now, of course, but in a future where gitea
instances federate if hidden services want to be part of the federation
they're probably going to need TLS certificates. They don't need to be
painful to set up.

This doesn't fix an open issue, but it might affect:
- https://github.com/go-gitea/gitea/issues/22335 - my `i2p.go` file
actually has a mod that fixes this but it requires adding a handful of
new dependencies to gitea and isn't compatible with the normal way you
guys recommend using a proxy so I don't think it's ready to send to you
as a PR, but if I can find a non-invasive way to fix it I will.
 - https://github.com/go-gitea/gitea/issues/18240

I hereby agree to the Code of Conduct published here:
8b89563bf1/CODE_OF_CONDUCT.md
I have read and understood the recommendations published here:
8b89563bf1/CONTRIBUTING.md

Thank you for your consideration.

---------

Co-authored-by: eyedeekay <idk@mulder>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
2023-07-24 07:18:17 +00:00
.devcontainer Add Github related extensions in devcontainer (#25800) 2023-07-14 15:58:02 +08:00
.gitea Issue template form (#16349) 2021-09-15 20:33:13 +03:00
.github Remove feature label from feature request issue template (#25696) 2023-07-05 16:58:56 +08:00
assets Replace gogs/cron with go-co-op/gocron (#25977) 2023-07-24 04:13:41 +00:00
build Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
cmd Add missing default value for some Bool cli flags (#26082) 2023-07-24 06:49:18 +00:00
contrib Refactor to use urfave/cli/v2 (#25959) 2023-07-21 17:28:19 +08:00
custom/conf Refactor to use urfave/cli/v2 (#25959) 2023-07-21 17:28:19 +08:00
docker Fix WORK_DIR for docker (root) image (#25738) 2023-07-10 08:26:07 +00:00
docs Update secrets.en-us.md (#26057) 2023-07-22 09:34:01 +00:00
models Reduce unnecessary DB queries for Actions tasks (#25199) 2023-07-24 06:11:27 +00:00
modules Allow the use of alternative net.Listener implementations by downstreams (#25855) 2023-07-24 07:18:17 +00:00
options Make organization redirect warning more clear (#26077) 2023-07-24 04:17:32 +00:00
public Serve pre-defined files in "public", add "security.txt", add CORS header for ".well-known" (#25974) 2023-07-21 12:14:20 +00:00
routers Reduce unnecessary DB queries for Actions tasks (#25199) 2023-07-24 06:11:27 +00:00
services Replace gogs/cron with go-co-op/gocron (#25977) 2023-07-24 04:13:41 +00:00
snap Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
templates Categorize admin settings sidebar panel (#26030) 2023-07-24 09:05:16 +08:00
tests Fix the truncate and alignment problem for some admin tables (#26042) 2023-07-22 10:54:48 +00:00
web_src Fix the truncate and alignment problem for some admin tables (#26042) 2023-07-22 10:54:48 +00:00
.air.toml Reduce verbosity of dev commands (#24917) 2023-05-24 20:11:04 +00:00
.changelog.yml Changelog for v1.15.0-rc1 (#16422) 2021-07-15 11:47:57 -04:00
.dockerignore Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
.drone.yml build nightly docker images (#25317) 2023-06-18 01:04:23 -04:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Update JS dependencies (#26025) 2023-07-21 11:34:10 +08:00
.gitattributes Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
.gitignore Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
.gitpod.yml Add Github related extensions in devcontainer (#25800) 2023-07-14 15:58:02 +08:00
.golangci.yml Update tool dependencies, lock govulncheck and actionlint (#25655) 2023-07-09 11:58:06 +00:00
.ignore Remove the service worker (#25010) 2023-05-31 02:07:04 +00:00
.markdownlint.yaml Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.npmrc Upgrade to npm lockfile v3 and explicitely set it (#23561) 2023-03-18 19:38:10 +01:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Update JS dependencies (#26025) 2023-07-21 11:34:10 +08:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
CHANGELOG.md Add changelog for 1.20.1 (#26015) 2023-07-22 17:01:38 +08:00
CODE_OF_CONDUCT.md Add Gitea Community Code of Conduct (#23188) 2023-03-09 10:49:34 +08:00
CONTRIBUTING.md Update blog links (#25843) 2023-07-12 11:35:07 +00:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile Update to Alpine 3.18 (#24700) 2023-05-14 01:49:00 +00:00
Dockerfile.rootless Update to Alpine 3.18 (#24700) 2023-05-14 01:49:00 +00:00
go.mod Replace gogs/cron with go-co-op/gocron (#25977) 2023-07-24 04:13:41 +00:00
go.sum Replace gogs/cron with go-co-op/gocron (#25977) 2023-07-24 04:13:41 +00:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Refactor to use urfave/cli/v2 (#25959) 2023-07-21 17:28:19 +08:00
MAINTAINERS Apply to became a maintainer. (#25745) 2023-07-07 13:49:34 +02:00
Makefile Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
package-lock.json Update JS dependencies (#26025) 2023-07-21 11:34:10 +08:00
package.json Update JS dependencies (#26025) 2023-07-21 11:34:10 +08:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
poetry.lock Update djlint, enable H026 and T027 (#25980) 2023-07-19 10:35:25 +02:00
poetry.toml Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
pyproject.toml Update djlint, enable H026 and T027 (#25980) 2023-07-19 10:35:25 +02:00
README_ZH.md Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
README.md Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
SECURITY.md Link to list of vulnerabilities (#25872) 2023-07-14 01:26:54 +00:00
vitest.config.js Update JS dependencies, misc tweaks (#25768) 2023-07-08 12:26:35 +02:00
webpack.config.js Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00

Gitea

Gitea - Git with a cup of tea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. You can try it out using the online demo. This project has been forked from Gogs since November of 2016, but a lot has changed.

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 Stable, required version is defined in go.mod.
  • 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 to fill it as questions pop up.

https://docs.gitea.io/en-us/contributing/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