Go to file
wxiaoguang faa28b5a44
Move public asset files to the proper directory (#25907)
Move `public/*` to `public/assets/*`

Some old PRs (like #15219) introduced inconsistent directory system.

For example: why the local directory "public" is accessed by
`http://site/assets`? How to serve the ".well-known" files properly in
the public directory?

For convention rules, the "public" directory is widely used for the
website's root directory. It shouldn't be an exception for Gitea.

So, this PR makes the things consistent:

* `http://site/assets/foo` means `{CustomPath}/public/assets/foo`.
* `{CustomPath}/public/.well-known` and `{CustomPath}/public/robots.txt`
can be used in the future.

This PR is also a prerequisite for a clear solution for:
* #21942
* #25892 
* discourse.gitea.io: [.well-known path serving custom files behind
proxy?](https://discourse.gitea.io/t/well-known-path-serving-custom-files-behind-proxy/5445/1)

This PR is breaking for users who have custom "public" files (CSS/JS).
After getting approvals, I will update the documents.

----

## ⚠️ BREAKING ⚠️

If you have files in your "custom/public/" folder, please move them to
"custom/public/assets/".

---------

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-07-18 18:06:43 +02: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 Upgrade go dependencies (#25819) 2023-07-14 11:00:31 +08:00
build Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
cmd Replace `interface{}` with `any` (#25686) 2023-07-04 18:36:08 +00:00
contrib Make environment-to-ini work with INSTALL_LOCK=true (#25926) 2023-07-17 17:56:06 +00:00
custom/conf Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
docker Fix WORK_DIR for docker (root) image (#25738) 2023-07-10 08:26:07 +00:00
docs Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
models Upgrade go dependencies (#25819) 2023-07-14 11:00:31 +08:00
modules Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
options [skip ci] Updated translations via Crowdin 2023-07-18 00:43:46 +00:00
public/assets/img Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
routers Ignore `runs-on` with expressions when warning no matched runners (#25917) 2023-07-17 18:19:53 +02:00
services fix incorrect repo url when changed the case of ownername (#25733) 2023-07-14 13:42:10 +08:00
snap Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
templates Fix margin on the new/edit project page. (#25885) 2023-07-16 14:53:54 +00:00
tests Fix the error message when the token is incorrect (#25701) 2023-07-11 10:04:28 +08:00
web_src Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02: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, misc tweaks (#25768) 2023-07-08 12:26:35 +02: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 and misc tweaks (#25540) 2023-06-27 21:44:17 +02:00
BSDmakefile update BSDmakefile to latest version from upstream (#24063) 2023-04-11 23:42:22 -04:00
CHANGELOG.md Add 1.20.0 changelog (#25901) 2023-07-16 15:28:21 +03: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
LICENSE Fix typo 2016-11-08 08:42:05 +01: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
README.md Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
README_ZH.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
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
go.mod Disallow dangerous url schemes (#25960) 2023-07-18 15:18:37 +00:00
go.sum Disallow dangerous url schemes (#25960) 2023-07-18 15:18:37 +00:00
main.go Do not prepare oauth2 config if it is not enabled, do not write config in some sub-commands (#25567) 2023-06-28 23:30:06 +02:00
package-lock.json Always pass 6-digit hex color to monaco (#25780) 2023-07-09 12:17:22 +02:00
package.json Always pass 6-digit hex color to monaco (#25780) 2023-07-09 12:17:22 +02:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
poetry.lock Add `make poetry-update`, upgrade `djlint` (#25399) 2023-06-26 21:14:00 +00:00
poetry.toml Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
pyproject.toml Enable H014 and H023 djlint rules (#25786) 2023-07-09 20:33:25 +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

README.md

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