summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
* Merge `push to create`, `open PR from push`, and `push options` docs ↵Lunny Xiao2023-04-074-73/+107
| | | | | | | | | | | | articles into one (#23744) Add documentation for this feature. <img width="734" alt="gitea-push-hint" src="https://user-images.githubusercontent.com/81045/227921177-af08ab76-7556-4a69-8da9-bb59cec1388b.png"> --------- Co-authored-by: delvh <dev.lh@web.de>
* Adjust some documentations titles (#23941)Lunny Xiao2023-04-0610-10/+10
| | | As title.
* Update docs markdown file weight to make it clear (#23909)Lunny Xiao2023-04-045-4/+6
| | | | For Docusaurus, it needs a meta data named `sidebar_position`, so we copy all `weight` under `menu/sidebar` as top meta key.
* Implement Issue Config (#20956)JakobDev2023-03-281-0/+38
| | | | | | | | Closes #20955 This PR adds the possibility to disable blank Issues, when the Repo has templates. This can be done by creating the file `.gitea/issue_config.yaml` with the content `blank_issues_enabled` in the Repo.
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-2323-1821/+1041
| | | | | | | | | | | | | | | | | | | | | | administration, usage, development, contributing the 5 main parts (#23629) - **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
* Update PR documentation (#23620)John Olheiser2023-03-211-1/+37
| | | | | | | | | This updates the PR docs and explains how to work with PRs, for those who may not know. It was mentioned that this page could explain PRs a bit better, in case some users are not familiar with GitHub or similar forges. Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Push option bonus for PTC docs (#23473)John Olheiser2023-03-143-2/+6
| | | | | | | | | Follow-up for #23458 I could have suggested this on the original PR, but I thought there would be more to add. Hadn't noticed the push options docs already had nearly the same shell command. 😅 Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Lint Markdown passtechknowlogick2023-03-141-1/+2
|
* Push to create docs (#23458)techknowlogick2023-03-141-0/+35
| | | | This PR adds user friendly documentation on how to use push to create feature
* Scoped label display and documentation tweaks (#23430)Brecht Van Lommel2023-03-131-5/+3
| | | | | | | | | | | * Fix scoped label left and right part breaking across lines. * Remove slanted divider in scoped label display, make it straight. After using this for a while, this feels more visually noisy than helpful. * Reduce contrast between scope and item to reduce probability of unreadable text on background. * Change documentation to remove mention of non-exclusive scoped labels. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add basic documentation for labels, including scoped labels (#23304)Brecht Van Lommel2023-03-051-0/+42
| | | | | | | Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
* Improve reverse proxies documentation (#23068)Joakim Pettersen2023-02-231-0/+20
| | | | | | | Add "Traefik with a sub-path" documentation closes #23047 Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Add command to bulk set must-change-password (#22823)zeripath2023-02-141-0/+7
| | | | | | | | | As part of administration sometimes it is appropriate to forcibly tell users to update their passwords. This PR creates a new command `gitea admin user must-change-password` which will set the `MustChangePassword` flag on the provided users. Signed-off-by: Andrew Thornton <art27@cantab.net>
* Map OIDC groups to Orgs/Teams (#21441)KN4CK3R2023-02-081-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | Fixes #19555 Test-Instructions: https://github.com/go-gitea/gitea/pull/21441#issuecomment-1419438000 This PR implements the mapping of user groups provided by OIDC providers to orgs teams in Gitea. The main part is a refactoring of the existing LDAP code to make it usable from different providers. Refactorings: - Moved the router auth code from module to service because of import cycles - Changed some model methods to take a `Context` parameter - Moved the mapping code from LDAP to a common location I've tested it with Keycloak but other providers should work too. The JSON mapping format is the same as for LDAP. ![grafik](https://user-images.githubusercontent.com/1666336/195634392-3fc540fc-b229-4649-99ac-91ae8e19df2d.png) --------- Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add CLI option tenant ID for oauth2 source (#22769)Adi2023-02-051-0/+2
| | | Fixes #22713
* Fix typo in command-line.en-us.md (#22681)Ivan Maximov2023-01-311-1/+1
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Fix typo in linked-references.en-us.md (#22682)Ivan Maximov2023-01-311-1/+1
|
* Add support for incoming emails (#22056)KN4CK3R2023-01-141-0/+47
| | | | | | | | | | | | | | | | | | | | | | | | | | | | closes #13585 fixes #9067 fixes #2386 ref #6226 ref #6219 fixes #745 This PR adds support to process incoming emails to perform actions. Currently I added handling of replies and unsubscribing from issues/pulls. In contrast to #13585 the IMAP IDLE command is used instead of polling which results (in my opinion 😉) in cleaner code. Procedure: - When sending an issue/pull reply email, a token is generated which is present in the Reply-To and References header. - IMAP IDLE waits until a new email arrives - The token tells which action should be performed A possible signature and/or reply gets stripped from the content. I added a new service to the drone pipeline to test the receiving of incoming mails. If we keep this in, we may test our outgoing emails too in future. Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update Gmail mailer configuration (#22291)James Liu2023-01-021-3/+6
| | | | | | | | | | | | | This PR updates the `[mailer]` configuration snippet for Gmail: - The `HELO_HOSTNAME` isn't required. - The `USER` must not include the @gmail domain. - `HOST` needs to be supplied, and the SMTP port number needs to be appended to the URL. I also added a note about the requirement to use App passwords instead of your Google account password directly. Co-authored-by: delvh <dev.lh@web.de>
* Refactor docs (#21627)Xinyu Zhou2022-10-313-0/+0
| | | | | | | | | | | | | | 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).
* 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>
* 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.
* 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>
* 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>
* Support Issue forms and PR forms (#20987)Jason Song2022-09-022-28/+235
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Fix typo (#20993)JonRB2022-08-291-1/+1
|
* Fix typo in backup documentation (pgdump->pg_dump) (#20913)Enrico2022-08-221-1/+1
| | | This PR fixes a small typo in the backup documentation: `pgdump` command is wrong, the correct name for the backup software in PostgreSQL is `pg_dump`
* docs: zh-cn translations for fail2ban setup (#20588)PEN²2022-08-011-0/+92
| | | Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Fix typos in backup documentation (#20567)tryfail2022-08-011-1/+1
| | | Fixed multiple typos "/user/local/bin" to the proper path "/usr/local/bin"
* Add markdownlint (#20512)silverwind2022-07-2812-19/+37
| | | | Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
* Fix alias traversal (#20076)Sandro2022-06-221-5/+5
| | | | | see https://github.com/yandex/gixy/blob/master/docs/en/plugins/aliastraversal.md Co-authored-by: 6543 <6543@obermui.de>
* Update permissions.en-us.md (#20075)Jordan Cech2022-06-211-4/+4
| | | | | | | | | | | | | | * Update permissions.en-us.md A few grammar tweaks to make docs a bit more clear. * Apply suggestions from code review Co-authored-by: delvh <dev.lh@web.de> * Update docs/content/doc/usage/permissions.en-us.md Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: delvh <dev.lh@web.de>
* docs: Mention file extension for issue_template directory (#20057)s-hamann2022-06-211-1/+1
|
* docs: recommendations to ensure backup consistency and reliability (#19845)singuliere2022-05-311-0/+17
| | | | | | | | | | | * docs: recommendations to ensure backup consistency and reliability * s/stooping/stopping/ * Update docs/content/doc/usage/backup-and-restore.en-us.md Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: delvh <dev.lh@web.de>
* Fix duplicate paragraph in documentation (#19820)Vladimir Yakovlev2022-05-271-9/+0
|
* Update document to use FHS `/usr/local/bin/gitea` instead of `/app/...` for ↵wxiaoguang2022-05-241-1/+1
| | | | | | | Docker (#19794) * Update document to use FHS `/usr/local/bin/gitea` instead of `/app/...` in Docker * Update docs/content/doc/installation/with-docker.zh-cn.md
* Allow custom default merge message with ↵Lunny Xiao2022-05-081-0/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | .gitea/default_merge_message/<merge_style>_TEMPLATE.md (#18177) * Allow custom default merge message with .gitea/MERGE_MESSAGE_<merge_style>_TEMPLATE.md * Some improvements * Follow some advices * Fix bug * Fix bug * Fix lint * Fix close comment * Fix test * Fix and docs * Improve codes * Update docs and remove unnecessary variables * return error for GetDefaultMergeMessage * Fix test * improve code * ignore unknow unit type * return error for GetDefaultMergeMessage * Update services/pull/merge.go * Some improvements * Follow some advices * Fix bug * Fix lint * Improve codes * Update docs and remove unnecessary variables * return error for GetDefaultMergeMessage * improve code * Handle deleted HeadRepo in GetDefaultMergeMessage Signed-off-by: Andrew Thornton <art27@cantab.net> * Fix test * Fix test Co-authored-by: zeripath <art27@cantab.net>
* Allow package dump skipping (#19506)KN4CK3R2022-04-261-0/+5
| | | | | | | | | | | | | | * Added addReader to support verbose. * Allow skipping packages. * Updated docs. * Update cmd/dump.go Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* doc: add brief intro on using traefik as reverse-proxy (#19432)Campbell He2022-04-202-0/+31
|
* Add Goroutine stack inspector to admin/monitor (#19207)zeripath2022-03-311-0/+7
| | | | | | | | | | | | | | | | | | | Continues on from #19202. Following the addition of pprof labels we can now more easily understand the relationship between a goroutine and the requests that spawn them. This PR takes advantage of the labels and adds a few others, then provides a mechanism for the monitoring page to query the pprof goroutine profile. The binary profile that results from this profile is immediately piped in to the google library for parsing this and then stack traces are formed for the goroutines. If the goroutine is within a context or has been created from a goroutine within a process context it will acquire the process description labels for that process. The goroutines are mapped with there associate pids and any that do not have an associated pid are placed in a group at the bottom as unbound. In this way we should be able to more easily examine goroutines that have been stuck. A manager command `gitea manager processes` is also provided that can export the processes (with or without stacktraces) to the command line. Signed-off-by: Andrew Thornton <art27@cantab.net>
* [docs] Enhance container selection in docker dump (#14292)Robin2022-03-221-1/+1
| | | | | | * Enhance container selection in docker dump The problem with the previous query was, that it sometimes selected multiple containers, which make the command file with a hard to understand message. Now, use '^...$' to make sure a regex full match.
* Add warning to set SENDMAIL_ARGS to -- (#19102)zeripath2022-03-181-0/+1
| | | | | | | Even with #17688 email addresses that contain an initial `-` may still be present in the db and it may in future still be possible to imagine a situation whereby initial `-` are repermitted. This PR simply updates the documentation to warn users to set their SENDMAIL_ARGS with a terminal `--` to prevent this possibility email addresses being interpreted as options. Signed-off-by: Andrew Thornton <art27@cantab.net>
* Fixed log path in fail2ban documentation (#19103)Fredrik Ekre2022-03-161-1/+1
| | | | This updates the log path in the [gitea-docker] jail configuration to match the path in the [gitea] jail, which was updated in #13726.
* adds restore docs for docker based instances (#18844)Marco Blessing2022-03-021-0/+56
| | | | | | | | | | | | | | | | | | | * adds docke restore section * fix typo * Update docs/content/doc/usage/backup-and-restore.en-us.md Co-authored-by: Gusted <williamzijl7@hotmail.com> * fix container id placeholder * adds restore help for docker-rootless * restore yml autoformater quotes Co-authored-by: Marco Blessing <marco.blessing@komm.one> Co-authored-by: Gusted <williamzijl7@hotmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Update nginx reverse proxy docs (#18922)JonRB2022-02-261-0/+8
| | | | | Add additional config lines for the set_header to forward additional information (eg the IP) Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Support custom ACME provider (#18340)Cristian Le2022-02-081-7/+21
| | | | | | * Added ACMECAURL option to support custom ACME provider. Closes #18306 * Refactor setting.go https settings, renamed options and variables, and documented app.example.ini * Refactored runLetsEncrypt to runACME * Improved documentation
* Fix oauth docs usage for 2fa (#18581)Sambhav Saggi2022-02-031-2/+2
|
* Switch to non-deprecation setting (#18358)Gusted2022-01-231-1/+3
| | | | | | * Switch to non-deprecation setting (Avoid by-default: "Deprecated fallback `[server]` `LFS_CONTENT_PATH` present. Use `[lfs]` `PATH` instead. This fallback will be removed in v1.18.0") * Update all references
* docs: mention client_max_body_size affects LFS (#18291)Jan Tojnar2022-01-151-0/+1
|
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 19:02:51 +0000