From 0b81e66c45cc6a7a24306a948707e8ee01361876 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Sun, 8 Oct 2023 15:11:22 +0200 Subject: [PATCH] sync with Gitea abe8fe352711601fbcd24bf4505f7e0b81a93c5d git diff bd4c7ce578956d9839309b16753bd5505b63b2e3..abe8fe352711601fbcd24bf4505f7e0b81a93c5d -- $(find . -type f -name '*en-us*') --- docs/admin/config-cheat-sheet.md | 7 +++++-- docs/admin/database-preparation.md | 6 +++--- docs/admin/email-setup.md | 5 ++--- docs/admin/incoming-email.md | 2 +- docs/admin/installation.md | 6 +++--- docs/admin/logging-documentation.md | 2 +- docs/admin/reverse-proxy.md | 2 +- docs/admin/search-engines-indexation.md | 2 +- docs/admin/seek-assistance.md | 2 +- docs/admin/signing.md | 2 +- docs/developer/from-source.md | 2 +- docs/user/actions.md | 16 ++++++++++++++++ docs/user/agit-support.md | 6 +++--- docs/user/api-usage.md | 2 +- docs/user/authentication.md | 11 ++++++----- docs/user/blame.md | 2 +- docs/user/issue-pull-request-templates.md | 2 +- docs/user/labels.md | 2 +- docs/user/linked-references.md | 2 +- docs/user/merge-message-templates.md | 2 +- docs/user/oauth2-provider.md | 2 +- docs/user/packages/alpine.md | 2 +- docs/user/packages/cargo.md | 15 +++++++++++---- docs/user/packages/chef.md | 2 +- docs/user/packages/composer.md | 2 +- docs/user/packages/conan.md | 2 +- docs/user/packages/conda.md | 2 +- docs/user/packages/container.md | 2 +- docs/user/packages/cran.md | 2 +- docs/user/packages/debian.md | 2 +- docs/user/packages/generic.md | 2 +- docs/user/packages/go.md | 2 +- docs/user/packages/helm.md | 2 +- docs/user/packages/maven.md | 2 +- docs/user/packages/npm.md | 2 +- docs/user/packages/nuget.md | 2 +- docs/user/packages/pub.md | 2 +- docs/user/packages/pypi.md | 2 +- docs/user/packages/rpm.md | 2 +- docs/user/packages/rubygems.md | 2 +- docs/user/packages/storage.md | 2 +- docs/user/packages/swift.md | 2 +- docs/user/packages/vagrant.md | 2 +- docs/user/profile.md | 4 ++-- docs/user/protection.md | 2 +- docs/user/push-to-create.md | 2 +- docs/user/token-scope.md | 2 +- docs/user/webhooks.md | 2 +- 48 files changed, 90 insertions(+), 64 deletions(-) diff --git a/docs/admin/config-cheat-sheet.md b/docs/admin/config-cheat-sheet.md index 646c868d..b771e77f 100644 --- a/docs/admin/config-cheat-sheet.md +++ b/docs/admin/config-cheat-sheet.md @@ -1,7 +1,7 @@ --- title: 'Configuration Cheat Sheet' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/administration/config-cheat-sheet.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/administration/config-cheat-sheet.en-us.md' --- This is a cheat sheet for the Forgejo configuration file. It contains most of the settings @@ -90,7 +90,7 @@ In addition, there is _`StaticRootPath`_ which can be set as a built-in at build - `ENABLE_PUSH_CREATE_USER`: **false**: Allow users to push local repositories to Forgejo and have them automatically created for a user. - `ENABLE_PUSH_CREATE_ORG`: **false**: Allow users to push local repositories to Forgejo and have them automatically created for an org. - `DISABLED_REPO_UNITS`: **_empty_**: Comma separated list of globally disabled repo units. Allowed values: \[repo.issues, repo.ext_issues, repo.pulls, repo.wiki, repo.ext_wiki, repo.projects, repo.packages, repo.actions\] -- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: Comma separated list of default new repo units. Allowed values: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. Note: Code and Releases can currently not be deactivated. If you specify default repo units you should still list them for future compatibility. External wiki and issue tracker can't be enabled by default as it requires additional settings. Disabled repo units will not be added to new repositories regardless if it is in the default list. +- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages,repo.actions**: Comma separated list of default new repo units. Allowed values: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. Note: Code and Releases can currently not be deactivated. If you specify default repo units you should still list them for future compatibility. External wiki and issue tracker can't be enabled by default as it requires additional settings. Disabled repo units will not be added to new repositories regardless if it is in the default list. - `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: Comma separated list of default forked repo units. The set of allowed values and rules is the same as `DEFAULT_REPO_UNITS`. - `PREFIX_ARCHIVE_FILES`: **true**: Prefix archive files by placing them in a directory named after the repository. - `DISABLE_MIGRATIONS`: **false**: Disable migrating feature. @@ -1275,6 +1275,9 @@ PROXY_HOSTS = *.github.com - `ENABLED`: **true**: Enable/Disable actions - `DEFAULT_ACTIONS_URL`: **https://code.forgejo.org**: Default address to get action plugins, e.g. the default value means downloading from "https://code.forgejo.org/actions/checkout" for "uses: actions/checkout@v3" - `ARTIFACT_RETENTION_DAYS`: **90**: Number of days to keep artifacts. Set to 0 to disable artifact retention. Default is 90 days if not set. +- `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time. +- `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time. +- `ABANDONED_JOB_TIMEOUT`: **24h**: Timeout to cancel the jobs which have waiting status, but haven't been picked by a runner for a long time. ## Other (`other`) diff --git a/docs/admin/database-preparation.md b/docs/admin/database-preparation.md index db524524..cb5e359e 100644 --- a/docs/admin/database-preparation.md +++ b/docs/admin/database-preparation.md @@ -1,10 +1,10 @@ --- title: 'Database Preparation' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/installation/database-preparation.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/installation/database-preparation.en-us.md' --- -You need a database to use Forgejo. Forgejo supports PostgreSQL (>=10), MySQL (>=5.7) or MariaDB (>=10.0), SQLite, and MSSQL (>=2008R2 SP3). This page will guide into preparing database. Only PostgreSQL and MySQL/MariaDB will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter. +You need a database to use Forgejo. Forgejo supports PostgreSQL (>=12), MySQL (>=8.0) or MariaDB (>=10.0), SQLite, and MSSQL (>=2012 SP4). This page will guide into preparing database. Only PostgreSQL and MySQL/MariaDB will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter. Database instance can be on same machine as Forgejo (local database setup), or on different machine (remote database). @@ -32,7 +32,7 @@ Note: All steps below requires that the database engine of your choice is instal ```sql SET old_passwords=0; - CREATE USER 'forgejo' IDENTIFIED BY 'passw0rd'; + CREATE USER 'forgejo'@'%' IDENTIFIED BY 'passw0rd'; ``` For remote database: diff --git a/docs/admin/email-setup.md b/docs/admin/email-setup.md index f1654d38..89518098 100644 --- a/docs/admin/email-setup.md +++ b/docs/admin/email-setup.md @@ -1,7 +1,7 @@ --- title: 'Email setup' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/administration/email-setup.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/administration/email-setup.en-us.md' --- Forgejo has mailer functionality for sending transactional emails (such as registration confirmation). It can be configured to either use Sendmail (or compatible MTAs like Postfix and msmtp) or directly use SMTP server. @@ -14,10 +14,9 @@ Directly use SMTP server as relay. This option is useful if you don't want to se [mailer] ENABLED = true FROM = forgejo@example.com -PROTOCOL = smtp +PROTOCOL = smtps SMTP_ADDR = mail.example.com SMTP_PORT = 587 -IS_TLS_ENABLED = true USER = forgejo@example.com PASSWD = `password` ``` diff --git a/docs/admin/incoming-email.md b/docs/admin/incoming-email.md index db14f7e1..57054c63 100644 --- a/docs/admin/incoming-email.md +++ b/docs/admin/incoming-email.md @@ -1,7 +1,7 @@ --- title: 'Incoming Email' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/incoming-email.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/incoming-email.en-us.md' --- Forgejo supports the execution of several actions through incoming mails. This page describes how to set this up. diff --git a/docs/admin/installation.md b/docs/admin/installation.md index 2c722197..6e2e05ea 100644 --- a/docs/admin/installation.md +++ b/docs/admin/installation.md @@ -9,10 +9,10 @@ origin_url: 'https://github.com/DanielGibson/DanielGibson.github.io/blob/5836269 Forgejo provides [container images](https://codeberg.org/forgejo/-/packages/container/forgejo/versions) for use with Docker or other containerization tools. ```shell -docker pull codeberg.org/forgejo/forgejo:1.20.1-0 +docker pull codeberg.org/forgejo/forgejo:1.20.5-0 ``` -The **1.20** tag is set to be the latest patch release, starting with [1.20.1-0](https://codeberg.org/forgejo/-/packages/container/forgejo/1.20.1-0). **1.20** will then be equal to **1.20.2-0** when it is released and so on. +The **1.20** tag is set to be the latest patch release, starting with [1.20.5-0](https://codeberg.org/forgejo/-/packages/container/forgejo/1.20.5-0). **1.20** will then be equal to **1.20.2-0** when it is released and so on. Upgrading from **1.X** to **1.X+1** (for instance from **1.19** to **1.20**) requires a [manual operation and human verification](../upgrade/). However it is possible to use the **X.Y** tag (for instance **1.20**) to get the latest point release automatically. @@ -160,7 +160,7 @@ and make it executable: > **NOTE:** when a line starts with #, it means the command 'foo --bar' must be run as root (or with sudo). -`# cp forgejo-1.20.1-0-linux-amd64 /usr/local/bin/forgejo` +`# cp forgejo-1.20.5-0-linux-amd64 /usr/local/bin/forgejo` `# chmod 755 /usr/local/bin/forgejo` Make sure `git` and `git-lfs` are installed: diff --git a/docs/admin/logging-documentation.md b/docs/admin/logging-documentation.md index e306f6b1..1ff790cf 100644 --- a/docs/admin/logging-documentation.md +++ b/docs/admin/logging-documentation.md @@ -1,7 +1,7 @@ --- title: 'Logging Configuration' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/administration/logging-config.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/administration/logging-config.en-us.md' --- The logging configuration of Forgejo mainly consists of 3 types of components: diff --git a/docs/admin/reverse-proxy.md b/docs/admin/reverse-proxy.md index a77043b2..0c0121f3 100644 --- a/docs/admin/reverse-proxy.md +++ b/docs/admin/reverse-proxy.md @@ -1,7 +1,7 @@ --- title: 'Reverse proxy' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/authentication.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/authentication.en-us.md' --- Forgejo supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with diff --git a/docs/admin/search-engines-indexation.md b/docs/admin/search-engines-indexation.md index b6f84ab2..5ba61ed0 100644 --- a/docs/admin/search-engines-indexation.md +++ b/docs/admin/search-engines-indexation.md @@ -1,7 +1,7 @@ --- title: 'Search Engines Indexation' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/administration/search-engines-indexation.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/administration/search-engines-indexation.en-us.md' --- ## Search engines indexation of your Forgejo installation diff --git a/docs/admin/seek-assistance.md b/docs/admin/seek-assistance.md index 8876971e..29567af1 100644 --- a/docs/admin/seek-assistance.md +++ b/docs/admin/seek-assistance.md @@ -1,7 +1,7 @@ --- title: 'Seek Assistance' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/help/seek-help.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/help/seek-help.en-us.md' --- - [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org) diff --git a/docs/admin/signing.md b/docs/admin/signing.md index ea73a2c6..73ca9bcf 100644 --- a/docs/admin/signing.md +++ b/docs/admin/signing.md @@ -1,7 +1,7 @@ --- title: 'GPG Commit Signatures' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/administration/signing.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/administration/signing.en-us.md' --- Forgejo will verify GPG commit signatures in the provided tree by diff --git a/docs/developer/from-source.md b/docs/developer/from-source.md index bc1139f5..e2be1d14 100644 --- a/docs/developer/from-source.md +++ b/docs/developer/from-source.md @@ -1,7 +1,7 @@ --- title: 'Compiling from source' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/installation/from-source.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/installation/from-source.en-us.md' --- ## Installation from source diff --git a/docs/user/actions.md b/docs/user/actions.md index 64284059..399bb409 100644 --- a/docs/user/actions.md +++ b/docs/user/actions.md @@ -275,6 +275,22 @@ Once the variable is added, its value cannot be changed. ![variables list](../_images/user/actions/variable-list.png) +### Name constraints + +The following rules apply to variable names: + +- Variable names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. +- Variable names must not start with the `FORGEJO_`, `GITHUB_` or `GITEA_` prefix. +- Variable names must not start with a number. +- Variable names are case-insensitive. +- Variable names must be unique at the level they are created at. +- Variable names must not be `CI`. + +### Precedence + +A variable found in the settings of the owner of a repository (organization or user) has precedence +over the same variable found in a repository. + ## Workflow reference guide The syntax and semantics of the YAML file describing a `workflow` are _partially_ explained here. When an entry is missing the [GitHub Actions](https://docs.github.com/en/actions) documentation may be helpful because there are similarities. But there also are significant differences that require testing. diff --git a/docs/user/agit-support.md b/docs/user/agit-support.md index 7958a335..22923339 100644 --- a/docs/user/agit-support.md +++ b/docs/user/agit-support.md @@ -1,15 +1,15 @@ --- title: 'Agit Setup' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/agit-support.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/agit-support.en-us.md' --- Limited support for [agit](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/). ## Creating PRs -Agit allows to create PRs while pushing code to the remote repo. \ -This can be done by pushing to the branch followed by a specific refspec (a location identifier known to git). \ +Agit allows to create PRs while pushing code to the remote repo. +This can be done by pushing to the branch followed by a specific refspec (a location identifier known to git). The following example illustrates this: ```shell diff --git a/docs/user/api-usage.md b/docs/user/api-usage.md index 537b9b7c..009bd050 100644 --- a/docs/user/api-usage.md +++ b/docs/user/api-usage.md @@ -1,7 +1,7 @@ --- title: 'API Usage' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/development/api-usage.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/development/api-usage.en-us.md' --- ## Enabling/configuring API access diff --git a/docs/user/authentication.md b/docs/user/authentication.md index 6d9fa3bd..6e51dcd2 100644 --- a/docs/user/authentication.md +++ b/docs/user/authentication.md @@ -1,7 +1,7 @@ --- title: 'Authentication' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/authentication.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/authentication.en-us.md' --- ## LDAP (Lightweight Directory Access Protocol) @@ -144,12 +144,13 @@ Uses the following fields: - User Attribute in Group (optional) - - Which user LDAP attribute is listed in the group. - - Example: `uid` + - The user attribute that is used to reference a user in the group object. + - Example: `uid` if the group objects contains a `member: bender` and the user object contains a `uid: bender`. + - Example: `dn` if the group object contains a `member: uid=bender,ou=users,dc=planetexpress,dc=com`. - Group Attribute for User (optional) - - Which group LDAP attribute contains an array above user attribute names. - - Example: `memberUid` + - The attribute of the group object that lists/contains the group members. + - Example: `memberUid` or `member` ## PAM (Pluggable Authentication Module) diff --git a/docs/user/blame.md b/docs/user/blame.md index 12b02ec1..a2c7b5c6 100644 --- a/docs/user/blame.md +++ b/docs/user/blame.md @@ -1,7 +1,7 @@ --- title: 'Blame File View' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/blame.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/blame.en-us.md' --- Forgejo supports viewing the line-by-line revision history for a file also known as blame view. diff --git a/docs/user/issue-pull-request-templates.md b/docs/user/issue-pull-request-templates.md index 535c832e..d03da677 100644 --- a/docs/user/issue-pull-request-templates.md +++ b/docs/user/issue-pull-request-templates.md @@ -1,7 +1,7 @@ --- title: 'Issue and Pull Request Templates' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/issue-pull-request-templates.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/issue-pull-request-templates.en-us.md' --- Some projects have a standard list of questions that users need to answer diff --git a/docs/user/labels.md b/docs/user/labels.md index 7831d156..d374e384 100644 --- a/docs/user/labels.md +++ b/docs/user/labels.md @@ -1,7 +1,7 @@ --- title: 'Labels' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/labels.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/labels.en-us.md' --- You can use labels to classify issues and pull requests and to improve your overview over them. diff --git a/docs/user/linked-references.md b/docs/user/linked-references.md index 221bc5f0..613bf943 100644 --- a/docs/user/linked-references.md +++ b/docs/user/linked-references.md @@ -1,7 +1,7 @@ --- title: 'Automatically Linked References in Issues, Pull Requests and Commit Messages' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/linked-references.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/linked-references.en-us.md' --- When an issue, pull request or comment is posted, the text description is parsed diff --git a/docs/user/merge-message-templates.md b/docs/user/merge-message-templates.md index f0cbed6c..ce2da0fc 100644 --- a/docs/user/merge-message-templates.md +++ b/docs/user/merge-message-templates.md @@ -1,7 +1,7 @@ --- title: 'Merge Message templates' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/merge-message-templates.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/merge-message-templates.en-us.md' --- ## File names diff --git a/docs/user/oauth2-provider.md b/docs/user/oauth2-provider.md index 86ce64e8..0104f303 100644 --- a/docs/user/oauth2-provider.md +++ b/docs/user/oauth2-provider.md @@ -1,7 +1,7 @@ --- title: 'OAuth2 provider' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/development/oauth2-provider.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/development/oauth2-provider.en-us.md' --- Forgejo supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent. diff --git a/docs/user/packages/alpine.md b/docs/user/packages/alpine.md index 1eb4f257..a515aa9f 100644 --- a/docs/user/packages/alpine.md +++ b/docs/user/packages/alpine.md @@ -1,7 +1,7 @@ --- title: 'Alpine Packages Repository' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/alpine.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/alpine.en-us.md' --- Publish [Alpine](https://pkgs.alpinelinux.org/) packages for your user or organization. diff --git a/docs/user/packages/cargo.md b/docs/user/packages/cargo.md index 4eee2210..8b15a01b 100644 --- a/docs/user/packages/cargo.md +++ b/docs/user/packages/cargo.md @@ -1,7 +1,7 @@ --- title: 'Cargo Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/cargo.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/cargo.en-us.md' --- Publish [Cargo](https://doc.rust-lang.org/stable/cargo/) packages for your user or organization. @@ -39,10 +39,11 @@ Add the following text to the configuration file located in the current users ho default = "forgejo" [registries.forgejo] -index = "https://forgejo.example.com/{owner}/_cargo-index.git" +index = "sparse+https://forgejo.example.com/api/packages/{owner}/cargo/" # Sparse index +# index = "https://forgejo.example.com/{owner}/_cargo-index.git" # Git -[net] -git-fetch-with-cli = true +# [net] +# git-fetch-with-cli = true ``` | Parameter | Description | @@ -61,6 +62,12 @@ token = "Bearer {token}" | --------- | ------------------------------------------------------------- | | `token` | Your [personal access token](../../api-usage/#authentication) | +## Git vs Sparse + +Currently, cargo supports two ways for fetching crates in a registry: Git index & sparse index. +Sparse index is the newest method and offers better performance when updating crates compared to git. +Since Rust 1.68, sparse is the default method for crates.io. + ## Publish a package Publish a package by running the following command in your project: diff --git a/docs/user/packages/chef.md b/docs/user/packages/chef.md index 03ecfeb1..05791298 100644 --- a/docs/user/packages/chef.md +++ b/docs/user/packages/chef.md @@ -1,7 +1,7 @@ --- title: 'Chef Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/chef.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/chef.en-us.md' --- Publish [Chef](https://chef.io/) cookbooks for your user or organization. diff --git a/docs/user/packages/composer.md b/docs/user/packages/composer.md index aa250066..ab1039ba 100644 --- a/docs/user/packages/composer.md +++ b/docs/user/packages/composer.md @@ -1,7 +1,7 @@ --- title: 'Composer Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/composer.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/composer.en-us.md' --- Publish [Composer](https://getcomposer.org/) packages for your user or organization. diff --git a/docs/user/packages/conan.md b/docs/user/packages/conan.md index 653d0249..8d1b4ae5 100644 --- a/docs/user/packages/conan.md +++ b/docs/user/packages/conan.md @@ -1,7 +1,7 @@ --- title: 'Conan Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/conan.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/conan.en-us.md' --- Publish [Conan](https://conan.io/) packages for your user or organization. diff --git a/docs/user/packages/conda.md b/docs/user/packages/conda.md index 1022ccd1..2955641f 100644 --- a/docs/user/packages/conda.md +++ b/docs/user/packages/conda.md @@ -1,7 +1,7 @@ --- title: 'Conda Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/conda.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/conda.en-us.md' --- Publish [Conda](https://docs.conda.io/en/latest/) packages for your user or organization. diff --git a/docs/user/packages/container.md b/docs/user/packages/container.md index 7d7cddf2..7d6ec52a 100644 --- a/docs/user/packages/container.md +++ b/docs/user/packages/container.md @@ -1,7 +1,7 @@ --- title: 'Container Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/container.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/container.en-us.md' --- Publish [Open Container Initiative](https://opencontainers.org/) compliant images for your user or organization. diff --git a/docs/user/packages/cran.md b/docs/user/packages/cran.md index fe97e538..a218afda 100644 --- a/docs/user/packages/cran.md +++ b/docs/user/packages/cran.md @@ -1,7 +1,7 @@ --- title: 'CRAN Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/cran.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/cran.en-us.md' --- Publish [R](https://www.r-project.org/) packages to a [CRAN](https://cran.r-project.org/)-like registry for your user or organization. diff --git a/docs/user/packages/debian.md b/docs/user/packages/debian.md index 3b8ca0e3..5f9e5907 100644 --- a/docs/user/packages/debian.md +++ b/docs/user/packages/debian.md @@ -1,7 +1,7 @@ --- title: 'Debian Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/debian.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/debian.en-us.md' --- Publish [Debian](https://www.debian.org/distrib/packages) packages for your user or organization. diff --git a/docs/user/packages/generic.md b/docs/user/packages/generic.md index b5ff622e..c8e5704a 100644 --- a/docs/user/packages/generic.md +++ b/docs/user/packages/generic.md @@ -1,7 +1,7 @@ --- title: 'Generic Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/generic.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/generic.en-us.md' --- Publish generic files, like release binaries or other output, for your user or organization. diff --git a/docs/user/packages/go.md b/docs/user/packages/go.md index a05c2828..8142377b 100644 --- a/docs/user/packages/go.md +++ b/docs/user/packages/go.md @@ -1,7 +1,7 @@ --- title: 'Go Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/go.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/go.en-us.md' --- Publish Go packages for your user or organization. diff --git a/docs/user/packages/helm.md b/docs/user/packages/helm.md index 95ef766a..f825a9a1 100644 --- a/docs/user/packages/helm.md +++ b/docs/user/packages/helm.md @@ -1,7 +1,7 @@ --- title: 'Helm Chart Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/helm.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/helm.en-us.md' --- Publish [Helm](https://helm.sh/) charts for your user or organization. diff --git a/docs/user/packages/maven.md b/docs/user/packages/maven.md index 5e0904a4..ad093e6f 100644 --- a/docs/user/packages/maven.md +++ b/docs/user/packages/maven.md @@ -1,7 +1,7 @@ --- title: 'Maven Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/maven.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/maven.en-us.md' --- Publish [Maven](https://maven.apache.org) packages for your user or organization. diff --git a/docs/user/packages/npm.md b/docs/user/packages/npm.md index 2ec34e3b..d72be513 100644 --- a/docs/user/packages/npm.md +++ b/docs/user/packages/npm.md @@ -1,7 +1,7 @@ --- title: 'npm Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/npm.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/npm.en-us.md' --- Publish [npm](https://www.npmjs.com/) packages for your user or organization. diff --git a/docs/user/packages/nuget.md b/docs/user/packages/nuget.md index 5d442f5e..5d052ecf 100644 --- a/docs/user/packages/nuget.md +++ b/docs/user/packages/nuget.md @@ -1,7 +1,7 @@ --- title: 'NuGet Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/nuget.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/nuget.en-us.md' --- Publish [NuGet](https://www.nuget.org/) packages for your user or organization. The package registry supports the V2 and V3 API protocol and you can work with [NuGet Symbol Packages](https://docs.microsoft.com/en-us/nuget/create-packages/symbol-packages-snupkg) too. diff --git a/docs/user/packages/pub.md b/docs/user/packages/pub.md index 91a2dbac..4d81ba8d 100644 --- a/docs/user/packages/pub.md +++ b/docs/user/packages/pub.md @@ -1,7 +1,7 @@ --- title: 'Pub Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/pub.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/pub.en-us.md' --- Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization. diff --git a/docs/user/packages/pypi.md b/docs/user/packages/pypi.md index 2b740657..ffcdf764 100644 --- a/docs/user/packages/pypi.md +++ b/docs/user/packages/pypi.md @@ -1,7 +1,7 @@ --- title: 'PyPI Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/pypi.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/pypi.en-us.md' --- Publish [PyPI](https://pypi.org/) packages for your user or organization. diff --git a/docs/user/packages/rpm.md b/docs/user/packages/rpm.md index 348949fb..7efc5669 100644 --- a/docs/user/packages/rpm.md +++ b/docs/user/packages/rpm.md @@ -1,7 +1,7 @@ --- title: 'RPM Package Registry' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/rpm.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/rpm.en-us.md' --- Publish [RPM](https://rpm.org/) packages for your user or organization. diff --git a/docs/user/packages/rubygems.md b/docs/user/packages/rubygems.md index 4643b832..c3c84163 100644 --- a/docs/user/packages/rubygems.md +++ b/docs/user/packages/rubygems.md @@ -1,7 +1,7 @@ --- title: 'RubyGems Packages Repository' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/rubygems.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/rubygems.en-us.md' --- Publish [RubyGems](https://guides.rubygems.org/) packages for your user or organization. diff --git a/docs/user/packages/storage.md b/docs/user/packages/storage.md index 4ba40799..95e049b2 100644 --- a/docs/user/packages/storage.md +++ b/docs/user/packages/storage.md @@ -1,7 +1,7 @@ --- title: 'Storage' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/storage.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/storage.en-us.md' --- This document describes the storage of the package registry and how it can be managed. diff --git a/docs/user/packages/swift.md b/docs/user/packages/swift.md index afdc4838..38001115 100644 --- a/docs/user/packages/swift.md +++ b/docs/user/packages/swift.md @@ -1,7 +1,7 @@ --- title: 'Swift Packages Repository' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/swift.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/swift.en-us.md' --- ## Swift Packages Repository diff --git a/docs/user/packages/vagrant.md b/docs/user/packages/vagrant.md index 9847b411..11f886d5 100644 --- a/docs/user/packages/vagrant.md +++ b/docs/user/packages/vagrant.md @@ -1,7 +1,7 @@ --- title: 'Vagrant Packages Repository' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/packages/vagrant.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/packages/vagrant.en-us.md' --- Publish [Vagrant](https://www.vagrantup.com/) packages for your user or organization. diff --git a/docs/user/profile.md b/docs/user/profile.md index 43db4c3f..4fd6df16 100644 --- a/docs/user/profile.md +++ b/docs/user/profile.md @@ -1,7 +1,7 @@ --- title: 'Profile customization' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/profile-readme.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/profile-readme.en-us.md' --- By default the profile page of a user is the list of repositories they @@ -17,4 +17,4 @@ user, if it exists. ![Profile README.md](../_images/user/profile/profile-step2.png) -> **NOTE:** if a the `.profile` repository is private the `README.md` they contain will be displayed publicly. It is **strongly recommended** to verify no such repository exist in a given instance before upgrading. +Making the `.profile` repository private will hide the Profile README. diff --git a/docs/user/protection.md b/docs/user/protection.md index 585a4b68..12543eef 100644 --- a/docs/user/protection.md +++ b/docs/user/protection.md @@ -1,7 +1,7 @@ --- title: 'Branch and tag protection' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/protected-tags.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/protected-tags.en-us.md' --- ## Protected branches diff --git a/docs/user/push-to-create.md b/docs/user/push-to-create.md index 93773fbf..cead470f 100644 --- a/docs/user/push-to-create.md +++ b/docs/user/push-to-create.md @@ -1,7 +1,7 @@ --- title: 'Push Options' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/push.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/push.en-us.md' --- ## Push To Create diff --git a/docs/user/token-scope.md b/docs/user/token-scope.md index 03fa6404..7e327715 100644 --- a/docs/user/token-scope.md +++ b/docs/user/token-scope.md @@ -1,7 +1,7 @@ --- title: 'Access Token scope' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/development/oauth2-provider.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/development/oauth2-provider.en-us.md' --- Forgejo supports scoped access tokens, which allow users to restrict tokens to operate only on selected url routes. Scopes are grouped by high-level API routes, and further refined to the following: diff --git a/docs/user/webhooks.md b/docs/user/webhooks.md index 731f6a70..810b6bec 100644 --- a/docs/user/webhooks.md +++ b/docs/user/webhooks.md @@ -1,7 +1,7 @@ --- title: 'Webhooks' license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/8d9e2d07f3f84a86265fdbe0ab7fcf63cc34ddbd/docs/content/usage/webhooks.en-us.md' +origin_url: 'https://github.com/go-gitea/gitea/blob/abe8fe352711601fbcd24bf4505f7e0b81a93c5d/docs/content/usage/webhooks.en-us.md' --- Forgejo supports webhooks for repository events. This can be configured in the settings