aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Improve docker rootless documentation (#21913)Xinyu Zhou2022-11-231-4/+20
| | | | | | | | Emphasize folder creation/permission granting Signed-off-by: Xinyu Zhou <i@sourcehut.net> Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Add option to enable CAPTCHA validation for login (#21638)Xinyu Zhou2022-11-222-1/+3
| | | | | | | | | | | | | | | | | Enable this to require captcha validation for user login. You also must enable `ENABLE_CAPTCHA`. Summary: - Consolidate CAPTCHA template - add CAPTCHA handle and context - add `REQUIRE_CAPTCHA_FOR_LOGIN` config and docs - Consolidate CAPTCHA set-up and verification code Partially resolved #6049 Signed-off-by: Xinyu Zhou <i@sourcehut.net> Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: Andrew Thornton <art27@cantab.net>
* Clarify logging documentation (#21665)mpeter502022-11-221-100/+168
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | My pull request changes the logging documentation that is visible here: https://docs.gitea.io/en-us/logging-configuration/ The reason behind the changes is that for some time I've found the logging documentation confusing, and wanted to give a try at making it more clear. --- If you find the existing changes to be ok, please don't merge yet, as I have further ideas which I want to discuss with you before making the changes. ### Swap the "Log Groups" and "Log outputs" sections. I want to move the "Log outputs" section before the "Log Groups" section. The reason is that the "Log Groups" section refers to ini sections that are only later explained, and to concepts that are general and should be documented in "Log outputs" or a different section. This change is essentially a swap of the "Log Groups" and "Log outputs" sections. That way the doumentation would follow the structure in which the ini file is built: first explaining the outer sections, and then the inner ones ([log], [log.name], [log.name.default], ...) ### Explain the workings of ambigous settings below the settings listing Right now the basics of a setting is shown later than the explanation of its special workings, for example with `FILE_NAME` at [the file output mode](https://docs.gitea.io/en-us/logging-configuration/#file-mode) (well, if the first changes are taken into account). Currently I have `TODO` witten at 2 settings, which I have to figure out how do they exactly work before I can document them. ### New section about [log] New section after "Collecting Logs for Help" about how the top level [log] itself works and what can go there. Currently, variables that directly go into [log] are noted throughout the whole document. --- Please let me know what you think about the changes. A counterargument that I myself see is that some of this is already present in the cheatsheet, but I think it would be better to have [this document](https://docs.gitea.io/en-us/logging-configuration/) as a throrough explanation of how logging is configured, and the cheatsheet would only have a short outline of the possible sections and variables. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Allow disable RSS/Atom feed (#21622)Xinyu Zhou2022-11-211-0/+1
| | | | | | | This patch provide a mechanism to disable RSS/Atom feed. Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de>
* Improve documentation for PAM and static deployment (#21866)Andrew Buettner2022-11-202-6/+47
| | | | | | | | | | | ## Changes proposed in [referenced issue 21845][1] - Expand PAM configuration description with working examples. - Clarify `STATIC_URL_PREFIX` use (include "assets" and only works after database has been initialized) - Add note for HTTPS proxy support VIA Apache. [1]: https://github.com/go-gitea/gitea/issues/21845
* Add package registry cleanup rules (#21658)KN4CK3R2022-11-201-0/+84
| | | | | | | | | | | | | | | | | | | | | | | | | Fixes #20514 Fixes #20766 Fixes #20631 This PR adds Cleanup Rules for the package registry. This allows to delete unneeded packages automatically. Cleanup rules can be set up from the user or org settings. Please have a look at the documentation because I'm not a native english speaker. Rule Form ![grafik](https://user-images.githubusercontent.com/1666336/199330792-c13918a6-e196-4e71-9f53-18554515edca.png) Rule List ![grafik](https://user-images.githubusercontent.com/1666336/199331261-5f6878e8-a80c-4985-800d-ebb3524b1a8d.png) Rule Preview ![grafik](https://user-images.githubusercontent.com/1666336/199330917-c95e4017-cf64-4142-a3e4-af18c4f127c3.png) Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Fix "build from source" document to clarify the `bindata` tag is required. ↵wxiaoguang2022-11-181-6/+5
| | | | (#21853)
* Improve pull/ push mirror documentation (especially for GitHub) (#21801)delvh2022-11-141-4/+8
|
* Add plural definitions for German translations (#21802)delvh2022-11-131-4/+4
| | | | Previously, there were discussions on how to write certain plurals. So, we explicitly document the special plurals to end the discussion.
* Add configuration for CORS allowed headers (#21747)Drew Noel2022-11-111-0/+1
| | | | | | | | | | This PR enhances the CORS middleware usage by allowing for the headers to be configured in `app.ini`. Fixes #21746 Co-authored-by: KN4CK3R <admin@oldschoolhack.me> Co-authored-by: John Olheiser <john.olheiser@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Attempt clarify AppWorkPath etc. (#21656)zeripath2022-11-093-38/+76
| | | | | | | | | | Attempt clarify the AppWorkPath in the documentation by using different notation and adding a section to the start of the cheat sheet. Fix #21523 Signed-off-by: Andrew Thornton <art27@cantab.net> Signed-off-by: Andrew Thornton <art27@cantab.net>
* Add package registry quota limits (#21584)KN4CK3R2022-11-091-0/+14
| | | | | | | | | | Related #20471 This PR adds global quota limits for the package registry. Settings for individual users/orgs can be added in a seperate PR using the settings table. Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Fix typo (#21695)Xinyu Zhou2022-11-072-2/+2
| | | | | | Duplicate parentheses written in link. Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: Lauris BH <lauris@nix.lv>
* Fix docs relref (#21685)Xinyu Zhou2022-11-042-2/+2
| | | | reslove https://github.com/go-gitea/gitea/issues/21627#issuecomment-1303678781
* Add Webhook authorization header (#20926)oliverpool2022-11-031-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | _This is a different approach to #20267, I took the liberty of adapting some parts, see below_ ## Context In some cases, a weebhook endpoint requires some kind of authentication. The usual way is by sending a static `Authorization` header, with a given token. For instance: - Matrix expects a `Bearer <token>` (already implemented, by storing the header cleartext in the metadata - which is buggy on retry #19872) - TeamCity #18667 - Gitea instances #20267 - SourceHut https://man.sr.ht/graphql.md#authentication-strategies (this is my actual personal need :) ## Proposed solution Add a dedicated encrypt column to the webhook table (instead of storing it as meta as proposed in #20267), so that it gets available for all present and future hook types (especially the custom ones #19307). This would also solve the buggy matrix retry #19872. As a first step, I would recommend focusing on the backend logic and improve the frontend at a later stage. For now the UI is a simple `Authorization` field (which could be later customized with `Bearer` and `Basic` switches): ![2022-08-23-142911](https://user-images.githubusercontent.com/3864879/186162483-5b721504-eef5-4932-812e-eb96a68494cc.png) The header name is hard-coded, since I couldn't fine any usecase justifying otherwise. ## Questions - What do you think of this approach? @justusbunsi @Gusted @silverwind - ~~How are the migrations generated? Do I have to manually create a new file, or is there a command for that?~~ - ~~I started adding it to the API: should I complete it or should I drop it? (I don't know how much the API is actually used)~~ ## Done as well: - add a migration for the existing matrix webhooks and remove the `Authorization` logic there _Closes #19872_ Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Gusted <williamzijl7@hotmail.com> Co-authored-by: delvh <dev.lh@web.de>
* Refactor docs (#21627)Xinyu Zhou2022-10-3116-175/+7
| | | | | | | | | | | | | | This patch: - Rename some files( `.md` to `.en-us.md`), fix missed translation copy - Update link which shoud be refer to `../hacking-on-gitea/` instead of `../make/` (outdated) - Update `_redirects`: - redirect `/{zh-cn|fr-fr}/make/` to `../hacking-on-gitea/` - redirect `/zh-cn/third-party-tools/` to `/zh-cn/integrations/` - Delete duplicated/outdated files. - Update menu `weight` of developers.zh-cn.md Signed-off-by: Xinyu Zhou <i@sourcehut.net>
* Update "email usage" page to current ver. (1.18) (#21649)melkor02022-10-311-2/+4
| | | | | In version 1.18 the naming scheme for smtp has been changed, HOST has been split in SMTP_ADDR and SMTP_PORT (https://docs.gitea.io/en-us/config-cheat-sheet/#mailer-mailer).
* Allow disable sitemap (#21617)Xinyu Zhou2022-10-281-0/+1
| | | | | | | This patch provide a mechanism to disable [sitemap](https://github.com/go-gitea/gitea/pull/18407). Signed-off-by: Xinyu Zhou <i@sourcehut.net> Co-authored-by: 6543 <6543@obermui.de>
* Improve documentation (#21612)mpeter502022-10-271-2/+2
| | | | | | | | | | Fix file reference at the FLAGS line at the Log subsections heading, improve COLORIZE line wording. The FLAGS line referenced a file that doesn't exist in the repository as of now. The COLORIZE line's wording implied that it would unconditionally colorize the log by default. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Record OAuth client type at registration (#21316)M Hickford2022-10-241-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The OAuth spec [defines two types of client](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1), confidential and public. Previously Gitea assumed all clients to be confidential. > OAuth defines two client types, based on their ability to authenticate securely with the authorization server (i.e., ability to > maintain the confidentiality of their client credentials): > > confidential > Clients capable of maintaining the confidentiality of their credentials (e.g., client implemented on a secure server with > restricted access to the client credentials), or capable of secure client authentication using other means. > > **public > Clients incapable of maintaining the confidentiality of their credentials (e.g., clients executing on the device used by the resource owner, such as an installed native application or a web browser-based application), and incapable of secure client authentication via any other means.** > > The client type designation is based on the authorization server's definition of secure authentication and its acceptable exposure levels of client credentials. The authorization server SHOULD NOT make assumptions about the client type. https://datatracker.ietf.org/doc/html/rfc8252#section-8.4 > Authorization servers MUST record the client type in the client registration details in order to identify and process requests accordingly. Require PKCE for public clients: https://datatracker.ietf.org/doc/html/rfc8252#section-8.1 > Authorization servers SHOULD reject authorization requests from native apps that don't use PKCE by returning an error message Fixes #21299 Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update macOS install command (#21507)RainboWu2022-10-191-1/+1
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* inline gitpod image (#21494)techknowlogick2022-10-182-1/+24
| | | | | fix #21492 Co-authored-by: 6543 <6543@obermui.de>
* Update reverse-proxies.zh-cn.md (#21484)rock2dust2022-10-171-0/+14
| | | | | | | | | | | | | add proxy header to nginx config example ``` proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; ``` Signed-off-by: rock2dust <its@baronbunny.cn> Signed-off-by: rock2dust <its@baronbunny.cn> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Docs: Update the feature comparison to other Git Hosting Services (#20933)delvh2022-10-171-89/+97
| | | This was drastically outdated recently.
* update current stable versiontechknowlogick2022-10-151-1/+1
|
* Add support for Chocolatey/NuGet v2 API (#21393)KN4CK3R2022-10-131-1/+1
| | | | | | | | Fixes #21294 This PR adds support for NuGet v2 API. Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Refactor Gitpod configuration to improve quick spin up of automated dev ↵Yarden Shoham2022-10-121-0/+6
| | | | | | | | | | | | | | | | | environments (#21411) This commit instructs Gitpod to run `docs` in watch mode in fresh development environments so any dev could start hacking in seconds. Also included some vscode extensions for Vue, Go, and Docker. Try it here: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/yardenshoham/gitea/tree/gitpod) Signed-off-by: Yarden Shoham <hrsi88@gmail.com> Co-authored-by: Gusted <williamzijl7@hotmail.com>
* Fix broken link to frontend guidelines in hacking guidelines (#21382)Yarden Shoham2022-10-112-1/+1
|
* Improve clarity for camo proxy parameters (#21386)Bill Wenrich2022-10-111-3/+3
| | | | | | | | | | Updates the Config Cheat Sheet for the `ALLWAYS` option in Camo proxy. - Clarifies the behavior for true (both HTTP and HTTPS is proxied) vs false (only HTTP is proxied) - Minor grammar and typo improvements Co-authored-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Fix some typos and update db transaction demo in backend guideline (#21322)rj12022-10-081-18/+14
| | | Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Add redirect of /upgrade/ to /upgrade-from-gitea/ on docs site (#21330)Joe Constant2022-10-062-0/+6
| | | | | | | | Since adding an aliases block doesn't seem to work locally for me (I suspect because a page actually exists and Hugo is granting preference to existing pages over aliases), I also added entries to static/_redirects file so Netlify will handle the redirects Fixes #7208
* Make app.ini read-only message more prominent (#21315)John Olheiser2022-10-021-6/+6
|
* Fix doc and heatmap for the Vue3 refactoring (#21312)wxiaoguang2022-10-025-8/+8
|
* Allow specifying SECRET_KEY_URI, similar to INTERNAL_TOKEN_URI (#19663)Clar Fon2022-10-021-2/+3
| | | | | | Only load SECRET_KEY and INTERNAL_TOKEN if they exist. Never write the config file if the keys do not exist, which was only a fallback for Gitea upgraded from < 1.5 Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Fix the hook related FAQ contents (#21297)wxiaoguang2022-09-291-5/+5
| | | | | | | | | Follows https://github.com/go-gitea/gitea/issues/21129#issuecomment-1260802986 * https://github.com/go-gitea/gitea/issues/21129#issuecomment-1260802986 A lot of users are asking similar questions. The old content in FAQ doesn't seem to be related to the problem.
* Typo in config-cheat-sheet (#21261)Julien Palard2022-09-251-1/+1
|
* NPM Package Registry search API endpoint (#20280)Jack Vine2022-09-241-0/+5
| | | | | | | | | | Close #20098, in the NPM registry API, implemented to match what's described by https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search Currently have only implemented the bare minimum to work with the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html). Co-authored-by: Jack Vine <jackv@jack-lemur-suse.cat-prometheus.ts.net> Co-authored-by: KN4CK3R <admin@oldschoolhack.me> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Clarify that `ENABLE_SWAGGER` only influences the API docs, not the routes ↵delvh2022-09-203-8/+8
| | | | | | | (#21215) Previously, the docs seemed to suggest that you can disable the API completely by setting `ENABLE_SWAGGER=false`. This is not the case.
* Add KaTeX rendering to Markdown. (#20571)zeripath2022-09-144-2/+7
| | | | | | | | | | | | | | | | | | | | This PR adds mathematical rendering with KaTeX. The first step is to add a Goldmark extension that detects the latex (and tex) mathematics delimiters. The second step to make this extension only run if math support is enabled. The second step is to then add KaTeX CSS and JS to the head which will load after the dom is rendered. Fix #3445 Signed-off-by: Andrew Thornton <art27@cantab.net> Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update docs comparison.zh-cn.md (#21035)ya2022-09-131-89/+89
| | | | | | | | | | | | | | | | | | - Update Chinese translation from comparison.en-us.md <!-- Please check the following: 1. Make sure you are targeting the `main` branch, pull requests on release branches are only allowed for bug fixes. 2. Read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md 3. Describe what your pull request does and which issue you're targeting (if any) --> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: 6543 <6543@obermui.de>
* Fix PlantUML example in document (#21142)wxiaoguang2022-09-111-5/+5
| | | | | | | The document was written before Gitea 1.15. Now Gitea uses `/assets` sub-directory (#15219). Close #21023 * #21023
* Fix typo of issue template name (#21117)Jason Song2022-09-092-2/+2
| | | | | | | | | Should be - .gitea/issue_template.md - .gitea/issue_template.yaml - .gitea/issue_template.~~md~~yml Related to #20987, #21030.
* Fix various typos (#21103)luzpaz2022-09-071-2/+2
| | | | | | | Found via `codespell -q 3 -S ./options/locale,./options/license,./public/vendor,./web_src/fomantic -L actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon` Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Update docs issue-pull-request-templates.zh-cn.md (#21030)ya2022-09-071-20/+280
| | | | | | | | | | | | | | | | | | Follow #20987, update docs issue-pull-request-templates.zh-cn.md <!-- Please check the following: 1. Make sure you are targeting the `main` branch, pull requests on release branches are only allowed for bug fixes. 2. Read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md 3. Describe what your pull request does and which issue you're targeting (if any) --> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Upgrade the document about how to collect logs for systemd and docker (#21101)wxiaoguang2022-09-073-6/+12
| | | | Many users (#21099) do not know how to collect logs if they are using systemd. This PR makes the document more clear.
* Remove insecure flag from curl (#21074)John Olheiser2022-09-051-1/+1
| | | | | | | | Followup to #21071 Thanks for the catch @wxiaoguang [WRT](https://github.com/go-gitea/gitea/pull/21071#discussion_r962706673) Ref #21071
* Update curl usage in API docs (#21071)John Olheiser2022-09-052-6/+6
|
* Added docs for agit-setup (#21027)Cypherpunk Samurai2022-09-031-0/+47
| | | | | | | | | This PR Adds Documentation for the new Agit feature. Agit allows creating PR directly while pushing code. Close #21018 Co-authored-by: CypherpunkSamurai <CypherpunkSamurai@users.noreply.github.com> Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: a1012112796 <1012112796@qq.com>
* Kd/ci playwright go test (#20123)Kyle D2022-09-022-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add initial playwright config * Simplify Makefile * Simplify Makefile * Use correct config files * Update playwright settings * Fix package-lock file * Don't use test logger for e2e tests * fix frontend lint * Allow passing TEST_LOGGER variable * Init postgres database * use standard gitea env variables * Update playwright * update drone * Move empty env var to commands * Cleanup * Move integrations to subfolder * tests integrations to tests integraton * Run e2e tests with go test * Fix linting * install CI deps * Add files to ESlint * Fix drone typo * Don't log to console in CI * Use go test http server * Add build step before tests * Move shared init function to common package * fix drone * Clean up tests * Fix linting * Better mocking for page + version string * Cleanup test generation * Remove dependency on gitea binary * Fix linting * add initial support for running specific tests * Add ACCEPT_VISUAL variable * don't require git-lfs * Add initial documentation * Review feedback * Add logged in session test * Attempt fixing drone race * Cleanup and bump version * Bump deps * Review feedback * simplify installation * Fix ci * Update install docs
* Support Issue forms and PR forms (#20987)Jason Song2022-09-023-28/+238
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * feat: extend issue template for yaml * feat: support yaml template * feat: render form to markdown * feat: support yaml template for pr * chore: rename to Fields * feat: template unmarshal * feat: split template * feat: render to markdown * feat: use full name as template file name * chore: remove useless file * feat: use dropdown of fomantic ui * feat: update input style * docs: more comments * fix: render text without render * chore: fix lint error * fix: support use description as about in markdown * fix: add field class in form * chore: generate swagger * feat: validate template * feat: support is_nummber and regex * test: fix broken unit tests * fix: ignore empty body of md template * fix: make multiple easymde editors work in one page * feat: better UI * fix: js error in pr form * chore: generate swagger * feat: support regex validation * chore: generate swagger * fix: refresh each markdown editor * chore: give up required validation * fix: correct issue template candidates * fix: correct checkboxes style * chore: ignore .hugo_build.lock in docs * docs: separate out a new doc for merge templates * docs: introduce syntax of yaml template * feat: show a alert for invalid templates * test: add case for a valid template * fix: correct attributes of required checkbox * fix: add class not-under-easymde for dropzone * fix: use more back-quotes * chore: remove translation in zh-CN * fix EasyMDE statusbar margin * fix: remove repeated blocks * fix: reuse regex for quotes Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-28 09:48:18 +0000