summaryrefslogtreecommitdiffstats
path: root/docs/content
Commit message (Collapse)AuthorAgeFilesLines
* Fix links in docs (#28234) (#28250)v1.20.6yp053272023-11-281-1/+1
| | | Backport #28234
* Fix some incorrect links in docs (#28191) (#28233)yp053272023-11-272-2/+2
| | | Backport https://github.com/go-gitea/gitea/pull/28191
* Update docs for docusaurus v3 (#28127)John Olheiser2023-11-203-6/+6
| | | Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Update database-preparation and add note re: MariaDB (#27232) (#27235)Giteabot2023-09-251-3/+3
| | | | | | | | Backport #27232 by @techknowlogick update DB docs per feedback. https://gitea.com/gitea/gitea-docusaurus/issues/69 Co-authored-by: techknowlogick <techknowlogick@gitea.com>
* Improve actions docs related to `pull_request` event (#27126) (#27145)Giteabot2023-09-202-0/+6
| | | | | | | | | | Backport #27126 by @Zettat123 Related to #27039 The `ref` property in Gitea Actions is different from GitHub Actions. This PR improves the documentation to explain the difference. Co-authored-by: Zettat123 <zettat123@gmail.com>
* Use secure cookie for HTTPS sites (#26999) (#27013)wxiaoguang2023-09-112-2/+2
| | | | | | | | | | | Backport #26999 If the AppURL(ROOT_URL) is an HTTPS URL, then the COOKIE_SECURE's default value should be true. And, if a user visits an "http" site with "https" AppURL, they won't be able to login, and they should have been warned. The only problem is that the "language" can't be set either in such case, while I think it is not a serious problem, and it could be fixed easily if needed.
* Correct the database.LOG_SQL default value in config cheat sheet (#26997) ↵Infinoid2023-09-102-2/+2
| | | | | (#27002) This is a manual backport of #26997 to v1.20.
* Improve LDAP group config documentation (#21227) (#26921)techknowlogick2023-09-051-4/+5
| | | | | | | | backport #21227 author @svenseeberg Co-authored-by: Sven Seeberg <mail@sven-seeberg.de> Co-authored-by: Giteabot <teabot@gitea.io>
* Update documents to fix some links (#26885) (#26888)Giteabot2023-09-0310-13/+13
| | | | | Backport #26885 by @lunny Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update docs about attachment path (#26883) (#26884)CaiCandong2023-09-032-2/+2
| | | | | | | | | | | | | | | | | | Backport #26883 This change was caused by #26271, for configuration as below: ``` [attachment] ENABLE = true PATH = data/attachments MAX_SIZE = 100 MAX_FILES = 5 ``` Before #26271, the resolved path is ${AppWorkPath}/${attachments.PATH} (such as `/var/lib/gitea/data/attachments`) After #26271, the resolved path is ${AppDataPath}/${attachments.PATH} (such as `/var/lib/gitea/data/data/attachments`) Fix https://github.com/go-gitea/gitea/issues/26864 Follow https://github.com/go-gitea/gitea/pull/26271
* Improve the "bug report" template and "support options" document (#26753) ↵Giteabot2023-08-291-22/+45
| | | | | | | | | | | | | (#26780) Backport #26753 by @wxiaoguang * `/help/support` is a better document than `/administration/logging-config` for bug reporting * Improve `support.en-us.md` * Move/add detailed contents into `Advanced Bug Report Tips` section * Merge `Chinese Support` section into `Support Options` Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Use docs.gitea.com instead of docs.gitea.io (#26769)Lunny Xiao2023-08-2824-43/+43
| | | backport #26739
* Fix Page Not Found error (#26768)xpume2023-08-282-2/+2
| | | Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add matrix to support (#26382) (#26722)Giteabot2023-08-251-0/+2
| | | | | | | | | | | | | Backport #26382 by @jolheiser This PR adds our matrix space to the support options and alphabetizes the list. I also considered adding our Mastodon, however that isn't as suitable as the other options because it's just whoever has access to the account vs a community chat/forum. Signed-off-by: jolheiser <john.olheiser@gmail.com> Co-authored-by: John Olheiser <john.olheiser@gmail.com>
* Prefer variables over subprocesses (#26690) (#26693)Giteabot2023-08-231-3/+3
| | | | | | | | Backport #26690 by @thomas-mc-work … because it doesn't require a separate shell, spawning a process which cost unnecessary resources and takes time. Co-authored-by: Thomas McWork <thomas.mc.work@posteo.de>
* add mfa doc (#26654) (#26674)Giteabot2023-08-231-0/+35
| | | | | | | | | | | | | | | | Backport #26654 by @lunny copy and modified from #14572 > Whilst debating enforcing MFA within our team, I realised there isn't a lot of context to the side effects of enabling it. Most of us use Git over HTTP and would need to add a token. I plan to add another PR that adds a sentence to the UI about needing to generate a token when enabling MFA if HTTP is to be used. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: silverwind <me@silverwind.io>
* Update upgrade documentation to add a check for deprecated configurations ↵Giteabot2023-08-112-8/+25
| | | | | | | | | | | (#26451) (#26452) Backport #26451 by @lunny fix https://github.com/go-gitea/gitea/issues/25995#issuecomment-1674096710 Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: silverwind <me@silverwind.io>
* [docs] Add missing backtick in quickstart.zh-cn.md (#26349) (#26357)Giteabot2023-08-061-1/+1
|
* [docs] Fix Gmail configuration (#26356)Brian Lachniet2023-08-061-2/+3
|
* Remove backslashed newlines on markdown (#26344) (#26348)Giteabot2023-08-051-2/+2
| | | | | | | Backport #26344 by @lunny Fix https://gitea.com/gitea/gitea-docusaurus/issues/56 Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Clarify the logger's MODE config option (#26267) (#26281)Giteabot2023-08-021-0/+3
| | | | | | | | | Backport #26267 by @wxiaoguang 1. Fix the wrong document (add the missing `MODE=`) 2. Add a more friendly log message to tell users to add `MODE=` in their config Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Update Arch linux URL from community to extra (#26273) (#26276)Giteabot2023-08-011-1/+1
| | | | Co-authored-by: minijaws <minijaws@gmail.com>
* Calculate MAX_WORKERS default value by CPU number (#26177) (#26183)Giteabot2023-07-271-1/+1
|
* Update email-setup.en-us.md (#26068) (#26166)Giteabot2023-07-266-15/+10
| | | | | | | | | Backport #26068 by @felixvictor The setting `MAILER_TYPE` is deprecated. According to the config cheat sheet, it should be `PROTOCOL`. Co-authored-by: Felix Victor <felix.victor.na@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Remove "misc" scope check from public API endpoints (#26134) (#26149)Giteabot2023-07-261-30/+30
| | | | | | | Backport #26134 by @wxiaoguang Fix #26035 Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Docusaurus-ify 1.20 (#26052)John Olheiser2023-07-26259-1327/+782
| | | | | | | | See https://github.com/go-gitea/gitea/pull/26051 --------- Signed-off-by: jolheiser <john.olheiser@gmail.com> Co-authored-by: JonRB <4564448+eeyrjmr@users.noreply.github.com>
* added ssh mirror workaround description (#26096) (#26136)Giteabot2023-07-251-0/+13
| | | | | | | | | | Backport #26096 by @thigg related #1635 #18159 This will probably be obsolete at some point, but it should not break anything and it may help some users Co-authored-by: thigg <thigg@users.noreply.github.com>
* RPM Registry: Show zypper commands for SUSE based distros as well (#25981) ↵Giteabot2023-07-204-5/+5
| | | | | | | | | | | (#26020) Backport #25981 by @asdil12 After RPM is supported with https://github.com/go-gitea/gitea/pull/23380 let's show the user how to add the repo and install the RPM via all common package managers. Co-authored-by: Dominik Heidler <dominik@heidler.eu>
* Correctly refer to dev tags as nightly in the docker docs (#26004) (#26019)Giteabot2023-07-202-2/+2
| | | | | | | Backport #26004 by @jolheiser As title, `dev` tags are no longer used since we switched to `nightly` Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Update path related documents (#25417) (#25982)Giteabot2023-07-196-33/+18
| | | | | | | | | | | | | | Backport #25417 by @wxiaoguang Update WorkPath/WORK_PATH related documents, remove out-dated information. Remove "StaticRootPath" on the admin config display page, because few end user really need it, it only causes misconfiguration. ![image](https://github.com/go-gitea/gitea/assets/2114189/8095afa4-da76-436b-9e89-2a92c229c01d) Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Make "install page" respect environment config (#25648) (#25799)wxiaoguang2023-07-102-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Backport #25648 Replace #25580 Fix #19453 The problem was: when users set "GITEA__XXX__YYY" , the "install page" doesn't respect it. So, to make the result consistent and avoid surprising end users, now the "install page" also writes the environment variables to the config file. And, to make things clear, there are enough messages on the UI to tell users what will happen. There are some necessary/related changes to `environment-to-ini.go`: * The "--clear" flag is removed and it was incorrectly written there. The "clear" operation should be done if INSTALL_LOCK=true * The "--prefix" flag is removed because it's never used, never documented and it only causes inconsistent behavior. The only conflict during backport is "ui divider" in templates/install.tmpl
* docs: rootless docker ssh's default port is 2222 (#25771) (#25772)Giteabot2023-07-091-1/+1
| | | | | | | | | | | Backport #25771 by @leavesster --- according `docker/rootless/usr/local/bin/docker-setup.sh` , in rootless docker setup, ssh port is 2222. and mysql database case should port same as PostgreSQL port Co-authored-by: leavesster <11785335+leavesster@users.noreply.github.com>
* Restrict `[actions].DEFAULT_ACTIONS_URL` to only `github` or `self` (#25581) ↵Giteabot2023-06-301-28/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (#25604) Backport #25581 by @wolfogre Resolve #24789 ## :warning: BREAKING :warning: Before this, `DEFAULT_ACTIONS_URL` cound be set to any custom URLs like `https://gitea.com` or `http://your-git-server,https://gitea.com`, and the default value was `https://gitea.com`. But now, `DEFAULT_ACTIONS_URL` supports only `github`(`https://github.com`) or `self`(the root url of current Gitea instance), and the default value is `github`. If it has configured with a URL, an error log will be displayed and it will fallback to `github`. Actually, what we really want to do is always make it `https://github.com`, however, this may not be acceptable for some instances of internal use, so there's extra support for `self`, but no more, even `https://gitea.com`. Please note that `uses: https://xxx/yyy/zzz` always works and it does exactly what it is supposed to do. Although it's breaking, I belive it should be backported to `v1.20` due to some security issues. Follow-up on the runner side: - https://gitea.com/gitea/act_runner/pulls/262 - https://gitea.com/gitea/act/pulls/70 Co-authored-by: Jason Song <i@wolfogre.com>
* Add documentation about supported workflow trigger events (#25582) (#25589)Giteabot2023-06-292-0/+40
| | | | | | | | | Backport #25582 by @Zettat123 Right now Gitea doesn't support all [Events that trigger workflows](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows). This PR lists the supported events to help users write workflow files. Co-authored-by: Zettat123 <zettat123@gmail.com>
* Document creating an API key from the CLI (#25504)lonix12023-06-251-0/+8
| | | | | | | Related to https://github.com/go-gitea/gitea/issues/25503 --------- Co-authored-by: delvh <dev.lh@web.de>
* Use the new download domain replace the old (#25405) (#25409)Giteabot2023-06-2110-17/+17
| | | | | | | Backport #25405 by @lunny As title. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add Exoscale to installation on cloud provider docs (#25342) (#25346)Giteabot2023-06-181-0/+10
| | | | | | | | | | | | | Backport #25342 by @pmig We created a Gitea application for the [Exoscale Marketplace](https://www.exoscale.com/marketplace/listing/glasskube-gitea/) for easier installation on the European cloud provider. The installation is managed via the [Glasskube Kubernetes Operator](https://github.com/glasskube/operator). Signed-off-by: Philip Miglinci <pmig@glasskube.eu> Co-authored-by: Philip Miglinci <p.miglinci@gmail.com>
* Add link to support page for commercial support (#25293) (#25297)Giteabot2023-06-161-0/+1
| | | | | Backport #25293 by @techknowlogick Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Docs about how to generate config for act runner with docker and setup it ↵Giteabot2023-06-162-0/+54
| | | | | | | | | | | | | with docker-compose (#25256) (#25296) Backport #25256 by @thezzisu In this pull request, the following changes are addressed: - State user should create `config.yaml` before start container to avoid errors. - Provided instructions to deploy runners using docker compose. Co-authored-by: Zisu Zhang <thezzisu@gmail.com>
* Fix all possible setting error related storages and added some tests ↵Giteabot2023-06-142-8/+110
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (#23911) (#25244) Backport #23911 by @lunny Follow up #22405 Fix #20703 This PR rewrites storage configuration read sequences with some breaks and tests. It becomes more strict than before and also fixed some inherit problems. - Move storage's MinioConfig struct into setting, so after the configuration loading, the values will be stored into the struct but not still on some section. - All storages configurations should be stored on one section, configuration items cannot be overrided by multiple sections. The prioioty of configuration is `[attachment]` > `[storage.attachments]` | `[storage.customized]` > `[storage]` > `default` - For extra override configuration items, currently are `SERVE_DIRECT`, `MINIO_BASE_PATH`, `MINIO_BUCKET`, which could be configured in another section. The prioioty of the override configuration is `[attachment]` > `[storage.attachments]` > `default`. - Add more tests for storages configurations. - Update the storage documentations. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Improve some documents: release version, logging, NFS lock (#25202) (#25204)Giteabot2023-06-122-42/+23
| | | | | | | | | | | | | | | | | Backport #25202 by @wxiaoguang Close #23654 Close #24684 @techknowlogick I still think we need to rename https://dl.gitea.com/gitea/1.20/ to https://dl.gitea.com/gitea/1.20-nightly/ `/gitea/1.20/` is quite confusing, it needs these words to explain why. If we call it `1.20-nightly`, the FAQ can be simplified a lot. Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Change branch name from master to main in some documents' links (#25126) ↵HesterG2023-06-0812-16/+16
| | | | | | | (#25140) Backport #25126 to 1.20 As title. And needs to backport to 1.19
* Enable all webpack sourcemaps in dev build, disable all in prod build (#25089)silverwind2023-06-061-0/+2
| | | | | | | | | | | | | | | - Enable all source maps in dev build - Disable all source maps in prod build - Provide `ENABLE_SOURCEMAP` env var to override it. I think the strange error seen in https://github.com/go-gitea/gitea/issues/24784 is sourcemap related, so if we enable/disable them all, it might go away. But it's most definitely a Safari bug. With all sourcemaps disabled, binary size goes down by around 1-2 MB, with all enabled it goes up by around 12MB. If +12MB is acceptable, we could also always enable them by default as fully source maps do have some debugging benefits.
* change placeholders in actions docstechknowlogick2023-06-051-1/+1
|
* change placeholders in actions docstechknowlogick2023-06-051-1/+1
|
* Introduce how to configure cache when starting a Runner with Docker (#25077)sillyguodong2023-06-052-0/+67
| | | | | | | If a user starts a runner using a Docker image without making additional configurations, the [cache action](https://github.com/actions/cache) will not work properly. Therefore, add a section in the documentation that explains how to configure the cache correctly.
* improve permission documentation (#23942)Lunny Xiao2023-06-051-9/+24
|
* Redesign Scoped Access Tokens (#24767)Jack Hay2023-06-041-36/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ## Changes - Adds the following high level access scopes, each with `read` and `write` levels: - `activitypub` - `admin` (hidden if user is not a site admin) - `misc` - `notification` - `organization` - `package` - `issue` - `repository` - `user` - Adds new middleware function `tokenRequiresScopes()` in addition to `reqToken()` - `tokenRequiresScopes()` is used for each high-level api section - _if_ a scoped token is present, checks that the required scope is included based on the section and HTTP method - `reqToken()` is used for individual routes - checks that required authentication is present (but does not check scope levels as this will already have been handled by `tokenRequiresScopes()` - Adds migration to convert old scoped access tokens to the new set of scopes - Updates the user interface for scope selection ### User interface example <img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM" src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3"> <img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM" src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c"> ## tokenRequiresScopes Design Decision - `tokenRequiresScopes()` was added to more reliably cover api routes. For an incoming request, this function uses the given scope category (say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say `DELETE`) and verifies that any scoped tokens in use include `delete:organization`. - `reqToken()` is used to enforce auth for individual routes that require it. If a scoped token is not present for a request, `tokenRequiresScopes()` will not return an error ## TODO - [x] Alphabetize scope categories - [x] Change 'public repos only' to a radio button (private vs public). Also expand this to organizations - [X] Disable token creation if no scopes selected. Alternatively, show warning - [x] `reqToken()` is missing from many `POST/DELETE` routes in the api. `tokenRequiresScopes()` only checks that a given token has the correct scope, `reqToken()` must be used to check that a token (or some other auth) is present. - _This should be addressed in this PR_ - [x] The migration should be reviewed very carefully in order to minimize access changes to existing user tokens. - _This should be addressed in this PR_ - [x] Link to api to swagger documentation, clarify what read/write/delete levels correspond to - [x] Review cases where more than one scope is needed as this directly deviates from the api definition. - _This should be addressed in this PR_ - For example: ```go m.Group("/users/{username}/orgs", func() { m.Get("", reqToken(), org.ListUserOrgs) m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions) }, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser, auth_model.AccessTokenScopeCategoryOrganization), context_service.UserAssignmentAPI()) ``` ## Future improvements - [ ] Add required scopes to swagger documentation - [ ] Redesign `reqToken()` to be opt-out rather than opt-in - [ ] Subdivide scopes like `repository` - [ ] Once a token is created, if it has no scopes, we should display text instead of an empty bullet point - [ ] If the 'public repos only' option is selected, should read categories be selected by default Closes #24501 Closes #24799 Co-authored-by: Jonathan Tran <jon@allspice.io> Co-authored-by: Kyle D <kdumontnu@gmail.com> Co-authored-by: silverwind <me@silverwind.io>
* Allow for PKCE flow without client secret + add docs (#25033)Denys Konovalov2023-06-031-7/+71
| | | | | | | | | | | | | | | | | | | | | | | The PKCE flow according to [RFC 7636](https://datatracker.ietf.org/doc/html/rfc7636) allows for secure authorization without the requirement to provide a client secret for the OAuth app. It is implemented in Gitea since #5378 (v1.8.0), however without being able to omit client secret. Since #21316 Gitea supports setting client type at OAuth app registration. As public clients are already forced to use PKCE since #21316, in this PR the client secret check is being skipped if a public client is detected. As Gitea seems to implement PKCE authorization correctly according to the spec, this would allow for PKCE flow without providing a client secret. Also add some docs for it, please check language as I'm not a native English speaker. Closes #17107 Closes #25047
* Fix link to customizing-gitea (#25056)kodermho2023-06-032-2/+2
| | | | The link to customizing-gitea in the label documentation is broken. This PR should adjust the relative path to fix the link
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 21:26:04 +0000