diff --git a/docusaurus.config.js b/docusaurus.config.js index a1b7f259..d1cf69e6 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,7 +1,7 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion -import {themes as prismThemes} from 'prism-react-renderer'; +import { themes as prismThemes } from "prism-react-renderer"; const lightCodeTheme = prismThemes.github; const darkCodeTheme = prismThemes.dracula; @@ -9,194 +9,206 @@ const darkCodeTheme = prismThemes.dracula; // order usage directory by type first function sortItemsByCategory(items) { // type with "category" (directory) first - const sortedItems = items.sort(function(a, b) { + const sortedItems = items.sort(function (a, b) { return a.type.localeCompare(b.type); - }) + }); return sortedItems; } -const renderApiSSR = process.env.API_SSR !== 'false'; +const renderApiSSR = process.env.API_SSR !== "false"; const apiConfig = [ - 'redocusaurus', + "redocusaurus", { // Plugin Options for loading OpenAPI files - specs: renderApiSSR ? [ - { - route: '/api/next/', - spec: 'static/swagger-latest.json', - }, - { - route: '/api/', - spec: 'static/swagger-23.json', - }, - { - route: '/api/1.23/', - spec: 'static/swagger-23.json', - }, - { - route: '/api/1.22/', - spec: 'static/swagger-22.json', - }, - { - route: '/api/1.21/', - spec: 'static/swagger-21.json', - }, - { - route: '/api/1.20/', - spec: 'static/swagger-20.json', - }, - { - route: '/api/1.19/', - spec: 'static/swagger-19.json', - } - ]: [], + specs: renderApiSSR + ? [ + { + route: "/api/next/", + spec: "static/swagger-latest.json", + }, + { + route: "/api/", + spec: "static/swagger-23.json", + }, + { + route: "/api/1.23/", + spec: "static/swagger-23.json", + }, + { + route: "/api/1.22/", + spec: "static/swagger-22.json", + }, + { + route: "/api/1.21/", + spec: "static/swagger-21.json", + }, + { + route: "/api/1.20/", + spec: "static/swagger-20.json", + }, + { + route: "/api/1.19/", + spec: "static/swagger-19.json", + }, + ] + : [], // Theme Options for modifying how redoc renders them theme: { // Change with your site colors - primaryColor: '#1890ff', + primaryColor: "#1890ff", }, }, -] +]; -const pageConfig = renderApiSSR ? { - exclude: [ - 'api/**', - ], -}: {} +const pageConfig = renderApiSSR + ? { + exclude: ["api/**"], + } + : {}; const globalVariables = { current: { - 'goVersion': '1.23', - 'minGoVersion': '1.23', - 'minNodeVersion': '18', - 'version': 'main-nightly', - 'sourceVersion': 'main', - 'sourceBranch': 'main', - 'dockerVersion': 'nightly', - 'displayVersion': '1.24-dev' + goVersion: "1.23", + minGoVersion: "1.23", + minNodeVersion: "18", + version: "main-nightly", + sourceVersion: "main", + sourceBranch: "main", + dockerVersion: "nightly", + displayVersion: "1.24-dev", }, - '1.23': { - 'goVersion': '1.23', - 'minGoVersion': '1.22', - 'minNodeVersion': '18', - 'version': '1.23.6', - 'sourceVersion': 'v1.23.0', - 'sourceBranch': 'release/v1.23', - 'dockerVersion': '1.23.6', - 'displayVersion': '1.23.6' + 1.23: { + goVersion: "1.23", + minGoVersion: "1.22", + minNodeVersion: "18", + version: "1.23.6", + sourceVersion: "v1.23.0", + sourceBranch: "release/v1.23", + dockerVersion: "1.23.6", + displayVersion: "1.23.6", }, - '1.22': { - 'goVersion': '1.22', - 'minGoVersion': '1.22', - 'minNodeVersion': '18', - 'version': '1.22.6', - 'sourceVersion': 'v1.22.6', - 'sourceBranch': 'release/v1.22', - 'dockerVersion': '1.22.6', - 'displayVersion': '1.22.6' + 1.22: { + goVersion: "1.22", + minGoVersion: "1.22", + minNodeVersion: "18", + version: "1.22.6", + sourceVersion: "v1.22.6", + sourceBranch: "release/v1.22", + dockerVersion: "1.22.6", + displayVersion: "1.22.6", }, - '1.21': { - 'goVersion': '1.21', - 'minGoVersion': '1.21', - 'minNodeVersion': '18', - 'version': '1.21.11', - 'sourceVersion': 'v1.21.11', - 'sourceBranch': 'release/v1.21', - 'dockerVersion': '1.21.11', - 'displayVersion': '1.21.11' + 1.21: { + goVersion: "1.21", + minGoVersion: "1.21", + minNodeVersion: "18", + version: "1.21.11", + sourceVersion: "v1.21.11", + sourceBranch: "release/v1.21", + dockerVersion: "1.21.11", + displayVersion: "1.21.11", }, - '1.20': { - 'goVersion': '1.20', - 'minGoVersion': '1.20', - 'minNodeVersion': '16', - 'version': '1.20.6', - 'sourceVersion': 'v1.20.6', - 'sourceBranch': 'release/v1.20', - 'dockerVersion': '1.20.6', - 'displayVersion': '1.20.6' + "1.20": { + goVersion: "1.20", + minGoVersion: "1.20", + minNodeVersion: "16", + version: "1.20.6", + sourceVersion: "v1.20.6", + sourceBranch: "release/v1.20", + dockerVersion: "1.20.6", + displayVersion: "1.20.6", }, - '1.19': { - 'goVersion': '1.20', - 'minGoVersion': '1.19', - 'minNodeVersion': '14', - 'version': '1.19.4', - 'sourceVersion': 'v1.19.4', - 'sourceBranch': 'release/v1.19', - 'dockerVersion': '1.19.4', - 'displayVersion': '1.19.4' - } -} + 1.19: { + goVersion: "1.20", + minGoVersion: "1.19", + minNodeVersion: "14", + version: "1.19.4", + sourceVersion: "v1.19.4", + sourceBranch: "release/v1.19", + dockerVersion: "1.19.4", + displayVersion: "1.19.4", + }, +}; const versions = { current: { - label: globalVariables['current'].displayVersion, // path is kept as next for dev (so users can always find "nightly" docs) - banner: 'unreleased', + label: globalVariables["current"].displayVersion, // path is kept as next for dev (so users can always find "nightly" docs) + banner: "unreleased", }, - '1.23': { - label: globalVariables['1.23'].displayVersion, + 1.23: { + label: globalVariables["1.23"].displayVersion, }, - '1.22': { - label: globalVariables['1.22'].displayVersion, + 1.22: { + label: globalVariables["1.22"].displayVersion, }, - '1.21': { - label: globalVariables['1.21'].displayVersion, + 1.21: { + label: globalVariables["1.21"].displayVersion, }, - '1.20': { - label: globalVariables['1.20'].displayVersion, + "1.20": { + label: globalVariables["1.20"].displayVersion, }, - '1.19': { - label: globalVariables['1.19'].displayVersion, - } -} + 1.19: { + label: globalVariables["1.19"].displayVersion, + }, +}; /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'Gitea Documentation', - tagline: 'Git with a cup of tea', - url: 'https://docs.gitea.com', - baseUrl: '/', - onBrokenLinks: 'warn', - onBrokenMarkdownLinks: 'warn', - favicon: 'img/favicon.png', - future:{ - experimental_faster: true + title: "Gitea Documentation", + tagline: "Git with a cup of tea", + url: "https://docs.gitea.com", + baseUrl: "/", + onBrokenLinks: "warn", + onBrokenMarkdownLinks: "warn", + favicon: "img/favicon.png", + future: { + experimental_faster: true, }, plugins: [ [ - 'docusaurus-plugin-plausible', + "docusaurus-plugin-plausible", { - domain: 'docs.gitea.com', + domain: "docs.gitea.com", }, ], // for runner documentations [ - '@docusaurus/plugin-content-docs', + "@docusaurus/plugin-content-docs", { - id: 'runner', - path: 'runner', - routeBasePath: 'runner', + id: "runner", + path: "runner", + routeBasePath: "runner", //sidebarPath: './runner/sidebars.js', versions: { current: { - label: 'main', - banner: 'unreleased', + label: "main", + banner: "unreleased", }, "0.2.11": { - path: '0.2.11', - label: '0.2.11', - } + path: "0.2.11", + label: "0.2.11", + }, }, - lastVersion: '0.2.11', - editUrl: ({versionDocsDirPath, docPath, locale, version, permalink}) => { - return `https://gitea.com/gitea/docs/src/branch/main/${version === 'current' ? 'runner': `runner_versioned_docs/version-${version}`}/${docPath}`; + lastVersion: "0.2.11", + editUrl: ({ + versionDocsDirPath, + docPath, + locale, + version, + permalink, + }) => { + return `https://gitea.com/gitea/docs/src/branch/main/${ + version === "current" + ? "runner" + : `runner_versioned_docs/version-${version}` + }/${docPath}`; }, - async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) { - const {item} = args; + async sidebarItemsGenerator({ defaultSidebarItemsGenerator, ...args }) { + const { item } = args; // Use the provided data to generate a custom sidebar slice const sidebarItems = await defaultSidebarItemsGenerator(args); - if (item.dirName !== 'usage') { + if (item.dirName !== "usage") { return sidebarItems; } else { return sortItemsByCategory(sidebarItems); @@ -207,44 +219,62 @@ const config = { ], i18n: { - defaultLocale: 'en-us', - locales: ['en-us', 'zh-cn'/*,'fr-fr', 'zh-tw'*/], // temporarily disable other locales + defaultLocale: "en-us", + locales: ["en-us", "zh-cn", "zh-tw"], localeConfigs: { - 'en-us': { - label: 'English', + "en-us": { + label: "English", }, - 'zh-cn': { - label: '中文', + "zh-cn": { + label: "簡體中文", + }, + "zh-tw": { + label: "繁體中文", }, }, }, presets: [ [ - '@docusaurus/preset-classic', + "@docusaurus/preset-classic", //'classic', /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - sidebarPath: require.resolve('./sidebars.js'), - routeBasePath: '/', // Serve the docs at the site's root - editUrl: ({versionDocsDirPath, docPath, locale, version, permalink}) => { + sidebarPath: require.resolve("./sidebars.js"), + routeBasePath: "/", // Serve the docs at the site's root + editUrl: ({ + versionDocsDirPath, + docPath, + locale, + version, + permalink, + }) => { // Special case for awesome page - if (docPath.includes('awesome.md')) { - return `https://gitea.com/gitea/awesome-gitea/src/branch/main/README.md` + if (docPath.includes("awesome.md")) { + return `https://gitea.com/gitea/awesome-gitea/src/branch/main/README.md`; } - if (locale === 'en-us') { - return `https://gitea.com/gitea/docs/src/branch/main/${version === 'current' ? 'docs': `versioned_docs/version-${version}`}/${docPath}`; + if (locale === "en-us") { + return `https://gitea.com/gitea/docs/src/branch/main/${ + version === "current" + ? "docs" + : `versioned_docs/version-${version}` + }/${docPath}`; } - return `https://gitea.com/gitea/docs/src/branch/main/i18n/${locale}/docusaurus-plugin-content-docs/${version === 'current' ? 'current': `version-${version}`}/${docPath}`; + return `https://gitea.com/gitea/docs/src/branch/main/i18n/${locale}/docusaurus-plugin-content-docs/${ + version === "current" ? "current" : `version-${version}` + }/${docPath}`; }, versions: versions, - lastVersion: '1.23', - async sidebarItemsGenerator({defaultSidebarItemsGenerator, ...args}) { - const {item} = args; + lastVersion: "1.23", + async sidebarItemsGenerator({ + defaultSidebarItemsGenerator, + ...args + }) { + const { item } = args; // Use the provided data to generate a custom sidebar slice const sidebarItems = await defaultSidebarItemsGenerator(args); - if (item.dirName !== 'usage') { + if (item.dirName !== "usage") { return sidebarItems; } else { return sortItemsByCategory(sidebarItems); @@ -253,37 +283,40 @@ const config = { }, blog: false, theme: { - customCss: require.resolve('./src/css/custom.css'), + customCss: require.resolve("./src/css/custom.css"), }, pages: pageConfig, gtag: { - trackingID: 'G-KHM0KYT506' + trackingID: "G-KHM0KYT506", }, }), ], apiConfig, ], markdown: { - preprocessor: ({filePath, fileContent}) => { - var key = ''; + preprocessor: ({ filePath, fileContent }) => { + var key = ""; var found = false; for (key in globalVariables) { - let folderName = (key == 'current' ? 'current' : `version-${key}`); + let folderName = key == "current" ? "current" : `version-${key}`; if (filePath.includes(`/${folderName}/`)) { found = true; break; } } - if (key == '' || !found) { - key = 'current'; + if (key == "" || !found) { + key = "current"; } let content = fileContent; for (const variable in globalVariables[key]) { - content = content.replaceAll('@'+variable+'@', globalVariables[key][variable]); + content = content.replaceAll( + "@" + variable + "@", + globalVariables[key][variable] + ); } - return content + return content; }, }, themes: [ @@ -295,164 +328,168 @@ const config = { highlightSearchTermsOnTargetPage: true, explicitSearchResultPath: true, indexBlog: false, - docsRouteBasePath: "/" - } - ] + docsRouteBasePath: "/", + }, + ], ], themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ metadata: [ - {name: 'keywords', content: 'gitea, git, devops, actions, packages, documentation, self-hosted, open-source, version control, gitlab, github'} + { + name: "keywords", + content: + "gitea, git, devops, actions, packages, documentation, self-hosted, open-source, version control, gitlab, github", + }, ], colorMode: { - defaultMode: 'light', + defaultMode: "light", disableSwitch: false, respectPrefersColorScheme: true, }, announcementBar: { - id: 'announcementBar-4', // Increment on change + id: "announcementBar-4", // Increment on change content: `Try   Gitea Cloud   ☁️   for 30 days Accelerate your Development & Deploys!`, }, navbar: { - title: 'Gitea', + title: "Gitea", logo: { - alt: 'Gitea Logo', - src: 'img/gitea.svg', - href: 'https://about.gitea.com/', - target: '_self', + alt: "Gitea Logo", + src: "img/gitea.svg", + href: "https://about.gitea.com/", + target: "_self", }, items: [ { - type: 'doc', - docId: 'index', - position: 'left', - label: 'Docs', + type: "doc", + docId: "index", + position: "left", + label: "Docs", }, { - to: '/api/1.23/', - label: 'API', - position: 'left', - activeBaseRegex: 'api/(1.19|1.20|1.21|1.22|1.23|next)/', + to: "/api/1.23/", + label: "API", + position: "left", + activeBaseRegex: "api/(1.19|1.20|1.21|1.22|1.23|next)/", }, { - to: '/runner/0.2.11/', - label: 'Runner', - position: 'left', - activeBaseRegex: 'runner/(0.2.11|next)/', + to: "/runner/0.2.11/", + label: "Runner", + position: "left", + activeBaseRegex: "runner/(0.2.11|next)/", }, { - position: 'left', - label: 'Enterprise', - href: 'https://docs.gitea.com/enterprise', - className: 'internal-href', - target: '_self', + position: "left", + label: "Enterprise", + href: "https://docs.gitea.com/enterprise", + className: "internal-href", + target: "_self", }, { - type: 'search', - position: 'right', + type: "search", + position: "right", }, { - type: 'localeDropdown', - position: 'right', + type: "localeDropdown", + position: "right", }, { - type: 'docsVersionDropdown', - position: 'right', + type: "docsVersionDropdown", + position: "right", dropdownActiveClassDisabled: true, }, { - type: 'custom-Dropdown', - label: 'API Version', - position: 'right', + type: "custom-Dropdown", + label: "API Version", + position: "right", items: [ - {to: '/api/next/', label: '1.24-dev' }, - {to: '/api/1.23/', label: '1.23.6' }, - {to: '/api/1.22/', label: '1.22.6' }, - {to: '/api/1.21/', label: '1.21.11' }, - {to: '/api/1.20/', label: '1.20.6' }, - {to: '/api/1.19/', label: '1.19.4' }, + { to: "/api/next/", label: "1.24-dev" }, + { to: "/api/1.23/", label: "1.23.6" }, + { to: "/api/1.22/", label: "1.22.6" }, + { to: "/api/1.21/", label: "1.21.11" }, + { to: "/api/1.20/", label: "1.20.6" }, + { to: "/api/1.19/", label: "1.19.4" }, ], - routerRgx: '\/api\/', - classNames: 'api-dropdown', + routerRgx: "/api/", + classNames: "api-dropdown", }, { - type: 'custom-Dropdown', - label: 'Runner Version', - position: 'right', + type: "custom-Dropdown", + label: "Runner Version", + position: "right", items: [ - {to: '/runner/next/', label: 'development' }, - {to: '/runner/0.2.11/', label: '0.2.11' }, + { to: "/runner/next/", label: "development" }, + { to: "/runner/0.2.11/", label: "0.2.11" }, ], - routerRgx: '\/runner\/', - classNames: 'runner-dropdown', + routerRgx: "/runner/", + classNames: "runner-dropdown", }, { - to: 'help/support', - position: 'right', - label: 'Support', - activeBaseRegex: 'help/support', + to: "help/support", + position: "right", + label: "Support", + activeBaseRegex: "help/support", }, { - href: 'https://gitea.com/user/login', - label: 'Sign In', - position: 'right', - className: 'internal-href signin-button', - target: '_self', + href: "https://gitea.com/user/login", + label: "Sign In", + position: "right", + className: "internal-href signin-button", + target: "_self", }, ], }, footer: { - style: 'dark', + style: "dark", links: [ { - title: 'Community', + title: "Community", items: [ { - label: 'Awesome Gitea', - href: 'https://gitea.com/gitea/awesome-gitea', + label: "Awesome Gitea", + href: "https://gitea.com/gitea/awesome-gitea", }, { - label: 'Stack Overflow', - href: 'https://stackoverflow.com/questions/tagged/gitea', + label: "Stack Overflow", + href: "https://stackoverflow.com/questions/tagged/gitea", }, { - label: 'Discord', - href: 'https://discord.gg/gitea', + label: "Discord", + href: "https://discord.gg/gitea", }, { - label: 'Matrix', - href: 'https://matrix.to/#/#gitea-space:matrix.org', + label: "Matrix", + href: "https://matrix.to/#/#gitea-space:matrix.org", }, { - label: 'Forum', - href: 'https://forum.gitea.com/', + label: "Forum", + href: "https://forum.gitea.com/", }, { - label: 'Twitter', - href: 'https://twitter.com/giteaio', + label: "Twitter", + href: "https://twitter.com/giteaio", }, { - label: 'Mastodon', - href: 'https://social.gitea.io/@gitea', + label: "Mastodon", + href: "https://social.gitea.io/@gitea", }, ], }, { - title: 'Code', + title: "Code", items: [ { - label: 'GitHub', - href: 'https://github.com/go-gitea/gitea', + label: "GitHub", + href: "https://github.com/go-gitea/gitea", }, { - label: 'Gitea', - href: 'https://gitea.com/gitea', + label: "Gitea", + href: "https://gitea.com/gitea", }, { - label: 'Tea CLI', - href: 'https://gitea.com/gitea/tea', + label: "Tea CLI", + href: "https://gitea.com/gitea/tea", }, ], }, @@ -461,7 +498,7 @@ const config = { prism: { theme: lightCodeTheme, darkTheme: darkCodeTheme, - additionalLanguages: ['ini','diff','json','http','docker','php'], + additionalLanguages: ["ini", "diff", "json", "http", "docker", "php"], }, }), }; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md index c04ed27b..2649e795 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md @@ -5,7 +5,6 @@ sidebar_position: 110 aliases: - /zh-cn/adding-legal-pages - --- # 添加法律页面 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/authentication.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/authentication.md index fe9e812b..c7fdd375 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/authentication.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/authentication.md @@ -10,7 +10,7 @@ aliases: ## 轻量级目录访问协议（Lightweight Directory Access Protocol，LDAP） -通过BindDN的LDAP和简单认证方式LDAP共享以下字段: +通过 BindDN 的 LDAP 和简单认证方式 LDAP 共享以下字段: - 认证名称 **(必选)** @@ -27,48 +27,52 @@ aliases: - 例如: LDAP `389`/ LDAPs `636` - 安全协议 (可选) - - 连接LDAP服务器时是否使用TLS协议。 + + - 连接 LDAP 服务器时是否使用 TLS 协议。 - 管理员过滤规则 (可选) - - 一个LDAP过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 + + - 一个 LDAP 过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 - 示例:`(objectClass=adminAccount)` - - 适用于Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` + - 适用于 Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` - 用户名属性（可选） - - 用户LDAP记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的Gitea账户用户名。若留空，则使用登录表单上提供的用户名。 - - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于Gitea账户名称，请参阅"用户过滤器"。 + - 用户 LDAP 记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的 Gitea 账户用户名。若留空，则使用登录表单上提供的用户名。 + - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于 Gitea 账户名称，请参阅"用户过滤器"。 - 示例:uid - - 适用于Microsoft Active Directory（AD）的示例:`sAMAccountName` + - 适用于 Microsoft Active Directory（AD）的示例:`sAMAccountName` - 名字属性（可选） - - 用户LDAP记录中包含用户名字的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户名字的属性。将用于填充他们的账户信息。 - 示例:givenName + - 姓氏属性（可选） - - 用户LDAP记录中包含用户姓氏的属性。将用于填充他们的账户信息。 + + - 用户 LDAP 记录中包含用户姓氏的属性。将用于填充他们的账户信息。 - 示例:`sn` - 电子邮件属性 **(必选)** - - 用户LDAP记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 - 示例:`mail` ### LDAP(via BindDN) 需要额外设置以下字段: -- 绑定DN (可选) +- 绑定 DN (可选) - - 搜索用户时绑定到LDAP服务器的DN。这可以留空以执行匿名搜索。 + - 搜索用户时绑定到 LDAP 服务器的 DN。这可以留空以执行匿名搜索。 - 示例: `cn=Search,dc=mydomain,dc=com` - 绑定密码 (可选) - - 上述指定的Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用SECRET_KEY进行加密存储。仍然建议确保Bind DN具有尽可能少的权限。 + - 上述指定的 Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用 SECRET_KEY 进行加密存储。仍然建议确保 Bind DN 具有尽可能少的权限。 - 用户搜索基准 **(必选)** - - 这是用于搜索用户帐户的LDAP基础路径. + - 这是用于搜索用户帐户的 LDAP 基础路径. - 示例: `ou=Users,dc=mydomain,dc=com` - 用户过滤规则 **(必选)** @@ -79,19 +83,19 @@ aliases: - 如需多次替换，应使用 `%[1]s`，例如在将提供的登录名与多个属性（如用户标识符、电子邮件甚至电话号码）进行匹配时。 - 示例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` - 启用用户同步 - - 这个选项启用了一个周期性任务，用于将Gitea用户与LDAP服务器进行同步。默认的同步周期是每24小时， - 但您可以在app.ini文件中进行更改。 + - 这个选项启用了一个周期性任务，用于将 Gitea 用户与 LDAP 服务器进行同步。默认的同步周期是每 24 小时， + 但您可以在 app.ini 文件中进行更改。 有关此部分的详细说明，请参阅[sample app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) - 的_cron.sync_external_users_ 部分的注释。前面提到的_User Search Base_和_User Filter_ - 设置将限制哪些用户可以使用Gitea以及哪些用户将被同步。 - 在初始运行任务时，将根据给定的设置创建所有与LDAP匹配的用户，因此在使用大型企业LDAP目录时需要小心。 + 的*cron.sync_external_users* 部分的注释。前面提到的*User Search Base*和*User Filter* + 设置将限制哪些用户可以使用 Gitea 以及哪些用户将被同步。 + 在初始运行任务时，将根据给定的设置创建所有与 LDAP 匹配的用户，因此在使用大型企业 LDAP 目录时需要小心。 ### LDAP(simple auth) 需要额外设置以下字段: -- 用户DN **(必选)** +- 用户 DN **(必选)** - 用作用户 DN 的模板。匹配参数 `%s` 将替换为登录表单中的登录名。 - 示例: `cn=%s,ou=Users,dc=mydomain,dc=com` @@ -108,11 +112,12 @@ aliases: - 示例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` -### 使用LDAP验证分组成员 +### 使用 LDAP 验证分组成员 使用以下字段: -- 群组搜索基础DN(可选) +- 群组搜索基础 DN(可选) + - 组使用的 LDAP DN。 - 示例: `ou=group,dc=mydomain,dc=com` @@ -132,43 +137,46 @@ aliases: ## 可插拔式认证模块(Pluggable Authentication Module,PAM) -这个过程启用了PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 -PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加到当前数据库中。为了与普通的Linux密码一起使用， -运行Gitea的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 +这个过程启用了 PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 +PAM 提供了一种机制，通过对用户进行 PAM 认证来自动将其添加到当前数据库中。为了与普通的 Linux 密码一起使用， +运行 Gitea 的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 -**注意**:如果用户已将SSH公钥添加到Gitea中，使用这些密钥可能会绕过登录检查系统。因此， -如果您希望禁用使用PAM进行身份验证的用户，应该在Gitea中手动禁用该账户，使用内置的用户管理功能。 +**注意**:如果用户已将 SSH 公钥添加到 Gitea 中，使用这些密钥可能会绕过登录检查系统。因此， +如果您希望禁用使用 PAM 进行身份验证的用户，应该在 Gitea 中手动禁用该账户，使用内置的用户管理功能。 1. 配置和安装准备. - - 建议您创建一个管理用户. - - 建议取消自动注册. + - 建议您创建一个管理用户. + - 建议取消自动注册. 1. 一旦数据库已初始化完成，使用新创建的管理员账户登录. 1. 导航至用户设置（右上角的图标），然后选择 -`Site Administration` -> `Authentication Sources`, 并选择 -`Add Authentication Source`. + `Site Administration` -> `Authentication Sources`, 并选择 + `Add Authentication Source`. 1. 填写字段如下: - - 认证类型:`PAM`。 - - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 - - PAM服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 - - PAM电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为gituse的用户， - 并且将此字段设置为mail.com，那么Gitea在验证一个GIT实例的用户时将期望user emai字段为gituser@mail.com[^2]。 + - 认证类型:`PAM`。 + - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 + - PAM 服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 + - PAM 电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为 gituse 的用户， + 并且将此字段设置为 mail.com，那么 Gitea 在验证一个 GIT 实例的用户时将期望 user emai 字段为gituser@mail.com[^2]。 **Note**: PAM 支持通过[build-time flags](installation/from-source.md#build)添加, -而官方提供的二进制文件通常不会默认启用此功能。PAM需要确保系统上有必要的libpam动态库，并且编译器可以访问必要的PAM开发头文件。 +而官方提供的二进制文件通常不会默认启用此功能。PAM 需要确保系统上有必要的 libpam 动态库，并且编译器可以访问必要的 PAM 开发头文件。 -[^1]: 例如，在Debian "Bullseye"上使用标准Linux登录，可以使用`common-session-noninteractive`。这个值对于其他版本的Debian， -包括Ubuntu和Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 +[^1]: + 例如，在 Debian "Bullseye"上使用标准 Linux 登录，可以使用`common-session-noninteractive`。这个值对于其他版本的 Debian， + 包括 Ubuntu 和 Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 -[^2]: **PAM的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到Gitea的Web界面。 +[^2]: **PAM 的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到 Gitea 的 Web 界面。 ## 简单邮件传输协议(Simple Mail Transfer Protocol,SMTP) 此选项允许 Gitea 以 Gitea 用户身份登录 SMTP 主机。请设置以下字段: - 身份验证名称 **(必选)** + - 分配给新授权方法的名称 - SMTP 验证类型 **(必选)** + - 用于连接 SMTP 主机的验证类型，plain 或 login - 主机名 **(必选)** @@ -188,7 +196,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 示例: `gitea.com,mydomain.com,mydomain2.com` - 强制使用 SMTPS - - 默认情况下将使用SMTPS连接到端口465.如果您希望将smtp用于其他端口，自行设置 + - 默认情况下将使用 SMTPS 连接到端口 465.如果您希望将 smtp 用于其他端口，自行设置 - 否则，如果服务器提供' STARTTLS '扩展名，则将使用此扩展名 - 跳过 TLS 验证 - 禁用 TLS 验证身份. @@ -199,7 +207,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 要使用 FreeIPA 凭据登录 Gitea，需要为 Gitea 创建一个绑定帐户。 创建一个绑定帐户: -- 在FreeIPA服务器上创建一个gitea.ldif文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 +- 在 FreeIPA 服务器上创建一个 gitea.ldif 文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 ```sh dn: uid=gitea,cn=sysaccounts,cn=etc,dc=example,dc=com @@ -212,33 +220,33 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 nsIdleTimeout: 0 ``` -- 导入LDIF文件（如果需要，请将localhost更改为IPA服务器）。系统会提示您输入Directory Manager的密码。: +- 导入 LDIF 文件（如果需要，请将 localhost 更改为 IPA 服务器）。系统会提示您输入 Directory Manager 的密码。: ```sh ldapmodify -h localhost -p 389 -x -D \ "cn=Directory Manager" -W -f gitea.ldif ``` -- 为`gitea_users`添加IPA组: +- 为`gitea_users`添加 IPA 组: ```sh ipa group-add --desc="Gitea Users" gitea_users ``` -- **提示**:对于IPA凭证错误，运行' kinit admin '并提供域管理帐户密码. -- 以管理员身份登录Gitea，点击Admin Panel下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 +- **提示**:对于 IPA 凭证错误，运行' kinit admin '并提供域管理帐户密码. +- 以管理员身份登录 Gitea，点击 Admin Panel 下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 ## SPNEGO with SSPI (Kerberos/NTLM, for Windows only) -Gitea支持通过Windows内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现SPNEGO单点登录认证（由RFC4559定义的方案），用于服务器的Web部分。SSPI仅在Windows环境中工作，即当服务器和客户端都在Windows操作系统上运行时。 +Gitea 支持通过 Windows 内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现 SPNEGO 单点登录认证（由 RFC4559 定义的方案），用于服务器的 Web 部分。SSPI 仅在 Windows 环境中工作，即当服务器和客户端都在 Windows 操作系统上运行时。 -在激活SSPI单点登录认证（SSO）之前，您需要准备您的环境: +在激活 SSPI 单点登录认证（SSO）之前，您需要准备您的环境: -- 在Active Directory中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在domain.local域下创建一个名为user的账户: -- 为运行gitea.exe的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为HTTP: +- 在 Active Directory 中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在 domain.local 域下创建一个名为 user 的账户: +- 为运行 gitea.exe 的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为 HTTP: - 以特权域用户（例如域管理员）的身份启动“命令提示符”或“PowerShell”。 - - 运行下面的命令，将host.domain.local替换为Web应用程序将运行的服务器的完全限定域名（FQDN），将domain\user替换为在前一步中创建的账户名称: + - 运行下面的命令，将 host.domain.local 替换为 Web 应用程序将运行的服务器的完全限定域名（FQDN），将 domain\user 替换为在前一步中创建的账户名称: ```sh setspn -A HTTP/host.domain.local domain\user @@ -247,22 +255,22 @@ Gitea支持通过Windows内置的安全支持提供程序接口（Security Suppo 在遵循上述步骤之前，请确保您按照以下流程进行操作: 1. 用之前创建的用户登录（如果已经登录，请先注销）。 -2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为Web应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 -3. 启动Web服务器（运行 `gitea.exe web`）。 -4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用SSPI认证。 +2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为 Web 应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 +3. 启动 Web 服务器（运行 `gitea.exe web`）。 +4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用 SSPI 认证。 5. 在域中的客户端计算机上，使用任何域用户登录（与运行`gitea.exe`的服务器不同）。 -6. 如果您使用Chrome或Edge浏览器，请将Web应用程序的URL添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 -7. 启动Chrome或Edge浏览器，导航到Gitea的FQDN URL（例如，`http://host.domain.local:3000`）。 -8. 在控制面板中点击“Sign In”按钮，然后选择SSPI，将会自动使用当前登录到计算机的用户进行登录。 +6. 如果您使用 Chrome 或 Edge 浏览器，请将 Web 应用程序的 URL 添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 +7. 启动 Chrome 或 Edge 浏览器，导航到 Gitea 的 FQDN URL（例如，`http://host.domain.local:3000`）。 +8. 在控制面板中点击“Sign In”按钮，然后选择 SSPI，将会自动使用当前登录到计算机的用户进行登录。 9. 如果无法正常工作，请确保: - - 您不是在运行`gitea.exe`的同一台服务器上运行Web浏览器。应该在与服务器不同的域加入计算机（客户端）上运行Web浏览器。如果客户端和服务器都在同一台计算机上运行，则NTLM将优先于Kerberos。 - - 主机上只有一个`HTTP/...`的SPN。 - - SPN中只包含主机名，不包含端口号。 - - 将Web应用程序的URL添加到"本地站点"。 - - 服务器和客户端的时钟差异不超过5分钟（取决于组策略）。 - - 在Internet Explorer中启用了"集成Windows身份验证"（在"高级设置"下）。 + - 您不是在运行`gitea.exe`的同一台服务器上运行 Web 浏览器。应该在与服务器不同的域加入计算机（客户端）上运行 Web 浏览器。如果客户端和服务器都在同一台计算机上运行，则 NTLM 将优先于 Kerberos。 + - 主机上只有一个`HTTP/...`的 SPN。 + - SPN 中只包含主机名，不包含端口号。 + - 将 Web 应用程序的 URL 添加到"本地站点"。 + - 服务器和客户端的时钟差异不超过 5 分钟（取决于组策略）。 + - 在 Internet Explorer 中启用了"集成 Windows 身份验证"（在"高级设置"下）。 -遵循这些步骤，您应该能够成功启用和使用SSPI单点登录认证（SSO）。 +遵循这些步骤，您应该能够成功启用和使用 SSPI 单点登录认证（SSO）。 ## 反向代理认证 @@ -279,7 +287,7 @@ ENABLE_REVERSE_PROXY_AUTHENTICATION = true 如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`，则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取，这样在自动创建用户时将使用这个字段作为用户全名，你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 -你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的IP地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 +你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 你可以通过以下配置为 API 启用此认证方法： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md index c0e840f8..73ce7c6a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md @@ -5,12 +5,11 @@ sidebar_position: 11 aliases: - /zh-cn/backup-and-restore - --- # 备份与恢复 -Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个zip压缩文件。该压缩文件可以被用来进行数据恢复。 +Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 ## 备份一致性 @@ -20,7 +19,7 @@ Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都 ## 备份命令 (`dump`) -先转到git用户的权限: `su git`. 再Gitea目录运行 `./gitea dump`。一般会显示类似如下的输出： +先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出： ``` 2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 @@ -33,12 +32,12 @@ Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都 最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容： -* `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 -* `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 -* `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 -* `repos/` - 仓库目录的完整副本。 -* `gitea-db.sql` - 数据库dump出来的 SQL。 -* `log/` - Logs文件，如果用作迁移不是必须的。 +- `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 +- `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 +- `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 +- `repos/` - 仓库目录的完整副本。 +- `gitea-db.sql` - 数据库 dump 出来的 SQL。 +- `log/` - Logs 文件，如果用作迁移不是必须的。 中间备份文件将会在临时目录进行创建，如果您要重新指定临时目录，可以用 `--tempdir` 参数，或者用 `TMPDIR` 环境变量。 @@ -53,7 +52,7 @@ mysqldump -u$USER -p$PASS --database $DATABASE > gitea-db.sql pg_dump -U $USER $DATABASE > gitea-db.sql ``` -### 使用Docker （`dump`） +### 使用 Docker （`dump`） 在使用 Docker 时，使用 `dump` 命令有一些注意事项。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md index fc037aaf..a2d2dc7e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md @@ -5,7 +5,6 @@ sidebar_position: 20 aliases: - /zh-cn/cmd-embedded - --- # 嵌入资源提取工具 @@ -30,7 +29,7 @@ gitea embedded list [--include-vendored] [patterns...] - 列出所有模板文件，无论在哪个虚拟目录下：`**.tmpl` - 列出所有邮件模板文件：`templates/mail/**.tmpl` -列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` + 列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` 不要忘记为模式使用引号，因为空格、`*` 和其他字符可能对命令行解释器有特殊含义。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/command-line.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/command-line.md index a9791e92..e7a563cb 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/command-line.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/command-line.md @@ -5,7 +5,6 @@ sidebar_position: 1 aliases: - /zh-cn/command-line - --- # 命令行 @@ -61,7 +60,7 @@ aliases: - 选项： - `--email`：要删除的用户的电子邮件。 - `--username`：要删除的用户的用户名。 - - `--id`：要删除的用户的ID。 + - `--id`：要删除的用户的 ID。 - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 - 示例： - `gitea admin user delete --id 1` @@ -170,11 +169,11 @@ aliases: - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 - `--skip-local-2fa`：跳过 2FA 登录。 - `--active`：启用此认证源。 - 备注： - `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： - `--option`、`--option=true` 以启用选项 - `--option=false` 以禁用选项 - 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 - 示例： - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` - `update-smtp`： @@ -283,12 +282,12 @@ aliases: ### cert -生成自签名的SSL证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 - 选项： - - `--host value`：逗号分隔的主机名和IP地址列表，此证书适用于这些主机。支持使用通配符。必填。 - - `--ecdsa-curve value`：用于生成密钥的ECDSA曲线。可选。有效选项为P224、P256、P384、P521。 - - `--rsa-bits value`：要生成的RSA密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 @@ -297,18 +296,18 @@ aliases: ### dump -将所有文件和数据库导出到一个zip文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 - 选项： - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 - `--skip-repository`，`-R`：跳过仓库的导出。可选。 - `--skip-custom-dir`：跳过自定义目录的导出。可选。 - - `--skip-lfs-data`：跳过LFS数据的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 - `--skip-attachment-data`：跳过附件数据的导出。可选。 - `--skip-package-data`：跳过包数据的导出。可选。 - `--skip-log`：跳过日志数据的导出。可选。 - - `--database`，`-d`：指定数据库的SQL语法。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 - `--type`：设置导出的格式。可选。（默认值：zip） - 示例： @@ -401,19 +400,19 @@ gitea doctor recreate-table - 命令: - `shutdown`: 优雅地关闭运行中的进程 - - `restart`: 优雅地重新启动运行中的进程（对于Windows服务器尚未实现） + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） - `flush-queues`: 刷新运行中的进程中的队列 - 选项: - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） - - `--non-blocking`: 设置为true，以在返回之前不等待刷新完成 + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 - `logging`: 调整日志命令 - 命令: - `pause`: 暂停日志记录 - 注意: - - 如果日志级别低于此级别，日志级别将被临时提升为INFO。 - - Gitea将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 - `resume`: 恢复日志记录 - - `release-and-reopen`: 使Gitea释放和重新打开用于日志记录的文件和连接（相当于向Gitea发送SIGUSR1信号）。 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 - `remove name`: 删除指定的日志记录器 - 选项: - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） @@ -429,7 +428,7 @@ gitea doctor recreate-table - `--expression value`, `-e value`: 日志记录器的匹配表达式 - `--prefix value`, `-p value`: 日志记录器的前缀 - `--color`: 在日志中使用颜色 - - `--stderr`: 将控制台日志输出到stderr - 仅适用于控制台 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 - `file`: 添加文件日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" @@ -459,9 +458,9 @@ gitea doctor recreate-table - `--color`: 在日志中使用颜色 - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 - `--reconnect`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix或udp（默认为tcp） + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） - - `smtp`: 添加SMTP日志记录器 + - `smtp`: 添加 SMTP 日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md index 7f0d92ec..6b1318bd 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md @@ -5,13 +5,12 @@ sidebar_position: 30 aliases: - /zh-cn/config-cheat-sheet - --- # 配置说明 -这是针对Gitea配置文件的说明， -你可以了解Gitea的强大配置。 +这是针对 Gitea 配置文件的说明， +你可以了解 Gitea 的强大配置。 需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 如果是从发行版本完成的安装， @@ -22,14 +21,12 @@ aliases: 包含`#`或者`;`的变量必须使用引号( `` ` `` 或者 `"` )包裹，否则会被解析为注释。 - 本文档使用以下约定： -* `[section].FOO_BAR` 或 `[section]FOO_BAR`: 一个位于 INI 文件 `[section]` 段中的配置项。 -* `FooBar`: 这是一个 Gitea 内部变量，不是一个配置项，仅用于描述相关逻辑。 -* `$FOO_BAR`: 这是一个环境变量，Gitea 可能会使用它的值，但是它不能直接用于配置文件中。 -* `{FOO_BAR}/something` 或 `{FooBar}/something`: 这个值会默认使用配置项 `FOO_BAR` 或者内部变量 `FooBar`。 - +- `[section].FOO_BAR` 或 `[section]FOO_BAR`: 一个位于 INI 文件 `[section]` 段中的配置项。 +- `FooBar`: 这是一个 Gitea 内部变量，不是一个配置项，仅用于描述相关逻辑。 +- `$FOO_BAR`: 这是一个环境变量，Gitea 可能会使用它的值，但是它不能直接用于配置文件中。 +- `{FOO_BAR}/something` 或 `{FooBar}/something`: 这个值会默认使用配置项 `FOO_BAR` 或者内部变量 `FooBar`。 **注意:** 修改完配置文件后，需要重启 Gitea 服务才能生效。 @@ -43,68 +40,68 @@ aliases: 这些值取决于环境，但构成了许多值的基础。当运行 `gitea help`或启动时，它们将 作为默认配置的一部分进行报告。它们在那里发出的顺序略有不同，但我们将按照设置的顺序在这里列出。 -- _`AppPath`_: Gitea二进制可执行文件的绝对路径 -- _`AppWorkPath`_: Gitea可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: +- _`AppPath`_: Gitea 二进制可执行文件的绝对路径 +- _`AppWorkPath`_: Gitea 可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: - `app.ini`中的`WORK_PATH`配置项 - - 启动Gitea时的`--work-path`命令行参数 + - 启动 Gitea 时的`--work-path`命令行参数 - `$GITEA_WORK_DIR`环境变量 - 在编译时设置的内置值（参见从源代码编译） - 默认为 _`AppPath`_ 的目录 - 如果上述任何路径为相对路径，将自动解析为相对于 _`AppPath`_ 目录的绝对路径 - _`CustomPath`_: 这是用于自定义模板和其他选项的基础目录。 -它是通过使用以下层次结构中的第一个设置的内容来确定的： + 它是通过使用以下层次结构中的第一个设置的内容来确定的： - 通过传递给二进制文件的`--custom-path`标志 - 环境变量 `$GITEA_CUSTOM` - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`AppWorkPath`_`/custom` - 如果上述任何路径是相对路径，则会相对于 _`AppWorkPath`_ 目录进行处理， - 使其变为绝对路径。 + 使其变为绝对路径。 - _`CustomConf`_: 这是指向`app.ini`文件的路径。 - 这是指向`app.ini`文件的路径。 - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`CustomPath`_`/conf/app.ini` - - 如果上述任何路径是相对路径，则会相对于_`CustomPath`_目录进行处理。 + - 如果上述任何路径是相对路径，则会相对于*`CustomPath`*目录进行处理。 -此外，还有_`StaticRootPath`_，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 +此外，还有*`StaticRootPath`*，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 ## Overall (`DEFAULT`) - `APP_NAME`: **Gitea: Git with a cup of tea** 应用名称，在网页的标题中显示。 -- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行Gitea的用户， +- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行 Gitea 的用户， 应当是一个专用的系统账户(非用户使用，推荐创建一个专用的`git`用户). 如果在你自己的个人电脑使用改成你自己的用户名。 - 该配置如果设置不正确，Gitea可能崩溃。 + 该配置如果设置不正确，Gitea 可能崩溃。 - `RUN_MODE`: **prod**: 应用的运行模式，对运行性能和问题排除有影响: `dev` 或者 `prod`,默认为 `prod`。 `dev`模式有助于开发和问题排查, 除设置为`dev` 外，均被视为 `prod`. - `WORK_PATH`: **_the-work-path_**: 工作目录, 前文有提及. ## 仓库 (`repository`) -- `ROOT`: **`{APP_DATA_PATH}/gitea-repositories`**: 存放git工程的根目录，建议填绝对路径。 +- `ROOT`: **`{APP_DATA_PATH}/gitea-repositories`**: 存放 git 工程的根目录，建议填绝对路径。 相对路径将被解析为**`{AppWorkPath}/{ROOT}`**. -- `SCRIPT_TYPE`: **bash**: 服务器支持的Shell类型，通常是`bash`， +- `SCRIPT_TYPE`: **bash**: 服务器支持的 Shell 类型，通常是`bash`， 但有些服务器也有可能是`sh`。 - `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 检测到的字符集的决定性顺序 - 如果检测到的字符集具有相等的置信度，则优先选择列表中较早出现的字符集，而不是较晚出现的字符集。添加“defaults”将会将未命名的字符集放置在该点。 -- `ANSI_CHARSET`: **_empty_**: 默认的ANSI字符集，用于覆盖非UTF-8字符集。 +- `ANSI_CHARSET`: **_empty_**: 默认的 ANSI 字符集，用于覆盖非 UTF-8 字符集。 - `FORCE_PRIVATE`: **false**: 强制使每个新仓库变为私有。 - `DEFAULT_PRIVATE`: **last**: 创建新仓库时默认为私有：`last`, `private`, `public`。 - `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送创建新仓库时默认为私有。 - `MAX_CREATION_LIMIT`: **-1**: 每个用户的全局仓库创建上限, - `-1` 代表无限制. + `-1` 代表无限制. - `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表顶部的指定许可证。 - 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 -- `DISABLE_HTTP_GIT`: **false**: 禁用HTTP协议与仓库进行 - 交互的能力。 -- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的SSH端口时，强制使用ssh://克隆URL， - 而不是scp-style uri。 -- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的URL作为https或ssh， - 默认为https。 + 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 +- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 协议与仓库进行 + 交互的能力。 +- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的 SSH 端口时，强制使用 ssh://克隆 URL， + 而不是 scp-style uri。 +- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的 URL 作为 https 或 ssh， + 默认为 https。 - `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用于 Access-Control-Allow-Origin 标头的值， -默认不提供。 -警告：如果您不提供正确的值，这可能对您的网站造成危害。 -- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 -- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到Gitea，并为用户自动创建它们。 -- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到Gitea，并为组织自动创建它们。 + 默认不提供。 + 警告：如果您不提供正确的值，这可能对您的网站造成危害。 +- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 +- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到 Gitea，并为用户自动创建它们。 +- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到 Gitea，并为组织自动创建它们。 - `DISABLED_REPO_UNITS`: **_empty_**: 逗号分隔的全局禁用的仓库单元列表。允许的值是：: \[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,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部wiki和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 +- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部 wiki 和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 - `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗号分隔的默认分叉仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 - `DEFAULT_MIRROR_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认镜像仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 - `DEFAULT_TEMPLATE_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认模板仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 @@ -120,15 +117,15 @@ aliases: ### 仓库 - 编辑器 (`repository.editor`) - `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中应该换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件进行换行，只需放置一个逗号。 -- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览API的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 +- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 ### 仓库 - 合并请求 (`repository.pull-request`) - `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取请求标题中用于标记工作正在进行中的前缀列表。 -这些前缀在不区分大小写的情况下进行匹配。 + 这些前缀在不区分大小写的情况下进行匹配。 - `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取请求评论中用于自动关闭相关问题的关键词列表。 - `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取请求评论中用于自动重新打开相关问题的 -关键词列表。 + 关键词列表。 - `DEFAULT_MERGE_STYLE`: **merge**: 设置创建仓库的默认合并方式，可选: `merge`, `rebase`, `rebase-merge`, `squash`, `fast-forward-only` - `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在默认合并消息中，对于`squash`提交，最多包括此数量的提交。设置为 -1 以包括所有提交。 - `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在默认的合并消息中，对于`squash`提交，限制提交消息的大小。设置为 `-1`以取消限制。仅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`为`true`时使用。 @@ -137,18 +134,18 @@ aliases: - `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在默认合并消息中，仅包括官方允许审查的审批者。 - `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在默认的 squash 合并消息中，包括构成拉取请求的所有提交的提交消息。 - `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者与作者不匹配，在合并提交消息中添加`co-authored-by`和`co-committed-by`标记。 -- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 +- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是 1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 ### 仓库 - 工单 (`repository.issue`) - `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合并请求或工单被锁定的原因列表。 -- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为0禁用固定工单。 +- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为 0 禁用固定工单。 ### 仓库 - 文件上传 (`repository.upload`) - `ENABLED`: **true**: 是否启用仓库文件上传。 -- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在Gitea重启的时候该目录会被清空)。 -- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 +- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在 Gitea 重启的时候该目录会被清空)。 +- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime 类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 - `FILE_MAX_SIZE`: **50**: 每个文件的最大大小(MB)。 - `MAX_FILES`: **5**: 每次上传的最大文件数。 @@ -170,10 +167,10 @@ aliases: - 除了 never 和 always 之外的选项可以组合为逗号分隔的列表。 - `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用于验证提交的默认信任模型。 - `collaborator`: 信任协作者密钥签名的签名。 - - `committer`: 信任与提交者匹配的签名（这与GitHub匹配，并会强制Gitea签名的提交具有Gitea作为提交者）。 + - `committer`: 信任与提交者匹配的签名（这与 GitHub 匹配，并会强制 Gitea 签名的提交具有 Gitea 作为提交者）。 - `collaboratorcommitter`: 信任与提交者匹配的协作者密钥签名的签名。 -- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对wiki提交进行签名。 -- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对CRUD操作进行签名。 +- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对 wiki 提交进行签名。 +- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对 CRUD 操作进行签名。 - 与上面相同的选项，增加了： - `parentsigned`: 仅在父提交进行了签名时才进行签名。 - `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 对合并操作进行签名。 @@ -186,7 +183,7 @@ aliases: - `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地仓库副本的路径。默认为 tmp/local-repo（内容在 Gitea 重新启动时被删除） -### 仓库 - MIME type mapping (`repository.mimetype_mapping`) +### 仓库 - MIME type mapping (`repository.mimetype_mapping`) 配置用于根据可下载文件的文件扩展名设置预期的 MIME 类型。配置以键值对的形式呈现，文件扩展名以`.`开头。 @@ -204,7 +201,7 @@ aliases: - `MAX_AGE`: **10m**: 缓存响应的最大时间 - `ALLOW_CREDENTIALS`: **false**: 允许带有凭据的请求 - `HEADERS`: **Content-Type,User-Agent**: 允许请求携带的头部 -- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP头部. +- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP 头部. ## 界面 (`ui`) @@ -213,23 +210,23 @@ aliases: - `MEMBERS_PAGING_NUM`: **20**: 组织成员页面每页显示的成员数量。 - `FEED_MAX_COMMIT_NUM`: **5**: 活动流页面显示的最大提交数量。 - `FEED_PAGING_NUM`: **20**: 活动流页面显示的最大活动数量。 -- `SITEMAP_PAGING_NUM`: **20**: 在单个子SiteMap中显示的项数。 -- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大commit数量。 +- `SITEMAP_PAGING_NUM`: **20**: 在单个子 SiteMap 中显示的项数。 +- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大 commit 数量。 - `CODE_COMMENT_LINES`: **4**: 在代码评论中能够显示的最大代码行数。 -- `DEFAULT_THEME`: **gitea-auto**: 在Gitea安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 +- `DEFAULT_THEME`: **gitea-auto**: 在 Gitea 安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 - `SHOW_USER_EMAIL`: **true**: 用户的电子邮件是否应该显示在`Explore Users`页面中。 -- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， -- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为8MiB）。 +- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， +- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为 8MiB）。 - `REACTIONS`: 用户可以在问题（Issue）、Pull Request（PR）以及评论中选择的所有可选的反应。 - 这些值可以是表情符号别名（例如：:smile:）或Unicode表情符号。 - 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 -- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在utf8标准中定义的额外表情符号。 - 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， - 并将其添加到此配置中。 + 这些值可以是表情符号别名（例如：:smile:）或 Unicode 表情符号。 + 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 +- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。 + 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， + 并将其添加到此配置中。 - `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示用户的全名。如果没有设置全名，则将使用用户名。 - `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的仓库搜索中搜索描述。 - `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字并使用默认排序时，是否仅在探索页面上显示相关的仓库。 - 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 + 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 ### 界面 - 管理员 (`ui.admin`) @@ -258,11 +255,11 @@ aliases: ### 界面 - SVG Images (`ui.svg`) -- `ENABLE_RENDER`: **true**: 是否将SVG文件呈现为图像。如果禁用了SVG渲染，SVG文件将显示为文本，无法作为图像嵌入到Markdown文件中。 +- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈现为图像。如果禁用了 SVG 渲染，SVG 文件将显示为文本，无法作为图像嵌入到 Markdown 文件中。 ### 界面 - CSV Files (`ui.csv`) -- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将CSV文件呈现为表格的最大文件大小（将其设置为0表示没有限制）。 +- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将 CSV 文件呈现为表格的最大文件大小（将其设置为 0 表示没有限制）。 - `MAX_ROWS`: **2500** : 最大允许的 CSV 文件行数。 (设置为 0 不限制) ## Markdown (`markdown`) @@ -273,10 +270,10 @@ aliases: - `ENABLE_HARD_LINE_BREAK_IN_DOCUMENTS`: **false**: 在文档中将软换行符呈现为硬换行符， 这意味着段落之间的单个换行符将导致换行， 并且不需要在段落后添加尾随空格来强制换行。 -- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在Markdown中呈现的附加URL超链接。 - 以http和https开头的URL始终显示。 - 如果此条目为空，则允许所有URL方案。 -- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为Markdown的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为Markdown，请只需放置一个逗号。 +- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在 Markdown 中呈现的附加 URL 超链接。 + 以 http 和 https 开头的 URL 始终显示。 + 如果此条目为空，则允许所有 URL 方案。 +- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为 Markdown，请只需放置一个逗号。 - `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作为数学块的检测。 ## 服务器 (`server`) @@ -289,26 +286,26 @@ aliases: - `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受带有未知类型的`PROXY`协议头。 - `DOMAIN`: **localhost**: 此服务器的域名。 - `ROOT_URL`: **`{PROTOCOL}://{DOMAIN}:{HTTP_PORT}/`**: - 覆盖自动生成的公共URL。 - 如果内部URL和外部URL不匹配（例如在Docker中），这很有用。 + 覆盖自动生成的公共 URL。 + 如果内部 URL 和外部 URL 不匹配（例如在 Docker 中），这很有用。 - `STATIC_URL_PREFIX`: **_empty_**: - 覆盖此选项以从不同的URL请求静态资源。 - 这包括CSS文件、图片、JS文件和Web字体。 - 头像图片是动态资源，仍由Gitea提供。 - 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. - 请求会变成 `{ROOT_URL}/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` - 静态文件位于Gitea源代码仓库的`public/`目录中。 - 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 + 覆盖此选项以从不同的 URL 请求静态资源。 + 这包括 CSS 文件、图片、JS 文件和 Web 字体。 + 头像图片是动态资源，仍由 Gitea 提供。 + 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. + 请求会变成 `{ROOT_URL}/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` + 静态文件位于 Gitea 源代码仓库的`public/`目录中。 + 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 - `HTTP_ADDR`: **0.0.0.0**: HTTP 监听地址。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 - `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - 如果 `PROTOCOL` 设置为 `http+unix` 或 `fcgi+unix`，则应该是要使用的 Unix 套接字文件的名称。相对路径将相对于 _`AppWorkPath`_ 被转换为绝对路径。 - `HTTP_PORT`: **3000**: HTTP 监听端口。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 `HTTP_ADDR` 和 `HTTP_PORT` - 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的权限。 -- `LOCAL_ROOT_URL`: **`{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`**: +- `LOCAL_ROOT_URL`: **`{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`**: 用于访问网络服务的 Gitea 工作器（例如 SSH 更新）的本地（DMZ）URL。 在大多数情况下，您不需要更改默认值。 仅在您的 SSH 服务器节点与 HTTP 节点不同的情况下才修改它。对于不同的协议，默认值不同。如果 `PROTOCOL` @@ -317,15 +314,15 @@ aliases: `{PROTOCOL}://localhost:{HTTP_PORT}/`， 否则默认值为 `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。 - `LOCAL_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在进行本地连接时传递 PROXY 协议头。 - 如果本地连接将经过代理，请将其设置为 false。 + 如果本地连接将经过代理，请将其设置为 false。 - `PER_WRITE_TIMEOUT`: **30s**: 连接的任何写操作的超时时间。（将其设置为 -1 以禁用所有超时。） - `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 连接每写入 1 KB 的超时时间。 -- `DISABLE_SSH`: **false**: 当SSH不可用时禁用SSH功能。 -- `START_SSH_SERVER`: **false**: 启用时，使用内置的SSH服务器。 -- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置SSH服务器建立连接时，期望PROXY协议头。 -- `BUILTIN_SSH_SERVER_USER`: **`{RUN_USER}`**: 用于内置SSH服务器的用户名。 -- `SSH_USER`: **BUILTIN_SSH_SERVER_USER**: 在克隆URL中显示的SSH用户名。 +- `DISABLE_SSH`: **false**: 当 SSH 不可用时禁用 SSH 功能。 +- `START_SSH_SERVER`: **false**: 启用时，使用内置的 SSH 服务器。 +- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置 SSH 服务器建立连接时，期望 PROXY 协议头。 +- `BUILTIN_SSH_SERVER_USER`: **`{RUN_USER}`**: 用于内置 SSH 服务器的用户名。 +- `SSH_USER`: **BUILTIN_SSH_SERVER_USER**: 在克隆 URL 中显示的 SSH 用户名。 如果设置为 `(DOER_USERNAME)`，将使用当前登录用户名作为克隆用的 SSH 用户名。 此配置项仅为自己配置 SSH 反向代理的高级用户准备， 大多数用户应当把它留空，或者按需修改 `BUILTIN_SSH_SERVER_USER`。 @@ -421,7 +418,7 @@ aliases: ## 数据库 (`database`) - `DB_TYPE`: **mysql**: 数据库类型 \[mysql, postgres, mssql, sqlite3\]。 -- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或unix套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 +- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或 unix 套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 - `NAME`: **gitea**: 数据库名称。 - `USER`: **root**: 数据库用户名。 - `PASSWD`: **_empty_**: 数据库密码。如果密码包含特殊字符，请使用 \`your password\` 或 """your password"""。 @@ -455,15 +452,15 @@ aliases: ## 索引 (`indexer`) - `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型，当前支持：`bleve`、`db`、`elasticsearch` 或 `meilisearch`。 -- `ISSUE_INDEXER_CONN_STR`：**** : 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 +- `ISSUE_INDEXER_CONN_STR`：\*\*\*\* : 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 - `ISSUE_INDEXER_NAME`：**gitea_issues**: 工单索引器名称，在 ISSUE_INDEXER_TYPE 为 elasticsearch 或 meilisearch 时可用。 -- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE_INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 _`AppWorkPath`_ 进行绝对路径化。 +- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE*INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 *`AppWorkPath`\_ 进行绝对路径化。 - `REPO_INDEXER_ENABLED`：**false**: 启用代码搜索（占用大量磁盘空间，约为存储库大小的 6 倍）。 - `REPO_INDEXER_REPO_TYPES`：**sources,forks,mirrors,templates**: 存储库索引器单元。要索引的项目可以是 `sources`、`forks`、`mirrors`、`templates` 或它们的任何组合，用逗号分隔。如果为空，则默认为仅 `sources`，如果要完全禁用，请参见 `REPO_INDEXER_ENABLED`。 - `REPO_INDEXER_TYPE`：**bleve**: 代码搜索引擎类型，可以为 `bleve` 或者 `elasticsearch`。 - `REPO_INDEXER_PATH`：**indexers/repos.bleve**: 用于代码搜索的索引文件。 -- `REPO_INDEXER_CONN_STR`：****: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` +- `REPO_INDEXER_CONN_STR`：\*\*\*\*: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` - `REPO_INDEXER_NAME`：**gitea_codes**: 代码索引器名称，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。 - `REPO_INDEXER_INCLUDE`：**empty**: 逗号分隔的 glob 模式列表（参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob)）以用于**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 扩展名的文件。空列表表示包括所有文件。 @@ -481,8 +478,8 @@ aliases: - `LENGTH`：**100000**: 通道队列阻塞之前的最大队列大小 - `BATCH_LENGTH`：**20**: 在传递给处理程序之前批处理数据 - `CONN_STR`：**redis://127.0.0.1:6379/0**: redis 队列类型的连接字符串。对于 `redis-cluster`，使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查询参数来设置选项。类似地，LevelDB 选项也可以使用：**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 进行设置，并将覆盖 `DATADIR`。 -- `QUEUE_NAME`：**_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 -- `SET_NAME`：**_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `QUEUE_NAME`：**\_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `SET_NAME`：**\_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 - `MAX_WORKERS`：**(dynamic)**: 队列的最大工作协程数。默认值为 "CpuNum/2"，限制在 1 到 10 之间。 Gitea 创建以下非唯一队列： @@ -506,8 +503,8 @@ Gitea 创建以下非唯一队列： - `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: 用户电子邮件通知的默认配置（用户可配置）。选项：enabled、onmention、disabled - `DISABLE_REGULAR_ORG_CREATION`: **false**: 禁止普通（非管理员）用户创建组织。 - `USER_DISABLED_FEATURES`:**_empty_** 禁用的用户特性，当前允许为空或者 `deletion`，`manage_ssh_keys`， `manage_gpg_keys` 未来可以增加更多设置。 - - `deletion`: 用户不能通过界面或者API删除他自己。 - - `manage_ssh_keys`: 用户不能通过界面或者API配置SSH Keys。 + - `deletion`: 用户不能通过界面或者 API 删除他自己。 + - `manage_ssh_keys`: 用户不能通过界面或者 API 配置 SSH Keys。 - `manage_gpg_keys`: 用户不能配置 GPG 密钥。 ## 安全性 (`security`) @@ -516,19 +513,19 @@ Gitea 创建以下非唯一队列： - `SECRET_KEY`: **\<每次安装时随机生成\>**: 全局服务器安全密钥。这个密钥非常重要，如果丢失将无法解密加密的数据（例如 2FA）。 - `SECRET_KEY_URI`: **_empty_**: 与定义 `SECRET_KEY` 不同，此选项可用于使用存储在文件中的密钥（示例值：`file:/etc/gitea/secret_key`）。它不应该像 `SECRET_KEY` 一样容易丢失。 - `LOGIN_REMEMBER_DAYS`: **31**: 在要求重新登录之前，记住用户的登录状态多长时间（以天为单位）。 -- `COOKIE_REMEMBER_NAME`: **gitea\_incredible**: 保存自动登录信息的 Cookie 名称。 +- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自动登录信息的 Cookie 名称。 - `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理认证的 HTTP 头部名称，用于提供用户信息。 - `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理认证的 HTTP 头部名称，用于提供邮箱信息。 - `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理认证的 HTTP 头部名称，用于提供全名信息。 - `REVERSE_PROXY_LIMIT`: **1**: 解释 X-Forwarded-For 标头或 X-Real-IP 标头，并将其设置为请求的远程 IP。 - 可信代理计数。设置为零以不使用这些标头。 + 可信代理计数。设置为零以不使用这些标头。 - `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗号分隔的受信任代理服务器的 IP 地址和网络列表。使用 `*` 来信任全部。 - `DISABLE_GIT_HOOKS`: **true**: 设置为 `false` 以允许具有 Git 钩子权限的用户创建自定义 Git 钩子。 - 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 - 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 - 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 - 这可能对您的网站或操作系统造成危害。 - 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 + 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 + 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 + 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 + 这可能对您的网站或操作系统造成危害。 + 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 - `DISABLE_WEBHOOKS`: **false**: 设置为 `true` 以禁用 Webhooks 功能。 - `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 设置为 `false` 以允许本地用户在未设置 Gitea 环境的情况下推送到 Gitea 存储库。不建议这样做，如果您希望本地用户推送到 Gitea 存储库，应该适当地设置环境。 - `IMPORT_LOCAL_PATHS`: **false**: 设置为 `false` 以防止所有用户（包括管理员）从服务器上导入本地路径。 @@ -556,7 +553,7 @@ Gitea 创建以下非唯一队列： - lower - 使用一个或多个小写拉丁字符 - upper - 使用一个或多个大写拉丁字符 - digit - 使用一个或多个数字 - - spec - 使用一个或多个特殊字符，如 ``!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~`` + - spec - 使用一个或多个特殊字符，如 `` !"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ `` - off - 不检查密码复杂性 - `PASSWORD_CHECK_PWN`: **false**: 检查密码是否在 [HaveIBeenPwned](https://haveibeenpwned.com/Passwords) 中曝光。 - `SUCCESSFUL_TOKENS_CACHE_SIZE`: **20**: 缓存成功的令牌哈希。API 令牌在数据库中存储为 pbkdf2 哈希，但这意味着在存在多个 API 操作时可能会有显着的哈希负载。此缓存将在 LRU 缓存中存储成功的哈希令牌，以在性能和安全性之间保持平衡。 @@ -564,27 +561,27 @@ Gitea 创建以下非唯一队列： ## Camo (`camo`) - `ENABLED`: **false**: 启用媒体代理，目前仅支持图像。 -- `SERVER_URL`: **_empty_**: Camo服务器的URL，如果启用camo，则**必填**。 -- `HMAC_KEY`: **_empty_**: 为URL编码提供HMAC密钥，如果启用camo，则**必填**。 -- `ALWAYS`: **false**: 设置为true以在HTTP和HTTPS内容上使用camo，否则仅代理非HTTPS URL。`ALLWAYS` 已经过期，并且会在未来版本中删除。 +- `SERVER_URL`: **_empty_**: Camo 服务器的 URL，如果启用 camo，则**必填**。 +- `HMAC_KEY`: **_empty_**: 为 URL 编码提供 HMAC 密钥，如果启用 camo，则**必填**。 +- `ALWAYS`: **false**: 设置为 true 以在 HTTP 和 HTTPS 内容上使用 camo，否则仅代理非 HTTPS URL。`ALLWAYS` 已经过期，并且会在未来版本中删除。 ## OpenID (`openid`) -- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过OpenID进行身份验证。 -- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: 允许通过OpenID进行注册。 -- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于允许访问。 -- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于阻止访问。 +- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过 OpenID 进行身份验证。 +- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: 允许通过 OpenID 进行注册。 +- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于允许访问。 +- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于阻止访问。 ## OAuth2 Client (`oauth2_client`) -- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER\_EMAIL\_CONFIRM**: 设置此项以启用或禁用OAuth2自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） -- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的OpenID连接范围的列表。（`openid`已隐式添加） -- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的OAuth2用户自动创建用户帐户。 -- `USERNAME`: **nickname**: 新OAuth2帐户的用户名来源： - - userid - 使用userid / sub属性 - - nickname - 使用nickname属性 - - email - 使用email属性的用户名部分 -- `UPDATE_AVATAR`: **false**: 如果OAuth2提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 +- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER_EMAIL_CONFIRM**: 设置此项以启用或禁用 OAuth2 自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） +- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的 OpenID 连接范围的列表。（`openid`已隐式添加） +- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的 OAuth2 用户自动创建用户帐户。 +- `USERNAME`: **nickname**: 新 OAuth2 帐户的用户名来源： + - userid - 使用 userid / sub 属性 + - nickname - 使用 nickname 属性 + - email - 使用 email 属性的用户名部分 +- `UPDATE_AVATAR`: **false**: 如果 OAuth2 提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 - `ACCOUNT_LINKING`: **login**: 如果帐户/电子邮件已存在，如何处理： - disabled - 显示错误 - login - 显示帐户链接登录 @@ -597,54 +594,54 @@ Gitea 创建以下非唯一队列： - `REGISTER_EMAIL_CONFIRM`: **false**: 启用此项以要求通过邮件确认注册。需要启用`Mailer`。 - `REGISTER_MANUAL_CONFIRM`: **false**: 启用此项以手动确认新的注册。需要禁用`REGISTER_EMAIL_CONFIRM`。 - `DISABLE_REGISTRATION`: **false**: 禁用注册，之后只有管理员可以为用户创建帐户。 -- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过GitHub、OpenID Connect等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 -- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用API。 +- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过 GitHub、OpenID Connect 等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 +- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用 API。 - `ENABLE_NOTIFY_MAIL`: **false**: 启用此项以在发生某些情况（如创建问题）时向存储库的观察者发送电子邮件。需要启用`Mailer`。 -- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用HTTP BASIC和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌API端点。此外，这仅会禁用使用密码的BASIC身份验证，而不会禁用令牌或OAuth Basic。 +- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用 HTTP BASIC 和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌 API 端点。此外，这仅会禁用使用密码的 BASIC 身份验证，而不会禁用令牌或 OAuth Basic。 - `ENABLE_REVERSE_PROXY_AUTHENTICATION`: **false**: 启用此项以允许反向代理身份验证。 - `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION`: **false**: 启用此项以允许反向身份验证的自动注册。 - `ENABLE_REVERSE_PROXY_EMAIL`: **false**: 启用此项以允许使用提供的电子邮件而不是生成的电子邮件进行自动注册。 - `ENABLE_REVERSE_PROXY_FULL_NAME`: **false**: 启用此项以允许使用提供的全名进行自动注册。 - `ENABLE_CAPTCHA`: **false**: 启用此项以对注册使用验证码验证。 - `REQUIRE_CAPTCHA_FOR_LOGIN`: **false**: 启用此项以要求登录使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 -- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即GitHub、OpenID Connect等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 +- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即 GitHub、OpenID Connect 等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 - `CAPTCHA_TYPE`: **image**: \[image、recaptcha、hcaptcha、mcaptcha、cfturnstile\] -- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的密钥。 -- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的站点密钥。 -- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/** ：设置recaptcha网址，允许使用recaptcha net。 -- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的密钥。 -- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的站点密钥。 -- `MCAPTCHA_SECRET`: **""**: 访问您的mCaptcha实例以获取mCaptcha的密钥。 -- `MCAPTCHA_SITEKEY`: **""**: 访问您的mCaptcha实例以获取mCaptcha的站点密钥。 -- `MCAPTCHA_URL` **https://demo.mcaptcha.org/** ：设置mCaptcha的URL。 -- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的密钥。 -- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的站点密钥。 +- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的密钥。 +- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的站点密钥。 +- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/** ：设置 recaptcha 网址，允许使用 recaptcha net。 +- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的密钥。 +- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的站点密钥。 +- `MCAPTCHA_SECRET`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的密钥。 +- `MCAPTCHA_SITEKEY`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的站点密钥。 +- `MCAPTCHA_URL` **https://demo.mcaptcha.org/** ：设置 mCaptcha 的 URL。 +- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的密钥。 +- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的站点密钥。 - `DEFAULT_KEEP_EMAIL_PRIVATE`: **false**: 默认情况下，将用户设置为保持其电子邮件地址私有。 - `DEFAULT_ALLOW_CREATE_ORGANIZATION`: **true**: 默认情况下，允许新用户创建组织。 - `DEFAULT_USER_IS_RESTRICTED`: **false**: 默认情况下，为新用户分配受限权限。 - `DEFAULT_ENABLE_DEPENDENCIES`: **true**: 启用此项以默认启用依赖项。 - `ALLOW_CROSS_REPOSITORY_DEPENDENCIES` : **true** 启用此项以允许从用户被授予访问权限的任何存储库上进行依赖项操作。 -- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务URL。位置将作为转义的查询参数附加到URL中。 +- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务 URL。位置将作为转义的查询参数附加到 URL 中。 - `ENABLE_USER_HEATMAP`: **true**: 启用此项以在用户个人资料上显示热图。 - `ENABLE_TIMETRACKING`: **true**: 启用时间跟踪功能。 - `DEFAULT_ENABLE_TIMETRACKING`: **true**: 默认情况下，允许存储库默认使用时间跟踪。 - `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: 仅允许具有写权限的用户跟踪时间。 - `EMAIL_DOMAIN_ALLOWLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，只能用于在此实例上注册，支持通配符。 - `EMAIL_DOMAIN_BLOCKLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，不能用于在此实例上注册，支持通配符。 -- `SHOW_REGISTRATION_BUTTON`: **! DISABLE\_REGISTRATION**: 显示注册按钮 +- `SHOW_REGISTRATION_BUTTON`: **! DISABLE_REGISTRATION**: 显示注册按钮 - `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** 启用此项以显示里程碑仪表板页面 - 查看所有用户的里程碑 - `AUTO_WATCH_NEW_REPOS`: **true** 启用此项以在创建新存储库时让所有组织用户观看新存储库 - `AUTO_WATCH_ON_CHANGES`: **false** 启用此项以在首次提交后使用户观看存储库 - `DEFAULT_USER_VISIBILITY`: **public**: 为用户设置默认的可见性模式，可以是"public"、"limited"或"private"。 - `ALLOWED_USER_VISIBILITY_MODES`: **public,limited,private**: 设置用户可以具有的可见性模式 - `DEFAULT_ORG_VISIBILITY`: **public**: 为组织设置默认的可见性模式，可以是"public"、"limited"或"private"。 -- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为True。 -- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为True以强制仅通过Gitea进行注册。 -- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为True以强制仅使用第三方服务进行注册。 -- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将KeepEmailPrivate设置为True，则在Git日志中的用户电子邮件地址的域部分的值。DOMAIN解析为server.DOMAIN中的值。 - 用户的电子邮件将被替换为小写的用户名、"@"和NO_REPLY_ADDRESS的连接。 +- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为 True。 +- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅通过 Gitea 进行注册。 +- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅使用第三方服务进行注册。 +- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将 KeepEmailPrivate 设置为 True，则在 Git 日志中的用户电子邮件地址的域部分的值。DOMAIN 解析为 server.DOMAIN 中的值。 + 用户的电子邮件将被替换为小写的用户名、"@"和 NO_REPLY_ADDRESS 的连接。 - `USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0**: 用户删除后，评论将保留的最短时间。 -- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点URL方案 +- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点 URL 方案 ### Service - Explore (`service.explore`) @@ -655,12 +652,12 @@ Gitea 创建以下非唯一队列： ## SSH Minimum Key Sizes (`ssh.minimum_key_sizes`) -定义允许的算法及其最小密钥长度（使用-1来禁用某个类型）： +定义允许的算法及其最小密钥长度（使用-1 来禁用某个类型）： - `ED25519`：**256** - `ECDSA`：**256** -- `RSA`：**3071**: 我们在这里设置为2047，因为一个其他方面有效的3072 RSA密钥可能被报告为3071长度。 -- `DSA`：**-1**: 默认情况下禁用DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的SSHD提供者 +- `RSA`：**3071**: 我们在这里设置为 2047，因为一个其他方面有效的 3072 RSA 密钥可能被报告为 3071 长度。 +- `DSA`：**-1**: 默认情况下禁用 DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的 SSHD 提供者 ## Webhook (`webhook`) @@ -677,7 +674,7 @@ Gitea 创建以下非唯一队列： - `SKIP_TLS_VERIFY`: **false**: 允许不安全的证书。 - `PAGING_NUM`: **10**: 一页中显示的 Webhook 历史事件数量。 - `PROXY_URL`: **_empty_**: 代理服务器 URL，支持 http://、https://、socks://，留空将遵循环境的 http_proxy/https_proxy 设置。如果未提供，将使用全局代理设置。 -- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (*)；使用 ** 来匹配所有主机。如果未提供，将使用全局代理设置。 +- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (\*)；使用 \*\* 来匹配所有主机。如果未提供，将使用全局代理设置。 ## 邮件 (`mailer`) @@ -733,7 +730,7 @@ Gitea 创建以下非唯一队列： ## 缓存 (`cache`) -- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的LRU缓存) +- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的 LRU 缓存) - `INTERVAL`: **60**: 垃圾回收间隔(秒)，只对`memory`和`towqueue`有效。 - `HOST`: **_empty_**: 缓存配置。`redis`, `redis-cluster`，`memcache`配置连接字符串;`twoqueue` 设置队列参数 - Redis: `redis://:macaron@127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` @@ -752,7 +749,7 @@ Gitea 创建以下非唯一队列： - `PROVIDER`: **memory**: 会话存储引擎 \[memory, file, redis, redis-cluster, db, mysql, couchbase, memcache, postgres\]。设置为 `db` 将会重用 `[database]` 的配置信息。 - `PROVIDER_CONFIG`: **data/sessions**: 对于文件，为根路径；对于 db，为空（将使用数据库配置）；对于其他引擎，为连接字符串。相对路径将根据 _`AppWorkPath`_ 绝对化。 - `COOKIE_SECURE`: **_empty_**: `true` 或 `false`。启用此选项以强制在所有会话访问中使用 HTTPS。如果没有设置，当 ROOT_URL 是 https 链接的时候默认设置为 true。 -- `COOKIE_NAME`: **i\_like\_gitea**: 用于会话 ID 的 cookie 名称。 +- `COOKIE_NAME`: **i_like_gitea**: 用于会话 ID 的 cookie 名称。 - `GC_INTERVAL_TIME`: **86400**: GC 间隔时间，以秒为单位。 - `SESSION_LIFE_TIME`: **86400**: 会话生命周期，以秒为单位，默认为 86400（1 天）。 - `DOMAIN`: **_empty_**: 设置 cookie 的域。 @@ -761,10 +758,10 @@ Gitea 创建以下非唯一队列： ## 图像 (`picture`) - `GRAVATAR_SOURCE`: **gravatar**: 头像来源，可以是 gravatar、duoshuo 或类似 http://cn.gravatar.com/avatar/ 的来源。 - `http://cn.gravatar.com/avatar/`。 + `http://cn.gravatar.com/avatar/`。 - `DISABLE_GRAVATAR`: **false**: 启用后，只使用内部头像。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `ENABLE_FEDERATED_AVATAR`: **false**: 启用头像联盟支持（参见 - [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 + [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `AVATAR_STORAGE_TYPE`: **default**: 在 `[storage.xxx]` 中定义的存储类型。默认为 `default`，如果没有 `[storage]` 部分，则将读取 `[storage]`，如果没有则将是 `local` 类型。 - `AVATAR_UPLOAD_PATH`: **data/avatars**: 存储用户头像图像文件的路径。 @@ -807,7 +804,7 @@ Gitea 创建以下非唯一队列： - `MINIO_USE_SSL`: **false**: Minio 启用 SSL，仅当 STORAGE_TYPE 为 `minio` 时可用。 - `MINIO_INSECURE_SKIP_VERIFY`: **false**: Minio 跳过 SSL 验证，仅当 STORAGE_TYPE 为 `minio` 时可用。 - `MINIO_CHECKSUM_ALGORITHM`: **default**: Minio 校验算法：`default`（适用于 MinIO 或 AWS S3）或 `md5`（适用于 Cloudflare 或 Backblaze） -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 ## 日志 (`log`) @@ -834,7 +831,7 @@ Gitea 创建以下非唯一队列： - 例如： - 在请求头中：X-Request-ID: **test-id-123** - 在 app.ini 中的配置：REQUEST_ID_HEADERS = X-Request-ID - - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... + - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... ### 日志子部分 (`log.`) @@ -870,13 +867,13 @@ Gitea 创建以下非唯一队列： ## 定时任务 (`cron`) -- `ENABLED`: **false**: 是否在后台运行定期任务。 +- `ENABLED`: **false**: 是否在后台运行定期任务。 - `RUN_AT_START`: **false**: 在应用程序启动时运行定时任务。 -- `NOTICE_ON_SUCCESS`: **false**: 设置为 true时，任务成功完成时将进行通知。 +- `NOTICE_ON_SUCCESS`: **false**: 设置为 true 时，任务成功完成时将进行通知。 - `SCHEDULE` 接受的格式: - - 完整的crontab语法规范, e.g. `* * * * * ?` - - 描述符e.g. `@midnight`, `@every 1h30m` ... + - 完整的 crontab 语法规范, e.g. `* * * * * ?` + - 描述符 e.g. `@midnight`, `@every 1h30m` ... - 更多详见: [cron documentation](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14) ### 基本定时任务 - 默认开启 @@ -885,31 +882,31 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 是否启用该定时任务。 - `RUN_AT_START`: **true**: 设置在服务启动时运行。 -- `SCHEDULE`: **@midnight**: 使用Cron语法的定时任务触发配置，例如 `@every 1h`。 +- `SCHEDULE`: **@midnight**: 使用 Cron 语法的定时任务触发配置，例如 `@every 1h`。 - `OLDER_THAN`: **24h**: 超过`OLDER_THAN`时间的存档将被删除，例如 `12h`。 #### 定时任务 - 更新镜像仓库 (`cron.update_mirrors`) -- `SCHEDULE`: **@every 10m**: 使用Cron语法的定时任务触发配置，例如 `@every 3h`。 -- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 -- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `SCHEDULE`: **@every 10m**: 使用 Cron 语法的定时任务触发配置，例如 `@every 3h`。 +- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 #### 定时任务 - 健康检查所有仓库 (`cron.repo_health_check`) -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库健康检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库健康检查。 - `TIMEOUT`: **60s**: 用于健康检查执行超时的时间持续语法。 - `ARGS`: **_empty_**: `git fsck` 命令的参数，例如 `--unreachable --tags`。在 http://git-scm.com/docs/git-fsck 上了解更多。 #### 定时任务 - 检查所有仓库统计 (`cron.check_repo_stats`) - `RUN_AT_START`: **true**: 在启动时运行仓库统计检查。 -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库统计检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库统计检查。 #### 定时任务 - 清理 hook_task 表 (`cron.cleanup_hook_task_table`) - `ENABLED`: **true**: 启用清理 hook_task 任务。 - `RUN_AT_START`: **false**: 在启动时运行清理 hook_task（如果启用）。 -- `SCHEDULE`: **@midnight**: Cron语法，用于清理 hook_task 表。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于清理 hook_task 表。 - `CLEANUP_TYPE` **OlderThan** OlderThan 或 PerWebhook 方法来清理 hook_task，可以按年龄（即 hook_task 记录传递多久）或按每个 Webhook 保留的数量（即每个 Webhook 保留最新的 x 个传递）来清理。 - `OLDER_THAN`: **168h**: 如果 CLEANUP_TYPE 设置为 OlderThan，则早于此表达式的任何传递的 hook_task 记录将被删除。 - `NUMBER_TO_KEEP`: **10**: 如果 CLEANUP_TYPE 设置为 PerWebhook，则 Webhook 的此数量 hook_task 记录将被保留（即保留最新的 x 个传递）。 @@ -919,7 +916,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 启用清理过期包任务。 - `RUN_AT_START`: **true**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 每次运行此任务时都会通知。 -- `SCHEDULE`: **@midnight**: Cron语法，用于任务。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于任务。 - `OLDER_THAN`: **24h**: 未引用的包数据创建超过 OLDER_THAN 时间的包将被删除。 #### Cron - 更新迁移海报 ID (`cron.update_migration_poster_id`) @@ -937,7 +934,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 - `TIMEOUT`: **60s**: 用于垃圾收集执行超时的时间持续语法。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 - `ARGS`: **_empty_**: `git gc` 命令的参数，例如 `--aggressive --auto`。默认值与 [git] -> GC_ARGS 相同。 @@ -947,95 +944,95 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新同步所有仓库的 pre-receive、update 和 post-receive 钩子 (`cron.resync_all_hooks`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新初始化所有缺失的 Git 仓库，但记录已存在 (`cron.reinit_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除所有缺少 Git 文件的仓库 (`cron.delete_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除生成的仓库头像 (`cron.delete_generated_repository_avatars`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 从数据库中删除所有旧的操作 (`cron.delete_old_actions`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1年），因为这是热力图的最大长度。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1 年），因为这是热力图的最大长度。 #### Cron - 从数据库中删除所有旧的系统通知 (`cron.delete_old_system_notices`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NO_SUCCESS_NOTICE`: **false**: 设置为 true 以关闭成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 - `OLDER_THAN`: **8760h**: 早于此表达式的任何系统通知都将从数据库中删除。 #### Cron - 在仓库中回收 LFS 指针 (`cron.gc_lfs`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 24h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认7天）的 LFSMetaObject。 -- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认3天）没有尝试过回收的 LFSMetaObject。 +- `SCHEDULE`: **@every 24h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认 7 天）的 LFSMetaObject。 +- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认 3 天）没有尝试过回收的 LFSMetaObject。 - `NUMBER_TO_CHECK_PER_REPO`: **100**: 每个仓库要检查的过期 LFSMetaObject 的最小数量。设置为 `0` 以始终检查所有。 ## Git (`git`) -- `PATH`: **""**: Git可执行文件的路径。如果为空，Gitea将在PATH环境中搜索。 -- `HOME_PATH`: **`{APP_DATA_PATH}/home`**: Git的HOME目录。 - 此目录将用于包含Gitea的git调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认Gitea是在此环境中唯一运行的应用程序，您可以将其设置为Gitea用户的正常主目录。 +- `PATH`: **""**: Git 可执行文件的路径。如果为空，Gitea 将在 PATH 环境中搜索。 +- `HOME_PATH`: **`{APP_DATA_PATH}/home`**: Git 的 HOME 目录。 + 此目录将用于包含 Gitea 的 git 调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认 Gitea 是在此环境中唯一运行的应用程序，您可以将其设置为 Gitea 用户的正常主目录。 - `DISABLE_DIFF_HIGHLIGHT`: **false**: 禁用已添加和已删除更改的高亮显示。 -- `MAX_GIT_DIFF_LINES`: **1000**: 在diff视图中允许单个文件的最大行数。 -- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在diff视图中每行的最大字符数。 -- `MAX_GIT_DIFF_FILES`: **100**: 在diff视图中显示的最大文件数。 +- `MAX_GIT_DIFF_LINES`: **1000**: 在 diff 视图中允许单个文件的最大行数。 +- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在 diff 视图中每行的最大字符数。 +- `MAX_GIT_DIFF_FILES`: **100**: 在 diff 视图中显示的最大文件数。 - `COMMITS_RANGE_SIZE`: **50**: 设置默认的提交范围大小 - `BRANCHES_RANGE_SIZE`: **20**: 设置默认的分支范围大小 - `GC_ARGS`: **_empty_**: 命令`git gc`的参数，例如`--aggressive --auto`。更多信息请参见http://git-scm.com/docs/git-gc/ -- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用Git版本 >= 2.18时使用Git wire协议版本2，默认为true，当您始终希望使用Git wire协议版本1时设置为false。 - 要在使用OpenSSH服务器的情况下为通过SSH的Git启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的sshd_config文件中。 -- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用URL创建拉取请求（如果启用了该存储库的拉取请求） +- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用 Git 版本 >= 2.18 时使用 Git wire 协议版本 2，默认为 true，当您始终希望使用 Git wire 协议版本 1 时设置为 false。 + 要在使用 OpenSSH 服务器的情况下为通过 SSH 的 Git 启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的 sshd_config 文件中。 +- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用 URL 创建拉取请求（如果启用了该存储库的拉取请求） - `VERBOSE_PUSH`: **true**: 在处理推送时打印有关推送状态的信息。 - `VERBOSE_PUSH_DELAY`: **5s**: 仅在推送时间超过此延迟时才打印详细信息。 -- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于Go-Git），不要在内存中缓存大于此大小的对象。（设置为0以禁用。） -- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为false。 -- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行git。 +- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于 Go-Git），不要在内存中缓存大于此大小的对象。（设置为 0 以禁用。） +- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为 false。 +- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行 git。 ### Git - 超时设置 (`git.timeout`) -- `DEFAULT`: **360**: Git操作的默认超时时间，单位秒 +- `DEFAULT`: **360**: Git 操作的默认超时时间，单位秒 - `MIGRATE`: **600**: 在迁移外部存储库时的超时时间，单位秒 - `MIRROR`: **300**: 在镜像外部存储库时的超时时间，单位秒 - `CLONE`: **300**: 在存储库之间进行内部克隆的超时时间，单位秒 - `PULL`: **300**: 在存储库之间进行内部拉取的超时时间，单位秒 -- `GC`: **60**: git存储库GC的超时时间，单位秒 +- `GC`: **60**: git 存储库 GC 的超时时间，单位秒 ### Git - 配置选项 (`git.config`) -此部分中的键/值对将用作git配置。 -此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从git配置中删除。格式为`some.configKey = value`。 +此部分中的键/值对将用作 git 配置。 +此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从 git 配置中删除。格式为`some.configKey = value`。 - `diff.algorithm`: **histogram** - `core.logAllRefUpdates`: **true** @@ -1043,45 +1040,45 @@ Gitea 创建以下非唯一队列： ## 指标 (`metrics`) -- `ENABLED`: **false**: 启用/prometheus的metrics端点。 +- `ENABLED`: **false**: 启用/prometheus 的 metrics 端点。 - `ENABLED_ISSUE_BY_LABEL`: **false**: 启用按标签统计问题，格式为`gitea_issues_by_label{label="bug"} 2`。 - `ENABLED_ISSUE_BY_REPOSITORY`: **false**: 启用按存储库统计问题，格式为`gitea_issues_by_repository{repository="org/repo"} 5`。 -- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在prometheus参数`bearer_token`或`bearer_token_file`中使用。 +- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在 prometheus 参数`bearer_token`或`bearer_token_file`中使用。 ## API (`api`) -- `ENABLE_SWAGGER`: **true**: 启用API文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 -- `MAX_RESPONSE_ITEMS`: **50**: API分页的最大单页项目数。 -- `DEFAULT_PAGING_NUM`: **30**: API分页的默认分页数。 -- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API的默认单页项目数。 -- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API的默认最大文件大小。 +- `ENABLE_SWAGGER`: **true**: 启用 API 文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 +- `MAX_RESPONSE_ITEMS`: **50**: API 分页的最大单页项目数。 +- `DEFAULT_PAGING_NUM`: **30**: API 分页的默认分页数。 +- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API 的默认单页项目数。 +- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API 的默认最大文件大小。 ## OAuth2 (`oauth2`) -- `ENABLED`: **true**: 启用OAuth2提供者。 -- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2访问令牌的生命周期，以秒为单位。 -- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2刷新令牌的生命周期，以小时为单位。 +- `ENABLED`: **true**: 启用 OAuth2 提供者。 +- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2 访问令牌的生命周期，以秒为单位。 +- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2 刷新令牌的生命周期，以小时为单位。 - `INVALIDATE_REFRESH_TOKENS`：**false**: 检查刷新令牌是否已被使用。 -- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署OAuth2令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 -- `JWT_SECRET`：**_empty_**: OAuth2访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 -- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向Gitea提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 -- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署OAuth2令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含PKCS8格式的RSA或ECDSA私钥。如果不存在密钥，则将为您创建一个4096位密钥。 -- `MAX_TOKEN_LENGTH`：**32767**: 从OAuth2提供者接受的令牌/cookie的最大长度。 -- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager, tea**: 在启动时预注册用于某些服务的OAuth应用程序。有关可用选项列表，请参阅[OAuth2文档](/development/oauth2-provider.md)。 +- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署 OAuth2 令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 +- `JWT_SECRET`：**_empty_**: OAuth2 访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 +- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向 Gitea 提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 +- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署 OAuth2 令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含 PKCS8 格式的 RSA 或 ECDSA 私钥。如果不存在密钥，则将为您创建一个 4096 位密钥。 +- `MAX_TOKEN_LENGTH`：**32767**: 从 OAuth2 提供者接受的令牌/cookie 的最大长度。 +- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager, tea**: 在启动时预注册用于某些服务的 OAuth 应用程序。有关可用选项列表，请参阅[OAuth2 文档](/development/oauth2-provider.md)。 ## i18n (`i18n`) -- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: - 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 +- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: + 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 -- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: - 对应于各区域设置的可见名称。 +- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: + 对应于各区域设置的可见名称。 ## Markup (`markup`) -- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置Mermaid源的最大大小。(设为-1代表禁止) +- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置 Mermaid 源的最大大小。(设为-1 代表禁止) -gitea支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 +gitea 支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 ```ini [markup.asciidoc] @@ -1093,21 +1090,21 @@ IS_INPUT_FILE = false ``` - ENABLED：**false** 设置是否启动渲染器 -- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1等。 -- FILE_EXTENSIONS：**_empty_** 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 +- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1 等。 +- FILE*EXTENSIONS：\*\*\_empty*\*\* 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 - RENDER_COMMAND：用于渲染所有匹配的扩展名的外部命令。 - IS_INPUT_FILE：**false** 输入不是标准输入，而是一个在`RENDER_COMMAND`之后带有文件参数的文件。 - RENDER_CONTENT_MODE：**sanitized** 内容将如何呈现。 - - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些HTML标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 - - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致XSS攻击。 - - iframe：在单独的独立页面中呈现内容，并通过iframe嵌入到当前页面中。iframe处于禁用同源策略的沙箱模式，并且JS代码与父页面安全隔离。 + - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些 HTML 标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 + - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致 XSS 攻击。 + - iframe：在单独的独立页面中呈现内容，并通过 iframe 嵌入到当前页面中。iframe 处于禁用同源策略的沙箱模式，并且 JS 代码与父页面安全隔离。 两个特殊的环境变量会传递给渲染命令： -- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前URL前缀。用作链接的前缀。 -- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前URL前缀。用作图像路径的前缀。 +- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前 URL 前缀。用作链接的前缀。 +- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前 URL 前缀。用作图像路径的前缀。 -如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea支持自定义用于呈现的HTML的清理策略。下面的示例将支持来自pandoc的KaTeX输出。 +如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea 支持自定义用于呈现的 HTML 的清理策略。下面的示例将支持来自 pandoc 的 KaTeX 输出。 ```ini [markup.sanitizer.TeX] @@ -1122,18 +1119,18 @@ ALLOW_DATA_URI_IMAGES = true - `ELEMENT`：此策略适用于的元素。必须非空。 - `ALLOW_ATTR`：此策略允许的属性。必须非空。 - `REGEXP`：用于匹配属性内容的正则表达式。必须存在，但可以为空，以无条件允许此属性的白名单。 -- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据URI图像（``）。 +- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据 URI 图像（``）。 可以通过添加唯一的子节来定义多个清理规则，例如`[markup.sanitizer.TeX-2]`。 要仅为指定的外部渲染器应用清理规则，它们必须使用渲染器名称，例如`[markup.sanitizer.asciidoc.rule-1]`。 -如果规则在渲染器ini节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 +如果规则在渲染器 ini 节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 ## 代码高亮映射 (`highlight.mapping`) - `file_extension 比如 .toml`: **language 比如 ini**。文件扩展名到语言的映射覆盖。 - Gitea 将使用 `.gitattributes` 文件中的 `linguist-language` 或 `gitlab-language` 属性来对文件进行高亮显示，如果可用。 -如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 + 如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 ## 时间 (`time`) @@ -1213,11 +1210,11 @@ ALLOW_DATA_URI_IMAGES = true - `MINIO_BASE_PATH`：**lfs/**: 桶上的 Minio 基本路径，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_USE_SSL`：**false**: Minio 启用 ssl，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_INSECURE_SKIP_VERIFY`：**false**: Minio 跳过 SSL 验证，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 ## 存储 (`storage`) -默认的附件、lfs、头像、仓库头像、仓库归档、软件包、操作日志、artifacts 的存储配置。推荐仅仅配置此 section 并让其它的section 从此配置项继承。 +默认的附件、lfs、头像、仓库头像、仓库归档、软件包、操作日志、artifacts 的存储配置。推荐仅仅配置此 section 并让其它的 section 从此配置项继承。 - `STORAGE_TYPE`：**local**: 存储类型，`local` 表示本地磁盘，`minio` 表示 S3，`azureblob` 表示 azure 对象存储。 - `SERVE_DIRECT`：**false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，仅支持通过签名的 URL 提供 Minio/S3，本地不执行任何操作。 @@ -1228,7 +1225,7 @@ ALLOW_DATA_URI_IMAGES = true - `MINIO_LOCATION`：**us-east-1**: 创建桶的 Minio 位置，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_USE_SSL`：**false**: Minio 启用 ssl，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_INSECURE_SKIP_VERIFY`：**false**: Minio 跳过 SSL 验证，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 - `AZURE_BLOB_ENDPOINT`: **_empty_**: Azure Blob 终端点，仅在 `STORAGE_TYPE` 为 `azureblob` 时可用。例如：https://accountname.blob.core.windows.net 或 http://127.0.0.1:10000/devstoreaccount1 - `AZURE_BLOB_ACCOUNT_NAME`: **_empty_**: Azure Blob 账号名，仅在 `STORAGE_TYPE` 为 `azureblob` 时可用。 @@ -1311,29 +1308,29 @@ MINIO_BUCKET_LOOKUP_TYPE = auto 存储库归档存储的配置。当将`STORAGE_TYPE`设置为`xxx`时，它将继承默认的 `[storage]` 或 `[storage.xxx]` 配置。`PATH`的默认值是`data/repo-archive`，`MINIO_BASE_PATH`的默认值是`repo-archive/`。 -- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 -- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的URL以直接提供文件。目前，只有Minio/S3支持通过签名URL，本地不执行任何操作。 +- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 +- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，只有 Minio/S3 支持通过签名 URL，本地不执行任何操作。 - `PATH`: **./data/repo-archive**: 用于存储归档文件的位置，仅在`STORAGE_TYPE`为`local`时可用。 -- `MINIO_ENDPOINT`: **localhost:9000**: Minio端点，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_ACCESS_KEY_ID`: Minio的accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_SECRET_ACCESS_KEY`: Minio的secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BUCKET`: **gitea**: 用于存储归档的Minio存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的Minio位置，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的Minio基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_USE_SSL`: **false**: 启用Minio的SSL，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过Minio的SSL验证，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ENDPOINT`: **localhost:9000**: Minio 端点，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ACCESS_KEY_ID`: Minio 的 accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_SECRET_ACCESS_KEY`: Minio 的 secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET`: **gitea**: 用于存储归档的 Minio 存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的 Minio 位置，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的 Minio 基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_USE_SSL`: **false**: 启用 Minio 的 SSL，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过 Minio 的 SSL 验证，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 ### 存储库归档 (`repo-archive`) -- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **repo-archive/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **repo-archive/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 ## 代理 (`proxy`) -- `PROXY_ENABLED`: **false**: 启用代理，如果为true，所有通过HTTP向外部的请求都将受到影响，如果为false，即使环境设置了http_proxy/https_proxy也不会使用 +- `PROXY_ENABLED`: **false**: 启用代理，如果为 true，所有通过 HTTP 向外部的请求都将受到影响，如果为 false，即使环境设置了 http_proxy/https_proxy 也不会使用 - `PROXY_URL`: **_empty_**: 代理服务器地址，支持 http://, https//, socks://，为空则不启用代理而使用环境变量中的 http_proxy/https_proxy -- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 * 号匹配符号， ** 表示匹配所有网站 +- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 \* 号匹配符号， \*\* 表示匹配所有网站 i.e. @@ -1347,8 +1344,8 @@ PROXY_HOSTS = *.github.com - `ENABLED`: **true**: 启用/禁用操作功能 - `DEFAULT_ACTIONS_URL`: **github**: 获取操作插件的默认平台，`github`表示`https://github.com`，`self`表示当前的 Gitea 实例。 -- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **actions_log/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **actions_log/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 - `LOG_RETENTION_DAYS`: **365**: 日志保留时间（天）。此期限后将删除旧日志。 - `LOG_COMPRESSION`: **zstd**: 日志压缩方式，`none`表示不压缩，`zstd`表示 zstd 压缩。 其它的压缩方式如`gzip`是不支持的，因为查看日志需要可寻址流。 @@ -1376,8 +1373,8 @@ PROXY_HOSTS = *.github.com ## 其他 (`other`) -- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示Gitea的版本。 +- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示 Gitea 的版本。 - `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: 在页脚显示模板执行的时间。 - `SHOW_FOOTER_POWERED_BY`: **true**: 在页脚显示“由...提供动力”的文本。 -- `ENABLE_SITEMAP`: **true**: 生成sitemap. -- `ENABLE_FEED`: **true**: 是否启用RSS/Atom +- `ENABLE_SITEMAP`: **true**: 生成 sitemap. +- `ENABLE_FEED`: **true**: 是否启用 RSS/Atom diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/customizing-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/customizing-gitea.md index 05ecde8a..ed090043 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/customizing-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/customizing-gitea.md @@ -5,14 +5,13 @@ sidebar_position: 100 aliases: - /zh-cn/customizing-gitea - --- # 自定义 Gitea 配置 Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板等默认配置。 -如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为Linux文件系统标准。Gitea +如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为 Linux 文件系统标准。Gitea 将会自动创建包括 `custom/` 在内的必要应用目录，应用本身的配置存放在 `custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接，查看配置详情请移步： @@ -66,7 +65,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板 除了 `extra_links.tmpl` 和 `extra_tabs.tmpl`，您可以在您的 `custom/templates/custom/` 目录中存放一些其他有用的模板，例如： -- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义CSS文件 +- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义 CSS 文件 - `body_outer_pre.tmpl`，在 `` 标记开始处的模板 - `body_inner_pre.tmpl`，在顶部导航栏之前，但在主 container 内部的模板，例如添加一个 `
` - `body_inner_post.tmpl`，在主 container 结束处的模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/email-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/email-setup.md index 3735e537..cc3f09e6 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/email-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/email-setup.md @@ -5,7 +5,6 @@ sidebar_position: 12 aliases: - /zh-cn/email-setup - --- # Email 设置 @@ -16,9 +15,9 @@ Gitea 具有邮件功能，用于发送事务性邮件（例如注册确认邮 使用 `sendmail` 命令作为邮件传输代理（mailer）。 -注意：对于在官方Gitea Docker镜像中使用，请使用SMTP版本进行配置（请参考下一节）。 +注意：对于在官方 Gitea Docker 镜像中使用，请使用 SMTP 版本进行配置（请参考下一节）。 -注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 +注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过 TLS 发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 ```ini title="app.ini" [mailer] @@ -55,9 +54,9 @@ PASSWD = `password` - 通过端口 587 的 STARTTLS（也称为 Opportunistic TLS）。初始连接是明文的，但如果服务器支持，则可以升级为 TLS。 - 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。 - 使用 `PROTOCOL=smtps` 进行强制的 SMTPS 连接。（这两种方式都被称为 Implicit TLS） -这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 + 这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 -请注意，自2018年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 +请注意，自 2018 年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 ### Gmail diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/environment-variables.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/environment-variables.md index a61c1842..2e25fc8f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/environment-variables.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/environment-variables.md @@ -5,7 +5,6 @@ sidebar_position: 10 aliases: - /zh-cn/environment-variables - --- # 环境变量清单 @@ -20,31 +19,31 @@ GITEA_CUSTOM=/home/gitea/custom ./gitea web 因为 Gitea 使用 Go 语言编写，因此它使用了一些相关的 Go 的配置参数： -* `GOOS` -* `GOARCH` -* [`GOPATH`](https://go.dev/cmd/go/#hdr-GOPATH_environment_variable) +- `GOOS` +- `GOARCH` +- [`GOPATH`](https://go.dev/cmd/go/#hdr-GOPATH_environment_variable) 您可以在[官方文档](https://go.dev/cmd/go/#hdr-Environment_variables)中查阅这些配置参数的详细信息。 ## Gitea 的文件目录 -* `GITEA_WORK_DIR`：工作目录的绝对路径 -* `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录 -* `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 -* `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 +- `GITEA_WORK_DIR`：工作目录的绝对路径 +- `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 _custom_ 目录 +- `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 +- `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 ## 操作系统配置 -* `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 -* `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` -* `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 +- `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 +- `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` +- `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 ### 仅限于 Windows 的配置 -* `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` -* `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘） -* `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 +- `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` +- `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C 盘） +- `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 ## Miscellaneous -* `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 +- `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/external-renderers.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/external-renderers.md index c5990ebd..ae4e49e2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/external-renderers.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/external-renderers.md @@ -5,7 +5,6 @@ sidebar_position: 60 aliases: - /zh-cn/external-renderers - --- # 外部渲染器 @@ -171,7 +170,8 @@ ALLOW_DATA_URI_IMAGES = true .markup.XXXXX body { color: #444; - font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", + serif; font-size: 12px; line-height: 1.7; padding: 1em; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/fail2ban-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/fail2ban-setup.md index 656dea53..3cef94a9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/fail2ban-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/fail2ban-setup.md @@ -5,7 +5,6 @@ sidebar_position: 16 aliases: - /zh-cn/fail2ban-setup - --- # 设置 Fail2ban diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/git-lfs-support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/git-lfs-support.md index 3154c38e..b1586476 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/git-lfs-support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/git-lfs-support.md @@ -5,7 +5,6 @@ sidebar_position: 12 aliases: - /zh-cn/git-lfs-setup - --- # Git LFS 设置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md index d1766619..78606546 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md @@ -17,18 +17,18 @@ aliases: 目前，以下通知事件使用模板： -| 操作名称 | 用途 | -| ----------- | ------------------------------------------------------------------------------------------------------------ | -| `new` | 创建了新的工单或合并请求。 | -| `comment` | 在现有工单或合并请求中创建了新的评论。 | -| `close` | 关闭了工单或合并请求。 | -| `reopen` | 重新打开了工单或合并请求。 | -| `review` | 在合并请求中进行审查的首要评论。 | -| `approve` | 对合并请求进行批准的首要评论。 | -| `reject` | 对合并请求提出更改请求的审查的首要评论。 | -| `code` | 关于合并请求的代码的单个评论。 | -| `assigned` | 用户被分配到工单或合并请求。 | -| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | +| 操作名称 | 用途 | +| ---------- | ---------------------------------------------------------------------- | +| `new` | 创建了新的工单或合并请求。 | +| `comment` | 在现有工单或合并请求中创建了新的评论。 | +| `close` | 关闭了工单或合并请求。 | +| `reopen` | 重新打开了工单或合并请求。 | +| `review` | 在合并请求中进行审查的首要评论。 | +| `approve` | 对合并请求进行批准的首要评论。 | +| `reject` | 对合并请求提出更改请求的审查的首要评论。 | +| `code` | 关于合并请求的代码的单个评论。 | +| `assigned` | 用户被分配到工单或合并请求。 | +| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | 特定消息类型的模板路径为： @@ -72,25 +72,25 @@ custom/templates/mail/pull/comment.tmpl 指定 _主题_ 部分是可选的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。 -_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： +_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： -| 名称 | 类型 | 可用性 | 用途 | -| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | -| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | -| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | -| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | -| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | -| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | -| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | -| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | -| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | -| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | -| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | -| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | -| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | -| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | -| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | +| 名称 | 类型 | 可用性 | 用途 | +| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | +| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | +| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | +| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | +| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | +| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | +| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | +| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | +| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | +| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | +| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | +| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | +| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | +| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | +| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | 所有名称区分大小写。 @@ -107,7 +107,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ - 删除所有前导、尾随和多余的空格。 - 将字符串截断为前 256 个字母（字符）。 -如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用Gitea的**内部默认值**。 +如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用 Gitea 的**内部默认值**。 内部默认（回退）主题相当于： @@ -117,7 +117,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 例如：`Re: [mike/stuff] New color palette (#38)` -即使存在有效的主题模板，Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 +即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 ### 模板中的邮件正文部分 @@ -139,7 +139,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 如果模板无法呈现，则只有在发送邮件时才会注意到。 如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈现了任何内容，则将使用该内容，忽略其他内容。 -如果遇到问题，请检查 [Gitea的日志](../administration/logging-config.md) 以获取错误消息。 +如果遇到问题，请检查 [Gitea 的日志](../administration/logging-config.md) 以获取错误消息。 ## 示例 @@ -221,11 +221,11 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ > > #### 消息内容 > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > Mike, I think we should tone down the blues a little. > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > [在 Gitea 上查看](#)。 @@ -233,20 +233,22 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 模板系统包含一些函数，可用于进一步处理和格式化消息。以下是其中一些函数的列表： -| 函数名 | 参数 | 可用于 | 用法 | -|------------------| ----------- | ------------ | ------------------------------ | -| `AppUrl` | - | 任何地方 | Gitea 的 URL | -| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | -| `AppDomain` | - | 任何地方 | Gitea 的主机名 | -| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | -| `SanitizeHTML` | string | 仅正文部分 | 通过删除其中的危险 HTML 标签对文本进行清理 | -| `SafeHTML` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于输出原始的 HTML 内容 | +| 函数名 | 参数 | 可用于 | 用法 | +| ---------------- | ----------- | ---------- | ------------------------------------------------ | +| `AppUrl` | - | 任何地方 | Gitea 的 URL | +| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | +| `AppDomain` | - | 任何地方 | Gitea 的主机名 | +| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | +| `SanitizeHTML` | string | 仅正文部分 | 通过删除其中的危险 HTML 标签对文本进行清理 | +| `SafeHTML` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于输出原始的 HTML 内容 | 这些都是 _函数_，而不是元数据，因此必须按以下方式使用： ```html -像这样使用： {{SanitizeHTML "Escapetext"}} -或者这样使用： {{"Escapetext" | SanitizeHTML}} -或者这样使用： {{AppUrl}} -但不要像这样使用： {{.AppUrl}} +像这样使用： {{SanitizeHTML "Escapetext"}} 或者这样使用： {{"Escapetext" | SanitizeHTML}} 或者这样使用： {{AppUrl}} 但不要像这样使用： + {{.AppUrl}} ``` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/repo-indexer.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/repo-indexer.md index 676c60c7..4743e61b 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/repo-indexer.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/repo-indexer.md @@ -30,7 +30,7 @@ REPO_INDEXER_EXCLUDE = resources/bin/** ### 按路径选择要索引的文件 -Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 +Gitea 使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 限制文件列表可以防止索引被派生或无关的文件（例如 lss、sym、map 等）污染，从而使搜索结果更相关。这还有助于减小索引的大小。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/reverse-proxies.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/reverse-proxies.md index 6c833b31..138f7d58 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/reverse-proxies.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/reverse-proxies.md @@ -229,7 +229,7 @@ git.example.com { 1. 在 IIS 中设置一个空网页，比如命名为 `Gitea Proxy`。 2. 根据[微软社区中为 IIS 设置 URL 重写的指南](https://techcommunity.microsoft.com/t5/iis-support-blog/setup-iis-with-url-rewrite-as-a-reverse-proxy-for-real-world/ba-p/846222#M343)的前两步进行配置，也就是： -- 使用 Microsoft Web Platform Installer 5.1 (WebPI) 安装 Application Request Routing（简称ARR），或者在 [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing) 下载这个插件。 +- 使用 Microsoft Web Platform Installer 5.1 (WebPI) 安装 Application Request Routing（简称 ARR），或者在 [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing) 下载这个插件。 - 一但这个模块被安装到 IIS 上，你将会在 IIS 管理控制台看到一个叫做 URL Rewrite 的新图标。 - 打开 IIS 管理控制台，在左边的列表中点击 `Gitea Proxy` 网页。在中间选中并且双击 URL Rewrite 的图标来加载 URL 重写的面板。 - 在管理控制台的右边选择 `Add Rule` 操作，并且在 `Inbound and Outbound Rules` 分类中选择 `Reverse Proxy Rule`。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/search-engines-indexation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/search-engines-indexation.md index 2f91167e..0b48a1f5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/search-engines-indexation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/search-engines-indexation.md @@ -22,7 +22,7 @@ User-agent: * Disallow: / ``` -如果您将Gitea安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 +如果您将 Gitea 安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 ```txt User-agent: * diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/signing.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/signing.md index e3dd8beb..e0ea3f9d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/signing.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/signing.md @@ -69,7 +69,7 @@ MERGES = pubkey, twofa, basesigned, commitssigned 如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。 与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。 -如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置，否则Gitea将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 +如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置，否则 Gitea 将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 ::: ### `INITIAL_COMMIT` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-backend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-backend.md index 80b2b666..758e4173 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-backend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-backend.md @@ -10,40 +10,40 @@ aliases: ## 背景 -Gitea使用Golang作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 -例如，Gitea使用[Chi](https://github.com/go-chi/chi)作为基本的Web框架。[Xorm](https://xorm.io)是一个用于与数据库交互的ORM框架。 +Gitea 使用 Golang 作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 +例如，Gitea 使用[Chi](https://github.com/go-chi/chi)作为基本的 Web 框架。[Xorm](https://xorm.io)是一个用于与数据库交互的 ORM 框架。 因此，管理这些包非常重要。在开始编写后端代码之前，请参考以下准则。 ## 包设计准则 ### 包列表 -为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea后端分为以下几个部分： +为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea 后端分为以下几个部分： -- `build`：帮助构建Gitea的脚本。 -- `cmd`：包含所有Gitea的实际子命令，包括web、doctor、serv、hooks、admin等。`web`将启动Web服务。`serv`和`hooks`将被Git或OpenSSH调用。其他子命令可以帮助维护Gitea。 +- `build`：帮助构建 Gitea 的脚本。 +- `cmd`：包含所有 Gitea 的实际子命令，包括 web、doctor、serv、hooks、admin 等。`web`将启动 Web 服务。`serv`和`hooks`将被 Git 或 OpenSSH 调用。其他子命令可以帮助维护 Gitea。 - `tests`：常用的测试函数 - `tests/integration`：集成测试，用于测试后端回归。 - `tests/e2e`：端到端测试，用于测试前端和后端的兼容性和视觉回归。 -- `models`：包含由xorm用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他Gitea代码的依赖关系。在某些情况下，比如日志记录时可以例外。 - - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从models/中调用。 +- `models`：包含由 xorm 用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他 Gitea 代码的依赖关系。在某些情况下，比如日志记录时可以例外。 + - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从 models/中调用。 - `models/fixtures`：单元测试和集成测试中使用的示例数据。一个`yml`文件表示一个将在测试开始时加载到数据库中的表。 - - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的PR**必须**包含一个迁移步骤。 -- `modules`：在Gitea中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于models的模块，因为它们依赖于数据库。 - - `modules/setting`：存储从ini文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 - - `modules/git`：用于与`Git`命令行或Gogit包交互的包。 -- `public`：编译后的前端文件（JavaScript、图像、CSS等） -- `routers`：处理服务器请求。由于它使用其他Gitea包来处理请求，因此其他包（models、modules或services）不能依赖于routers。 - - `routers/api`：包含`/api/v1`相关路由，用于处理RESTful API请求。 + - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的 PR**必须**包含一个迁移步骤。 +- `modules`：在 Gitea 中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于 models 的模块，因为它们依赖于数据库。 + - `modules/setting`：存储从 ini 文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 + - `modules/git`：用于与`Git`命令行或 Gogit 包交互的包。 +- `public`：编译后的前端文件（JavaScript、图像、CSS 等） +- `routers`：处理服务器请求。由于它使用其他 Gitea 包来处理请求，因此其他包（models、modules 或 services）不能依赖于 routers。 + - `routers/api`：包含`/api/v1`相关路由，用于处理 RESTful API 请求。 - `routers/install`：只能在系统处于安装模式（INSTALL_LOCK=false）时响应。 - `routers/private`：仅由内部子命令调用，特别是`serv`和`hooks`。 - - `routers/web`：处理来自Web浏览器或Git SMART HTTP协议的HTTP请求。 + - `routers/web`：处理来自 Web 浏览器或 Git SMART HTTP 协议的 HTTP 请求。 - `services`：用于常见路由操作或命令执行的支持函数。使用`models`和`modules`来处理请求。 -- `templates`：用于生成HTML输出的Golang模板。 +- `templates`：用于生成 HTML 输出的 Golang 模板。 ### 包依赖关系 -由于Golang不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 +由于 Golang 不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 `cmd` -> `routers` -> `services` -> `models` -> `modules` @@ -88,18 +88,18 @@ func UpdateIssue(ctx context.Context, repoID int64) error { ### 导入别名 -由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个Go文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 +由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个 Go 文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 例如：`import user_service "code.gitea.io/gitea/services/user"` ### 重要注意事项 - 永远不要写成`x.Update(exemplar)`，而没有明确的`WHERE`子句： - - 这将导致表中的所有行都被使用exemplar的非零值进行更新，包括ID。 + - 这将导致表中的所有行都被使用 exemplar 的非零值进行更新，包括 ID。 - 通常应该写成`x.ID(id).Update(exemplar)`。 -- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而ID是预设的： - - 对于MSSQL变体，你将需要执行``SET IDENTITY_INSERT `table` ON``（否则迁移将失败） - - 对于PostgreSQL，你还需要更新ID序列，否则迁移将悄无声息地通过，但后续的插入将失败： - ``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)`` +- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而 ID 是预设的： + - 对于 MSSQL 变体，你将需要执行`` SET IDENTITY_INSERT `table` ON ``（否则迁移将失败） + - 对于 PostgreSQL，你还需要更新 ID 序列，否则迁移将悄无声息地通过，但后续的插入将失败： + `` SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false) `` ### 未来的任务 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-frontend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-frontend.md index d6581343..4f347891 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-frontend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-frontend.md @@ -16,10 +16,10 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 源文件可以在以下目录中找到： -* **CSS 样式**： `web_src/css/` -* **JavaScript 文件**： `web_src/js/` -* **Vue 组件**： `web_src/js/components/` -* **Go HTML 模板**： `templates/` +- **CSS 样式**： `web_src/css/` +- **JavaScript 文件**： `web_src/js/` +- **Vue 组件**： `web_src/js/components/` +- **Go HTML 模板**： `templates/` ## 通用准则 @@ -28,9 +28,9 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ## Gitea 特定准则 1. 每个功能（Fomantic-UI/jQuery 模块）应放在单独的文件/目录中。 -2. HTML 的 id 和 class 应使用 kebab-case，最好包含2-3个与功能相关的关键词。 -3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含2-3个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 -4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有2-3个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 +2. HTML 的 id 和 class 应使用 kebab-case，最好包含 2-3 个与功能相关的关键词。 +3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含 2-3 个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 +4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有 2-3 个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 5. 后端可以通过使用`ctx.PageData["myModuleData"] = map[]{}`将复杂数据传递给前端，但不要将整个模型暴露给前端，以避免泄露敏感数据。 6. 简单页面和与 SEO 相关的页面使用 Go HTML 模板渲染生成静态的 Fomantic-UI HTML 输出。复杂页面可以使用 Vue3。 7. 明确变量类型，优先使用`elem.disabled = true`而不是`elem.setAttribute('disabled', 'anything')`，优先使用`$el.prop('checked', var === 'yes')`而不是`$el.prop('checked', var)`。 @@ -39,11 +39,11 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 10. 避免在一个事件监听器中混合不同的事件，优先为每个事件使用独立的事件监听器。 11. 推荐使用自定义事件名称前缀`ce-`。 12. 建议使用 Tailwind CSS，它可以通过 `tw-` 前缀获得，例如 `tw-relative`. Gitea 自身的助手类 CSS 使用 `gt-` 前缀（`gt-ellipsis`），Gitea 自身的私有框架级 CSS 类使用 `g-` 前缀（`g-modal-confirm`）。 -13. 尽量避免内联脚本和样式，建议将JS代码放入JS文件中并使用CSS类。如果内联脚本和样式不可避免，请解释无法避免的原因。 +13. 尽量避免内联脚本和样式，建议将 JS 代码放入 JS 文件中并使用 CSS 类。如果内联脚本和样式不可避免，请解释无法避免的原因。 ### 可访问性 / ARIA -在历史上，Gitea大量使用了可访问性不友好的框架 Fomantic UI。 +在历史上，Gitea 大量使用了可访问性不友好的框架 Fomantic UI。 Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`）， 但仍然存在许多问题需要大量的工作和时间来修复。 @@ -54,16 +54,16 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 推荐的实现方式： -* Vue + Vanilla JS -* Fomantic-UI（jQuery） -* htmx （部分页面重新加载其他静态组件） -* Vanilla JS +- Vue + Vanilla JS +- Fomantic-UI（jQuery） +- htmx （部分页面重新加载其他静态组件） +- Vanilla JS 不推荐的实现方式： -* Vue + Fomantic-UI（jQuery） -* jQuery + Vanilla JS -* htmx + 任何其他需要大量 JavaScript 代码或不必要的功能，如 htmx 脚本 (`hx-on`) +- Vue + Fomantic-UI（jQuery） +- jQuery + Vanilla JS +- htmx + 任何其他需要大量 JavaScript 代码或不必要的功能，如 htmx 脚本 (`hx-on`) 为了保持界面一致，Vue 组件可以使用 Fomantic-UI 的 CSS 类。 尽管不建议混合使用不同的框架， @@ -83,7 +83,7 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 如果我们想在非异步上下文中调用`async`函数， 建议使用`const _promise = asyncFoo()`来告诉读者 -这是有意为之的，我们想调用异步函数并忽略Promise。 +这是有意为之的，我们想调用异步函数并忽略 Promise。 一些 lint 规则和 IDE 也会在未处理返回的 Promise 时发出警告。 ### 获取数据 @@ -97,31 +97,41 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 禁止使用`dataset`，它的驼峰命名行为使得搜索属性变得困难。 然而，仍然存在一些特殊情况，因此当前的准则是： -* 对于旧代码： - * 应将`$.data()`重构为`$.attr()`。 - * 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 +- 对于旧代码： -* 对于新代码： - * 不应使用`node.dataset`，而应使用`node.getAttribute`。 - * 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 + - 应将`$.data()`重构为`$.attr()`。 + - 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 + +- 对于新代码： + - 不应使用`node.dataset`，而应使用`node.getAttribute`。 + - 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 ### 显示/隐藏元素 -* 推荐在Vue组件中使用`v-if`和`v-show`来显示/隐藏元素。 -* Go 模板代码应使用 `.tw-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.tw-hidden`的注释以获取更多详细信息。 +- 推荐在 Vue 组件中使用`v-if`和`v-show`来显示/隐藏元素。 +- Go 模板代码应使用 `.tw-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.tw-hidden`的注释以获取更多详细信息。 ### Go HTML 模板中的样式和属性 建议使用以下方式： ```html -
+
``` 而不是： ```html -
+
``` 以使代码更易读。 @@ -134,6 +144,6 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） Gitea 现在正在使用 Vue3。我们决定不引入 JSX，以保持 HTML 代码和 JavaScript 代码分离。 -### UI示例 +### UI 示例 Gitea 使用一些自制的 UI 元素并自定义其他元素，以将它们更好地集成到通用 UI 方法中。当在开发模式（`RUN_MODE=dev`）下运行 Gitea 时，在 `http(s)://your-gitea-url:port/devtest` 下会提供一个包含一些标准化 UI 示例的页面。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-refactoring.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-refactoring.md index e0ab3e3b..6df29443 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-refactoring.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/guidelines-refactoring.md @@ -10,31 +10,31 @@ aliases: ## 背景 -自2014年2月12日编写了第一行代码以来，Gitea已经发展成为一个庞大的项目。 +自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成为一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多过时的机制，许多框架混合在一起，一些遗留代码可能会导致错误并阻碍新功能的开发。 -为了使代码库更易于维护，使Gitea变得更好，开发人员应牢记使用现代机制来重构旧代码。 +为了使代码库更易于维护，使 Gitea 变得更好，开发人员应牢记使用现代机制来重构旧代码。 本文档是关于重构代码库的指南集合。 ## 重构建议 -* 设计更多关于未来的内容，而不仅仅解决当前问题。 -* 减少模糊性，减少冲突，提高可维护性。 -* 描述重构，例如： - * 为什么需要重构。 - * 如何解决旧问题。 - * 重构的优点/缺点是什么。 -* 只做必要的更改，尽量保留旧逻辑。 -* 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个PR中完成。 -* 如果存在分歧，应该请TOC（技术监督委员会）参与决策。 -* 添加必要的测试以确保重构的正确性。 -* 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 +- 设计更多关于未来的内容，而不仅仅解决当前问题。 +- 减少模糊性，减少冲突，提高可维护性。 +- 描述重构，例如： + - 为什么需要重构。 + - 如何解决旧问题。 + - 重构的优点/缺点是什么。 +- 只做必要的更改，尽量保留旧逻辑。 +- 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。 +- 如果存在分歧，应该请 TOC（技术监督委员会）参与决策。 +- 添加必要的测试以确保重构的正确性。 +- 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 ## 审查和合并建议 -* 重构的PR不应该长时间保持打开状态（通常为7天），应尽快进行审查。 -* 重构的PR应尽快合并，不应被其他PR阻塞。 -* 如果TOC没有异议，重构的PR可以在7天后由一名核心成员（非作者）批准后合并。 -* 如果最终结果良好，容忍一些不完美/临时的步骤。 -* 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 +- 重构的 PR 不应该长时间保持打开状态（通常为 7 天），应尽快进行审查。 +- 重构的 PR 应尽快合并，不应被其他 PR 阻塞。 +- 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合并。 +- 如果最终结果良好，容忍一些不完美/临时的步骤。 +- 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/localization.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/localization.md index 29596205..e0b81a3a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/localization.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/contributing/localization.md @@ -8,9 +8,9 @@ aliases: # 本地化 -Gitea的本地化是通过我们的[Crowdin项目](https://crowdin.com/project/gitea)进行的。 +Gitea 的本地化是通过我们的[Crowdin 项目](https://crowdin.com/project/gitea)进行的。 -对于对**英语翻译**的更改，可以发出pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 +对于对**英语翻译**的更改，可以发出 pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 有关对**非英语**翻译的更改，请参阅上面的 Crowdin 项目。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/hacking-on-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/hacking-on-gitea.md index 0d5657a8..de93ee2d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/hacking-on-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/hacking-on-gitea.md @@ -16,7 +16,7 @@ aliases: ## 安装 Golang -您需要 [安装 go]( https://go.dev/doc/install ) 并设置您的 go 环境。 +您需要 [安装 go](https://go.dev/doc/install) 并设置您的 go 环境。 接下来，[使用 npm 安装 Node.js](https://nodejs.org/en/download/) ，这是构建 JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @minNodeVersion@ @@ -24,12 +24,12 @@ JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @mi **注意** ：当执行需要外部工具的 make 任务时，比如 `make watch-backend`，Gitea 会自动下载并构建这些必要的组件。为了能够使用这些，你必须 -将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把go bin目录添加到可执行路径你必须手动 +将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把 go bin 目录添加到可执行路径你必须手动 指定可执行程序路径。 -**注意2** ：Go版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 +**注意 2** ：Go 版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 格式化源代码。然而，`gofmt` 的结果可能因 `go` 的版本而有差异。因此推荐安装我们持续集成使用 -的 Go版本。截至上次更新，Go 版本应该是 @goVersion@。 +的 Go 版本。截至上次更新，Go 版本应该是 @goVersion@。 ## 安装 Make @@ -55,15 +55,15 @@ sudo yum install make Make 的这三个发行版都可以在 Windows 上运行： -- [单个二进制构建]( http://www.equation.com/servlet/equation.cmd?fa=make )。复制到某处并添加到 `PATH`。 +- [单个二进制构建](http://www.equation.com/servlet/equation.cmd?fa=make)。复制到某处并添加到 `PATH`。 - [32 位版本](http://www.equation.com/ftpdir/make/32/make.exe) - [64 位版本](http://www.equation.com/ftpdir/make/64/make.exe) - [MinGW-w64](https://www.mingw-w64.org) / [MSYS2](https://www.msys2.org/)。 - MSYS2 是一个工具和库的集合，为您提供一个易于使用的环境来构建、安装和运行本机 Windows 软件，它包括 MinGW-w64。 - 在 MingGW-w64 中，二进制文件称为 `mingw32-make.exe` 而不是 `make.exe`。将 `bin` 文件夹添加到 `PATH`。 - 在 MSYS2 中，您可以直接使用 `make`。请参阅 [MSYS2 移植](https://www.msys2.org/wiki/Porting/)。 - - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 _beginthread 一样。 -- [Chocolatey包管理器]( https://chocolatey.org/packages/make )。运行`choco install make` + - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 \_beginthread 一样。 +- [Chocolatey 包管理器](https://chocolatey.org/packages/make)。运行`choco install make` **注意** ：如果您尝试在 Windows 命令提示符下使用 make 进行构建，您可能会遇到问题。建议使用上述提示（Git bash 或 MinGW），但是如果您只有命令提示符（或可能是 PowerShell），则可以使用 [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) 命令，例如 `set TAGS=bindata`。 @@ -75,7 +75,7 @@ Make 的这三个发行版都可以在 Windows 上运行： git clone https://github.com/go-gitea/gitea ``` -（自从go modules出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） +（自从 go modules 出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） ## 派生 Gitea @@ -196,7 +196,7 @@ SVG 图标是使用 `make svg` 命令构建的，该命令将图标资源编译 ### 构建 Logo -Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 +Gitea Logo 的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 通过更新 `assets/logo.svg` 并运行 `make generate-images`，同样的过程也可用于从 SVG 源文件生成自定义 Logo PNG。忽略 gitea 编译选项将仅更新用户指定的 LOGO 文件。 @@ -205,7 +205,7 @@ Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 创建新的 API 路由或修改现有的 API 路由时，您**必须** 更新和/或创建 [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/) 这些使用 [go-swagger](https://goswagger.io/) 评论的文档。 -[规范]( https://goswagger.io/use/spec.html#annotation-syntax )中描述了这些注释的结构。 +[规范](https://goswagger.io/use/spec.html#annotation-syntax)中描述了这些注释的结构。 如果您想了解更多有关 Swagger 结构的信息，可以查看 [Swagger 2.0 文档](https://swagger.io/docs/specification/2-0/basic-structure/) 或与添加新 API 端点的先前 PR 进行比较，例如 [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20) @@ -239,7 +239,7 @@ make swagger-check 并到[配置备忘单](../administration/config-cheat-sheet.md) 在 `docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到 -### 更改Logo +### 更改 Logo 更改 Gitea Logo SVG 时，您将需要运行并提交结果的： @@ -291,7 +291,7 @@ TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite 我们的持续集成将测试代码是否通过了单元测试，并且所有支持的数据库都将在 Docker 环境中通过集成测试。 还将测试从几个最新版本的 Gitea 迁移。 -请在PR中附带提交适当的单元测试和集成测试。 +请在 PR 中附带提交适当的单元测试和集成测试。 ## 网站文档 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/integrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/integrations.md index 052a8734..049d0bba 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/integrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/integrations.md @@ -8,7 +8,7 @@ aliases: # 集成 -Gitea拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 +Gitea 拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 我们正在[awesome-gitea](https://gitea.com/gitea/awesome-gitea)上整理一个列表来跟踪这些集成！ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/migrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/migrations.md index b92449e6..60cad1ab 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/migrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/migrations.md @@ -8,24 +8,24 @@ aliases: # 迁移接口 -完整迁移功能在Gitea 1.9.0版本中引入。它定义了两个接口，用于支持从其他Git托管平台迁移存储库数据到Gitea，或者在将来将Gitea数据迁移到其他Git托管平台。 +完整迁移功能在 Gitea 1.9.0 版本中引入。它定义了两个接口，用于支持从其他 Git 托管平台迁移存储库数据到 Gitea，或者在将来将 Gitea 数据迁移到其他 Git 托管平台。 -目前已实现了从GitHub、GitLab和其他Gitea实例的迁移。 +目前已实现了从 GitHub、GitLab 和其他 Gitea 实例的迁移。 -首先，Gitea在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 +首先，Gitea 在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 ## 下载器接口 -要从新的Git托管平台迁移，需要进行两个步骤的更新。 +要从新的 Git 托管平台迁移，需要进行两个步骤的更新。 - 您应该实现一个`Downloader`，用于获取存储库信息。 -- 您应该实现一个`DownloaderFactory`，用于检测URL是否匹配，并创建上述的`Downloader`。 +- 您应该实现一个`DownloaderFactory`，用于检测 URL 是否匹配，并创建上述的`Downloader`。 - 您需要在`init()`中通过`RegisterDownloaderFactory`注册`DownloaderFactory`。 您可以在[downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go)中找到这些接口。 ## 上传器接口 -目前，只实现了`GiteaLocalUploader`，因此我们只能通过此Uploader将下载的数据保存到本地的Gitea实例。目前不支持其他上传器。 +目前，只实现了`GiteaLocalUploader`，因此我们只能通过此 Uploader 将下载的数据保存到本地的 Gitea 实例。目前不支持其他上传器。 您可以在[uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go)中找到这些接口。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/oauth2-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/oauth2-provider.md index da39853f..66dd333d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/oauth2-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/development/oauth2-provider.md @@ -33,40 +33,40 @@ Gitea 支持作为 OAuth2 提供者，允许第三方应用程序在用户同意 Gitea 支持以下令牌范围: -| 名称 | 介绍 | -| ---- | ----------- | -| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | -| **repo** | 完全控制所有存储库 | -|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | -|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | -| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | -|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | -|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | -| **admin:org** | 授予对组织设置的完全访问权限 | -|     **write:org** | 授予对组织设置的读/写访问权限 | -|     **read:org** | 授予对组织设置的只读访问权限 | -| **admin:public_key** | 授予公钥管理的完全访问权限 | -|     **write:public_key** | 授予对公钥的读/写访问权限 | -|     **read:public_key** | 授予对公钥的只读访问权限 | -| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | -| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | -| **notification** | 授予对通知的完全访问权限 | -| **user** | 授予对用户个人资料信息的完全访问权限 | -|     **read:user** | 授予对用户个人资料的读取权限 | -|     **user:email** | 授予对用户电子邮件地址的读取权限 | -|     **user:follow** | 授予访问权限以关注/取消关注用户 | -| **delete_repo** | 授予删除存储库的权限 | -| **package** | 授予对托管包的完全访问权限 | -|     **write:package** | 授予对包的读/写访问权限 | -|     **read:package** | 授予对包的读取权限 | -|     **delete:package** | 授予对包的删除权限 | -| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | -|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | -|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | -| **admin:application** | 授予应用程序管理的完全访问权限 | -|     **write:application** | 授予应用程序管理的读/写访问权限 | -|     **read:application** | 授予应用程序管理的读取权限 | -| **sudo** | 允许以站点管理员身份执行操作 | +| 名称 | 介绍 | +| ---------------------------------------- | --------------------------------------------------------------- | +| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | +| **repo** | 完全控制所有存储库 | +|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | +|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | +| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | +|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | +|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | +| **admin:org** | 授予对组织设置的完全访问权限 | +|     **write:org** | 授予对组织设置的读/写访问权限 | +|     **read:org** | 授予对组织设置的只读访问权限 | +| **admin:public_key** | 授予公钥管理的完全访问权限 | +|     **write:public_key** | 授予对公钥的读/写访问权限 | +|     **read:public_key** | 授予对公钥的只读访问权限 | +| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | +| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | +| **notification** | 授予对通知的完全访问权限 | +| **user** | 授予对用户个人资料信息的完全访问权限 | +|     **read:user** | 授予对用户个人资料的读取权限 | +|     **user:email** | 授予对用户电子邮件地址的读取权限 | +|     **user:follow** | 授予访问权限以关注/取消关注用户 | +| **delete_repo** | 授予删除存储库的权限 | +| **package** | 授予对托管包的完全访问权限 | +|     **write:package** | 授予对包的读/写访问权限 | +|     **read:package** | 授予对包的读取权限 | +|     **delete:package** | 授予对包的删除权限 | +| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | +|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | +|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | +| **admin:application** | 授予应用程序管理的完全访问权限 | +|     **write:application** | 授予应用程序管理的读/写访问权限 | +|     **read:application** | 授予应用程序管理的读取权限 | +| **sudo** | 允许以站点管理员身份执行操作 | ## 客户端类型 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/faq.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/faq.md index 81a2d172..e99bb62f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/faq.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/faq.md @@ -12,127 +12,127 @@ aliases: 有关更多帮助资源，请查看所有[支持选项](help/support.md)。 -## 1.x和1.x.x下载之间的区别 +## 1.x 和 1.x.x 下载之间的区别 -以1.7.x版本为例。 +以 1.7.x 版本为例。 -**注意：**此示例也适用于Docker镜像！ +**注意：**此示例也适用于 Docker 镜像！ -在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个1.7目录，以及1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5和1.7.6的目录。 +在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个 1.7 目录，以及 1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5 和 1.7.6 的目录。 -1.7目录和1.7.0目录是**不同**的。1.7目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 +1.7 目录和 1.7.0 目录是**不同**的。1.7 目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 -然而，1.7.0目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 +然而，1.7.0 目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 -这意味着1.x的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 +这意味着 1.x 的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 -另一方面，1.x.x的下载应该永远不会改变。 +另一方面，1.x.x 的下载应该永远不会改变。 -## 如何从Gogs/GitHub等迁移到Gitea +## 如何从 Gogs/GitHub 等迁移到 Gitea -要从Gogs迁移到Gitea： +要从 Gogs 迁移到 Gitea： -- [Gogs版本0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) +- [Gogs 版本 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) -要从GitHub迁移到Gitea，您可以使用Gitea内置的迁移表单。 +要从 GitHub 迁移到 Gitea，您可以使用 Gitea 内置的迁移表单。 为了迁移诸如问题、拉取请求等项目，您需要至少输入您的用户名。 [Example (requires login)](https://demo.gitea.com/repo/migrate) -要从GitLab迁移到Gitea，您可以使用这个非关联的工具： +要从 GitLab 迁移到 Gitea，您可以使用这个非关联的工具： https://github.com/loganinak/MigrateGitlabToGogs -## Gitea存储文件的位置 +## Gitea 存储文件的位置 - _`AppWorkPath`_ - `--work-path`标志 - 或者环境变量`GITEA_WORK_DIR` - 或者在构建时设置的内置值 - - 或者包含Gitea二进制文件的目录 + - 或者包含 Gitea 二进制文件的目录 - `%(APP_DATA_PATH)`（数据库、索引器等的默认路径） - `app.ini`中的`APP_DATA_PATH` - - 或者_`AppWorkPath`_`/data` + - 或者*`AppWorkPath`*`/data` - _`CustomPath`_（自定义模板） - `--custom-path`标志 - 或者环境变量`GITEA_CUSTOM` - 或者在构建时设置的内置值 - - 或者_`AppWorkPath`_`/custom` + - 或者*`AppWorkPath`*`/custom` - HomeDir - Unix：环境变量`HOME` - Windows：环境变量`USERPROFILE`，或者环境变量`HOMEDRIVE`+`HOMEPATH` - RepoRootPath - `app.ini`中\[repository]部分的`ROOT`（如果是绝对路径） - - 否则_`AppWorkPath`_`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） + - 否则*`AppWorkPath`*`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） - 默认值为`%(APP_DATA_PATH)/gitea-repositories` - INI（配置文件） - `--config`标志 - 或者在构建时设置的可能内置值 - 或者 _`CustomPath`_`/conf/app.ini` -- SQLite数据库 - - app.ini中database部分的PATH +- SQLite 数据库 + - app.ini 中 database 部分的 PATH - 或者`%(APP_DATA_PATH)/gitea.db` -## 看不到克隆URL或克隆URL不正确 +## 看不到克隆 URL 或克隆 URL 不正确 有几个地方可能会导致显示不正确。 1. 如果使用反向代理，请确保按照[反向代理指南](../administration/reverse-proxies.md)中的正确说明进行设置。 2. 确保在`app.ini`的`server`部分中正确设置了`ROOT_URL`。 -如果某些克隆选项未显示（HTTP/S或SSH），可以在`app.ini中` +如果某些克隆选项未显示（HTTP/S 或 SSH），可以在`app.ini中` -- `DISABLE_HTTP_GIT`: 如果设为true, 将会没有HTTP/HTTPS链接 -- `DISABLE_SSH`: 如果设为true, 将会没有SSH链接 -- `SSH_EXPOSE_ANONYMOUS`: 如果设为false, SSH链接将会对匿名用户隐藏 +- `DISABLE_HTTP_GIT`: 如果设为 true, 将会没有 HTTP/HTTPS 链接 +- `DISABLE_SSH`: 如果设为 true, 将会没有 SSH 链接 +- `SSH_EXPOSE_ANONYMOUS`: 如果设为 false, SSH 链接将会对匿名用户隐藏 ## 文件上传失败：413 Request Entity Too Large 当反向代理限制文件上传大小时，会出现此错误。 -有关使用nginx解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 +有关使用 nginx 解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 ## 自定义模板无法加载或运行错误 -Gitea的自定义模板必须将其添加到正确的位置，否则Gitea将无法找到并使用自定义模板。 +Gitea 的自定义模板必须将其添加到正确的位置，否则 Gitea 将无法找到并使用自定义模板。 模板的正确路径应该相对于`CustomPath`。 1. 要找到`CustomPath`，请在站点管理 -> 配置 中查找自定义文件根路径。 - 如果找不到，请尝试`echo $GITEA_CUSTOM`。 + 如果找不到，请尝试`echo $GITEA_CUSTOM`。 2. 如果仍然找不到，默认值可以被[计算](faq.md#Gitea存储文件的位置) -3. 如果仍然找不到路径，则可以参考[自定义Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 +3. 如果仍然找不到路径，则可以参考[自定义 Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 -## Gitea是否有"GitHub/GitLab Pages"功能？ +## Gitea 是否有"GitHub/GitLab Pages"功能？ -Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供静态页面，以避免CSRF安全风险。 +Gitea 不提供内置的 Pages 服务器。您需要一个专用的域名来提供静态页面，以避免 CSRF 安全风险。 -对于简单的用法，您可以使用反向代理来重写和提供Gitea的原始文件URL中的静态内容。 +对于简单的用法，您可以使用反向代理来重写和提供 Gitea 的原始文件 URL 中的静态内容。 还有一些已经可用的第三方服务，比如独立[pages server](https://codeberg.org/Codeberg/pages-server)的或[caddy plugin](https://github.com/42wim/caddy-gitea)，可以提供所需的功能。 ## 活跃用户与禁止登录用户 -在Gitea中，"活跃用户"是指通过电子邮件激活其帐户的用户。 +在 Gitea 中，"活跃用户"是指通过电子邮件激活其帐户的用户。 -"禁止登录用户"是指不允许再登录到Gitea的用户。 +"禁止登录用户"是指不允许再登录到 Gitea 的用户。 ## 设置日志记录 - [官方文档](../administration/logging-config.md) -## 什么是Swagger？ +## 什么是 Swagger？ -[Swagger](https://swagger.io/) 是Gitea用于其API文档的工具。 +[Swagger](https://swagger.io/) 是 Gitea 用于其 API 文档的工具。 -所有Gitea实例都有内置的API，无法完全禁用它。 -但是，您可以在app.ini的api部分将ENABLE_SWAGGER设置为false，以禁用其文档显示。 -有关更多信息，请参阅Gitea的[API文档](development/api-usage.md)。 +所有 Gitea 实例都有内置的 API，无法完全禁用它。 +但是，您可以在 app.ini 的 api 部分将 ENABLE_SWAGGER 设置为 false，以禁用其文档显示。 +有关更多信息，请参阅 Gitea 的[API 文档](development/api-usage.md)。 -您可以在上查看最新的API（例如）https://gitea.com/api/swagger +您可以在上查看最新的 API（例如）https://gitea.com/api/swagger 您还可以在上查看`swagger.json`文件的示例 https://gitea.com/swagger.v1.json @@ -143,7 +143,7 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 有多种方法可以组合使用来防止垃圾邮件发送者： 1. 通过设置电子邮件域名的白名单或黑名单。 -2. 通过设置一些域名或者OpenID白名单（见下文）。 +2. 通过设置一些域名或者 OpenID 白名单（见下文）。 3. 在您的`app.ini`中将`ENABLE_CAPTCHA`设置为`true`，并正确配置`RECAPTCHA_SECRET`和 `RECAPTCHA_SITEKEY`。 4. 将`DISABLE_REGISTRATION`设置为`true`，并通过 [CLI](../administration/command-line.md)、[API](development/api-usage.md) 或 Gitea 的管理界面创建新用户。 @@ -173,13 +173,13 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 使用 [Fail2Ban](../administration/fail2ban-setup.md) 监视并阻止基于日志模式的自动登录尝试或其他恶意行为。 -## SSHD vs 内建SSH +## SSHD vs 内建 SSH -SSHD是大多数Unix系统上内建的SSH服务器。 +SSHD 是大多数 Unix 系统上内建的 SSH 服务器。 -Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 +Gitea 还提供了自己的 SSH 服务器，用于在 SSHD 不可用时使用。 -## Gitea运行缓慢 +## Gitea 运行缓慢 导致此问题的最常见原因是加载联合头像。 @@ -189,21 +189,21 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 ## 无法创建仓库/文件 -请确保Gitea具有足够的权限来写入其主目录和数据目录。 +请确保 Gitea 具有足够的权限来写入其主目录和数据目录。 参见[AppDataPath 和 RepoRootPath](faq.md#Gitea存储文件的位置) -**适用于Arch用户的注意事项：**在撰写本文时，Arch软件包的systemd文件包含了以下行： +**适用于 Arch 用户的注意事项：**在撰写本文时，Arch 软件包的 systemd 文件包含了以下行： `ReadWritePaths=/etc/gitea/app.ini` -这将使得Gitea无法写入其他路径。 +这将使得 Gitea 无法写入其他路径。 ## 翻译不正确/如何添加更多翻译 -我们当前的翻译是在我们的[Crowdin项目](https://crowdin.com/project/gitea)上众包进行的 +我们当前的翻译是在我们的[Crowdin 项目](https://crowdin.com/project/gitea)上众包进行的 -无论您想要更改翻译还是添加新的翻译，都需要在Crowdin集成中进行，因为所有翻译都会被CI覆盖。 +无论您想要更改翻译还是添加新的翻译，都需要在 Crowdin 集成中进行，因为所有翻译都会被 CI 覆盖。 ## 推送钩子/ Webhook / Actions 未运行 @@ -211,15 +211,15 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 这可能是由于以下原因： -1. Git钩子不同步：在站点管理面板上运行“重新同步所有仓库的pre-receive、update和post-receive钩子” -2. Git仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由NAS挂载），请确保文件系统支持`chmod a+x any-script` -3. 如果您使用的是Docker，请确保Docker Server（而不是客户端）的版本 >= 20.10.6 +1. Git 钩子不同步：在站点管理面板上运行“重新同步所有仓库的 pre-receive、update 和 post-receive 钩子” +2. Git 仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由 NAS 挂载），请确保文件系统支持`chmod a+x any-script` +3. 如果您使用的是 Docker，请确保 Docker Server（而不是客户端）的版本 >= 20.10.6 -## SSH问题 +## SSH 问题 如果无法通过`ssh`访问仓库，但`https`正常工作，请考虑以下情况。 -首先，请确保您可以通过SSH访问Gitea。 +首先，请确保您可以通过 SSH 访问 Gitea。 `ssh git@myremote.example` @@ -247,16 +247,18 @@ fatal: Could not read from remote repository. - 在客户端： - 确保公钥和私钥已添加到正确的 Gitea 用户。 - - 确保远程 URL 中没有任何问题。特别是，请确保∂ - Git 用户（@ 之前的部分）的名称拼写正确。 + - 确保远程 URL 中没有任何问题。特别是，请确保 ∂ + Git 用户（@ 之前的部分）的名称拼写正确。 - 确保客户端机器上的公钥和私钥正确无误。 - 在服务器上： + - 确保存储库存在并且命名正确。 - 检查系统用户主目录中的 `.ssh` 目录的权限。 - 验证正确的公钥是否已添加到 `.ssh/authorized_keys` 中。 尝试在 Gitea 管理面板上运行 `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)`。 + - 查看 Gitea 日志。 - 查看 /var/log/auth（或类似的文件）。 - 检查存储库的权限。 @@ -328,7 +330,9 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 - 使用[管理 CLI 命令](../administration/command-line.md#admin)。 请注意，大多数命令还需要一个[全局标志](../administration/command-line.md#全局选项)来指向正确的配置。 + - 作为**用户**，您可以更改密码... + - 在您的账户的`设置 -> 账户`页面（此方法**需要**您知道当前密码）。 - 使用`忘记密码`链接。 @@ -338,7 +342,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 在 Gitea 版本 `1.11` 中，我们转换为使用[goldmark](https://github.com/yuin/goldmark)进行 Markdown 渲染，它符合[CommonMark](https://commonmark.org/)标准。 -如果您在版本`1.11`之前的Markdown正常工作，但在升级后无法正常工作，请仔细阅读CommonMark规范，看看问题是由错误还是非兼容的语法引起的。 +如果您在版本`1.11`之前的 Markdown 正常工作，但在升级后无法正常工作，请仔细阅读 CommonMark 规范，看看问题是由错误还是非兼容的语法引起的。 如果是后者，通常规范中会列出一种符合标准的替代方法。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/support.md index 1e291061..b191f7c6 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/support.md @@ -58,12 +58,12 @@ Gitea 可以使用 Golang 的 pprof 处理程序和工具链来收集堆栈跟 1. 设置 app.ini： - ``` - [server] - ENABLE_PPROF = true - ``` + ``` + [server] + ENABLE_PPROF = true + ``` 2. 重新启动 Gitea -3. 尝试触发bug，当请求卡住一段时间，使用或浏览器访问：获取堆栈跟踪。 -`curl http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` +3. 尝试触发 bug，当请求卡住一段时间，使用或浏览器访问：获取堆栈跟踪。 + `curl http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/comparison.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/comparison.md index ae9ca785..68d6c795 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/comparison.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/comparison.md @@ -14,68 +14,68 @@ aliases: _表格中的符号含义:_ -* _✓ - 支持_ +- _✓ - 支持_ -* _⁄ - 部分支持_ +- _⁄ - 部分支持_ -* _✘ - 不支持_ +- _✘ - 不支持_ -* _⚙️ - 由第三方服务或插件支持_ +- _⚙️ - 由第三方服务或插件支持_ #### 主要特性 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------- | -------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | -| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | -| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | -| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | -| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | -| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | -| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | -| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | -| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | -| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | -| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | -| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | -| Markdown绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Markdown数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | +| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | +| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | +| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | +| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | +| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | +| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | +| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | +| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | +| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | +| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | +| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | +| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | +| Markdown 绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Markdown 数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | #### 代码管理 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------------ | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | -| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | -| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | -| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | -| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | -| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | -| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | +| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | +| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | +| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | +| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | +| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | +| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | #### 工单管理 @@ -93,7 +93,7 @@ _表格中的符号含义:_ | 工单批处理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单看板 | [✓](https://github.com/go-gitea/gitea/pull/8346) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 从工单创建分支 | ✘ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单全局搜索 | [✘](https://github.com/go-gitea/gitea/issues/2434) | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单依赖关系 | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | @@ -115,7 +115,7 @@ _表格中的符号含义:_ | Pull/Merge requests 模板 | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | | 查看 Cherry-picking 的更改 | [✓](https://github.com/go-gitea/gitea/issues/5158) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 下载 Patch | ✓ | ✘ | ✓ | ✓ | ✓ | [/](https://jira.atlassian.com/plugins/servlet/mobile#issue/BCLOUD-8323) | ✘ | -| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | +| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | #### 第三方集成 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/database-preparation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/database-preparation.md index 2cee91be..4c76c21f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/database-preparation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/database-preparation.md @@ -20,153 +20,153 @@ aliases: 1. 对于远程数据库设置，您需要让 MySQL 监听您的 IP 地址。编辑数据库实例上的 `/etc/mysql/my.cnf` 文件中的 `bind-address` 选项为： - ```ini - bind-address = 203.0.113.3 - ``` + ```ini + bind-address = 203.0.113.3 + ``` 2. 在数据库实例上，使用 `root` 用户登录到数据库控制台： - ``` - mysql -u root -p - ``` + ``` + mysql -u root -p + ``` - 按提示输入密码。 + 按提示输入密码。 3. 创建一个将被 Gitea 使用的数据库用户，并使用密码进行身份验证。以下示例中使用了 `'gitea'` 作为密码。请为您的实例使用一个安全密码。 - 对于本地数据库： + 对于本地数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea' IDENTIFIED BY 'gitea'; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; + ``` - 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 + 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 - 根据需要替换上述用户名和密码。 + 根据需要替换上述用户名和密码。 4. 使用 UTF-8 字符集和大小写敏感的排序规则创建数据库。 - `utf8mb4_bin` 是 MySQL/MariaDB 的通用排序规则。 - Gitea 启动后会尝试把数据库修改为更合适的字符集 (`utf8mb4_0900_as_cs` 或者 `uca1400_as_cs`) 并在可能的情况下更改数据库。 - 如果你想指定自己的字符集规则，可以在 `app.ini` 中设置 `[database].CHARSET_COLLATION`。 + `utf8mb4_bin` 是 MySQL/MariaDB 的通用排序规则。 + Gitea 启动后会尝试把数据库修改为更合适的字符集 (`utf8mb4_0900_as_cs` 或者 `uca1400_as_cs`) 并在可能的情况下更改数据库。 + 如果你想指定自己的字符集规则，可以在 `app.ini` 中设置 `[database].CHARSET_COLLATION`。 - ```sql - CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin'; - ``` + ```sql + CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 5. 将数据库上的所有权限授予上述创建的数据库用户。 - 对于本地数据库： + 对于本地数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; + FLUSH PRIVILEGES; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; + FLUSH PRIVILEGES; + ``` 6. 通过 `exit` 退出数据库控制台。 7. 在您的 Gitea 服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h 203.0.113.3 -p giteadb - ``` + ``` + mysql -u gitea -h 203.0.113.3 -p giteadb + ``` - 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 `-h` 选项。 + 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 `-h` 选项。 - 到此您应该能够连接到数据库了。 + 到此您应该能够连接到数据库了。 ## PostgreSQL 1. 对于远程数据库设置，通过编辑数据库实例上的 postgresql.conf 文件中的 `listen_addresses` 将 `PostgreSQL` 配置为监听您的 IP 地址： - ```ini - listen_addresses = 'localhost, 203.0.113.3' - ``` + ```ini + listen_addresses = 'localhost, 203.0.113.3' + ``` 2. PostgreSQL 默认使用 `md5` 质询-响应加密方案进行密码身份验证。现在这个方案不再被认为是安全的。改用 SCRAM-SHA-256 方案，通过编辑数据库服务器上的` postgresql.conf` 配置文件： - ```ini - password_encryption = scram-sha-256 - ``` + ```ini + password_encryption = scram-sha-256 + ``` - 重启 PostgreSQL 以应用该设置。 + 重启 PostgreSQL 以应用该设置。 3. 在数据库服务器上，以超级用户身份登录到数据库控制台： - ``` - su -c "psql" - postgres - ``` + ``` + su -c "psql" - postgres + ``` 4. 创建具有登录权限和密码的数据库用户（在 PostgreSQL 术语中称为角色）。请使用安全的、强密码，而不是下面的 `'gitea'`： - ```sql - CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; - ``` + ```sql + CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; + ``` - 根据需要替换用户名和密码。 + 根据需要替换用户名和密码。 5. 使用 UTF-8 字符集创建数据库，并由之前创建的数据库用户拥有。可以根据预期内容使用任何 `libc` 排序规则，使用 `LC_COLLATE` 和 `LC_CTYPE` 参数指定： - ```sql - CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; - ``` + ```sql + CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 6. 通过将以下身份验证规则添加到 `pg_hba.conf`，允许数据库用户访问上面创建的数据库。 - 对于本地数据库： + 对于本地数据库： - ```ini - local giteadb gitea scram-sha-256 - ``` + ```ini + local giteadb gitea scram-sha-256 + ``` - 对于远程数据库： + 对于远程数据库： - ```ini - host giteadb gitea 192.0.2.10/32 scram-sha-256 - ``` + ```ini + host giteadb gitea 192.0.2.10/32 scram-sha-256 + ``` - 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 + 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 - 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 + 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 - 重启 PostgreSQL 以应用新的身份验证规则。 + 重启 PostgreSQL 以应用新的身份验证规则。 7. 在您的 Gitea 服务器上，测试与数据库的连接。 - 对于本地数据库： + 对于本地数据库： - ``` - psql -U gitea -d giteadb - ``` + ``` + psql -U gitea -d giteadb + ``` - 对于远程数据库： + 对于远程数据库： - ``` - psql "postgres://gitea@203.0.113.3/giteadb" - ``` + ``` + psql "postgres://gitea@203.0.113.3/giteadb" + ``` - 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 + 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 - 您应该会被提示输入数据库用户的密码，并连接到数据库。 + 您应该会被提示输入数据库用户的密码，并连接到数据库。 ## 使用 TLS 进行数据库连接 @@ -185,116 +185,116 @@ Gitea 使用的 PostgreSQL 驱动程序支持双向 TLS。在双向 TLS 中， 1. 在数据库实例所在的服务器上，放置以下凭据： - - `/path/to/postgresql.crt`: 数据库实例证书 - - `/path/to/postgresql.key`: 数据库实例私钥 - - `/path/to/root.crt`: 用于验证客户端证书的CA证书链 + - `/path/to/postgresql.crt`: 数据库实例证书 + - `/path/to/postgresql.key`: 数据库实例私钥 + - `/path/to/root.crt`: 用于验证客户端证书的 CA 证书链 2. 在 `postgresql.conf` 中添加以下选项： - ```ini - ssl = on - ssl_ca_file = '/path/to/root.crt' - ssl_cert_file = '/path/to/postgresql.crt' - ssl_key_file = '/path/to/postgresql.key' - ssl_min_protocol_version = 'TLSv1.2' - ``` + ```ini + ssl = on + ssl_ca_file = '/path/to/root.crt' + ssl_cert_file = '/path/to/postgresql.crt' + ssl_key_file = '/path/to/postgresql.key' + ssl_min_protocol_version = 'TLSv1.2' + ``` 3. 根据 PostgreSQL 的要求，调整凭据的所有权和权限： - ``` - chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - ``` + ``` + chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + ``` -4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过SSL连接，并要求客户端证书验证。 +4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过 SSL 连接，并要求客户端证书验证。 - 对于PostgreSQL 12： + 对于 PostgreSQL 12： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full + ``` - 对于PostgreSQL 11及更早版本： + 对于 PostgreSQL 11 及更早版本： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 + ``` - 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 + 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 5. 重新启动 PostgreSQL 以应用上述配置。 6. 在运行 Gitea 实例的服务器上，将以下凭据放置在运行 Gitea 的用户的主目录下（例如 `git`）： - - `~/.postgresql/postgresql.crt`: 数据库客户端证书 - - `~/.postgresql/postgresql.key`: 数据库客户端私钥 - - `~/.postgresql/root.crt`: 用于验证服务器证书的CA证书链 + - `~/.postgresql/postgresql.crt`: 数据库客户端证书 + - `~/.postgresql/postgresql.key`: 数据库客户端私钥 + - `~/.postgresql/root.crt`: 用于验证服务器证书的 CA 证书链 - 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 + 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 7. 根据需要调整凭据、所有权和权限： - ``` - chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - ``` + ``` + chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + ``` 8. 测试与数据库的连接： - ``` - psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" - ``` + ``` + psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" + ``` - 您将被提示输入数据库用户的密码，然后连接到数据库。 + 您将被提示输入数据库用户的密码，然后连接到数据库。 ### MySQL/MariaDB TLS -虽然 Gitea 使用的MySQL驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 +虽然 Gitea 使用的 MySQL 驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 -在单向TLS中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 +在单向 TLS 中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 1. 在数据库实例上放置以下凭据： - - `/path/to/mysql.crt`: 数据库实例证书 - - `/path/to/mysql.key`: 数据库实例密钥 - - `/path/to/ca.crt`: CA证书链。在单向TLS中不使用此文件，但用于验证双向TLS中的客户端证书。 + - `/path/to/mysql.crt`: 数据库实例证书 + - `/path/to/mysql.key`: 数据库实例密钥 + - `/path/to/ca.crt`: CA 证书链。在单向 TLS 中不使用此文件，但用于验证双向 TLS 中的客户端证书。 2. 将以下选项添加到 `my.cnf`： - ```ini - [mysqld] - ssl-ca = /path/to/ca.crt - ssl-cert = /path/to/mysql.crt - ssl-key = /path/to/mysql.key - tls-version = TLSv1.2,TLSv1.3 - ``` + ```ini + [mysqld] + ssl-ca = /path/to/ca.crt + ssl-cert = /path/to/mysql.crt + ssl-key = /path/to/mysql.key + tls-version = TLSv1.2,TLSv1.3 + ``` 3. 调整凭据的所有权和权限： - ``` - chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - ``` + ``` + chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + ``` -4. 重新启动MySQL以应用设置。 +4. 重新启动 MySQL 以应用设置。 5. Gitea 的数据库用户可能已经创建过，但只会对运行 Gitea 的服务器的 IP 地址进行身份验证。要对其域名进行身份验证，请重新创建用户，并设置其需要通过 TLS 连接到数据库： - ```sql - DROP USER 'gitea'@'192.0.2.10'; - CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + DROP USER 'gitea'@'192.0.2.10'; + CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; + FLUSH PRIVILEGES; + ``` - 根据需要替换数据库用户名、密码和 Gitea 实例域名。 + 根据需要替换数据库用户名、密码和 Gitea 实例域名。 -6. 确保用于验证数据库服务器证书的CA证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 +6. 确保用于验证数据库服务器证书的 CA 证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 -7. 在运行Gitea的服务器上，测试与数据库的连接： +7. 在运行 Gitea 的服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h example.db -p --ssl - ``` + ``` + mysql -u gitea -h example.db -p --ssl + ``` - 至此应该成功连接到数据库了。 + 至此应该成功连接到数据库了。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-binary.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-binary.md index f16d687d..f940b094 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-binary.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-binary.md @@ -35,7 +35,7 @@ chmod +x gitea ## 验证 GPG 签名 -Gitea 对打包的二进制文件使用 [GPG密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 +Gitea 对打包的二进制文件使用 [GPG 密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 请根据对应文件名 `.asc` 中包含的校验码检验文件的一致性。 ```sh @@ -166,7 +166,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini **提示：** 我们不建议使用 SIGKILL 信号（`-9`），这会强制停止 Gitea 程序，但不会正确关闭队列、索引器等任务。 -请参阅下面的疑难解答说明，以在Gitea版本更新后修复损坏的仓库。 +请参阅下面的疑难解答说明，以在 Gitea 版本更新后修复损坏的仓库。 ## 排查故障 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-source.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-source.md index 8e51c540..a05edd39 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-source.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/from-source.md @@ -8,7 +8,7 @@ aliases: # 使用源代码安装 -你需要 [安装Go](https://golang.google.cn/doc/install) 并正确设置Go环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 +你需要 [安装 Go](https://golang.google.cn/doc/install) 并正确设置 Go 环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 接下来，[安装 Node.js 和 npm](https://nodejs.org/zh-cn/download/)， 这是构建 JavaScript 和 CSS 文件所需的。最低支持的 Node.js 版本是 @minNodeVersion@，建议使用最新的 LTS 版本。 @@ -33,7 +33,7 @@ git branch -a git checkout @sourceBranch@ ``` -要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID是 `2663 `）： +要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID 是 `2663 `）： ```bash git fetch origin pull/xyz/head:pr-xyz @@ -55,7 +55,7 @@ git checkout @sourceVersion@ # or git checkout pr-xyz - `node` @minNodeVersion@ 或更高版本，并且安装 `npm`, 请参阅 [这里](https://nodejs.org/zh-cn/download/) - `make`, 请参阅 [这里](development/hacking-on-gitea.md) -为了尽可能简化编译过程，提供了各种 [make任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 +为了尽可能简化编译过程，提供了各种 [make 任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 根据你的构建需求，以下 tags 可以使用： @@ -103,7 +103,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite 尽管在开发时这些值很有用，但可能与下游用户的偏好冲突。 -一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行Gitea之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： +一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行 Gitea 之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： - 要设置`CustomPath`，请使用`LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.CustomPath=custom-path\""` - 对于`CustomConf`，应该使用`-X \"code.gitea.io/gitea/modules/setting.CustomConf=conf.ini\"` @@ -119,7 +119,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite `go`编译器工具链支持将代码交叉编译到不同的目标架构上。请参考[`GOOS`和`GOARCH`环境变量](https://go.dev/doc/install/source#environment) 以获取支持的目标列表。如果您想为性能较弱的系统（如树莓派）构建 Gitea，交叉编译非常有用。 -要使用构建标签（`TAGS`）进行交叉编译Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 +要使用构建标签（`TAGS`）进行交叉编译 Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 在没有任何标签的情况下，交叉编译的 Gitea 为 Linux ARM64 版本： @@ -127,7 +127,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite GOOS=linux GOARCH=arm64 make build ``` -要交叉编译 Linux ARM64 下的Gitea，这是推荐的构建标签： +要交叉编译 Linux ARM64 下的 Gitea，这是推荐的构建标签： ``` CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sqlite_unlock_notify" make build @@ -213,6 +213,6 @@ make build 默认情况下，gitea 会为前端文件生成精简的 Source Map 以节省空间。 这可以通过“ENABLE_SOURCEMAP”环境变量进行控制： -- `ENABLE_SOURCEMAP=true` 生成所有Source Map，这是开发版本的默认设置 -- `ENABLE_SOURCEMAP=reduced` 生成有限的Source Map，这是生产版本的默认设置 -- `ENABLE_SOURCEMAP=false` 不生成Source Map +- `ENABLE_SOURCEMAP=true` 生成所有 Source Map，这是开发版本的默认设置 +- `ENABLE_SOURCEMAP=reduced` 生成有限的 Source Map，这是生产版本的默认设置 +- `ENABLE_SOURCEMAP=false` 不生成 Source Map diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-cloud-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-cloud-provider.md index 35499877..2cd15123 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-cloud-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-cloud-provider.md @@ -15,9 +15,9 @@ Cloudron 使得在您的服务器上运行 Gitea，并保持其更新和安全 [![Install](/cloudron.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp) -Gitea软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). +Gitea 软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). -这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行Gitea。 +这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行 Gitea。 ## Linode diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-kubernetes.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-kubernetes.md index ddc3d68a..b127e830 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-kubernetes.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/on-kubernetes.md @@ -35,15 +35,15 @@ helm install gitea -f values.yaml gitea/gitea Gitea 附带了一个运行状况检查接口 `/api/healthz`，你可以像这样在 Kubernetes 中配置它： ```yaml - livenessProbe: - httpGet: - path: /api/healthz - port: http - initialDelaySeconds: 200 - timeoutSeconds: 5 - periodSeconds: 10 - successThreshold: 1 - failureThreshold: 10 +livenessProbe: + httpGet: + path: /api/healthz + port: http + initialDelaySeconds: 200 + timeoutSeconds: 5 + periodSeconds: 10 + successThreshold: 1 + failureThreshold: 10 ``` 成功的运行状况检查响应代码为 HTTP `200`，下面是示例： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/windows-service.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/windows-service.md index c066d40c..d991cb77 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/windows-service.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/windows-service.md @@ -6,7 +6,7 @@ aliases: - /zh-cn/windows-service --- -# 注册为Windows服务 +# 注册为 Windows 服务 ## 准备工作 @@ -29,9 +29,9 @@ COMPUTERNAME 是从命令行中运行 `echo %COMPUTERNAME%` 后得到的响应 PATH = c:/gitea/data/gitea.db ``` -## 注册为Windows服务 +## 注册为 Windows 服务 -要注册为Windows服务，首先以Administrator身份运行 `cmd`，然后执行以下命令： +要注册为 Windows 服务，首先以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\"" @@ -39,7 +39,7 @@ sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \" 别忘了将 `C:\gitea` 替换成你的 Gitea 安装目录。 -之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000是默认端口）。 +之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000 是默认端口）。 ### 服务启动类型 @@ -60,9 +60,9 @@ sc.exe config gitea depend= mariadb 这将确保在 Windows 计算机重新启动时，将延迟自动启动 Gitea，直到数据库准备就绪，从而减少启动失败的情况。 -## 从Windows服务中删除 +## 从 Windows 服务中删除 -以Administrator身份运行 `cmd`，然后执行以下命令： +以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc.exe delete gitea diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker-rootless.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker-rootless.md index 1dcd2d6b..be04d7e4 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker-rootless.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker-rootless.md @@ -45,7 +45,7 @@ services: - "2222:2222" ``` -请注意，卷应由在配置文件中指定的UID/GID的用户/组所有。默认情况下，Docker中的Gitea将使用uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： +请注意，卷应由在配置文件中指定的 UID/GID 的用户/组所有。默认情况下，Docker 中的 Gitea 将使用 uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： ```sh sudo chown 1000:1000 config/ data/ @@ -53,11 +53,11 @@ sudo chown 1000:1000 config/ data/ > 如果未为卷设置正确的权限，容器可能无法启动。 -对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 +对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x 是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 ## 自定义端口 -要将集成的SSH和Web服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 +要将集成的 SSH 和 Web 服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 ```diff version: "2" @@ -258,7 +258,7 @@ docker-compose up -d 除了上述的环境变量外，`app.ini` 中的任何设置都可以通过形式为 `GITEA__SECTION_NAME__KEY_NAME` 的环境变量进行设置或覆盖。这些设置在每次 Docker 容器启动时都会生效。完整信息请参考[这里](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini). -这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA__mailer__FROM、GITEA__mailer__HOST、GITEA__mailer__PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： +这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA**mailer**FROM、GITEA**mailer**HOST、GITEA**mailer**PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： ```bash ... diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker.md index 7a409489..0cceeca8 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/installation/with-docker.md @@ -296,7 +296,7 @@ docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKE ``` ```yaml -... +--- services: server: environment: diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/clone-filter.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/clone-filter.md index f14b0375..90b6709c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/clone-filter.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/clone-filter.md @@ -5,7 +5,6 @@ slug: "clone-filters" sidebar_position: 25 aliases: - /zh-cn/clone-filters - --- # 克隆过滤器 (部分克隆) diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/incoming-email.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/incoming-email.md index 4ae55422..c91d1ae9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/incoming-email.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/incoming-email.md @@ -5,7 +5,6 @@ slug: "incoming-email" sidebar_position: 13 aliases: - /zh-cn/incoming-email - --- # 邮件接收 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/issue-pull-request-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/issue-pull-request-templates.md index 7302368b..07dde742 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/issue-pull-request-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/issue-pull-request-templates.md @@ -100,16 +100,13 @@ Gitea 支持两种格式的模板：Markdown 和 YAML。 ```md --- - name: "Template Name" about: "This template is for testing!" title: "[TEST] " ref: "main" labels: - -- bug -- "help needed" - + - bug + - "help needed" --- This is the template! diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/linked-references.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/linked-references.md index fe760eb7..2d151d4c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/linked-references.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/linked-references.md @@ -90,11 +90,11 @@ aliases: - `m` - 分钟 - `h` - 小时 -- `d` - 天（相当于8小时） -- `w` - 周（相当于5天） -- `mo` - 月（相当于4周） +- `d` - 天（相当于 8 小时） +- `w` - 周（相当于 5 天） +- `mo` - 月（相当于 4 周） -用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示1小时10分钟。 +用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示 1 小时 10 分钟。 提交消息示例： @@ -115,26 +115,26 @@ Gitea 支持使用外部工单跟踪器，并可以在合并请求中创建对 下表说明了工单和合并请求的不同类型的交叉引用。在示例中，`User1/Repo1` 指的是使用引用的仓库，而 `UserZ/RepoZ` 表示另一个仓库。 -| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | -| ----------------------- | :-------------------: | :-------------------: | ------------------------------------------------ | -| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | -| **字母数字工单编号:** | - | - | - | -| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | +| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | +| ----------------------- | :------------------: | :------------------: | --------------------------------------------- | +| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | +| **字母数字工单编号:** | - | - | - | +| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | _最后一部分适用于使用字母数字格式的外部工单跟踪器的仓库。_ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/merge-message-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/merge-message-templates.md index 4c0c79e3..ebfeab7f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/merge-message-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/merge-message-templates.md @@ -5,7 +5,6 @@ sidebar_position: 15 aliases: - /zh-cn/merge-message-templates - --- # 合并消息模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/permissions.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/permissions.md index fae08cd6..bbe0088d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/permissions.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/permissions.md @@ -14,35 +14,35 @@ Gitea 支持对仓库进行权限管理，这样您就可以为不同的人员 在 Gitea 中，我们将仓库的子模块称为 `单元（Unit）`。现在我们有以下几个单元。 -| 名称 | 描述 | 权限 | -| ----------------- | --------------------------------------------------- | ------------ | -| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | -| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | -| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | -| 发布 | 跟踪项目版本和下载。 | 读取 写入 | -| 百科 | 与协作者编写和共享文档。 | 读取 写入 | -| 外部百科 | 链接到外部维基。 | 读取 | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | -| 项目 | 模板仓库的 URL。 | 读取 写入 | -| 包 | 链接到仓库 | 读取 写入 | -| Actions | 审查Actions日志或重启/取消工作流 | 读取 写入 | -| 设置 | 管理仓库。 | 管理员 | +| 名称 | 描述 | 权限 | +| -------------- | ---------------------------------- | --------- | +| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | +| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | +| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | +| 发布 | 跟踪项目版本和下载。 | 读取 写入 | +| 百科 | 与协作者编写和共享文档。 | 读取 写入 | +| 外部百科 | 链接到外部维基。 | 读取 | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | +| 项目 | 模板仓库的 URL。 | 读取 写入 | +| 包 | 链接到仓库 | 读取 写入 | +| Actions | 审查 Actions 日志或重启/取消工作流 | 读取 写入 | +| 设置 | 管理仓库。 | 管理员 | 通过不同的权限，用户可以在这些单元上执行不同的操作。 -| 名称 | 读取 | 写入 | 管理员 | -| ----------------- | -------------------------------------------------- | ------------------------------ | ------------------------- | -| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | -| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | -| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | -| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | -| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | -| 外部百科 | 链接到外部百科。 | - | - | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | -| 项目 | 查看面板。 | 在面板之间移动工单。 | - | -| 包 | 查看包 | 上传/删除包 | - | -| Actions | 查看 Actions日志 | 同意 / 取消 / 重启 | - | -| 设置 | - | - | 管理仓库 | +| 名称 | 读取 | 写入 | 管理员 | +| -------------- | -------------------------------- | ------------------------------ | -------- | +| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | +| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | +| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | +| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | +| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | +| 外部百科 | 链接到外部百科。 | - | - | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | +| 项目 | 查看面板。 | 在面板之间移动工单。 | - | +| 包 | 查看包 | 上传/删除包 | - | +| Actions | 查看 Actions 日志 | 同意 / 取消 / 重启 | - | +| 设置 | - | - | 管理仓库 | 个人仓库和组织仓库之间的权限存在一些差异。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/protected-tags.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/protected-tags.md index 307b048f..1bc4b8a2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/protected-tags.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/protected-tags.md @@ -25,17 +25,17 @@ aliases: 示例： -| 类型 | 模式受保护的标签 | 可能匹配的标签 | +| 类型 | 模式受保护的标签 | 可能匹配的标签 | | ----- | ------------------------ | --------------------------------------- | | Glob | `v*` | `v`，`v-1`，`version2` | -| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | +| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | | Glob | `*-release` | `2.1-release`，`final-release` | | Glob | `gitea` | 仅限 `gitea` | | Glob | `*gitea*` | `gitea`，`2.1-gitea`，`1_gitea-release` | | Glob | `{v,rel}-*` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Glob | `*` | 匹配所有可能的标签名称 | +| Glob | `*` | 匹配所有可能的标签名称 | | Regex | `/\Av/` | `v`，`v-1`，`version2` | -| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | +| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | | Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`，`v2.1.0` | | Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`，`v2.1`，`v1.2.34` | | Regex | `/-release\z/` | `2.1-release`，`final-release` | @@ -43,4 +43,4 @@ aliases: | Regex | `/\Agitea\z/` | 仅限 `gitea` | | Regex | `/^gitea$/` | 仅限 `gitea` | | Regex | `/\A(v\|rel)-/` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Regex | `/.+/` | 匹配所有可能的标签名称 | +| Regex | `/.+/` | 匹配所有可能的标签名称 | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/pull-request.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/pull-request.md index 389ce66e..01b7a7df 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/pull-request.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/pull-request.md @@ -17,15 +17,15 @@ aliases: 要创建合并请求，您需要遵循以下步骤： 1. **Fork 仓库** - 如果您没有直接对仓库进行更改的权限，您需要将仓库 fork 到您自己的账户中。 -这将创建一个您可以对其进行更改的仓库副本。 + 这将创建一个您可以对其进行更改的仓库副本。 2. **创建分支（可选）** - 在 fork 的仓库中创建一个新分支，该分支包含您要提出的更改。 -给分支取一个描述性的名称，以指示更改的内容。 + 给分支取一个描述性的名称，以指示更改的内容。 3. **进行更改** - 进行您想要的更改，提交并将其推送到 fork 的仓库中。 4. **创建合并请求** - 转到原始仓库并转到“合并请求”选项卡。单击“新建合并请求”按钮，并将您的新分支选择为源分支。 -为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 + 为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 ## 评审合并请求 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/repo-mirror.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/repo-mirror.md index b4c7b54a..b89df30d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/repo-mirror.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/repo-mirror.md @@ -53,7 +53,7 @@ aliases: 要从 Gitea 设置镜像到 GitHub，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *public_repo* 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 +1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同，GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史，您也可以使用现有的远程仓库。 3. 在您的 Gitea 仓库设置中，填写**Git 远程仓库 URL**：`https://github.com//.git`。 4. 使用您的 GitHub 用户名填写**授权**字段，并将个人访问令牌作为**密码**。 @@ -66,7 +66,7 @@ aliases: 要从 Gitea 设置镜像到 GitLab，您需要按照以下步骤进行操作： -1. 创建具有 *write_repository* 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 +1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 2. 填写**Git 远程仓库 URL**：`https:////.git`。 3. 在**授权**字段中填写 `oauth2` 作为**用户名**，并将您的 GitLab 个人访问令牌作为**密码**。 4. 选择**添加推送镜像**以保存配置。 @@ -77,7 +77,7 @@ aliases: 要从 Gitea 设置镜像到 Bitbucket，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *Repository Write* 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 +1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 2. 填写**Git 远程仓库 URL**：`https://bitbucket.org//.git`。 3. 使用您的 Bitbucket 用户名填写**授权**字段，并将应用密码作为**密码**。 4. 选择**添加推送镜像**以保存配置。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/template-repositories.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/template-repositories.md index a051d7ba..f9bc1744 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/template-repositories.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/template-repositories.md @@ -42,20 +42,20 @@ a/b/c/d.json 所有变量都必须采用`$VAR`或`${VAR}`的形式。要转义扩展，使用双重`$$`，例如`$$VAR`或`$${VAR}`。 -| 变量 | 扩展为 | 可转换 | -| -------------------- | --------------------------------------------------- | ------------- | -| REPO_NAME | 生成的仓库名称 | ✓ | -| TEMPLATE_NAME | 模板仓库名称 | ✓ | -| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | -| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | -| REPO_OWNER | 生成的仓库所有者 | ✓ | -| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | -| REPO_LINK | 生成的仓库链接 | ✘ | -| TEMPLATE_LINK | 模板仓库链接 | ✘ | -| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | -| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | -| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | -| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | +| 变量 | 扩展为 | 可转换 | +| -------------------- | ----------------------------- | ------ | +| REPO_NAME | 生成的仓库名称 | ✓ | +| TEMPLATE_NAME | 模板仓库名称 | ✓ | +| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | +| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | +| REPO_OWNER | 生成的仓库所有者 | ✓ | +| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | +| REPO_LINK | 生成的仓库链接 | ✘ | +| TEMPLATE_LINK | 模板仓库链接 | ✘ | +| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | +| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | +| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | +| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | ## 转换器 :robot: @@ -65,12 +65,12 @@ Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。 将 `go-sdk` 传递给可用的转换器的效果如下... -| 转换器 | 效果 | -| ----------- | ------------ | -| SNAKE | go_sdk | -| KEBAB | go-sdk | -| CAMEL | goSdk | -| PASCAL | GoSdk | -| LOWER | go-sdk | -| UPPER | GO-SDK | -| TITLE | Go-Sdk | +| 转换器 | 效果 | +| ------ | ------ | +| SNAKE | go_sdk | +| KEBAB | go-sdk | +| CAMEL | goSdk | +| PASCAL | GoSdk | +| LOWER | go-sdk | +| UPPER | GO-SDK | +| TITLE | Go-Sdk | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/webhooks.md b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/webhooks.md index fcb12da2..9210f0b5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/webhooks.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/current/usage/webhooks.md @@ -8,7 +8,7 @@ aliases: # Webhooks -Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks还可以基于组织和整个系统进行配置。 +Gitea 支持用于仓库事件的 Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks 还可以基于组织和整个系统进行配置。 所有事件推送都是 POST 请求。目前支持： - Gitea (也可以是 GET 请求) @@ -26,7 +26,7 @@ Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置 **警告**：自 Gitea 1.13.0 版起，payload 中的 `secret` 字段已被弃用，并将在 1.14.0 版中移除：https://github.com/go-gitea/gitea/issues/11755 -以下是 Gitea 将发送给 payload URL的事件信息示例： +以下是 Gitea 将发送给 payload URL 的事件信息示例： ```http X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473 @@ -182,4 +182,4 @@ if (json_last_error() !== JSON_ERROR_NONE) { ### 授权头（Authorization header） -**从1.19版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 +**从 1.19 版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/command-line.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/command-line.md index e0d69ca6..7dc8e0a5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/command-line.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/command-line.md @@ -59,7 +59,7 @@ aliases: - 选项： - `--email`：要删除的用户的电子邮件。 - `--username`：要删除的用户的用户名。 - - `--id`：要删除的用户的ID。 + - `--id`：要删除的用户的 ID。 - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 - 示例： - `gitea admin user delete --id 1` @@ -168,11 +168,11 @@ aliases: - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 - `--skip-local-2fa`：跳过 2FA 登录。 - `--active`：启用此认证源。 - 备注： - `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： - `--option`、`--option=true` 以启用选项 - `--option=false` 以禁用选项 - 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 - 示例： - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` - `update-smtp`： @@ -281,12 +281,12 @@ aliases: ### cert -生成自签名的SSL证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 - 选项： - - `--host value`：逗号分隔的主机名和IP地址列表，此证书适用于这些主机。支持使用通配符。必填。 - - `--ecdsa-curve value`：用于生成密钥的ECDSA曲线。可选。有效选项为P224、P256、P384、P521。 - - `--rsa-bits value`：要生成的RSA密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：2048）。 + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：2048）。 - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 @@ -295,18 +295,18 @@ aliases: ### dump -将所有文件和数据库导出到一个zip文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 - 选项： - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 - `--skip-repository`，`-R`：跳过仓库的导出。可选。 - `--skip-custom-dir`：跳过自定义目录的导出。可选。 - - `--skip-lfs-data`：跳过LFS数据的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 - `--skip-attachment-data`：跳过附件数据的导出。可选。 - `--skip-package-data`：跳过包数据的导出。可选。 - `--skip-log`：跳过日志数据的导出。可选。 - - `--database`，`-d`：指定数据库的SQL语法。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 - `--type`：设置导出的格式。可选。（默认值：zip） - 示例： @@ -409,19 +409,19 @@ gitea doctor recreate-table - 命令: - `shutdown`: 优雅地关闭运行中的进程 - - `restart`: 优雅地重新启动运行中的进程（对于Windows服务器尚未实现） + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） - `flush-queues`: 刷新运行中的进程中的队列 - 选项: - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） - - `--non-blocking`: 设置为true，以在返回之前不等待刷新完成 + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 - `logging`: 调整日志命令 - 命令: - `pause`: 暂停日志记录 - 注意: - - 如果日志级别低于此级别，日志级别将被临时提升为INFO。 - - Gitea将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 - `resume`: 恢复日志记录 - - `release-and-reopen`: 使Gitea释放和重新打开用于日志记录的文件和连接（相当于向Gitea发送SIGUSR1信号）。 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 - `remove name`: 删除指定的日志记录器 - 选项: - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） @@ -437,7 +437,7 @@ gitea doctor recreate-table - `--expression value`, `-e value`: 日志记录器的匹配表达式 - `--prefix value`, `-p value`: 日志记录器的前缀 - `--color`: 在日志中使用颜色 - - `--stderr`: 将控制台日志输出到stderr - 仅适用于控制台 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 - `file`: 添加文件日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" @@ -467,9 +467,9 @@ gitea doctor recreate-table - `--color`: 在日志中使用颜色 - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 - `--reconnect`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix或udp（默认为tcp） + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） - - `smtp`: 添加SMTP日志记录器 + - `smtp`: 添加 SMTP 日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/email-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/email-setup.md index 2531fd5d..46f7f2b3 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/email-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/email-setup.md @@ -14,9 +14,9 @@ Gitea 具有邮件功能，用于发送事务性邮件（例如注册确认邮 使用 `sendmail` 命令作为邮件传输代理（mailer）。 -注意：对于在官方Gitea Docker镜像中使用，请使用SMTP版本进行配置（请参考下一节）。 +注意：对于在官方 Gitea Docker 镜像中使用，请使用 SMTP 版本进行配置（请参考下一节）。 -注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 +注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过 TLS 发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 ```ini title="app.ini" [mailer] @@ -54,9 +54,9 @@ PASSWD = `password` - 通过端口 587 的 STARTTLS（也称为 Opportunistic TLS）。初始连接是明文的，但如果服务器支持，则可以升级为 TLS。 - 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。 - 使用 `IS_TLS_ENABLED=true` 进行强制的 SMTPS 连接。（这两种方式都被称为 Implicit TLS） -这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 + 这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 -请注意，自2018年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 +请注意，自 2018 年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 ### Gmail diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/external-renderers.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/external-renderers.md index a82b4833..4a10b3f5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/external-renderers.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/external-renderers.md @@ -171,7 +171,8 @@ ALLOW_DATA_URI_IMAGES = true .markup.XXXXX body { color: #444; - font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", + serif; font-size: 12px; line-height: 1.7; padding: 1em; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/mail-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/mail-templates.md index ff0030c9..b5402c22 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/mail-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/mail-templates.md @@ -17,18 +17,18 @@ aliases: 目前，以下通知事件使用模板： -| 操作名称 | 用途 | -| ----------- | ------------------------------------------------------------------------------------------------------------ | -| `new` | 创建了新的工单或合并请求。 | -| `comment` | 在现有工单或合并请求中创建了新的评论。 | -| `close` | 关闭了工单或合并请求。 | -| `reopen` | 重新打开了工单或合并请求。 | -| `review` | 在合并请求中进行审查的首要评论。 | -| `approve` | 对合并请求进行批准的首要评论。 | -| `reject` | 对合并请求提出更改请求的审查的首要评论。 | -| `code` | 关于合并请求的代码的单个评论。 | -| `assigned` | 用户被分配到工单或合并请求。 | -| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | +| 操作名称 | 用途 | +| ---------- | ---------------------------------------------------------------------- | +| `new` | 创建了新的工单或合并请求。 | +| `comment` | 在现有工单或合并请求中创建了新的评论。 | +| `close` | 关闭了工单或合并请求。 | +| `reopen` | 重新打开了工单或合并请求。 | +| `review` | 在合并请求中进行审查的首要评论。 | +| `approve` | 对合并请求进行批准的首要评论。 | +| `reject` | 对合并请求提出更改请求的审查的首要评论。 | +| `code` | 关于合并请求的代码的单个评论。 | +| `assigned` | 用户被分配到工单或合并请求。 | +| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | 特定消息类型的模板路径为： @@ -72,25 +72,25 @@ custom/templates/mail/pull/comment.tmpl 指定 _主题_ 部分是可选的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。 -_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： +_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://golang.org/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： -| 名称 | 类型 | 可用性 | 用途 | -| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | -| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | -| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | -| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | -| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | -| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | -| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | -| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | -| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | -| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | -| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | -| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | -| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | -| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | -| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | +| 名称 | 类型 | 可用性 | 用途 | +| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | +| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | +| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | +| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | +| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | +| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | +| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | +| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | +| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | +| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | +| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | +| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | +| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | +| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | +| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | 所有名称区分大小写。 @@ -107,7 +107,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t - 删除所有前导、尾随和多余的空格。 - 将字符串截断为前 256 个字母（字符）。 -如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用Gitea的**内部默认值**。 +如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用 Gitea 的**内部默认值**。 内部默认（回退）主题相当于： @@ -117,7 +117,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 例如：`Re: [mike/stuff] New color palette (#38)` -即使存在有效的主题模板，Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 +即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 ### 模板中的邮件正文部分 @@ -139,7 +139,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 如果模板无法呈现，则只有在发送邮件时才会注意到。 如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈现了任何内容，则将使用该内容，忽略其他内容。 -如果遇到问题，请检查 [Gitea的日志](https://docs.gitea.io/en-us/logging-configuration/) 以获取错误消息。 +如果遇到问题，请检查 [Gitea 的日志](https://docs.gitea.io/en-us/logging-configuration/) 以获取错误消息。 ## 示例 @@ -221,11 +221,11 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t > > #### 消息内容： > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > Mike, I think we should tone down the blues a little. > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > [在 Gitea 上查看](#)。 @@ -233,20 +233,22 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 模板系统包含一些函数，可用于进一步处理和格式化消息。以下是其中一些函数的列表： -| 函数名 | 参数 | 可用于 | 用法 | -| ----------------- | ----------- | ------------ | --------------------------------------------------------------------------------- | -| `AppUrl` | - | 任何地方 | Gitea 的 URL | -| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | -| `AppDomain` | - | 任何地方 | Gitea 的主机名 | -| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | -| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 | -| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于 `.ReviewComments.RenderedContent` 等字段 | +| 函数名 | 参数 | 可用于 | 用法 | +| ---------------- | ----------- | ---------- | --------------------------------------------------------------------- | +| `AppUrl` | - | 任何地方 | Gitea 的 URL | +| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | +| `AppDomain` | - | 任何地方 | Gitea 的主机名 | +| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | +| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 | +| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于 `.ReviewComments.RenderedContent` 等字段 | 这些都是 _函数_，而不是元数据，因此必须按以下方式使用： ```html -像这样使用： {{Str2html "Escapetext"}} -或者这样使用： {{"Escapetext" | Str2html}} -或者这样使用： {{AppUrl}} -但不要像这样使用： {{.AppUrl}} +像这样使用： {{Str2html "Escapetext"}} 或者这样使用： {{"Escapetext" | Str2html}} 或者这样使用： {{AppUrl}} 但不要像这样使用： + {{.AppUrl}} ``` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/repo-indexer.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/repo-indexer.md index fa078c68..5f3b8410 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/repo-indexer.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/repo-indexer.md @@ -30,7 +30,7 @@ REPO_INDEXER_EXCLUDE = resources/bin/** ### 按路径选择要索引的文件 -Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 +Gitea 使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 限制文件列表可以防止索引被派生或无关的文件（例如 lss、sym、map 等）污染，从而使搜索结果更相关。这还有助于减小索引的大小。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/search-engines-indexation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/search-engines-indexation.md index 761b1d11..50b06ab5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/search-engines-indexation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/search-engines-indexation.md @@ -22,7 +22,7 @@ User-agent: * Disallow: / ``` -如果您将Gitea安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 +如果您将 Gitea 安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 ```txt User-agent: * diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/signing.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/signing.md index b7e2d403..fac88ed7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/signing.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/administration/signing.md @@ -69,7 +69,7 @@ MERGES = pubkey, twofa, basesigned, commitssigned 如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。 与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。 -如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则Gitea将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 +如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则 Gitea 将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 ::: ### `INITIAL_COMMIT` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-backend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-backend.md index 80b2b666..758e4173 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-backend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-backend.md @@ -10,40 +10,40 @@ aliases: ## 背景 -Gitea使用Golang作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 -例如，Gitea使用[Chi](https://github.com/go-chi/chi)作为基本的Web框架。[Xorm](https://xorm.io)是一个用于与数据库交互的ORM框架。 +Gitea 使用 Golang 作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 +例如，Gitea 使用[Chi](https://github.com/go-chi/chi)作为基本的 Web 框架。[Xorm](https://xorm.io)是一个用于与数据库交互的 ORM 框架。 因此，管理这些包非常重要。在开始编写后端代码之前，请参考以下准则。 ## 包设计准则 ### 包列表 -为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea后端分为以下几个部分： +为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea 后端分为以下几个部分： -- `build`：帮助构建Gitea的脚本。 -- `cmd`：包含所有Gitea的实际子命令，包括web、doctor、serv、hooks、admin等。`web`将启动Web服务。`serv`和`hooks`将被Git或OpenSSH调用。其他子命令可以帮助维护Gitea。 +- `build`：帮助构建 Gitea 的脚本。 +- `cmd`：包含所有 Gitea 的实际子命令，包括 web、doctor、serv、hooks、admin 等。`web`将启动 Web 服务。`serv`和`hooks`将被 Git 或 OpenSSH 调用。其他子命令可以帮助维护 Gitea。 - `tests`：常用的测试函数 - `tests/integration`：集成测试，用于测试后端回归。 - `tests/e2e`：端到端测试，用于测试前端和后端的兼容性和视觉回归。 -- `models`：包含由xorm用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他Gitea代码的依赖关系。在某些情况下，比如日志记录时可以例外。 - - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从models/中调用。 +- `models`：包含由 xorm 用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他 Gitea 代码的依赖关系。在某些情况下，比如日志记录时可以例外。 + - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从 models/中调用。 - `models/fixtures`：单元测试和集成测试中使用的示例数据。一个`yml`文件表示一个将在测试开始时加载到数据库中的表。 - - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的PR**必须**包含一个迁移步骤。 -- `modules`：在Gitea中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于models的模块，因为它们依赖于数据库。 - - `modules/setting`：存储从ini文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 - - `modules/git`：用于与`Git`命令行或Gogit包交互的包。 -- `public`：编译后的前端文件（JavaScript、图像、CSS等） -- `routers`：处理服务器请求。由于它使用其他Gitea包来处理请求，因此其他包（models、modules或services）不能依赖于routers。 - - `routers/api`：包含`/api/v1`相关路由，用于处理RESTful API请求。 + - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的 PR**必须**包含一个迁移步骤。 +- `modules`：在 Gitea 中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于 models 的模块，因为它们依赖于数据库。 + - `modules/setting`：存储从 ini 文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 + - `modules/git`：用于与`Git`命令行或 Gogit 包交互的包。 +- `public`：编译后的前端文件（JavaScript、图像、CSS 等） +- `routers`：处理服务器请求。由于它使用其他 Gitea 包来处理请求，因此其他包（models、modules 或 services）不能依赖于 routers。 + - `routers/api`：包含`/api/v1`相关路由，用于处理 RESTful API 请求。 - `routers/install`：只能在系统处于安装模式（INSTALL_LOCK=false）时响应。 - `routers/private`：仅由内部子命令调用，特别是`serv`和`hooks`。 - - `routers/web`：处理来自Web浏览器或Git SMART HTTP协议的HTTP请求。 + - `routers/web`：处理来自 Web 浏览器或 Git SMART HTTP 协议的 HTTP 请求。 - `services`：用于常见路由操作或命令执行的支持函数。使用`models`和`modules`来处理请求。 -- `templates`：用于生成HTML输出的Golang模板。 +- `templates`：用于生成 HTML 输出的 Golang 模板。 ### 包依赖关系 -由于Golang不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 +由于 Golang 不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 `cmd` -> `routers` -> `services` -> `models` -> `modules` @@ -88,18 +88,18 @@ func UpdateIssue(ctx context.Context, repoID int64) error { ### 导入别名 -由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个Go文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 +由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个 Go 文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 例如：`import user_service "code.gitea.io/gitea/services/user"` ### 重要注意事项 - 永远不要写成`x.Update(exemplar)`，而没有明确的`WHERE`子句： - - 这将导致表中的所有行都被使用exemplar的非零值进行更新，包括ID。 + - 这将导致表中的所有行都被使用 exemplar 的非零值进行更新，包括 ID。 - 通常应该写成`x.ID(id).Update(exemplar)`。 -- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而ID是预设的： - - 对于MSSQL变体，你将需要执行``SET IDENTITY_INSERT `table` ON``（否则迁移将失败） - - 对于PostgreSQL，你还需要更新ID序列，否则迁移将悄无声息地通过，但后续的插入将失败： - ``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)`` +- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而 ID 是预设的： + - 对于 MSSQL 变体，你将需要执行`` SET IDENTITY_INSERT `table` ON ``（否则迁移将失败） + - 对于 PostgreSQL，你还需要更新 ID 序列，否则迁移将悄无声息地通过，但后续的插入将失败： + `` SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false) `` ### 未来的任务 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-frontend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-frontend.md index 5305ebd3..ce489a07 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-frontend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-frontend.md @@ -16,10 +16,10 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 源文件可以在以下目录中找到： -* **CSS 样式**： `web_src/css/` -* **JavaScript 文件**： `web_src/js/` -* **Vue 组件**： `web_src/js/components/` -* **Go HTML 模板**： `templates/` +- **CSS 样式**： `web_src/css/` +- **JavaScript 文件**： `web_src/js/` +- **Vue 组件**： `web_src/js/components/` +- **Go HTML 模板**： `templates/` ## 通用准则 @@ -28,9 +28,9 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ## Gitea 特定准则： 1. 每个功能（Fomantic-UI/jQuery 模块）应放在单独的文件/目录中。 -2. HTML 的 id 和 class 应使用 kebab-case，最好包含2-3个与功能相关的关键词。 -3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含2-3个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 -4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有2-3个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 +2. HTML 的 id 和 class 应使用 kebab-case，最好包含 2-3 个与功能相关的关键词。 +3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含 2-3 个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 +4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有 2-3 个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 5. 后端可以通过使用`ctx.PageData["myModuleData"] = map[]{}`将复杂数据传递给前端，但不要将整个模型暴露给前端，以避免泄露敏感数据。 6. 简单页面和与 SEO 相关的页面使用 Go HTML 模板渲染生成静态的 Fomantic-UI HTML 输出。复杂页面可以使用 Vue3。 7. 明确变量类型，优先使用`elem.disabled = true`而不是`elem.setAttribute('disabled', 'anything')`，优先使用`$el.prop('checked', var === 'yes')`而不是`$el.prop('checked', var)`。 @@ -42,8 +42,8 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ### 可访问性 / ARIA -在历史上，Gitea大量使用了可访问性不友好的框架 Fomantic UI。 -Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`aria.md`）， +在历史上，Gitea 大量使用了可访问性不友好的框架 Fomantic UI。 +Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见`aria.js`和`aria.md`）， 但仍然存在许多问题需要大量的工作和时间来修复。 ### 框架使用 @@ -53,14 +53,14 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 推荐的实现方式： -* Vue + Vanilla JS -* Fomantic-UI（jQuery） -* Vanilla JS +- Vue + Vanilla JS +- Fomantic-UI（jQuery） +- Vanilla JS 不推荐的实现方式： -* Vue + Fomantic-UI（jQuery） -* jQuery + Vanilla JS +- Vue + Fomantic-UI（jQuery） +- jQuery + Vanilla JS 为了保持界面一致，Vue 组件可以使用 Fomantic-UI 的 CSS 类。 尽管不建议混合使用不同的框架， @@ -79,7 +79,7 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 如果我们想在非异步上下文中调用`async`函数， 建议使用`const _promise = asyncFoo()`来告诉读者 -这是有意为之的，我们想调用异步函数并忽略Promise。 +这是有意为之的，我们想调用异步函数并忽略 Promise。 一些 lint 规则和 IDE 也会在未处理返回的 Promise 时发出警告。 ### HTML 属性和 dataset @@ -87,31 +87,41 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 禁止使用`dataset`，它的驼峰命名行为使得搜索属性变得困难。 然而，仍然存在一些特殊情况，因此当前的准则是： -* 对于旧代码： - * 应将`$.data()`重构为`$.attr()`。 - * 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 +- 对于旧代码： -* 对于新代码： - * 不应使用`node.dataset`，而应使用`node.getAttribute`。 - * 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 + - 应将`$.data()`重构为`$.attr()`。 + - 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 + +- 对于新代码： + - 不应使用`node.dataset`，而应使用`node.getAttribute`。 + - 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 ### 显示/隐藏元素 -* 推荐在Vue组件中使用`v-if`和`v-show`来显示/隐藏元素。 -* Go 模板代码应使用 Gitea 的 `.gt-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.gt-hidden`的注释以获取更多详细信息。 +- 推荐在 Vue 组件中使用`v-if`和`v-show`来显示/隐藏元素。 +- Go 模板代码应使用 Gitea 的 `.gt-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.gt-hidden`的注释以获取更多详细信息。 ### Go HTML 模板中的样式和属性 建议使用以下方式： ```html -
+
``` 而不是： ```html -
+
``` 以使代码更易读。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-refactoring.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-refactoring.md index e0ab3e3b..6df29443 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-refactoring.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/guidelines-refactoring.md @@ -10,31 +10,31 @@ aliases: ## 背景 -自2014年2月12日编写了第一行代码以来，Gitea已经发展成为一个庞大的项目。 +自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成为一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多过时的机制，许多框架混合在一起，一些遗留代码可能会导致错误并阻碍新功能的开发。 -为了使代码库更易于维护，使Gitea变得更好，开发人员应牢记使用现代机制来重构旧代码。 +为了使代码库更易于维护，使 Gitea 变得更好，开发人员应牢记使用现代机制来重构旧代码。 本文档是关于重构代码库的指南集合。 ## 重构建议 -* 设计更多关于未来的内容，而不仅仅解决当前问题。 -* 减少模糊性，减少冲突，提高可维护性。 -* 描述重构，例如： - * 为什么需要重构。 - * 如何解决旧问题。 - * 重构的优点/缺点是什么。 -* 只做必要的更改，尽量保留旧逻辑。 -* 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个PR中完成。 -* 如果存在分歧，应该请TOC（技术监督委员会）参与决策。 -* 添加必要的测试以确保重构的正确性。 -* 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 +- 设计更多关于未来的内容，而不仅仅解决当前问题。 +- 减少模糊性，减少冲突，提高可维护性。 +- 描述重构，例如： + - 为什么需要重构。 + - 如何解决旧问题。 + - 重构的优点/缺点是什么。 +- 只做必要的更改，尽量保留旧逻辑。 +- 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。 +- 如果存在分歧，应该请 TOC（技术监督委员会）参与决策。 +- 添加必要的测试以确保重构的正确性。 +- 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 ## 审查和合并建议 -* 重构的PR不应该长时间保持打开状态（通常为7天），应尽快进行审查。 -* 重构的PR应尽快合并，不应被其他PR阻塞。 -* 如果TOC没有异议，重构的PR可以在7天后由一名核心成员（非作者）批准后合并。 -* 如果最终结果良好，容忍一些不完美/临时的步骤。 -* 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 +- 重构的 PR 不应该长时间保持打开状态（通常为 7 天），应尽快进行审查。 +- 重构的 PR 应尽快合并，不应被其他 PR 阻塞。 +- 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合并。 +- 如果最终结果良好，容忍一些不完美/临时的步骤。 +- 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/localization.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/localization.md index 29596205..e0b81a3a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/localization.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/contributing/localization.md @@ -8,9 +8,9 @@ aliases: # 本地化 -Gitea的本地化是通过我们的[Crowdin项目](https://crowdin.com/project/gitea)进行的。 +Gitea 的本地化是通过我们的[Crowdin 项目](https://crowdin.com/project/gitea)进行的。 -对于对**英语翻译**的更改，可以发出pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 +对于对**英语翻译**的更改，可以发出 pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 有关对**非英语**翻译的更改，请参阅上面的 Crowdin 项目。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/integrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/integrations.md index 052a8734..049d0bba 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/integrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/integrations.md @@ -8,7 +8,7 @@ aliases: # 集成 -Gitea拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 +Gitea 拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 我们正在[awesome-gitea](https://gitea.com/gitea/awesome-gitea)上整理一个列表来跟踪这些集成！ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/migrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/migrations.md index b92449e6..60cad1ab 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/migrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/migrations.md @@ -8,24 +8,24 @@ aliases: # 迁移接口 -完整迁移功能在Gitea 1.9.0版本中引入。它定义了两个接口，用于支持从其他Git托管平台迁移存储库数据到Gitea，或者在将来将Gitea数据迁移到其他Git托管平台。 +完整迁移功能在 Gitea 1.9.0 版本中引入。它定义了两个接口，用于支持从其他 Git 托管平台迁移存储库数据到 Gitea，或者在将来将 Gitea 数据迁移到其他 Git 托管平台。 -目前已实现了从GitHub、GitLab和其他Gitea实例的迁移。 +目前已实现了从 GitHub、GitLab 和其他 Gitea 实例的迁移。 -首先，Gitea在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 +首先，Gitea 在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 ## 下载器接口 -要从新的Git托管平台迁移，需要进行两个步骤的更新。 +要从新的 Git 托管平台迁移，需要进行两个步骤的更新。 - 您应该实现一个`Downloader`，用于获取存储库信息。 -- 您应该实现一个`DownloaderFactory`，用于检测URL是否匹配，并创建上述的`Downloader`。 +- 您应该实现一个`DownloaderFactory`，用于检测 URL 是否匹配，并创建上述的`Downloader`。 - 您需要在`init()`中通过`RegisterDownloaderFactory`注册`DownloaderFactory`。 您可以在[downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go)中找到这些接口。 ## 上传器接口 -目前，只实现了`GiteaLocalUploader`，因此我们只能通过此Uploader将下载的数据保存到本地的Gitea实例。目前不支持其他上传器。 +目前，只实现了`GiteaLocalUploader`，因此我们只能通过此 Uploader 将下载的数据保存到本地的 Gitea 实例。目前不支持其他上传器。 您可以在[uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go)中找到这些接口。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/oauth2-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/oauth2-provider.md index 24067a0b..9fb9e666 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/oauth2-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/development/oauth2-provider.md @@ -33,40 +33,40 @@ Gitea 支持作为 OAuth2 提供者，允许第三方应用程序在用户同意 Gitea 支持以下令牌范围: -| 名称 | 介绍 | -| ---- | ----------- | -| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | -| **repo** | 完全控制所有存储库 | -|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | -|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | -| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | -|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | -|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | -| **admin:org** | 授予对组织设置的完全访问权限 | -|     **write:org** | 授予对组织设置的读/写访问权限 | -|     **read:org** | 授予对组织设置的只读访问权限 | -| **admin:public_key** | 授予公钥管理的完全访问权限 | -|     **write:public_key** | 授予对公钥的读/写访问权限 | -|     **read:public_key** | 授予对公钥的只读访问权限 | -| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | -| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | -| **notification** | 授予对通知的完全访问权限 | -| **user** | 授予对用户个人资料信息的完全访问权限 | -|     **read:user** | 授予对用户个人资料的读取权限 | -|     **user:email** | 授予对用户电子邮件地址的读取权限 | -|     **user:follow** | 授予访问权限以关注/取消关注用户 | -| **delete_repo** | 授予删除存储库的权限 | -| **package** | 授予对托管包的完全访问权限 | -|     **write:package** | 授予对包的读/写访问权限 | -|     **read:package** | 授予对包的读取权限 | -|     **delete:package** | 授予对包的删除权限 | -| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | -|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | -|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | -| **admin:application** | 授予应用程序管理的完全访问权限 | -|     **write:application** | 授予应用程序管理的读/写访问权限 | -|     **read:application** | 授予应用程序管理的读取权限 | -| **sudo** | 允许以站点管理员身份执行操作 | +| 名称 | 介绍 | +| ---------------------------------------- | --------------------------------------------------------------- | +| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | +| **repo** | 完全控制所有存储库 | +|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | +|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | +| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | +|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | +|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | +| **admin:org** | 授予对组织设置的完全访问权限 | +|     **write:org** | 授予对组织设置的读/写访问权限 | +|     **read:org** | 授予对组织设置的只读访问权限 | +| **admin:public_key** | 授予公钥管理的完全访问权限 | +|     **write:public_key** | 授予对公钥的读/写访问权限 | +|     **read:public_key** | 授予对公钥的只读访问权限 | +| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | +| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | +| **notification** | 授予对通知的完全访问权限 | +| **user** | 授予对用户个人资料信息的完全访问权限 | +|     **read:user** | 授予对用户个人资料的读取权限 | +|     **user:email** | 授予对用户电子邮件地址的读取权限 | +|     **user:follow** | 授予访问权限以关注/取消关注用户 | +| **delete_repo** | 授予删除存储库的权限 | +| **package** | 授予对托管包的完全访问权限 | +|     **write:package** | 授予对包的读/写访问权限 | +|     **read:package** | 授予对包的读取权限 | +|     **delete:package** | 授予对包的删除权限 | +| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | +|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | +|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | +| **admin:application** | 授予应用程序管理的完全访问权限 | +|     **write:application** | 授予应用程序管理的读/写访问权限 | +|     **read:application** | 授予应用程序管理的读取权限 | +| **sudo** | 允许以站点管理员身份执行操作 | ## 客户端类型 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/help/faq.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/help/faq.md index 3dd5187c..f4a9bb66 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/help/faq.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/help/faq.md @@ -4,7 +4,6 @@ slug: "faq" sidebar_position: 5 aliases: - /zh-cn/faq - --- # 常见问题 @@ -13,128 +12,128 @@ aliases: 有关更多帮助资源，请查看所有[支持选项](seek-help.md)。 -## 1.x和1.x.x下载之间的区别 +## 1.x 和 1.x.x 下载之间的区别 -以1.7.x版本为例。 +以 1.7.x 版本为例。 -**注意：**此示例也适用于Docker镜像！ +**注意：**此示例也适用于 Docker 镜像！ -在我们的[下载页面](https://dl.gitea.io/gitea/)上，您会看到一个1.7目录，以及1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5和1.7.6的目录。 +在我们的[下载页面](https://dl.gitea.io/gitea/)上，您会看到一个 1.7 目录，以及 1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5 和 1.7.6 的目录。 -1.7目录和1.7.0目录是**不同**的。1.7目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 +1.7 目录和 1.7.0 目录是**不同**的。1.7 目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 -然而，1.7.0目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 +然而，1.7.0 目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 -这意味着1.x的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 +这意味着 1.x 的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 -另一方面，1.x.x的下载应该永远不会改变。 +另一方面，1.x.x 的下载应该永远不会改变。 -## 如何从Gogs/GitHub等迁移到Gitea +## 如何从 Gogs/GitHub 等迁移到 Gitea -要从Gogs迁移到Gitea： +要从 Gogs 迁移到 Gitea： -- [Gogs版本0.9.146或更低](installation/upgrade-from-gogs.md) -- [Gogs版本0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) +- [Gogs 版本 0.9.146 或更低](installation/upgrade-from-gogs.md) +- [Gogs 版本 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) -要从GitHub迁移到Gitea，您可以使用Gitea内置的迁移表单。 +要从 GitHub 迁移到 Gitea，您可以使用 Gitea 内置的迁移表单。 为了迁移诸如问题、拉取请求等项目，您需要至少输入您的用户名。 [Example (requires login)](https://try.gitea.io/repo/migrate) -要从GitLab迁移到Gitea，您可以使用这个非关联的工具： +要从 GitLab 迁移到 Gitea，您可以使用这个非关联的工具： https://github.com/loganinak/MigrateGitlabToGogs -## Gitea存储文件的位置 +## Gitea 存储文件的位置 - _`AppWorkPath`_ - `--work-path`标志 - 或者环境变量`GITEA_WORK_DIR` - 或者在构建时设置的内置值 - - 或者包含Gitea二进制文件的目录 + - 或者包含 Gitea 二进制文件的目录 - `%(APP_DATA_PATH)`（数据库、索引器等的默认路径） - `app.ini`中的`APP_DATA_PATH` - - 或者_`AppWorkPath`_`/data` + - 或者*`AppWorkPath`*`/data` - _`CustomPath`_（自定义模板） - `--custom-path`标志 - 或者环境变量`GITEA_CUSTOM` - 或者在构建时设置的内置值 - - 或者_`AppWorkPath`_`/custom` + - 或者*`AppWorkPath`*`/custom` - HomeDir - Unix：环境变量`HOME` - Windows：环境变量`USERPROFILE`，或者环境变量`HOMEDRIVE`+`HOMEPATH` - RepoRootPath - `app.ini`中\[repository]部分的`ROOT`（如果是绝对路径） - - 否则_`AppWorkPath`_`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） + - 否则*`AppWorkPath`*`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） - 默认值为`%(APP_DATA_PATH)/gitea-repositories` - INI（配置文件） - `--config`标志 - 或者在构建时设置的可能内置值 - 或者 _`CustomPath`_`/conf/app.ini` -- SQLite数据库 - - app.ini中database部分的PATH +- SQLite 数据库 + - app.ini 中 database 部分的 PATH - 或者`%(APP_DATA_PATH)/gitea.db` -## 看不到克隆URL或克隆URL不正确 +## 看不到克隆 URL 或克隆 URL 不正确 有几个地方可能会导致显示不正确。 1. 如果使用反向代理，请确保按照[反向代理指南](../administration/reverse-proxies.md)中的正确说明进行设置。 2. 确保在`app.ini`的`server`部分中正确设置了`ROOT_URL`。 -如果某些克隆选项未显示（HTTP/S或SSH），可以在`app.ini中` +如果某些克隆选项未显示（HTTP/S 或 SSH），可以在`app.ini中` -- `DISABLE_HTTP_GIT`: 如果设为true, 将会没有HTTP/HTTPS链接 -- `DISABLE_SSH`: 如果设为true, 将会没有SSH链接 -- `SSH_EXPOSE_ANONYMOUS`: 如果设为false, SSH链接将会对匿名用户隐藏 +- `DISABLE_HTTP_GIT`: 如果设为 true, 将会没有 HTTP/HTTPS 链接 +- `DISABLE_SSH`: 如果设为 true, 将会没有 SSH 链接 +- `SSH_EXPOSE_ANONYMOUS`: 如果设为 false, SSH 链接将会对匿名用户隐藏 ## 文件上传失败：413 Request Entity Too Large 当反向代理限制文件上传大小时，会出现此错误。 -有关使用nginx解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 +有关使用 nginx 解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 ## 自定义模板无法加载或运行错误 -Gitea的自定义模板必须将其添加到正确的位置，否则Gitea将无法找到并使用自定义模板。 +Gitea 的自定义模板必须将其添加到正确的位置，否则 Gitea 将无法找到并使用自定义模板。 模板的正确路径应该相对于`CustomPath`。 1. 要找到`CustomPath`，请在站点管理 -> 配置 中查找自定义文件根路径。 - 如果找不到，请尝试`echo $GITEA_CUSTOM`。 + 如果找不到，请尝试`echo $GITEA_CUSTOM`。 2. 如果仍然找不到，默认值可以被[计算](faq.md#Gitea存储文件的位置) -3. 如果仍然找不到路径，则可以参考[自定义Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 +3. 如果仍然找不到路径，则可以参考[自定义 Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 -## Gitea是否有"GitHub/GitLab Pages"功能？ +## Gitea 是否有"GitHub/GitLab Pages"功能？ -Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供静态页面，以避免CSRF安全风险。 +Gitea 不提供内置的 Pages 服务器。您需要一个专用的域名来提供静态页面，以避免 CSRF 安全风险。 -对于简单的用法，您可以使用反向代理来重写和提供Gitea的原始文件URL中的静态内容。 +对于简单的用法，您可以使用反向代理来重写和提供 Gitea 的原始文件 URL 中的静态内容。 还有一些已经可用的第三方服务，比如独立[pages server](https://codeberg.org/Codeberg/pages-server)的或[caddy plugin](https://github.com/42wim/caddy-gitea)，可以提供所需的功能。 ## 活跃用户与禁止登录用户 -在Gitea中，"活跃用户"是指通过电子邮件激活其帐户的用户。 +在 Gitea 中，"活跃用户"是指通过电子邮件激活其帐户的用户。 -"禁止登录用户"是指不允许再登录到Gitea的用户。 +"禁止登录用户"是指不允许再登录到 Gitea 的用户。 ## 设置日志记录 - [官方文档](../administration/logging-documentation.md) -## 什么是Swagger？ +## 什么是 Swagger？ -[Swagger](https://swagger.io/) 是Gitea用于其API文档的工具。 +[Swagger](https://swagger.io/) 是 Gitea 用于其 API 文档的工具。 -所有Gitea实例都有内置的API，无法完全禁用它。 -但是，您可以在app.ini的api部分将ENABLE_SWAGGER设置为false，以禁用其文档显示。 -有关更多信息，请参阅Gitea的[API文档](development/api-usage.md)。 +所有 Gitea 实例都有内置的 API，无法完全禁用它。 +但是，您可以在 app.ini 的 api 部分将 ENABLE_SWAGGER 设置为 false，以禁用其文档显示。 +有关更多信息，请参阅 Gitea 的[API 文档](development/api-usage.md)。 -您可以在上查看最新的API（例如）https://try.gitea.io/api/swagger +您可以在上查看最新的 API（例如）https://try.gitea.io/api/swagger 您还可以在上查看`swagger.json`文件的示例 https://try.gitea.io/swagger.v1.json @@ -145,7 +144,7 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 有多种方法可以组合使用来防止垃圾邮件发送者： 1. 通过设置电子邮件域名的白名单或黑名单。 -2. 通过设置一些域名或者OpenID白名单（见下文）。 +2. 通过设置一些域名或者 OpenID 白名单（见下文）。 3. 在您的`app.ini`中将`ENABLE_CAPTCHA`设置为`true`，并正确配置`RECAPTCHA_SECRET`和 `RECAPTCHA_SITEKEY`。 4. 将`DISABLE_REGISTRATION`设置为`true`，并通过 [CLI](../administration/command-line.md)、[API](../development/api-usage.md) 或 Gitea 的管理界面创建新用户。 @@ -186,13 +185,13 @@ Gitea 目前支持三个官方主题，分别是 `gitea`（亮色）、`arc-gree 通过将`arc-blue`添加到`app.ini`中的`THEMES`列表中，允许用户使用该主题 -## SSHD vs 内建SSH +## SSHD vs 内建 SSH -SSHD是大多数Unix系统上内建的SSH服务器。 +SSHD 是大多数 Unix 系统上内建的 SSH 服务器。 -Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 +Gitea 还提供了自己的 SSH 服务器，用于在 SSHD 不可用时使用。 -## Gitea运行缓慢 +## Gitea 运行缓慢 导致此问题的最常见原因是加载联合头像。 @@ -202,35 +201,35 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 ## 无法创建仓库/文件 -请确保Gitea具有足够的权限来写入其主目录和数据目录。 +请确保 Gitea 具有足够的权限来写入其主目录和数据目录。 参见[AppDataPath 和 RepoRootPath](faq.md#Gitea存储文件的位置) -**适用于Arch用户的注意事项：**在撰写本文时，Arch软件包的systemd文件包含了以下行： +**适用于 Arch 用户的注意事项：**在撰写本文时，Arch 软件包的 systemd 文件包含了以下行： `ReadWritePaths=/etc/gitea/app.ini` -这将使得Gitea无法写入其他路径。 +这将使得 Gitea 无法写入其他路径。 ## 翻译不正确/如何添加更多翻译 -我们当前的翻译是在我们的[Crowdin项目](https://crowdin.com/project/gitea)上众包进行的 +我们当前的翻译是在我们的[Crowdin 项目](https://crowdin.com/project/gitea)上众包进行的 -无论您想要更改翻译还是添加新的翻译，都需要在Crowdin集成中进行，因为所有翻译都会被CI覆盖。 +无论您想要更改翻译还是添加新的翻译，都需要在 Crowdin 集成中进行，因为所有翻译都会被 CI 覆盖。 -## 推送钩子/ Webhook未运行 +## 推送钩子/ Webhook 未运行 -如果您可以推送但无法在主页仪表板上看到推送活动，或者推送不触发Webhook，有几种可能性： +如果您可以推送但无法在主页仪表板上看到推送活动，或者推送不触发 Webhook，有几种可能性： -1. Git钩子不同步：在站点管理面板上运行“重新同步所有仓库的pre-receive、update和post-receive钩子” -2. Git仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由NAS挂载），请确保文件系统支持`chmod a+x any-script` -3. 如果您使用的是Docker，请确保Docker Server（而不是客户端）的版本 >= 20.10.6 +1. Git 钩子不同步：在站点管理面板上运行“重新同步所有仓库的 pre-receive、update 和 post-receive 钩子” +2. Git 仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由 NAS 挂载），请确保文件系统支持`chmod a+x any-script` +3. 如果您使用的是 Docker，请确保 Docker Server（而不是客户端）的版本 >= 20.10.6 -## SSH问题 +## SSH 问题 如果无法通过`ssh`访问仓库，但`https`正常工作，请考虑以下情况。 -首先，请确保您可以通过SSH访问Gitea。 +首先，请确保您可以通过 SSH 访问 Gitea。 `ssh git@myremote.example` @@ -258,16 +257,18 @@ fatal: Could not read from remote repository. - 在客户端： - 确保公钥和私钥已添加到正确的 Gitea 用户。 - - 确保远程 URL 中没有任何问题。特别是，请确保∂ - Git 用户（@ 之前的部分）的名称拼写正确。 + - 确保远程 URL 中没有任何问题。特别是，请确保 ∂ + Git 用户（@ 之前的部分）的名称拼写正确。 - 确保客户端机器上的公钥和私钥正确无误。 - 在服务器上： + - 确保存储库存在并且命名正确。 - 检查系统用户主目录中的 `.ssh` 目录的权限。 - 验证正确的公钥是否已添加到 `.ssh/authorized_keys` 中。 尝试在 Gitea 管理面板上运行 `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)`。 + - 查看 Gitea 日志。 - 查看 /var/log/auth（或类似的文件）。 - 检查存储库的权限。 @@ -339,7 +340,9 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 - 使用[管理 CLI 命令](../administration/command-line.md#admin)。 请注意，大多数命令还需要一个[全局标志](../administration/command-line.md#全局选项)来指向正确的配置。 + - 作为**用户**，您可以更改密码... + - 在您的账户的`设置 -> 账户`页面（此方法**需要**您知道当前密码）。 - 使用`忘记密码`链接。 @@ -349,7 +352,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 在 Gitea 版本 `1.11` 中，我们转换为使用[goldmark](https://github.com/yuin/goldmark)进行 Markdown 渲染，它符合[CommonMark](https://commonmark.org/)标准。 -如果您在版本`1.11`之前的Markdown正常工作，但在升级后无法正常工作，请仔细阅读CommonMark规范，看看问题是由错误还是非兼容的语法引起的。 +如果您在版本`1.11`之前的 Markdown 正常工作，但在升级后无法正常工作，请仔细阅读 CommonMark 规范，看看问题是由错误还是非兼容的语法引起的。 如果是后者，通常规范中会列出一种符合标准的替代方法。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/database-preparation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/database-preparation.md index 1f06a2a1..4f2e046c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/database-preparation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/database-preparation.md @@ -18,149 +18,149 @@ aliases: 1. 对于远程数据库设置，您需要让 MySQL 监听您的 IP 地址。编辑数据库实例上的 `/etc/mysql/my.cnf` 文件中的 `bind-address` 选项为： - ```ini - bind-address = 203.0.113.3 - ``` + ```ini + bind-address = 203.0.113.3 + ``` 2. 在数据库实例上，使用 `root` 用户登录到数据库控制台： - ``` - mysql -u root -p - ``` + ``` + mysql -u root -p + ``` - 按提示输入密码。 + 按提示输入密码。 3. 创建一个将被 Gitea 使用的数据库用户，并使用密码进行身份验证。以下示例中使用了 `'gitea'` 作为密码。请为您的实例使用一个安全密码。 - 对于本地数据库： + 对于本地数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea' IDENTIFIED BY 'gitea'; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; + ``` - 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 + 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 - 根据需要替换上述用户名和密码。 + 根据需要替换上述用户名和密码。 4. 使用 UTF-8 字符集和排序规则创建数据库。确保使用 `**utf8mb4**` 字符集，而不是 `utf8`，因为前者支持 _Basic Multilingual Plane_ 之外的所有 Unicode 字符（包括表情符号）。排序规则根据您预期的内容选择。如果不确定，可以使用 `unicode_ci` 或 `general_ci`。 - ```sql - CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci'; - ``` + ```sql + CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 5. 将数据库上的所有权限授予上述创建的数据库用户。 - 对于本地数据库： + 对于本地数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; + FLUSH PRIVILEGES; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; + FLUSH PRIVILEGES; + ``` 6. 通过 exit 退出数据库控制台。 7. 在您的 Gitea 服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h 203.0.113.3 -p giteadb - ``` + ``` + mysql -u gitea -h 203.0.113.3 -p giteadb + ``` - 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 -h 选项。 + 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 -h 选项。 - 到此您应该能够连接到数据库了。 + 到此您应该能够连接到数据库了。 ## PostgreSQL 1. 对于远程数据库设置，通过编辑数据库实例上的 postgresql.conf 文件中的 listen_addresses 将 PostgreSQL 配置为监听您的 IP 地址： - ```ini - listen_addresses = 'localhost, 203.0.113.3' - ``` + ```ini + listen_addresses = 'localhost, 203.0.113.3' + ``` 2. PostgreSQL 默认使用 `md5` 质询-响应加密方案进行密码身份验证。现在这个方案不再被认为是安全的。改用 SCRAM-SHA-256 方案，通过编辑数据库服务器上的` postgresql.conf` 配置文件： - ```ini - password_encryption = scram-sha-256 - ``` + ```ini + password_encryption = scram-sha-256 + ``` - 重启 PostgreSQL 以应用该设置。 + 重启 PostgreSQL 以应用该设置。 3. 在数据库服务器上，以超级用户身份登录到数据库控制台： - ``` - su -c "psql" - postgres - ``` + ``` + su -c "psql" - postgres + ``` 4. 创建具有登录权限和密码的数据库用户（在 PostgreSQL 术语中称为角色）。请使用安全的、强密码，而不是下面的 `'gitea'`： - ```sql - CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; - ``` + ```sql + CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; + ``` - 根据需要替换用户名和密码。 + 根据需要替换用户名和密码。 5. 使用 UTF-8 字符集创建数据库，并由之前创建的数据库用户拥有。可以根据预期内容使用任何 `libc` 排序规则，使用 `LC_COLLATE` 和 `LC_CTYPE` 参数指定： - ```sql - CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; - ``` + ```sql + CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 6. 通过将以下身份验证规则添加到 `pg_hba.conf`，允许数据库用户访问上面创建的数据库。 - 对于本地数据库： + 对于本地数据库： - ```ini - local giteadb gitea scram-sha-256 - ``` + ```ini + local giteadb gitea scram-sha-256 + ``` - 对于远程数据库： + 对于远程数据库： - ```ini - host giteadb gitea 192.0.2.10/32 scram-sha-256 - ``` + ```ini + host giteadb gitea 192.0.2.10/32 scram-sha-256 + ``` - 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 + 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 - 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 + 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 - 重启 PostgreSQL 以应用新的身份验证规则。 + 重启 PostgreSQL 以应用新的身份验证规则。 7. 在您的 Gitea 服务器上，测试与数据库的连接。 - 对于本地数据库： + 对于本地数据库： - ``` - psql -U gitea -d giteadb - ``` + ``` + psql -U gitea -d giteadb + ``` - 对于远程数据库： + 对于远程数据库： - ``` - psql "postgres://gitea@203.0.113.3/giteadb" - ``` + ``` + psql "postgres://gitea@203.0.113.3/giteadb" + ``` - 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 + 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 - 您应该会被提示输入数据库用户的密码，并连接到数据库。 + 您应该会被提示输入数据库用户的密码，并连接到数据库。 ## 使用 TLS 进行数据库连接 @@ -179,116 +179,116 @@ Gitea 使用的 PostgreSQL 驱动程序支持双向 TLS。在双向 TLS 中， 1. 在数据库实例所在的服务器上，放置以下凭据： - - `/path/to/postgresql.crt`: 数据库实例证书 - - `/path/to/postgresql.key`: 数据库实例私钥 - - `/path/to/root.crt`: 用于验证客户端证书的CA证书链 + - `/path/to/postgresql.crt`: 数据库实例证书 + - `/path/to/postgresql.key`: 数据库实例私钥 + - `/path/to/root.crt`: 用于验证客户端证书的 CA 证书链 2. 在 `postgresql.conf` 中添加以下选项： - ```ini - ssl = on - ssl_ca_file = '/path/to/root.crt' - ssl_cert_file = '/path/to/postgresql.crt' - ssl_key_file = '/path/to/postgresql.key' - ssl_min_protocol_version = 'TLSv1.2' - ``` + ```ini + ssl = on + ssl_ca_file = '/path/to/root.crt' + ssl_cert_file = '/path/to/postgresql.crt' + ssl_key_file = '/path/to/postgresql.key' + ssl_min_protocol_version = 'TLSv1.2' + ``` 3. 根据 PostgreSQL 的要求，调整凭据的所有权和权限： - ``` - chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - ``` + ``` + chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + ``` -4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过SSL连接，并要求客户端证书验证。 +4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过 SSL 连接，并要求客户端证书验证。 - 对于PostgreSQL 12： + 对于 PostgreSQL 12： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full + ``` - 对于PostgreSQL 11及更早版本： + 对于 PostgreSQL 11 及更早版本： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 + ``` - 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 + 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 5. 重新启动 PostgreSQL 以应用上述配置。 6. 在运行 Gitea 实例的服务器上，将以下凭据放置在运行 Gitea 的用户的主目录下（例如 `git`）： - - `~/.postgresql/postgresql.crt`: 数据库客户端证书 - - `~/.postgresql/postgresql.key`: 数据库客户端私钥 - - `~/.postgresql/root.crt`: 用于验证服务器证书的CA证书链 + - `~/.postgresql/postgresql.crt`: 数据库客户端证书 + - `~/.postgresql/postgresql.key`: 数据库客户端私钥 + - `~/.postgresql/root.crt`: 用于验证服务器证书的 CA 证书链 - 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 + 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 7. 根据需要调整凭据、所有权和权限： - ``` - chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - ``` + ``` + chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + ``` 8. 测试与数据库的连接： - ``` - psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" - ``` + ``` + psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" + ``` - 您将被提示输入数据库用户的密码，然后连接到数据库。 + 您将被提示输入数据库用户的密码，然后连接到数据库。 ### MySQL -虽然 Gitea 使用的MySQL驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 +虽然 Gitea 使用的 MySQL 驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 -在单向TLS中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 +在单向 TLS 中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 1. 在数据库实例上放置以下凭据： - - `/path/to/mysql.crt`: 数据库实例证书 - - `/path/to/mysql.key`: 数据库实例密钥 - - `/path/to/ca.crt`: CA证书链。在单向TLS中不使用此文件，但用于验证双向TLS中的客户端证书。 + - `/path/to/mysql.crt`: 数据库实例证书 + - `/path/to/mysql.key`: 数据库实例密钥 + - `/path/to/ca.crt`: CA 证书链。在单向 TLS 中不使用此文件，但用于验证双向 TLS 中的客户端证书。 2. 将以下选项添加到 `my.cnf`： - ```ini - [mysqld] - ssl-ca = /path/to/ca.crt - ssl-cert = /path/to/mysql.crt - ssl-key = /path/to/mysql.key - tls-version = TLSv1.2,TLSv1.3 - ``` + ```ini + [mysqld] + ssl-ca = /path/to/ca.crt + ssl-cert = /path/to/mysql.crt + ssl-key = /path/to/mysql.key + tls-version = TLSv1.2,TLSv1.3 + ``` 3. 调整凭据的所有权和权限： - ``` - chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - ``` + ``` + chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + ``` -4. 重新启动MySQL以应用设置。 +4. 重新启动 MySQL 以应用设置。 5. Gitea 的数据库用户可能已经创建过，但只会对运行 Gitea 的服务器的 IP 地址进行身份验证。要对其域名进行身份验证，请重新创建用户，并设置其需要通过 TLS 连接到数据库： - ```sql - DROP USER 'gitea'@'192.0.2.10'; - CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + DROP USER 'gitea'@'192.0.2.10'; + CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; + FLUSH PRIVILEGES; + ``` - 根据需要替换数据库用户名、密码和 Gitea 实例域名。 + 根据需要替换数据库用户名、密码和 Gitea 实例域名。 -6. 确保用于验证数据库服务器证书的CA证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 +6. 确保用于验证数据库服务器证书的 CA 证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 -7. 在运行Gitea的服务器上，测试与数据库的连接： +7. 在运行 Gitea 的服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h example.db -p --ssl - ``` + ``` + mysql -u gitea -h example.db -p --ssl + ``` - 至此应该成功连接到数据库了。 + 至此应该成功连接到数据库了。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/from-source.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/from-source.md index aebffe70..bdafe8b1 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/from-source.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/from-source.md @@ -6,13 +6,13 @@ sidebar_position: 30 # 使用源代码安装 -首先你需要安装Golang，关于Golang的安装，参见[官方文档](https://golang.google.cn/doc/install)。 +首先你需要安装 Golang，关于 Golang 的安装，参见[官方文档](https://golang.google.cn/doc/install)。 -其次你需要[安装Node.js](https://nodejs.org/zh-cn/download/)，Node.js 和 npm 将用于构建 Gitea 前端。 +其次你需要[安装 Node.js](https://nodejs.org/zh-cn/download/)，Node.js 和 npm 将用于构建 Gitea 前端。 ## 下载 -你需要获取Gitea的源码，最方便的方式是使用 `git` 命令。执行以下命令： +你需要获取 Gitea 的源码，最方便的方式是使用 `git` 命令。执行以下命令： ``` git clone https://github.com/go-gitea/gitea @@ -48,8 +48,8 @@ git checkout @sourceVersion@ 按照您的编译需求，以下 tags 可以使用： -- `bindata`: 这个编译选项将会把运行Gitea所需的所有外部资源都打包到可执行文件中，这样部署将非常简单因为除了可执行程序将不再需要任何其他文件。 -- `sqlite sqlite_unlock_notify`: 这个编译选项将启用SQLite3数据库的支持，建议只在少数人使用时使用这个模式。 +- `bindata`: 这个编译选项将会把运行 Gitea 所需的所有外部资源都打包到可执行文件中，这样部署将非常简单因为除了可执行程序将不再需要任何其他文件。 +- `sqlite sqlite_unlock_notify`: 这个编译选项将启用 SQLite3 数据库的支持，建议只在少数人使用时使用这个模式。 - `pam`: 这个编译选项将会启用 PAM (Linux Pluggable Authentication Modules) 认证，如果你使用这一认证模式的话需要开启这个选项。 使用 bindata 可以打包资源文件到二进制可以使开发和测试更容易，你可以根据自己的需求决定是否打包资源文件。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-cloud-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-cloud-provider.md index 3df86aff..ebbe7831 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-cloud-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-cloud-provider.md @@ -15,9 +15,9 @@ Cloudron 使得在您的服务器上运行 Gitea，并保持其更新和安全 [![Install](/cloudron.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp) -Gitea软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). +Gitea 软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). -这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行Gitea。 +这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行 Gitea。 ## Linode diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-kubernetes.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-kubernetes.md index d1d1c2f8..486bfe55 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-kubernetes.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/on-kubernetes.md @@ -33,15 +33,15 @@ helm install gitea -f values.yaml gitea/gitea Gitea 附带了一个运行状况检查接口 `/api/healthz`，你可以像这样在 Kubernetes 中配置它： ```yaml - livenessProbe: - httpGet: - path: /api/healthz - port: http - initialDelaySeconds: 200 - timeoutSeconds: 5 - periodSeconds: 10 - successThreshold: 1 - failureThreshold: 10 +livenessProbe: + httpGet: + path: /api/healthz + port: http + initialDelaySeconds: 200 + timeoutSeconds: 5 + periodSeconds: 10 + successThreshold: 1 + failureThreshold: 10 ``` 成功的运行状况检查响应代码为 HTTP `200`，下面是示例： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker-rootless.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker-rootless.md index 1da45312..184e9678 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker-rootless.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker-rootless.md @@ -45,7 +45,7 @@ services: - "2222:2222" ``` -请注意，卷应由在配置文件中指定的UID/GID的用户/组所有。默认情况下，Docker中的Gitea将使用uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： +请注意，卷应由在配置文件中指定的 UID/GID 的用户/组所有。默认情况下，Docker 中的 Gitea 将使用 uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： ```sh sudo chown 1000:1000 config/ data/ @@ -53,11 +53,11 @@ sudo chown 1000:1000 config/ data/ > 如果未为卷设置正确的权限，容器可能无法启动。 -对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 +对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x 是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 ## 自定义端口 -要将集成的SSH和Web服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 +要将集成的 SSH 和 Web 服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 ```diff version: "2" @@ -258,7 +258,7 @@ docker-compose up -d 除了上述的环境变量外，`app.ini` 中的任何设置都可以通过形式为 `GITEA__SECTION_NAME__KEY_NAME` 的环境变量进行设置或覆盖。这些设置在每次 Docker 容器启动时都会生效。完整信息请参考[这里](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini). -这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA__mailer__FROM、GITEA__mailer__HOST、GITEA__mailer__PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： +这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA**mailer**FROM、GITEA**mailer**HOST、GITEA**mailer**PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： ```bash ... diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker.md index 97bca760..3721fc53 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/installation/with-docker.md @@ -295,7 +295,7 @@ docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKE ``` ```yaml -... +--- services: server: environment: diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/linked-references.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/linked-references.md index 8648e403..fcd81851 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/linked-references.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/linked-references.md @@ -90,11 +90,11 @@ aliases: - `m` - 分钟 - `h` - 小时 -- `d` - 天（相当于8小时） -- `w` - 周（相当于5天） -- `mo` - 月（相当于4周） +- `d` - 天（相当于 8 小时） +- `w` - 周（相当于 5 天） +- `mo` - 月（相当于 4 周） -用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示1小时10分钟。 +用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示 1 小时 10 分钟。 提交消息示例： @@ -115,26 +115,26 @@ Gitea 支持使用外部工单跟踪器，并可以在合并请求中创建对 下表说明了工单和合并请求的不同类型的交叉引用。在示例中，`User1/Repo1` 指的是使用引用的仓库，而 `UserZ/RepoZ` 表示另一个仓库。 -| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | -| ----------------------- | :-------------------: | :-------------------: | ------------------------------------------------ | -| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | -| **字母数字工单编号:** | - | - | - | -| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | +| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | +| ----------------------- | :------------------: | :------------------: | --------------------------------------------- | +| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | +| **字母数字工单编号:** | - | - | - | +| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | _最后一部分适用于使用字母数字格式的外部工单跟踪器的仓库。_ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/permissions.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/permissions.md index 8153fff1..226365eb 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/permissions.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/permissions.md @@ -14,31 +14,31 @@ Gitea 支持对仓库进行权限管理，这样您就可以为不同的人员 在 Gitea 中，我们将仓库的子模块称为 `单元（Unit）`。现在我们有以下几个单元。 -| 名称 | 描述 | 权限 | -| ----------------- | --------------------------------------------------- | ------------ | -| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | -| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | -| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | -| 发布 | 跟踪项目版本和下载。 | 读取 写入 | -| 维基 | 与协作者编写和共享文档。 | 读取 写入 | -| 外部维基 | 链接到外部维基。 | 读取 | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | -| 项目 | 模板仓库的 URL。 | 读取 写入 | -| 设置 | 管理仓库。 | 管理员 | +| 名称 | 描述 | 权限 | +| -------------- | ------------------------------ | --------- | +| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | +| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | +| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | +| 发布 | 跟踪项目版本和下载。 | 读取 写入 | +| 维基 | 与协作者编写和共享文档。 | 读取 写入 | +| 外部维基 | 链接到外部维基。 | 读取 | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | +| 项目 | 模板仓库的 URL。 | 读取 写入 | +| 设置 | 管理仓库。 | 管理员 | 通过不同的权限，用户可以在这些单元上执行不同的操作。 -| 名称 | 读取 | 写入 | 管理员 | -| ----------------- | -------------------------------------------------- | ------------------------------ | ------------------------- | -| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | -| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | -| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | -| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | -| 维基 | 查看维基页面。克隆维基仓库。 | 创建/编辑维基页面，推送更改。 | - | -| 外部维基 | 链接到外部维基。 | - | - | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | -| 项目 | 查看面板。 | 在面板之间移动工单。 | - | -| 设置 | - | - | 管理仓库 | +| 名称 | 读取 | 写入 | 管理员 | +| -------------- | -------------------------------- | ------------------------------ | -------- | +| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | +| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | +| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | +| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | +| 维基 | 查看维基页面。克隆维基仓库。 | 创建/编辑维基页面，推送更改。 | - | +| 外部维基 | 链接到外部维基。 | - | - | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | +| 项目 | 查看面板。 | 在面板之间移动工单。 | - | +| 设置 | - | - | 管理仓库 | 个人仓库和组织仓库之间的权限存在一些差异。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/protected-tags.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/protected-tags.md index 307b048f..1bc4b8a2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/protected-tags.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/protected-tags.md @@ -25,17 +25,17 @@ aliases: 示例： -| 类型 | 模式受保护的标签 | 可能匹配的标签 | +| 类型 | 模式受保护的标签 | 可能匹配的标签 | | ----- | ------------------------ | --------------------------------------- | | Glob | `v*` | `v`，`v-1`，`version2` | -| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | +| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | | Glob | `*-release` | `2.1-release`，`final-release` | | Glob | `gitea` | 仅限 `gitea` | | Glob | `*gitea*` | `gitea`，`2.1-gitea`，`1_gitea-release` | | Glob | `{v,rel}-*` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Glob | `*` | 匹配所有可能的标签名称 | +| Glob | `*` | 匹配所有可能的标签名称 | | Regex | `/\Av/` | `v`，`v-1`，`version2` | -| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | +| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | | Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`，`v2.1.0` | | Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`，`v2.1`，`v1.2.34` | | Regex | `/-release\z/` | `2.1-release`，`final-release` | @@ -43,4 +43,4 @@ aliases: | Regex | `/\Agitea\z/` | 仅限 `gitea` | | Regex | `/^gitea$/` | 仅限 `gitea` | | Regex | `/\A(v\|rel)-/` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Regex | `/.+/` | 匹配所有可能的标签名称 | +| Regex | `/.+/` | 匹配所有可能的标签名称 | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/repo-mirror.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/repo-mirror.md index 4143cb32..b5792c98 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/repo-mirror.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/repo-mirror.md @@ -53,7 +53,7 @@ aliases: 要从 Gitea 设置镜像到 GitHub，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *public_repo* 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 +1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同，GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史，您也可以使用现有的远程仓库。 3. 在您的 Gitea 仓库设置中，填写**Git 远程仓库 URL**：`https://github.com//.git`。 4. 使用您的 GitHub 用户名填写**授权**字段，并将个人访问令牌作为**密码**。 @@ -66,7 +66,7 @@ aliases: 要从 Gitea 设置镜像到 GitLab，您需要按照以下步骤进行操作： -1. 创建具有 *write_repository* 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 +1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 2. 填写**Git 远程仓库 URL**：`https:////.git`。 3. 在**授权**字段中填写 `oauth2` 作为**用户名**，并将您的 GitLab 个人访问令牌作为**密码**。 4. 选择**添加推送镜像**以保存配置。 @@ -77,7 +77,7 @@ aliases: 要从 Gitea 设置镜像到 Bitbucket，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *Repository Write* 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 +1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 2. 填写**Git 远程仓库 URL**：`https://bitbucket.org//.git`。 3. 使用您的 Bitbucket 用户名填写**授权**字段，并将应用密码作为**密码**。 4. 选择**添加推送镜像**以保存配置。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/template-repositories.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/template-repositories.md index 8faabd96..bf6ab589 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/template-repositories.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.19/usage/template-repositories.md @@ -40,20 +40,20 @@ a/b/c/d.json 所有变量都必须采用`$VAR`或`${VAR}`的形式。要转义扩展，使用双重`$$`，例如`$$VAR`或`$${VAR}`。 -| 变量 | 扩展为 | 可转换 | -| -------------------- | --------------------------------------------------- | ------------- | -| REPO_NAME | 生成的仓库名称 | ✓ | -| TEMPLATE_NAME | 模板仓库名称 | ✓ | -| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | -| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | -| REPO_OWNER | 生成的仓库所有者 | ✓ | -| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | -| REPO_LINK | 生成的仓库链接 | ✘ | -| TEMPLATE_LINK | 模板仓库链接 | ✘ | -| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | -| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | -| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | -| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | +| 变量 | 扩展为 | 可转换 | +| -------------------- | ----------------------------- | ------ | +| REPO_NAME | 生成的仓库名称 | ✓ | +| TEMPLATE_NAME | 模板仓库名称 | ✓ | +| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | +| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | +| REPO_OWNER | 生成的仓库所有者 | ✓ | +| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | +| REPO_LINK | 生成的仓库链接 | ✘ | +| TEMPLATE_LINK | 模板仓库链接 | ✘ | +| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | +| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | +| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | +| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | ## 转换器 :robot: @@ -63,12 +63,12 @@ Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。 将 `go-sdk` 传递给可用的转换器的效果如下... -| 转换器 | 效果 | -| ----------- | ------------ | -| SNAKE | go_sdk | -| KEBAB | go-sdk | -| CAMEL | goSdk | -| PASCAL | GoSdk | -| LOWER | go-sdk | -| UPPER | GO-SDK | -| TITLE | Go-Sdk | +| 转换器 | 效果 | +| ------ | ------ | +| SNAKE | go_sdk | +| KEBAB | go-sdk | +| CAMEL | goSdk | +| PASCAL | GoSdk | +| LOWER | go-sdk | +| UPPER | GO-SDK | +| TITLE | Go-Sdk | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/authentication.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/authentication.md index e56d7262..fe462fbf 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/authentication.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/authentication.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/authentication - --- # 认证 @@ -26,6 +25,6 @@ ENABLE_REVERSE_PROXY_AUTHENTICATION = true 如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`，则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取，这样在自动创建用户时将使用这个字段作为用户全名，你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 -你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的IP地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 +你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 注意：反向代理认证不支持认证 API，API 仍旧需要用 access token 来进行认证。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/backup-and-restore.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/backup-and-restore.md index 6b140851..d3fe3b8a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/backup-and-restore.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/backup-and-restore.md @@ -8,11 +8,11 @@ aliases: # 备份与恢复 -Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个zip压缩文件。该压缩文件可以被用来进行数据恢复。 +Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 ## 备份命令 (`dump`) -先转到git用户的权限: `su git`. 再Gitea目录运行 `./gitea dump`。一般会显示类似如下的输出： +先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出： ``` 2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 @@ -25,11 +25,11 @@ Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一 最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容： -* `custom` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 -* `data` - 数据目录下的所有内容不包含使用文件session的文件。该目录包含 `attachments`, `avatars`, `lfs`, `indexers`, 如果使用sqlite 还会包含 sqlite 数据库文件。 -* `gitea-db.sql` - 数据库dump出来的 SQL。 -* `gitea-repo.zip` - Git仓库压缩文件。 -* `log/` - Logs文件，如果用作迁移不是必须的。 +- `custom` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 +- `data` - 数据目录下的所有内容不包含使用文件 session 的文件。该目录包含 `attachments`, `avatars`, `lfs`, `indexers`, 如果使用 sqlite 还会包含 sqlite 数据库文件。 +- `gitea-db.sql` - 数据库 dump 出来的 SQL。 +- `gitea-repo.zip` - Git 仓库压缩文件。 +- `log/` - Logs 文件，如果用作迁移不是必须的。 中间备份文件将会在临时目录进行创建，如果您要重新指定临时目录，可以用 `--tempdir` 参数，或者用 `TMPDIR` 环境变量。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/command-line.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/command-line.md index e0d69ca6..7dc8e0a5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/command-line.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/command-line.md @@ -59,7 +59,7 @@ aliases: - 选项： - `--email`：要删除的用户的电子邮件。 - `--username`：要删除的用户的用户名。 - - `--id`：要删除的用户的ID。 + - `--id`：要删除的用户的 ID。 - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 - 示例： - `gitea admin user delete --id 1` @@ -168,11 +168,11 @@ aliases: - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 - `--skip-local-2fa`：跳过 2FA 登录。 - `--active`：启用此认证源。 - 备注： - `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： - `--option`、`--option=true` 以启用选项 - `--option=false` 以禁用选项 - 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 - 示例： - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` - `update-smtp`： @@ -281,12 +281,12 @@ aliases: ### cert -生成自签名的SSL证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 - 选项： - - `--host value`：逗号分隔的主机名和IP地址列表，此证书适用于这些主机。支持使用通配符。必填。 - - `--ecdsa-curve value`：用于生成密钥的ECDSA曲线。可选。有效选项为P224、P256、P384、P521。 - - `--rsa-bits value`：要生成的RSA密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：2048）。 + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：2048）。 - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 @@ -295,18 +295,18 @@ aliases: ### dump -将所有文件和数据库导出到一个zip文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 - 选项： - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 - `--skip-repository`，`-R`：跳过仓库的导出。可选。 - `--skip-custom-dir`：跳过自定义目录的导出。可选。 - - `--skip-lfs-data`：跳过LFS数据的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 - `--skip-attachment-data`：跳过附件数据的导出。可选。 - `--skip-package-data`：跳过包数据的导出。可选。 - `--skip-log`：跳过日志数据的导出。可选。 - - `--database`，`-d`：指定数据库的SQL语法。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 - `--type`：设置导出的格式。可选。（默认值：zip） - 示例： @@ -409,19 +409,19 @@ gitea doctor recreate-table - 命令: - `shutdown`: 优雅地关闭运行中的进程 - - `restart`: 优雅地重新启动运行中的进程（对于Windows服务器尚未实现） + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） - `flush-queues`: 刷新运行中的进程中的队列 - 选项: - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） - - `--non-blocking`: 设置为true，以在返回之前不等待刷新完成 + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 - `logging`: 调整日志命令 - 命令: - `pause`: 暂停日志记录 - 注意: - - 如果日志级别低于此级别，日志级别将被临时提升为INFO。 - - Gitea将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 - `resume`: 恢复日志记录 - - `release-and-reopen`: 使Gitea释放和重新打开用于日志记录的文件和连接（相当于向Gitea发送SIGUSR1信号）。 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 - `remove name`: 删除指定的日志记录器 - 选项: - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） @@ -437,7 +437,7 @@ gitea doctor recreate-table - `--expression value`, `-e value`: 日志记录器的匹配表达式 - `--prefix value`, `-p value`: 日志记录器的前缀 - `--color`: 在日志中使用颜色 - - `--stderr`: 将控制台日志输出到stderr - 仅适用于控制台 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 - `file`: 添加文件日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" @@ -467,9 +467,9 @@ gitea doctor recreate-table - `--color`: 在日志中使用颜色 - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 - `--reconnect`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix或udp（默认为tcp） + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） - - `smtp`: 添加SMTP日志记录器 + - `smtp`: 添加 SMTP 日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/config-cheat-sheet.md index a7700537..0ed7d616 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/config-cheat-sheet.md @@ -8,30 +8,30 @@ aliases: # 配置说明 -这是针对Gitea配置文件的说明，你可以了解Gitea的强大配置。需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 +这是针对 Gitea 配置文件的说明，你可以了解 Gitea 的强大配置。需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 所有默认值可以通过 [app.example.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) 查看到。 如果你发现 `%(X)s` 这样的内容，请查看 [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。 标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 -## ⚠️时效性警告⚠️ +## ⚠️ 时效性警告 ⚠️ 此文档的内容可能过于陈旧或者错误，请参考英文文档。 ## Overall (`DEFAULT`) - `APP_NAME`: 应用名称，改成你希望的名字。 -- `RUN_USER`: 运行Gitea的用户，推荐使用 `git`；如果在你自己的个人电脑使用改成你自己的用户名。如果设置不正确，Gitea可能崩溃。 +- `RUN_USER`: 运行 Gitea 的用户，推荐使用 `git`；如果在你自己的个人电脑使用改成你自己的用户名。如果设置不正确，Gitea 可能崩溃。 - `RUN_MODE`: 从性能考虑，如果在产品级的服务上改成 `prod`。如果您使用安装向导安装的那么会自动设置为 `prod`。 ## Repository (`repository`) -- `ROOT`: 存放git工程的根目录。这里必须填绝对路径，默认值是 `~//gitea-repositories`。 -- `SCRIPT_TYPE`: 服务器支持的Shell类型，通常是 `bash`，但有些服务器也有可能是 `sh`。 +- `ROOT`: 存放 git 工程的根目录。这里必须填绝对路径，默认值是 `~//gitea-repositories`。 +- `SCRIPT_TYPE`: 服务器支持的 Shell 类型，通常是 `bash`，但有些服务器也有可能是 `sh`。 - `ANSI_CHARSET`: 默认字符编码。 -- `FORCE_PRIVATE`: 强制所有git工程必须私有。 -- `DEFAULT_PRIVATE`: 默认创建的git工程为私有。 可以是`last`, `private` 或 `public`。默认值是 `last`表示用户最后创建的Repo的选择。 -- `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 通过 ``push-to-create`` 方式创建的仓库是否默认为私有仓库. -- `MAX_CREATION_LIMIT`: 全局最大每个用户创建的git工程数目， `-1` 表示没限制。 +- `FORCE_PRIVATE`: 强制所有 git 工程必须私有。 +- `DEFAULT_PRIVATE`: 默认创建的 git 工程为私有。 可以是`last`, `private` 或 `public`。默认值是 `last`表示用户最后创建的 Repo 的选择。 +- `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 通过 `push-to-create` 方式创建的仓库是否默认为私有仓库. +- `MAX_CREATION_LIMIT`: 全局最大每个用户创建的 git 工程数目， `-1` 表示没限制。 ### Repository - Release (`repository.release`) @@ -60,16 +60,16 @@ aliases: - `PROTOCOL`: 可选 `http` 或 `https`。 - `DOMAIN`: 服务器域名。 -- `ROOT_URL`: Gitea服务器的对外 URL。 +- `ROOT_URL`: Gitea 服务器的对外 URL。 - `HTTP_ADDR`: HTTP 监听地址。 - `HTTP_PORT`: HTTP 监听端口。 -- `DISABLE_SSH`: 是否禁用SSH。 -- `START_SSH_SERVER`: 是否启用内部SSH服务器。 -- `SSH_PORT`: SSH端口，默认为 `22`。 +- `DISABLE_SSH`: 是否禁用 SSH。 +- `START_SSH_SERVER`: 是否启用内部 SSH 服务器。 +- `SSH_PORT`: SSH 端口，默认为 `22`。 - `OFFLINE_MODE`: 针对静态和头像文件禁用 CDN。 - `DISABLE_ROUTER_LOG`: 关闭日志中的路由日志。 -- `CERT_FILE`: 启用HTTPS的证书文件。 -- `KEY_FILE`: 启用HTTPS的密钥文件。 +- `CERT_FILE`: 启用 HTTPS 的证书文件。 +- `KEY_FILE`: 启用 HTTPS 的密钥文件。 - `STATIC_ROOT_PATH`: 存放模板和静态文件的根目录，默认是 Gitea 的根目录。 - `STATIC_CACHE_TIME`: **6h**: 静态资源文件，包括 `custom/`, `public/` 和所有上传的头像的浏览器缓存时间。 - `ENABLE_GZIP`: 启用实时生成的数据启用 GZIP 压缩，不包括静态资源。 @@ -86,24 +86,24 @@ aliases: - `NAME`: 数据库名称。 - `USER`: 数据库用户名。 - `PASSWD`: 数据库用户密码。 -- `SSL_MODE`: MySQL 或 PostgreSQL数据库是否启用SSL模式。 +- `SSL_MODE`: MySQL 或 PostgreSQL 数据库是否启用 SSL 模式。 - `CHARSET`: **utf8mb4**: 仅当数据库为 MySQL 时有效, 可以为 "utf8" 或 "utf8mb4"。注意：如果使用 "utf8mb4"，你的 MySQL InnoDB 版本必须在 5.6 以上。 - `PATH`: SQLite3 数据文件存放路径。 -- `LOG_SQL`: **false**: 显示生成的SQL，默认为真。 +- `LOG_SQL`: **false**: 显示生成的 SQL，默认为真。 - `MAX_IDLE_CONNS` **0**: 最大空闲数据库连接 - `CONN_MAX_LIFETIME` **3s**: 数据库连接最大存活时间 ## Indexer (`indexer`) - `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型，当前支持 `bleve`, `db` 和 `elasticsearch`，当为 `db` 时其它工单索引项可不用设置。 -- `ISSUE_INDEXER_CONN_STR`: ****: 工单索引连接字符串，仅当 ISSUE_INDEXER_TYPE 为 `elasticsearch` 时有效。例如: http://elastic:changeme@localhost:9200 +- `ISSUE_INDEXER_CONN_STR`: \*\*\*\*: 工单索引连接字符串，仅当 ISSUE_INDEXER_TYPE 为 `elasticsearch` 时有效。例如: http://elastic:changeme@localhost:9200 - `ISSUE_INDEXER_NAME`: **gitea_issues**: 工单索引名称，仅当 ISSUE_INDEXER_TYPE 为 `elasticsearch` 时有效。 - `ISSUE_INDEXER_PATH`: **indexers/issues.bleve**: 工单索引文件存放路径，当索引类型为 `bleve` 时有效。 -- `REPO_INDEXER_ENABLED`: **false**: 是否启用代码搜索（启用后会占用比较大的磁盘空间，如果是bleve可能需要占用约6倍存储空间）。 +- `REPO_INDEXER_ENABLED`: **false**: 是否启用代码搜索（启用后会占用比较大的磁盘空间，如果是 bleve 可能需要占用约 6 倍存储空间）。 - `REPO_INDEXER_TYPE`: **bleve**: 代码搜索引擎类型，可以为 `bleve` 或者 `elasticsearch`。 - `REPO_INDEXER_PATH`: **indexers/repos.bleve**: 用于代码搜索的索引文件路径。 -- `REPO_INDEXER_CONN_STR`: ****: 代码搜索引擎连接字符串，当 `REPO_INDEXER_TYPE` 为 `elasticsearch` 时有效。例如： http://elastic:changeme@localhost:9200 +- `REPO_INDEXER_CONN_STR`: \*\*\*\*: 代码搜索引擎连接字符串，当 `REPO_INDEXER_TYPE` 为 `elasticsearch` 时有效。例如： http://elastic:changeme@localhost:9200 - `REPO_INDEXER_NAME`: **gitea_codes**: 代码搜索引擎的名字，当 `REPO_INDEXER_TYPE` 为 `elasticsearch` 时有效。 - `MAX_FILE_SIZE`: **1048576**: 进行解析的源代码文件的最大长度，小于该值时才会索引。 @@ -152,11 +152,11 @@ aliases: ## Webhook (`webhook`) - `QUEUE_LENGTH`: 说明: Hook 任务队列长度。 -- `DELIVER_TIMEOUT`: 请求webhooks的超时时间，单位秒。 +- `DELIVER_TIMEOUT`: 请求 webhooks 的超时时间，单位秒。 - `SKIP_TLS_VERIFY`: 是否允许不安全的证书。 -- `PAGING_NUM`: 每页显示的Webhook 历史数量。 -- `PROXY_URL`: ****: 代理服务器网址，支持 http://, https//, socks://, 为空将使用环境变量中的 http_proxy/https_proxy 设置。 -- `PROXY_HOSTS`: ****: 逗号分隔的需要代理的域名或IP地址。支持 * 号匹配符，使用 ** 匹配所有域名和IP地址。 +- `PAGING_NUM`: 每页显示的 Webhook 历史数量。 +- `PROXY_URL`: \*\*\*\*: 代理服务器网址，支持 http://, https//, socks://, 为空将使用环境变量中的 http_proxy/https_proxy 设置。 +- `PROXY_HOSTS`: \***_: 逗号分隔的需要代理的域名或 IP 地址。支持 _ 号匹配符，使用 ** 匹配所有域名和 IP 地址。 ## Mailer (`mailer`) @@ -175,8 +175,8 @@ aliases: - `ENABLED`: **true**: 是否启用。 - `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis` 或 `memcache`。 -- `INTERVAL`: **60**: 只对内存缓存有效，GC间隔，单位秒。 -- `HOST`: **_empty_**: 针对redis和memcache有效，主机地址和端口。 +- `INTERVAL`: **60**: 只对内存缓存有效，GC 间隔，单位秒。 +- `HOST`: **_empty_**: 针对 redis 和 memcache 有效，主机地址和端口。 - Redis: `network=tcp,addr=127.0.0.1:6379,password=macaron,db=0,pool_size=100,idle_timeout=180` - Memache: `127.0.0.1:9090;127.0.0.1:9091` - `ITEM_TTL`: **16h**: 缓存项目失效时间，设置为 -1 则禁用缓存。 @@ -192,7 +192,7 @@ aliases: - `PROVIDER`: Session 内容存储方式，可选 `memory`, `file`, `redis` 或 `mysql`。 - `PROVIDER_CONFIG`: 如果是文件，那么这里填根目录；其他的要填主机地址和端口。 - `COOKIE_SECURE`: **_empty_**: `true` 或 `false`。启用此选项以强制在所有会话访问中使用 HTTPS。如果没有设置，当 ROOT_URL 是 https 链接的时候默认设置为 true。 -- `GC_INTERVAL_TIME`: Session失效时间。 +- `GC_INTERVAL_TIME`: Session 失效时间。 ## Picture (`picture`) @@ -200,13 +200,13 @@ aliases: - `DISABLE_GRAVATAR`: 开启则只使用内部头像。 - `ENABLE_FEDERATED_AVATAR`: 启用头像联盟支持 (参见 http://www.libravatar.org) -- `AVATAR_STORAGE_TYPE`: **local**: 头像存储类型，可以为 `local` 或 `minio`，分别支持本地文件系统和 minio 兼容的API。 +- `AVATAR_STORAGE_TYPE`: **local**: 头像存储类型，可以为 `local` 或 `minio`，分别支持本地文件系统和 minio 兼容的 API。 - `AVATAR_UPLOAD_PATH`: **data/avatars**: 存储头像的文件系统路径。 - `AVATAR_MAX_WIDTH`: **4096**: 头像最大宽度，单位像素。 - `AVATAR_MAX_HEIGHT`: **4096**: 头像最大高度，单位像素。 - `AVATAR_MAX_FILE_SIZE`: **1048576** (1MiB): 头像最大大小。 -- `REPOSITORY_AVATAR_STORAGE_TYPE`: **local**: 仓库头像存储类型，可以为 `local` 或 `minio`，分别支持本地文件系统和 minio 兼容的API。 +- `REPOSITORY_AVATAR_STORAGE_TYPE`: **local**: 仓库头像存储类型，可以为 `local` 或 `minio`，分别支持本地文件系统和 minio 兼容的 API。 - `REPOSITORY_AVATAR_UPLOAD_PATH`: **data/repo-avatars**: 存储仓库头像的路径。 - `REPOSITORY_AVATAR_FALLBACK`: **none**: 当头像丢失时的处理方式 - none = 不显示头像 @@ -230,7 +230,7 @@ aliases: - `MINIO_BASE_PATH`: **attachments/**: Minio base path on the bucket，仅当 `STORAGE_TYPE` 是 `minio` 时有效。 - `MINIO_USE_SSL`: **false**: Minio enabled ssl，仅当 `STORAGE_TYPE` 是 `minio` 时有效。 -关于 `ALLOWED_TYPES`， 在 (*)unix 系统中可以使用`file -I ` 来快速获得对应的 `MIME type`。 +关于 `ALLOWED_TYPES`， 在 (\*)unix 系统中可以使用`file -I ` 来快速获得对应的 `MIME type`。 ```shell $ file -I test00.tar.xz @@ -257,12 +257,12 @@ test01.xls: application/vnd.ms-excel; charset=binary - `Start`: 请求开始时间。 - `ResponseWriter`: - `RequestID`: 从请求头中解析得到的与 `REQUEST_ID_HEADERS` 匹配的值，默认: “`-`”。 - - 一定要谨慎配置该模板，否则可能会引起panic. + - 一定要谨慎配置该模板，否则可能会引起 panic. - `REQUEST_ID_HEADERS`: 从 Request Header 中匹配指定 Key，并将匹配到的值输出到 `access.log` 中(需要在 `ACCESS_LOG_TEMPLATE` 中指定输出位置)。如果在该参数中配置多个 Key， 请用逗号分割，程序将按照配置的顺序进行匹配。 - 示例： - - 请求头： X-Request-ID: **test-id-123** - - 配置文件： REQUEST_ID_HEADERS = X-Request-ID - - 日志输出： 127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... + - 请求头： X-Request-ID: **test-id-123** + - 配置文件： REQUEST_ID_HEADERS = X-Request-ID + - 日志输出： 127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... ## Cron (`cron`) @@ -271,22 +271,22 @@ test01.xls: application/vnd.ms-excel; charset=binary - `SCHEDULE` 所接受的格式 - 完整 crontab 控制, 例如 `* * * * * ?` - 描述符, 例如 `@midnight`, `@every 1h30m` ... - - 更多细节参见 [cron api文档](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14) + - 更多细节参见 [cron api 文档](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14) ### Cron - Update Mirrors (`cron.update_mirrors`) -- `SCHEDULE`: 自动同步镜像仓库的Cron语法，比如：`@every 1h`。 +- `SCHEDULE`: 自动同步镜像仓库的 Cron 语法，比如：`@every 1h`。 ### Cron - Repository Health Check (`cron.repo_health_check`) -- `SCHEDULE`: 仓库健康监测的Cron语法，比如：`@midnight`。 +- `SCHEDULE`: 仓库健康监测的 Cron 语法，比如：`@midnight`。 - `TIMEOUT`: 仓库健康监测的超时时间，比如：`60s`. - `ARGS`: 执行 `git fsck` 命令的参数，比如：`--unreachable --tags`。 ### Cron - Repository Statistics Check (`cron.check_repo_stats`) - `RUN_AT_START`: 是否启动时自动运行仓库统计。 -- `SCHEDULE`: 仓库统计时的Cron 语法，比如：`@midnight`. +- `SCHEDULE`: 仓库统计时的 Cron 语法，比如：`@midnight`. ### Cron - Update Migration Poster ID (`cron.update_migration_poster_id`) @@ -301,25 +301,25 @@ test01.xls: application/vnd.ms-excel; charset=binary ## Git - 超时设置 (`git.timeout`) -- `DEFAUlT`: **360**: Git操作默认超时时间，单位秒 +- `DEFAUlT`: **360**: Git 操作默认超时时间，单位秒 - `MIGRATE`: **600**: 迁移外部仓库时的超时时间，单位秒 - `MIRROR`: **300**: 镜像外部仓库的超时时间，单位秒 - `CLONE`: **300**: 内部仓库间克隆的超时时间，单位秒 - `PULL`: **300**: 内部仓库间拉取的超时时间，单位秒 -- `GC`: **60**: git仓库GC的超时时间，单位秒 -- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 是否根据 Git Wire Protocol协议支持情况自动切换版本，当 git 版本在 2.18 及以上时会自动切换到版本2。为 `false` 则不切换。 +- `GC`: **60**: git 仓库 GC 的超时时间，单位秒 +- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 是否根据 Git Wire Protocol 协议支持情况自动切换版本，当 git 版本在 2.18 及以上时会自动切换到版本 2。为 `false` 则不切换。 ## API (`api`) -- `ENABLE_SWAGGER`: **true**: 是否启用swagger路由 /api/swagger, /api/v1/swagger etc. endpoints. True 或 false. +- `ENABLE_SWAGGER`: **true**: 是否启用 swagger 路由 /api/swagger, /api/v1/swagger etc. endpoints. True 或 false. - `MAX_RESPONSE_ITEMS`: **50**: 一个页面最大的项目数。 -- `DEFAULT_PAGING_NUM`: **30**: API中默认分页条数。 -- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: GIT TREES API每页的默认最大项数. -- `DEFAULT_MAX_BLOB_SIZE`: **10485760**: BLOBS API默认最大大小. +- `DEFAULT_PAGING_NUM`: **30**: API 中默认分页条数。 +- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: GIT TREES API 每页的默认最大项数. +- `DEFAULT_MAX_BLOB_SIZE`: **10485760**: BLOBS API 默认最大大小. ## Markup (`markup`) -外部渲染工具支持，你可以用你熟悉的文档渲染工具. 比如一下将新增一个名字为 `asciidoc` 的渲染工具which is followed `markup.` ini section. And there are some config items below. +外部渲染工具支持，你可以用你熟悉的文档渲染工具. 比如一下将新增一个名字为 `asciidoc` 的渲染工具 which is followed `markup.` ini section. And there are some config items below. ```ini [markup.asciidoc] @@ -330,8 +330,8 @@ RENDER_COMMAND = "asciidoctor --embedded --safe-mode=secure --out-file=- -" IS_INPUT_FILE = false ``` -- ENABLED: 是否启用，默认为false。 -- NEED\_POSTPROCESS: **true** 设置为 true 则会替换渲染文件中的内部链接和Commit ID 等。 +- ENABLED: 是否启用，默认为 false。 +- NEED_POSTPROCESS: **true** 设置为 true 则会替换渲染文件中的内部链接和 Commit ID 等。 - FILE_EXTENSIONS: 关联的文档的扩展名，多个扩展名用都好分隔。 - RENDER_COMMAND: 工具的命令行命令及参数。 - IS_INPUT_FILE: 输入方式是最后一个参数为文件路径还是从标准输入读取。 @@ -342,8 +342,8 @@ IS_INPUT_FILE = false 以下两个环境变量将会被传递给渲染命令： -- `GITEA_PREFIX_SRC`：包含当前的`src`路径的URL前缀，可以被用于链接的前缀。 -- `GITEA_PREFIX_RAW`：包含当前的`raw`路径的URL前缀，可以被用于图片的前缀。 +- `GITEA_PREFIX_SRC`：包含当前的`src`路径的 URL 前缀，可以被用于链接的前缀。 +- `GITEA_PREFIX_RAW`：包含当前的`raw`路径的 URL 前缀，可以被用于图片的前缀。 如果 `RENDER_CONTENT_MODE` 为 `sanitized`，则 Gitea 支持自定义渲染 HTML 的净化策略。以下例子将用 pandoc 支持 KaTeX 输出。 @@ -362,7 +362,7 @@ ALLOW_DATA_URI_IMAGES = true - `REGEXP`: 正则表达式，用来匹配属性的内容。如果为空，则跟属性内容无关。 - `ALLOW_DATA_URI_IMAGES`: **false** 允许 data uri 图片 (``)。 -多个净化规则可以被同时定义，只要section名称最后一位不重复即可。如： `[markup.sanitizer.TeX-2]`。 +多个净化规则可以被同时定义，只要 section 名称最后一位不重复即可。如： `[markup.sanitizer.TeX-2]`。 为了针对一种渲染类型进行一个特殊的净化策略，必须使用形如 `[markup.sanitizer.asciidoc.rule-1]` 的方式来命名 section。 如果此规则没有匹配到任何渲染类型，它将会被应用到所有的渲染类型。 @@ -375,7 +375,7 @@ ALLOW_DATA_URI_IMAGES = true - `QUEUE_TYPE`: **channel**: 任务队列类型，可以为 `channel` 或 `redis`。 - `QUEUE_LENGTH`: **1000**: 任务队列长度，当 `QUEUE_TYPE` 为 `channel` 时有效。 -- `QUEUE_CONN_STR`: **addrs=127.0.0.1:6379 db=0**: 任务队列连接字符串，当 `QUEUE_TYPE` 为 `redis` 时有效。如果redis有密码，则可以 `addrs=127.0.0.1:6379 password=123 db=0`。 +- `QUEUE_CONN_STR`: **addrs=127.0.0.1:6379 db=0**: 任务队列连接字符串，当 `QUEUE_TYPE` 为 `redis` 时有效。如果 redis 有密码，则可以 `addrs=127.0.0.1:6379 password=123 db=0`。 ## Migrations (`migrations`) @@ -438,7 +438,7 @@ MINIO_INSECURE_SKIP_VERIFY = false SERVE_DIRECT = true ``` -默认的，每一个存储都会有各自默认的 BasePath 在同一个minio中，默认值如下： +默认的，每一个存储都会有各自默认的 BasePath 在同一个 minio 中，默认值如下： | storage | default base path | | ----------------- | ------------------ | @@ -505,7 +505,7 @@ Repository archive 的存储配置。 如果 `STORAGE_TYPE` 为空，则此配 - `PROXY_ENABLED`: **false**: 是否启用全局代理。如果为否，则不使用代理，环境变量中的代理也不使用 - `PROXY_URL`: **_empty_**: 代理服务器地址，支持 http://, https//, socks://，为空则不启用代理而使用环境变量中的 http_proxy/https_proxy -- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 * 号匹配符号， ** 表示匹配所有网站 +- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 \* 号匹配符号， \*\* 表示匹配所有网站 i.e. @@ -517,4 +517,4 @@ PROXY_HOSTS = *.github.com ## Other (`other`) -- `SHOW_FOOTER_VERSION`: 为真则在页面底部显示Gitea的版本。 +- `SHOW_FOOTER_VERSION`: 为真则在页面底部显示 Gitea 的版本。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/customizing-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/customizing-gitea.md index 6894257d..92ec5e6b 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/customizing-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/customizing-gitea.md @@ -10,7 +10,7 @@ aliases: Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板等默认配置。 -如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为Linux文件系统标准。Gitea +如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为 Linux 文件系统标准。Gitea 将会自动创建包括 `custom/` 在内的必要应用目录，应用本身的配置存放在 `custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接，查看配置详情请移步： @@ -64,7 +64,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板 除了 `extra_links.tmpl` 和 `extra_tabs.tmpl`，您可以在您的 `custom/templates/custom/` 目录中存放一些其他有用的模板，例如： -- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义CSS文件 +- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义 CSS 文件 - `body_outer_pre.tmpl`，在 `` 标记开始处的模板 - `body_inner_pre.tmpl`，在顶部导航栏之前，但在主 container 内部的模板，例如添加一个 `
` - `body_inner_post.tmpl`，在主 container 结束处的模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/email-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/email-setup.md index 15a24b97..845cca1b 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/email-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/email-setup.md @@ -14,9 +14,9 @@ Gitea 具有邮件功能，用于发送事务性邮件（例如注册确认邮 使用 `sendmail` 命令作为邮件传输代理（mailer）。 -注意：对于在官方Gitea Docker镜像中使用，请使用SMTP版本进行配置（请参考下一节）。 +注意：对于在官方 Gitea Docker 镜像中使用，请使用 SMTP 版本进行配置（请参考下一节）。 -注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 +注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过 TLS 发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 ```ini title="app.ini" [mailer] @@ -53,9 +53,9 @@ PASSWD = `password` - 通过端口 587 的 STARTTLS（也称为 Opportunistic TLS）。初始连接是明文的，但如果服务器支持，则可以升级为 TLS。 - 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。 - 使用 `IS_TLS_ENABLED=true` 进行强制的 SMTPS 连接。（这两种方式都被称为 Implicit TLS） -这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 + 这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 -请注意，自2018年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 +请注意，自 2018 年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 ### Gmail diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/environment-variables.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/environment-variables.md index 9a751259..d5d77a04 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/environment-variables.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/environment-variables.md @@ -18,31 +18,31 @@ GITEA_CUSTOM=/home/gitea/custom ./gitea web 因为 Gitea 使用 Go 语言编写，因此它使用了一些相关的 Go 的配置参数： -* `GOOS` -* `GOARCH` -* [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) +- `GOOS` +- `GOARCH` +- [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) 您可以在[官方文档](https://golang.org/cmd/go/#hdr-Environment_variables)中查阅这些配置参数的详细信息。 ## Gitea 的文件目录 -* `GITEA_WORK_DIR`：工作目录的绝对路径 -* `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录 -* `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 -* `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 +- `GITEA_WORK_DIR`：工作目录的绝对路径 +- `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 _custom_ 目录 +- `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 +- `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 ## 操作系统配置 -* `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 -* `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` -* `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 +- `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 +- `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` +- `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 ### 仅限于 Windows 的配置 -* `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` -* `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘） -* `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 +- `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` +- `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C 盘） +- `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 ## Miscellaneous -* `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 +- `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/external-renderers.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/external-renderers.md index a82b4833..4a10b3f5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/external-renderers.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/external-renderers.md @@ -171,7 +171,8 @@ ALLOW_DATA_URI_IMAGES = true .markup.XXXXX body { color: #444; - font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", + serif; font-size: 12px; line-height: 1.7; padding: 1em; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/mail-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/mail-templates.md index f7bf7acb..c4ed3b5e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/mail-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/mail-templates.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/mail-templates - --- # 邮件模板 @@ -20,18 +19,18 @@ aliases: 目前，以下通知事件使用模板： -| 操作名称 | 用途 | -| ----------- | ------------------------------------------------------------------------------------------------------------ | -| `new` | 创建了新的工单或合并请求。 | -| `comment` | 在现有工单或合并请求中创建了新的评论。 | -| `close` | 关闭了工单或合并请求。 | -| `reopen` | 重新打开了工单或合并请求。 | -| `review` | 在合并请求中进行审查的首要评论。 | -| `approve` | 对合并请求进行批准的首要评论。 | -| `reject` | 对合并请求提出更改请求的审查的首要评论。 | -| `code` | 关于合并请求的代码的单个评论。 | -| `assigned` | 用户被分配到工单或合并请求。 | -| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | +| 操作名称 | 用途 | +| ---------- | ---------------------------------------------------------------------- | +| `new` | 创建了新的工单或合并请求。 | +| `comment` | 在现有工单或合并请求中创建了新的评论。 | +| `close` | 关闭了工单或合并请求。 | +| `reopen` | 重新打开了工单或合并请求。 | +| `review` | 在合并请求中进行审查的首要评论。 | +| `approve` | 对合并请求进行批准的首要评论。 | +| `reject` | 对合并请求提出更改请求的审查的首要评论。 | +| `code` | 关于合并请求的代码的单个评论。 | +| `assigned` | 用户被分配到工单或合并请求。 | +| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | 特定消息类型的模板路径为： @@ -75,25 +74,25 @@ custom/templates/mail/pull/comment.tmpl 指定 _主题_ 部分是可选的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。 -_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： +_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://golang.org/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： -| 名称 | 类型 | 可用性 | 用途 | -| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | -| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | -| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | -| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | -| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | -| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | -| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | -| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | -| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | -| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | -| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | -| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | -| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | -| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | -| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | +| 名称 | 类型 | 可用性 | 用途 | +| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | +| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | +| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | +| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | +| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | +| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | +| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | +| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | +| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | +| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | +| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | +| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | +| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | +| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | +| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | 所有名称区分大小写。 @@ -110,7 +109,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t - 删除所有前导、尾随和多余的空格。 - 将字符串截断为前 256 个字母（字符）。 -如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用Gitea的**内部默认值**。 +如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用 Gitea 的**内部默认值**。 内部默认（回退）主题相当于： @@ -120,7 +119,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 例如：`Re: [mike/stuff] New color palette (#38)` -即使存在有效的主题模板，Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 +即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 ### 模板中的邮件正文部分 @@ -142,7 +141,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 如果模板无法呈现，则只有在发送邮件时才会注意到。 如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈现了任何内容，则将使用该内容，忽略其他内容。 -如果遇到问题，请检查 [Gitea的日志](../administration/logging-config.md) 以获取错误消息。 +如果遇到问题，请检查 [Gitea 的日志](../administration/logging-config.md) 以获取错误消息。 ## 示例 @@ -224,11 +223,11 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t > > #### 消息内容： > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > Mike, I think we should tone down the blues a little. > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > [在 Gitea 上查看](#)。 @@ -236,20 +235,22 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 模板系统包含一些函数，可用于进一步处理和格式化消息。以下是其中一些函数的列表： -| 函数名 | 参数 | 可用于 | 用法 | -| ----------------- | ----------- | ------------ | --------------------------------------------------------------------------------- | -| `AppUrl` | - | 任何地方 | Gitea 的 URL | -| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | -| `AppDomain` | - | 任何地方 | Gitea 的主机名 | -| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | -| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 | -| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于 `.ReviewComments.RenderedContent` 等字段 | +| 函数名 | 参数 | 可用于 | 用法 | +| ---------------- | ----------- | ---------- | --------------------------------------------------------------------- | +| `AppUrl` | - | 任何地方 | Gitea 的 URL | +| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | +| `AppDomain` | - | 任何地方 | Gitea 的主机名 | +| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | +| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 | +| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于 `.ReviewComments.RenderedContent` 等字段 | 这些都是 _函数_，而不是元数据，因此必须按以下方式使用： ```html -像这样使用： {{Str2html "Escapetext"}} -或者这样使用： {{"Escapetext" | Str2html}} -或者这样使用： {{AppUrl}} -但不要像这样使用： {{.AppUrl}} +像这样使用： {{Str2html "Escapetext"}} 或者这样使用： {{"Escapetext" | Str2html}} 或者这样使用： {{AppUrl}} 但不要像这样使用： + {{.AppUrl}} ``` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/repo-indexer.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/repo-indexer.md index ea765c44..bd3c328d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/repo-indexer.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/repo-indexer.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/repo-indexer - --- # 仓库索引器 @@ -33,7 +32,7 @@ REPO_INDEXER_EXCLUDE = resources/bin/** ### 按路径选择要索引的文件 -Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 +Gitea 使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 限制文件列表可以防止索引被派生或无关的文件（例如 lss、sym、map 等）污染，从而使搜索结果更相关。这还有助于减小索引的大小。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/reverse-proxies.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/reverse-proxies.md index 54746f03..96db56ac 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/reverse-proxies.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/reverse-proxies.md @@ -6,7 +6,6 @@ sidebar_position: 16 aliases: - /zh-cn/reverse-proxies - --- # 反向代理 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/search-engines-indexation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/search-engines-indexation.md index 8a044a0d..c7aeb64d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/search-engines-indexation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/search-engines-indexation.md @@ -6,7 +6,6 @@ sidebar_position: 60 aliases: - /zh-cn/search-engines-indexation - --- # 搜索引擎索引 @@ -25,7 +24,7 @@ User-agent: * Disallow: / ``` -如果您将Gitea安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 +如果您将 Gitea 安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 ```txt User-agent: * diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/signing.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/signing.md index b7e2d403..fac88ed7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/signing.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/administration/signing.md @@ -69,7 +69,7 @@ MERGES = pubkey, twofa, basesigned, commitssigned 如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。 与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。 -如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则Gitea将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 +如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则 Gitea 将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 ::: ### `INITIAL_COMMIT` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-backend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-backend.md index 15e693ce..db7c1616 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-backend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-backend.md @@ -6,47 +6,46 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-backend - --- # 后端开发指南 ## 背景 -Gitea使用Golang作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 -例如，Gitea使用[Chi](https://github.com/go-chi/chi)作为基本的Web框架。[Xorm](https://xorm.io)是一个用于与数据库交互的ORM框架。 +Gitea 使用 Golang 作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 +例如，Gitea 使用[Chi](https://github.com/go-chi/chi)作为基本的 Web 框架。[Xorm](https://xorm.io)是一个用于与数据库交互的 ORM 框架。 因此，管理这些包非常重要。在开始编写后端代码之前，请参考以下准则。 ## 包设计准则 ### 包列表 -为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea后端分为以下几个部分： +为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea 后端分为以下几个部分： -- `build`：帮助构建Gitea的脚本。 -- `cmd`：包含所有Gitea的实际子命令，包括web、doctor、serv、hooks、admin等。`web`将启动Web服务。`serv`和`hooks`将被Git或OpenSSH调用。其他子命令可以帮助维护Gitea。 +- `build`：帮助构建 Gitea 的脚本。 +- `cmd`：包含所有 Gitea 的实际子命令，包括 web、doctor、serv、hooks、admin 等。`web`将启动 Web 服务。`serv`和`hooks`将被 Git 或 OpenSSH 调用。其他子命令可以帮助维护 Gitea。 - `tests`：常用的测试函数 - `tests/integration`：集成测试，用于测试后端回归。 - `tests/e2e`：端到端测试，用于测试前端和后端的兼容性和视觉回归。 -- `models`：包含由xorm用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他Gitea代码的依赖关系。在某些情况下，比如日志记录时可以例外。 - - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从models/中调用。 +- `models`：包含由 xorm 用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他 Gitea 代码的依赖关系。在某些情况下，比如日志记录时可以例外。 + - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从 models/中调用。 - `models/fixtures`：单元测试和集成测试中使用的示例数据。一个`yml`文件表示一个将在测试开始时加载到数据库中的表。 - - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的PR**必须**包含一个迁移步骤。 -- `modules`：在Gitea中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于models的模块，因为它们依赖于数据库。 - - `modules/setting`：存储从ini文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 - - `modules/git`：用于与`Git`命令行或Gogit包交互的包。 -- `public`：编译后的前端文件（JavaScript、图像、CSS等） -- `routers`：处理服务器请求。由于它使用其他Gitea包来处理请求，因此其他包（models、modules或services）不能依赖于routers。 - - `routers/api`：包含`/api/v1`相关路由，用于处理RESTful API请求。 + - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的 PR**必须**包含一个迁移步骤。 +- `modules`：在 Gitea 中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于 models 的模块，因为它们依赖于数据库。 + - `modules/setting`：存储从 ini 文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 + - `modules/git`：用于与`Git`命令行或 Gogit 包交互的包。 +- `public`：编译后的前端文件（JavaScript、图像、CSS 等） +- `routers`：处理服务器请求。由于它使用其他 Gitea 包来处理请求，因此其他包（models、modules 或 services）不能依赖于 routers。 + - `routers/api`：包含`/api/v1`相关路由，用于处理 RESTful API 请求。 - `routers/install`：只能在系统处于安装模式（INSTALL_LOCK=false）时响应。 - `routers/private`：仅由内部子命令调用，特别是`serv`和`hooks`。 - - `routers/web`：处理来自Web浏览器或Git SMART HTTP协议的HTTP请求。 + - `routers/web`：处理来自 Web 浏览器或 Git SMART HTTP 协议的 HTTP 请求。 - `services`：用于常见路由操作或命令执行的支持函数。使用`models`和`modules`来处理请求。 -- `templates`：用于生成HTML输出的Golang模板。 +- `templates`：用于生成 HTML 输出的 Golang 模板。 ### 包依赖关系 -由于Golang不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 +由于 Golang 不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 `cmd` -> `routers` -> `services` -> `models` -> `modules` @@ -91,18 +90,18 @@ func UpdateIssue(ctx context.Context, repoID int64) error { ### 导入别名 -由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个Go文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 +由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个 Go 文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 例如：`import user_service "code.gitea.io/gitea/services/user"` ### 重要注意事项 - 永远不要写成`x.Update(exemplar)`，而没有明确的`WHERE`子句： - - 这将导致表中的所有行都被使用exemplar的非零值进行更新，包括ID。 + - 这将导致表中的所有行都被使用 exemplar 的非零值进行更新，包括 ID。 - 通常应该写成`x.ID(id).Update(exemplar)`。 -- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而ID是预设的： - - 对于MSSQL变体，你将需要执行``SET IDENTITY_INSERT `table` ON``（否则迁移将失败） - - 对于PostgreSQL，你还需要更新ID序列，否则迁移将悄无声息地通过，但后续的插入将失败： - ``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)`` +- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而 ID 是预设的： + - 对于 MSSQL 变体，你将需要执行`` SET IDENTITY_INSERT `table` ON ``（否则迁移将失败） + - 对于 PostgreSQL，你还需要更新 ID 序列，否则迁移将悄无声息地通过，但后续的插入将失败： + `` SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false) `` ### 未来的任务 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-frontend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-frontend.md index 6716d5f5..785ad1f0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-frontend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-frontend.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-frontend - --- # 前端开发指南 @@ -19,10 +18,10 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 源文件可以在以下目录中找到： -* **CSS 样式**： `web_src/css/` -* **JavaScript 文件**： `web_src/js/` -* **Vue 组件**： `web_src/js/components/` -* **Go HTML 模板**： `templates/` +- **CSS 样式**： `web_src/css/` +- **JavaScript 文件**： `web_src/js/` +- **Vue 组件**： `web_src/js/components/` +- **Go HTML 模板**： `templates/` ## 通用准则 @@ -31,9 +30,9 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ## Gitea 特定准则： 1. 每个功能（Fomantic-UI/jQuery 模块）应放在单独的文件/目录中。 -2. HTML 的 id 和 class 应使用 kebab-case，最好包含2-3个与功能相关的关键词。 -3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含2-3个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 -4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有2-3个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 +2. HTML 的 id 和 class 应使用 kebab-case，最好包含 2-3 个与功能相关的关键词。 +3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含 2-3 个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 +4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有 2-3 个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 5. 后端可以通过使用`ctx.PageData["myModuleData"] = map[]{}`将复杂数据传递给前端，但不要将整个模型暴露给前端，以避免泄露敏感数据。 6. 简单页面和与 SEO 相关的页面使用 Go HTML 模板渲染生成静态的 Fomantic-UI HTML 输出。复杂页面可以使用 Vue3。 7. 明确变量类型，优先使用`elem.disabled = true`而不是`elem.setAttribute('disabled', 'anything')`，优先使用`$el.prop('checked', var === 'yes')`而不是`$el.prop('checked', var)`。 @@ -45,8 +44,8 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ### 可访问性 / ARIA -在历史上，Gitea大量使用了可访问性不友好的框架 Fomantic UI。 -Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`aria.md`）， +在历史上，Gitea 大量使用了可访问性不友好的框架 Fomantic UI。 +Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见`aria.js`和`aria.md`）， 但仍然存在许多问题需要大量的工作和时间来修复。 ### 框架使用 @@ -56,14 +55,14 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 推荐的实现方式： -* Vue + Vanilla JS -* Fomantic-UI（jQuery） -* Vanilla JS +- Vue + Vanilla JS +- Fomantic-UI（jQuery） +- Vanilla JS 不推荐的实现方式： -* Vue + Fomantic-UI（jQuery） -* jQuery + Vanilla JS +- Vue + Fomantic-UI（jQuery） +- jQuery + Vanilla JS 为了保持界面一致，Vue 组件可以使用 Fomantic-UI 的 CSS 类。 尽管不建议混合使用不同的框架， @@ -82,7 +81,7 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 如果我们想在非异步上下文中调用`async`函数， 建议使用`const _promise = asyncFoo()`来告诉读者 -这是有意为之的，我们想调用异步函数并忽略Promise。 +这是有意为之的，我们想调用异步函数并忽略 Promise。 一些 lint 规则和 IDE 也会在未处理返回的 Promise 时发出警告。 ### HTML 属性和 dataset @@ -90,31 +89,41 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 禁止使用`dataset`，它的驼峰命名行为使得搜索属性变得困难。 然而，仍然存在一些特殊情况，因此当前的准则是： -* 对于旧代码： - * 应将`$.data()`重构为`$.attr()`。 - * 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 +- 对于旧代码： -* 对于新代码： - * 不应使用`node.dataset`，而应使用`node.getAttribute`。 - * 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 + - 应将`$.data()`重构为`$.attr()`。 + - 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 + +- 对于新代码： + - 不应使用`node.dataset`，而应使用`node.getAttribute`。 + - 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 ### 显示/隐藏元素 -* 推荐在Vue组件中使用`v-if`和`v-show`来显示/隐藏元素。 -* Go 模板代码应使用 Gitea 的 `.gt-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.gt-hidden`的注释以获取更多详细信息。 +- 推荐在 Vue 组件中使用`v-if`和`v-show`来显示/隐藏元素。 +- Go 模板代码应使用 Gitea 的 `.gt-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.gt-hidden`的注释以获取更多详细信息。 ### Go HTML 模板中的样式和属性 建议使用以下方式： ```html -
+
``` 而不是： ```html -
+
``` 以使代码更易读。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-refactoring.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-refactoring.md index fbc4ae49..589efe64 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-refactoring.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/guidelines-refactoring.md @@ -6,38 +6,37 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-refactoring - --- # 重构指南 ## 背景 -自2014年2月12日编写了第一行代码以来，Gitea已经发展成为一个庞大的项目。 +自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成为一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多过时的机制，许多框架混合在一起，一些遗留代码可能会导致错误并阻碍新功能的开发。 -为了使代码库更易于维护，使Gitea变得更好，开发人员应牢记使用现代机制来重构旧代码。 +为了使代码库更易于维护，使 Gitea 变得更好，开发人员应牢记使用现代机制来重构旧代码。 本文档是关于重构代码库的指南集合。 ## 重构建议 -* 设计更多关于未来的内容，而不仅仅解决当前问题。 -* 减少模糊性，减少冲突，提高可维护性。 -* 描述重构，例如： - * 为什么需要重构。 - * 如何解决旧问题。 - * 重构的优点/缺点是什么。 -* 只做必要的更改，尽量保留旧逻辑。 -* 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个PR中完成。 -* 如果存在分歧，应该请TOC（技术监督委员会）参与决策。 -* 添加必要的测试以确保重构的正确性。 -* 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 +- 设计更多关于未来的内容，而不仅仅解决当前问题。 +- 减少模糊性，减少冲突，提高可维护性。 +- 描述重构，例如： + - 为什么需要重构。 + - 如何解决旧问题。 + - 重构的优点/缺点是什么。 +- 只做必要的更改，尽量保留旧逻辑。 +- 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。 +- 如果存在分歧，应该请 TOC（技术监督委员会）参与决策。 +- 添加必要的测试以确保重构的正确性。 +- 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 ## 审查和合并建议 -* 重构的PR不应该长时间保持打开状态（通常为7天），应尽快进行审查。 -* 重构的PR应尽快合并，不应被其他PR阻塞。 -* 如果TOC没有异议，重构的PR可以在7天后由一名核心成员（非作者）批准后合并。 -* 如果最终结果良好，容忍一些不完美/临时的步骤。 -* 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 +- 重构的 PR 不应该长时间保持打开状态（通常为 7 天），应尽快进行审查。 +- 重构的 PR 应尽快合并，不应被其他 PR 阻塞。 +- 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合并。 +- 如果最终结果良好，容忍一些不完美/临时的步骤。 +- 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/localization.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/localization.md index 29596205..e0b81a3a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/localization.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/contributing/localization.md @@ -8,9 +8,9 @@ aliases: # 本地化 -Gitea的本地化是通过我们的[Crowdin项目](https://crowdin.com/project/gitea)进行的。 +Gitea 的本地化是通过我们的[Crowdin 项目](https://crowdin.com/project/gitea)进行的。 -对于对**英语翻译**的更改，可以发出pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 +对于对**英语翻译**的更改，可以发出 pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 有关对**非英语**翻译的更改，请参阅上面的 Crowdin 项目。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/hacking-on-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/hacking-on-gitea.md index 92d88415..2d084cc6 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/hacking-on-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/hacking-on-gitea.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/hacking-on-gitea - --- # Hacking on Gitea @@ -19,7 +18,7 @@ aliases: ## 安装 Golang -您需要 [安装 go]( https://golang.org/doc/install ) 并设置您的 go 环境。 +您需要 [安装 go](https://golang.org/doc/install) 并设置您的 go 环境。 接下来，[使用 npm 安装 Node.js](https://nodejs.org/en/download/) ，这是构建 JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @minNodeVersion@ @@ -27,12 +26,12 @@ JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @mi **注意** ：当执行需要外部工具的 make 任务时，比如 `make watch-backend`，Gitea 会自动下载并构建这些必要的组件。为了能够使用这些，你必须 -将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把go bin目录添加到可执行路径你必须手动 +将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把 go bin 目录添加到可执行路径你必须手动 指定可执行程序路径。 -**注意2** ：Go版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 +**注意 2** ：Go 版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 格式化源代码。然而，`gofmt` 的结果可能因 `go` 的版本而有差异。因此推荐安装我们持续集成使用 -的 Go版本。截至上次更新，Go 版本应该是 @goVersion@。 +的 Go 版本。截至上次更新，Go 版本应该是 @goVersion@。 ## 安装 Make @@ -58,15 +57,15 @@ sudo yum install make Make 的这三个发行版都可以在 Windows 上运行： -- [单个二进制构建]( http://www.equation.com/servlet/equation.cmd?fa=make )。复制到某处并添加到 `PATH`。 +- [单个二进制构建](http://www.equation.com/servlet/equation.cmd?fa=make)。复制到某处并添加到 `PATH`。 - [32 位版本](http://www.equation.com/ftpdir/make/32/make.exe) - [64 位版本](http://www.equation.com/ftpdir/make/64/make.exe) - [MinGW-w64](https://www.mingw-w64.org) / [MSYS2](https://www.msys2.org/)。 - MSYS2 是一个工具和库的集合，为您提供一个易于使用的环境来构建、安装和运行本机 Windows 软件，它包括 MinGW-w64。 - 在 MingGW-w64 中，二进制文件称为 `mingw32-make.exe` 而不是 `make.exe`。将 `bin` 文件夹添加到 `PATH`。 - 在 MSYS2 中，您可以直接使用 `make`。请参阅 [MSYS2 移植](https://www.msys2.org/wiki/Porting/)。 - - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 _beginthread 一样。 -- [Chocolatey包管理器]( https://chocolatey.org/packages/make )。运行`choco install make` + - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 \_beginthread 一样。 +- [Chocolatey 包管理器](https://chocolatey.org/packages/make)。运行`choco install make` **注意** ：如果您尝试在 Windows 命令提示符下使用 make 进行构建，您可能会遇到问题。建议使用上述提示（Git bash 或 MinGW），但是如果您只有命令提示符（或可能是 PowerShell），则可以使用 [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) 命令，例如 `set TAGS=bindata`。 @@ -78,7 +77,7 @@ Make 的这三个发行版都可以在 Windows 上运行： git clone https://github.com/go-gitea/gitea ``` -（自从go modules出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） +（自从 go modules 出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） ## 派生 Gitea @@ -199,7 +198,7 @@ SVG 图标是使用 `make svg` 目标构建的，该目标将 `build/generate-sv ### 构建 Logo -Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 +Gitea Logo 的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 通过更新 `assets/logo.svg` 并运行 `make generate-images`，同样的过程也可用于从 SVG 源文件生成自定义 Logo PNG。忽略 gitea 编译选项将仅更新用户指定的 LOGO 文件。 @@ -208,7 +207,7 @@ Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 创建新的 API 路由或修改现有的 API 路由时，您**必须** 更新和/或创建 [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/) 这些使用 [go-swagger](https://goswagger.io/) 评论的文档。 -[规范]( https://goswagger.io/use/spec.html#annotation-syntax )中描述了这些注释的结构。 +[规范](https://goswagger.io/use/spec.html#annotation-syntax)中描述了这些注释的结构。 如果您想了解更多有关 Swagger 结构的信息，可以查看 [Swagger 2.0 文档](https://swagger.io/docs/specification/2-0/basic-structure/) 或与添加新 API 端点的先前 PR 进行比较，例如 [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20) @@ -242,7 +241,7 @@ make swagger-check 并到[配置备忘单](../administration/config-cheat-sheet.md) 在 `docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到 -### 更改Logo +### 更改 Logo 更改 Gitea Logo SVG 时，您将需要运行并提交结果的： @@ -294,7 +293,7 @@ TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite 我们的持续集成将测试代码是否通过了单元测试，并且所有支持的数据库都将在 Docker 环境中通过集成测试。 还将测试从几个最新版本的 Gitea 迁移。 -请在PR中附带提交适当的单元测试和集成测试。 +请在 PR 中附带提交适当的单元测试和集成测试。 ## 网站文档 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/integrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/integrations.md index 052a8734..049d0bba 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/integrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/integrations.md @@ -8,7 +8,7 @@ aliases: # 集成 -Gitea拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 +Gitea 拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 我们正在[awesome-gitea](https://gitea.com/gitea/awesome-gitea)上整理一个列表来跟踪这些集成！ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/migrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/migrations.md index e6763f8a..a0fc8371 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/migrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/migrations.md @@ -6,29 +6,28 @@ sidebar_position: 55 aliases: - /zh-cn/migrations-interfaces - --- # 迁移接口 -完整迁移功能在Gitea 1.9.0版本中引入。它定义了两个接口，用于支持从其他Git托管平台迁移存储库数据到Gitea，或者在将来将Gitea数据迁移到其他Git托管平台。 +完整迁移功能在 Gitea 1.9.0 版本中引入。它定义了两个接口，用于支持从其他 Git 托管平台迁移存储库数据到 Gitea，或者在将来将 Gitea 数据迁移到其他 Git 托管平台。 -目前已实现了从GitHub、GitLab和其他Gitea实例的迁移。 +目前已实现了从 GitHub、GitLab 和其他 Gitea 实例的迁移。 -首先，Gitea在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 +首先，Gitea 在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 ## 下载器接口 -要从新的Git托管平台迁移，需要进行两个步骤的更新。 +要从新的 Git 托管平台迁移，需要进行两个步骤的更新。 - 您应该实现一个`Downloader`，用于获取存储库信息。 -- 您应该实现一个`DownloaderFactory`，用于检测URL是否匹配，并创建上述的`Downloader`。 +- 您应该实现一个`DownloaderFactory`，用于检测 URL 是否匹配，并创建上述的`Downloader`。 - 您需要在`init()`中通过`RegisterDownloaderFactory`注册`DownloaderFactory`。 您可以在[downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go)中找到这些接口。 ## 上传器接口 -目前，只实现了`GiteaLocalUploader`，因此我们只能通过此Uploader将下载的数据保存到本地的Gitea实例。目前不支持其他上传器。 +目前，只实现了`GiteaLocalUploader`，因此我们只能通过此 Uploader 将下载的数据保存到本地的 Gitea 实例。目前不支持其他上传器。 您可以在[uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go)中找到这些接口。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/oauth2-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/oauth2-provider.md index b63809b2..08058ee7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/oauth2-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/development/oauth2-provider.md @@ -6,7 +6,6 @@ sidebar_position: 41 aliases: - /zh-cn/oauth2-provider - --- # OAuth2 提供者 @@ -36,40 +35,40 @@ Gitea 支持作为 OAuth2 提供者，允许第三方应用程序在用户同意 Gitea 支持以下令牌范围: -| 名称 | 介绍 | -| ---- | ----------- | -| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | -| **repo** | 完全控制所有存储库 | -|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | -|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | -| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | -|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | -|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | -| **admin:org** | 授予对组织设置的完全访问权限 | -|     **write:org** | 授予对组织设置的读/写访问权限 | -|     **read:org** | 授予对组织设置的只读访问权限 | -| **admin:public_key** | 授予公钥管理的完全访问权限 | -|     **write:public_key** | 授予对公钥的读/写访问权限 | -|     **read:public_key** | 授予对公钥的只读访问权限 | -| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | -| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | -| **notification** | 授予对通知的完全访问权限 | -| **user** | 授予对用户个人资料信息的完全访问权限 | -|     **read:user** | 授予对用户个人资料的读取权限 | -|     **user:email** | 授予对用户电子邮件地址的读取权限 | -|     **user:follow** | 授予访问权限以关注/取消关注用户 | -| **delete_repo** | 授予删除存储库的权限 | -| **package** | 授予对托管包的完全访问权限 | -|     **write:package** | 授予对包的读/写访问权限 | -|     **read:package** | 授予对包的读取权限 | -|     **delete:package** | 授予对包的删除权限 | -| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | -|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | -|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | -| **admin:application** | 授予应用程序管理的完全访问权限 | -|     **write:application** | 授予应用程序管理的读/写访问权限 | -|     **read:application** | 授予应用程序管理的读取权限 | -| **sudo** | 允许以站点管理员身份执行操作 | +| 名称 | 介绍 | +| ---------------------------------------- | --------------------------------------------------------------- | +| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | +| **repo** | 完全控制所有存储库 | +|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | +|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | +| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | +|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | +|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | +| **admin:org** | 授予对组织设置的完全访问权限 | +|     **write:org** | 授予对组织设置的读/写访问权限 | +|     **read:org** | 授予对组织设置的只读访问权限 | +| **admin:public_key** | 授予公钥管理的完全访问权限 | +|     **write:public_key** | 授予对公钥的读/写访问权限 | +|     **read:public_key** | 授予对公钥的只读访问权限 | +| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | +| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | +| **notification** | 授予对通知的完全访问权限 | +| **user** | 授予对用户个人资料信息的完全访问权限 | +|     **read:user** | 授予对用户个人资料的读取权限 | +|     **user:email** | 授予对用户电子邮件地址的读取权限 | +|     **user:follow** | 授予访问权限以关注/取消关注用户 | +| **delete_repo** | 授予删除存储库的权限 | +| **package** | 授予对托管包的完全访问权限 | +|     **write:package** | 授予对包的读/写访问权限 | +|     **read:package** | 授予对包的读取权限 | +|     **delete:package** | 授予对包的删除权限 | +| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | +|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | +|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | +| **admin:application** | 授予应用程序管理的完全访问权限 | +|     **write:application** | 授予应用程序管理的读/写访问权限 | +|     **read:application** | 授予应用程序管理的读取权限 | +| **sudo** | 允许以站点管理员身份执行操作 | ## 客户端类型 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/faq.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/faq.md index b71957eb..9edac51e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/faq.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/faq.md @@ -6,7 +6,6 @@ sidebar_position: 5 aliases: - /zh-cn/faq - --- # 常见问题 @@ -15,128 +14,128 @@ aliases: 有关更多帮助资源，请查看所有[支持选项](help/support.md)。 -## 1.x和1.x.x下载之间的区别 +## 1.x 和 1.x.x 下载之间的区别 -以1.7.x版本为例。 +以 1.7.x 版本为例。 -**注意：**此示例也适用于Docker镜像！ +**注意：**此示例也适用于 Docker 镜像！ -在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个1.7目录，以及1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5和1.7.6的目录。 +在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个 1.7 目录，以及 1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5 和 1.7.6 的目录。 -1.7目录和1.7.0目录是**不同**的。1.7目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 +1.7 目录和 1.7.0 目录是**不同**的。1.7 目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 -然而，1.7.0目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 +然而，1.7.0 目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 -这意味着1.x的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 +这意味着 1.x 的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 -另一方面，1.x.x的下载应该永远不会改变。 +另一方面，1.x.x 的下载应该永远不会改变。 -## 如何从Gogs/GitHub等迁移到Gitea +## 如何从 Gogs/GitHub 等迁移到 Gitea -要从Gogs迁移到Gitea： +要从 Gogs 迁移到 Gitea： -- [Gogs版本0.9.146或更低](installation/upgrade-from-gogs.md) -- [Gogs版本0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) +- [Gogs 版本 0.9.146 或更低](installation/upgrade-from-gogs.md) +- [Gogs 版本 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) -要从GitHub迁移到Gitea，您可以使用Gitea内置的迁移表单。 +要从 GitHub 迁移到 Gitea，您可以使用 Gitea 内置的迁移表单。 为了迁移诸如问题、拉取请求等项目，您需要至少输入您的用户名。 [Example (requires login)](https://try.gitea.io/repo/migrate) -要从GitLab迁移到Gitea，您可以使用这个非关联的工具： +要从 GitLab 迁移到 Gitea，您可以使用这个非关联的工具： https://github.com/loganinak/MigrateGitlabToGogs -## Gitea存储文件的位置 +## Gitea 存储文件的位置 - _`AppWorkPath`_ - `--work-path`标志 - 或者环境变量`GITEA_WORK_DIR` - 或者在构建时设置的内置值 - - 或者包含Gitea二进制文件的目录 + - 或者包含 Gitea 二进制文件的目录 - `%(APP_DATA_PATH)`（数据库、索引器等的默认路径） - `app.ini`中的`APP_DATA_PATH` - - 或者_`AppWorkPath`_`/data` + - 或者*`AppWorkPath`*`/data` - _`CustomPath`_（自定义模板） - `--custom-path`标志 - 或者环境变量`GITEA_CUSTOM` - 或者在构建时设置的内置值 - - 或者_`AppWorkPath`_`/custom` + - 或者*`AppWorkPath`*`/custom` - HomeDir - Unix：环境变量`HOME` - Windows：环境变量`USERPROFILE`，或者环境变量`HOMEDRIVE`+`HOMEPATH` - RepoRootPath - `app.ini`中\[repository]部分的`ROOT`（如果是绝对路径） - - 否则_`AppWorkPath`_`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） + - 否则*`AppWorkPath`*`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） - 默认值为`%(APP_DATA_PATH)/gitea-repositories` - INI（配置文件） - `--config`标志 - 或者在构建时设置的可能内置值 - 或者 _`CustomPath`_`/conf/app.ini` -- SQLite数据库 - - app.ini中database部分的PATH +- SQLite 数据库 + - app.ini 中 database 部分的 PATH - 或者`%(APP_DATA_PATH)/gitea.db` -## 看不到克隆URL或克隆URL不正确 +## 看不到克隆 URL 或克隆 URL 不正确 有几个地方可能会导致显示不正确。 1. 如果使用反向代理，请确保按照[反向代理指南](../administration/reverse-proxies.md)中的正确说明进行设置。 2. 确保在`app.ini`的`server`部分中正确设置了`ROOT_URL`。 -如果某些克隆选项未显示（HTTP/S或SSH），可以在`app.ini中` +如果某些克隆选项未显示（HTTP/S 或 SSH），可以在`app.ini中` -- `DISABLE_HTTP_GIT`: 如果设为true, 将会没有HTTP/HTTPS链接 -- `DISABLE_SSH`: 如果设为true, 将会没有SSH链接 -- `SSH_EXPOSE_ANONYMOUS`: 如果设为false, SSH链接将会对匿名用户隐藏 +- `DISABLE_HTTP_GIT`: 如果设为 true, 将会没有 HTTP/HTTPS 链接 +- `DISABLE_SSH`: 如果设为 true, 将会没有 SSH 链接 +- `SSH_EXPOSE_ANONYMOUS`: 如果设为 false, SSH 链接将会对匿名用户隐藏 ## 文件上传失败：413 Request Entity Too Large 当反向代理限制文件上传大小时，会出现此错误。 -有关使用nginx解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 +有关使用 nginx 解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 ## 自定义模板无法加载或运行错误 -Gitea的自定义模板必须将其添加到正确的位置，否则Gitea将无法找到并使用自定义模板。 +Gitea 的自定义模板必须将其添加到正确的位置，否则 Gitea 将无法找到并使用自定义模板。 模板的正确路径应该相对于`CustomPath`。 1. 要找到`CustomPath`，请在站点管理 -> 配置 中查找自定义文件根路径。 - 如果找不到，请尝试`echo $GITEA_CUSTOM`。 + 如果找不到，请尝试`echo $GITEA_CUSTOM`。 2. 如果仍然找不到，默认值可以被[计算](faq.md#Gitea存储文件的位置) -3. 如果仍然找不到路径，则可以参考[自定义Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 +3. 如果仍然找不到路径，则可以参考[自定义 Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 -## Gitea是否有"GitHub/GitLab Pages"功能？ +## Gitea 是否有"GitHub/GitLab Pages"功能？ -Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供静态页面，以避免CSRF安全风险。 +Gitea 不提供内置的 Pages 服务器。您需要一个专用的域名来提供静态页面，以避免 CSRF 安全风险。 -对于简单的用法，您可以使用反向代理来重写和提供Gitea的原始文件URL中的静态内容。 +对于简单的用法，您可以使用反向代理来重写和提供 Gitea 的原始文件 URL 中的静态内容。 还有一些已经可用的第三方服务，比如独立[pages server](https://codeberg.org/Codeberg/pages-server)的或[caddy plugin](https://github.com/42wim/caddy-gitea)，可以提供所需的功能。 ## 活跃用户与禁止登录用户 -在Gitea中，"活跃用户"是指通过电子邮件激活其帐户的用户。 +在 Gitea 中，"活跃用户"是指通过电子邮件激活其帐户的用户。 -"禁止登录用户"是指不允许再登录到Gitea的用户。 +"禁止登录用户"是指不允许再登录到 Gitea 的用户。 ## 设置日志记录 - [官方文档](../administration/logging-config.md) -## 什么是Swagger？ +## 什么是 Swagger？ -[Swagger](https://swagger.io/) 是Gitea用于其API文档的工具。 +[Swagger](https://swagger.io/) 是 Gitea 用于其 API 文档的工具。 -所有Gitea实例都有内置的API，无法完全禁用它。 -但是，您可以在app.ini的api部分将ENABLE_SWAGGER设置为false，以禁用其文档显示。 -有关更多信息，请参阅Gitea的[API文档](development/api-usage.md)。 +所有 Gitea 实例都有内置的 API，无法完全禁用它。 +但是，您可以在 app.ini 的 api 部分将 ENABLE_SWAGGER 设置为 false，以禁用其文档显示。 +有关更多信息，请参阅 Gitea 的[API 文档](development/api-usage.md)。 -您可以在上查看最新的API（例如）https://try.gitea.io/api/swagger +您可以在上查看最新的 API（例如）https://try.gitea.io/api/swagger 您还可以在上查看`swagger.json`文件的示例 https://try.gitea.io/swagger.v1.json @@ -147,7 +146,7 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 有多种方法可以组合使用来防止垃圾邮件发送者： 1. 通过设置电子邮件域名的白名单或黑名单。 -2. 通过设置一些域名或者OpenID白名单（见下文）。 +2. 通过设置一些域名或者 OpenID 白名单（见下文）。 3. 在您的`app.ini`中将`ENABLE_CAPTCHA`设置为`true`，并正确配置`RECAPTCHA_SECRET`和 `RECAPTCHA_SITEKEY`。 4. 将`DISABLE_REGISTRATION`设置为`true`，并通过 [CLI](../administration/command-line.md)、[API](development/api-usage.md) 或 Gitea 的管理界面创建新用户。 @@ -188,13 +187,13 @@ Gitea 目前支持三个官方主题，分别是 `gitea`（亮色）、`arc-gree 通过将`arc-blue`添加到`app.ini`中的`THEMES`列表中，允许用户使用该主题 -## SSHD vs 内建SSH +## SSHD vs 内建 SSH -SSHD是大多数Unix系统上内建的SSH服务器。 +SSHD 是大多数 Unix 系统上内建的 SSH 服务器。 -Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 +Gitea 还提供了自己的 SSH 服务器，用于在 SSHD 不可用时使用。 -## Gitea运行缓慢 +## Gitea 运行缓慢 导致此问题的最常见原因是加载联合头像。 @@ -204,35 +203,35 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 ## 无法创建仓库/文件 -请确保Gitea具有足够的权限来写入其主目录和数据目录。 +请确保 Gitea 具有足够的权限来写入其主目录和数据目录。 参见[AppDataPath 和 RepoRootPath](help/faq.md#Gitea存储文件的位置) -**适用于Arch用户的注意事项：**在撰写本文时，Arch软件包的systemd文件包含了以下行： +**适用于 Arch 用户的注意事项：**在撰写本文时，Arch 软件包的 systemd 文件包含了以下行： `ReadWritePaths=/etc/gitea/app.ini` -这将使得Gitea无法写入其他路径。 +这将使得 Gitea 无法写入其他路径。 ## 翻译不正确/如何添加更多翻译 -我们当前的翻译是在我们的[Crowdin项目](https://crowdin.com/project/gitea)上众包进行的 +我们当前的翻译是在我们的[Crowdin 项目](https://crowdin.com/project/gitea)上众包进行的 -无论您想要更改翻译还是添加新的翻译，都需要在Crowdin集成中进行，因为所有翻译都会被CI覆盖。 +无论您想要更改翻译还是添加新的翻译，都需要在 Crowdin 集成中进行，因为所有翻译都会被 CI 覆盖。 -## 推送钩子/ Webhook未运行 +## 推送钩子/ Webhook 未运行 -如果您可以推送但无法在主页仪表板上看到推送活动，或者推送不触发Webhook，有几种可能性： +如果您可以推送但无法在主页仪表板上看到推送活动，或者推送不触发 Webhook，有几种可能性： -1. Git钩子不同步：在站点管理面板上运行“重新同步所有仓库的pre-receive、update和post-receive钩子” -2. Git仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由NAS挂载），请确保文件系统支持`chmod a+x any-script` -3. 如果您使用的是Docker，请确保Docker Server（而不是客户端）的版本 >= 20.10.6 +1. Git 钩子不同步：在站点管理面板上运行“重新同步所有仓库的 pre-receive、update 和 post-receive 钩子” +2. Git 仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由 NAS 挂载），请确保文件系统支持`chmod a+x any-script` +3. 如果您使用的是 Docker，请确保 Docker Server（而不是客户端）的版本 >= 20.10.6 -## SSH问题 +## SSH 问题 如果无法通过`ssh`访问仓库，但`https`正常工作，请考虑以下情况。 -首先，请确保您可以通过SSH访问Gitea。 +首先，请确保您可以通过 SSH 访问 Gitea。 `ssh git@myremote.example` @@ -260,16 +259,18 @@ fatal: Could not read from remote repository. - 在客户端： - 确保公钥和私钥已添加到正确的 Gitea 用户。 - - 确保远程 URL 中没有任何问题。特别是，请确保∂ - Git 用户（@ 之前的部分）的名称拼写正确。 + - 确保远程 URL 中没有任何问题。特别是，请确保 ∂ + Git 用户（@ 之前的部分）的名称拼写正确。 - 确保客户端机器上的公钥和私钥正确无误。 - 在服务器上： + - 确保存储库存在并且命名正确。 - 检查系统用户主目录中的 `.ssh` 目录的权限。 - 验证正确的公钥是否已添加到 `.ssh/authorized_keys` 中。 尝试在 Gitea 管理面板上运行 `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)`。 + - 查看 Gitea 日志。 - 查看 /var/log/auth（或类似的文件）。 - 检查存储库的权限。 @@ -341,7 +342,9 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 - 使用[管理 CLI 命令](../administration/command-line.md#admin)。 请注意，大多数命令还需要一个[全局标志](../administration/command-line.md#全局选项)来指向正确的配置。 + - 作为**用户**，您可以更改密码... + - 在您的账户的`设置 -> 账户`页面（此方法**需要**您知道当前密码）。 - 使用`忘记密码`链接。 @@ -351,7 +354,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 在 Gitea 版本 `1.11` 中，我们转换为使用[goldmark](https://github.com/yuin/goldmark)进行 Markdown 渲染，它符合[CommonMark](https://commonmark.org/)标准。 -如果您在版本`1.11`之前的Markdown正常工作，但在升级后无法正常工作，请仔细阅读CommonMark规范，看看问题是由错误还是非兼容的语法引起的。 +如果您在版本`1.11`之前的 Markdown 正常工作，但在升级后无法正常工作，请仔细阅读 CommonMark 规范，看看问题是由错误还是非兼容的语法引起的。 如果是后者，通常规范中会列出一种符合标准的替代方法。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/support.md index 2d255ea8..90df6718 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/help/support.md @@ -13,4 +13,4 @@ aliases: - 到 [GitHub Issue](https://github.com/go-gitea/gitea/issues) 提问(因为项目维护人员来自世界各地，为保证沟通顺畅，请使用英文提问) - 中文问题到 [Gitea 论坛](https://discourse.gitea.io/c/5-category/5) 提问 - 访问 [Discord Gitea 聊天室 - 英文](https://discord.gg/Gitea) -- 加入 QQ群 328432459 获得进一步的支持 +- 加入 QQ 群 328432459 获得进一步的支持 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/comparison.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/comparison.md index 08d6cc73..81143630 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/comparison.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/comparison.md @@ -6,7 +6,6 @@ sidebar_position: 5 aliases: - /zh-cn/comparison - --- # 对比 Gitea 与其它 Git 托管工具 @@ -17,15 +16,15 @@ aliases: _表格中的符号含义:_ -* _✓ - 支持_ +- _✓ - 支持_ -* _⁄ - 部分支持_ +- _⁄ - 部分支持_ -* _✘ - 不支持_ +- _✘ - 不支持_ -* _? - 不确定_ +- _? - 不确定_ -* _⚙️ - 由第三方服务或插件支持_ +- _⚙️ - 由第三方服务或插件支持_ #### 主要特性 @@ -40,7 +39,7 @@ _表格中的符号含义:_ | 支持 Orgmode | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ? | | 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | | 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | | 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/database-preparation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/database-preparation.md index d10ec543..16d8e2d8 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/database-preparation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/database-preparation.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/database-prep - --- # 数据库准备 @@ -21,149 +20,149 @@ aliases: 1. 对于远程数据库设置，您需要让 MySQL 监听您的 IP 地址。编辑数据库实例上的 `/etc/mysql/my.cnf` 文件中的 `bind-address` 选项为： - ```ini - bind-address = 203.0.113.3 - ``` + ```ini + bind-address = 203.0.113.3 + ``` 2. 在数据库实例上，使用 `root` 用户登录到数据库控制台： - ``` - mysql -u root -p - ``` + ``` + mysql -u root -p + ``` - 按提示输入密码。 + 按提示输入密码。 3. 创建一个将被 Gitea 使用的数据库用户，并使用密码进行身份验证。以下示例中使用了 `'gitea'` 作为密码。请为您的实例使用一个安全密码。 - 对于本地数据库： + 对于本地数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea' IDENTIFIED BY 'gitea'; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; + ``` - 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 + 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 - 根据需要替换上述用户名和密码。 + 根据需要替换上述用户名和密码。 4. 使用 UTF-8 字符集和排序规则创建数据库。确保使用 `**utf8mb4**` 字符集，而不是 `utf8`，因为前者支持 _Basic Multilingual Plane_ 之外的所有 Unicode 字符（包括表情符号）。排序规则根据您预期的内容选择。如果不确定，可以使用 `unicode_ci` 或 `general_ci`。 - ```sql - CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci'; - ``` + ```sql + CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 5. 将数据库上的所有权限授予上述创建的数据库用户。 - 对于本地数据库： + 对于本地数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; + FLUSH PRIVILEGES; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; + FLUSH PRIVILEGES; + ``` 6. 通过 exit 退出数据库控制台。 7. 在您的 Gitea 服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h 203.0.113.3 -p giteadb - ``` + ``` + mysql -u gitea -h 203.0.113.3 -p giteadb + ``` - 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 -h 选项。 + 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 -h 选项。 - 到此您应该能够连接到数据库了。 + 到此您应该能够连接到数据库了。 ## PostgreSQL 1. 对于远程数据库设置，通过编辑数据库实例上的 postgresql.conf 文件中的 listen_addresses 将 PostgreSQL 配置为监听您的 IP 地址： - ```ini - listen_addresses = 'localhost, 203.0.113.3' - ``` + ```ini + listen_addresses = 'localhost, 203.0.113.3' + ``` 2. PostgreSQL 默认使用 `md5` 质询-响应加密方案进行密码身份验证。现在这个方案不再被认为是安全的。改用 SCRAM-SHA-256 方案，通过编辑数据库服务器上的` postgresql.conf` 配置文件： - ```ini - password_encryption = scram-sha-256 - ``` + ```ini + password_encryption = scram-sha-256 + ``` - 重启 PostgreSQL 以应用该设置。 + 重启 PostgreSQL 以应用该设置。 3. 在数据库服务器上，以超级用户身份登录到数据库控制台： - ``` - su -c "psql" - postgres - ``` + ``` + su -c "psql" - postgres + ``` 4. 创建具有登录权限和密码的数据库用户（在 PostgreSQL 术语中称为角色）。请使用安全的、强密码，而不是下面的 `'gitea'`： - ```sql - CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; - ``` + ```sql + CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; + ``` - 根据需要替换用户名和密码。 + 根据需要替换用户名和密码。 5. 使用 UTF-8 字符集创建数据库，并由之前创建的数据库用户拥有。可以根据预期内容使用任何 `libc` 排序规则，使用 `LC_COLLATE` 和 `LC_CTYPE` 参数指定： - ```sql - CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; - ``` + ```sql + CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 6. 通过将以下身份验证规则添加到 `pg_hba.conf`，允许数据库用户访问上面创建的数据库。 - 对于本地数据库： + 对于本地数据库： - ```ini - local giteadb gitea scram-sha-256 - ``` + ```ini + local giteadb gitea scram-sha-256 + ``` - 对于远程数据库： + 对于远程数据库： - ```ini - host giteadb gitea 192.0.2.10/32 scram-sha-256 - ``` + ```ini + host giteadb gitea 192.0.2.10/32 scram-sha-256 + ``` - 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 + 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 - 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 + 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 - 重启 PostgreSQL 以应用新的身份验证规则。 + 重启 PostgreSQL 以应用新的身份验证规则。 7. 在您的 Gitea 服务器上，测试与数据库的连接。 - 对于本地数据库： + 对于本地数据库： - ``` - psql -U gitea -d giteadb - ``` + ``` + psql -U gitea -d giteadb + ``` - 对于远程数据库： + 对于远程数据库： - ``` - psql "postgres://gitea@203.0.113.3/giteadb" - ``` + ``` + psql "postgres://gitea@203.0.113.3/giteadb" + ``` - 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 + 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 - 您应该会被提示输入数据库用户的密码，并连接到数据库。 + 您应该会被提示输入数据库用户的密码，并连接到数据库。 ## 使用 TLS 进行数据库连接 @@ -182,116 +181,116 @@ Gitea 使用的 PostgreSQL 驱动程序支持双向 TLS。在双向 TLS 中， 1. 在数据库实例所在的服务器上，放置以下凭据： - - `/path/to/postgresql.crt`: 数据库实例证书 - - `/path/to/postgresql.key`: 数据库实例私钥 - - `/path/to/root.crt`: 用于验证客户端证书的CA证书链 + - `/path/to/postgresql.crt`: 数据库实例证书 + - `/path/to/postgresql.key`: 数据库实例私钥 + - `/path/to/root.crt`: 用于验证客户端证书的 CA 证书链 2. 在 `postgresql.conf` 中添加以下选项： - ```ini - ssl = on - ssl_ca_file = '/path/to/root.crt' - ssl_cert_file = '/path/to/postgresql.crt' - ssl_key_file = '/path/to/postgresql.key' - ssl_min_protocol_version = 'TLSv1.2' - ``` + ```ini + ssl = on + ssl_ca_file = '/path/to/root.crt' + ssl_cert_file = '/path/to/postgresql.crt' + ssl_key_file = '/path/to/postgresql.key' + ssl_min_protocol_version = 'TLSv1.2' + ``` 3. 根据 PostgreSQL 的要求，调整凭据的所有权和权限： - ``` - chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - ``` + ``` + chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + ``` -4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过SSL连接，并要求客户端证书验证。 +4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过 SSL 连接，并要求客户端证书验证。 - 对于PostgreSQL 12： + 对于 PostgreSQL 12： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full + ``` - 对于PostgreSQL 11及更早版本： + 对于 PostgreSQL 11 及更早版本： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 + ``` - 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 + 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 5. 重新启动 PostgreSQL 以应用上述配置。 6. 在运行 Gitea 实例的服务器上，将以下凭据放置在运行 Gitea 的用户的主目录下（例如 `git`）： - - `~/.postgresql/postgresql.crt`: 数据库客户端证书 - - `~/.postgresql/postgresql.key`: 数据库客户端私钥 - - `~/.postgresql/root.crt`: 用于验证服务器证书的CA证书链 + - `~/.postgresql/postgresql.crt`: 数据库客户端证书 + - `~/.postgresql/postgresql.key`: 数据库客户端私钥 + - `~/.postgresql/root.crt`: 用于验证服务器证书的 CA 证书链 - 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 + 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 7. 根据需要调整凭据、所有权和权限： - ``` - chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - ``` + ``` + chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + ``` 8. 测试与数据库的连接： - ``` - psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" - ``` + ``` + psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" + ``` - 您将被提示输入数据库用户的密码，然后连接到数据库。 + 您将被提示输入数据库用户的密码，然后连接到数据库。 ### MySQL -虽然 Gitea 使用的MySQL驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 +虽然 Gitea 使用的 MySQL 驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 -在单向TLS中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 +在单向 TLS 中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 1. 在数据库实例上放置以下凭据： - - `/path/to/mysql.crt`: 数据库实例证书 - - `/path/to/mysql.key`: 数据库实例密钥 - - `/path/to/ca.crt`: CA证书链。在单向TLS中不使用此文件，但用于验证双向TLS中的客户端证书。 + - `/path/to/mysql.crt`: 数据库实例证书 + - `/path/to/mysql.key`: 数据库实例密钥 + - `/path/to/ca.crt`: CA 证书链。在单向 TLS 中不使用此文件，但用于验证双向 TLS 中的客户端证书。 2. 将以下选项添加到 `my.cnf`： - ```ini - [mysqld] - ssl-ca = /path/to/ca.crt - ssl-cert = /path/to/mysql.crt - ssl-key = /path/to/mysql.key - tls-version = TLSv1.2,TLSv1.3 - ``` + ```ini + [mysqld] + ssl-ca = /path/to/ca.crt + ssl-cert = /path/to/mysql.crt + ssl-key = /path/to/mysql.key + tls-version = TLSv1.2,TLSv1.3 + ``` 3. 调整凭据的所有权和权限： - ``` - chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - ``` + ``` + chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + ``` -4. 重新启动MySQL以应用设置。 +4. 重新启动 MySQL 以应用设置。 5. Gitea 的数据库用户可能已经创建过，但只会对运行 Gitea 的服务器的 IP 地址进行身份验证。要对其域名进行身份验证，请重新创建用户，并设置其需要通过 TLS 连接到数据库： - ```sql - DROP USER 'gitea'@'192.0.2.10'; - CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + DROP USER 'gitea'@'192.0.2.10'; + CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; + FLUSH PRIVILEGES; + ``` - 根据需要替换数据库用户名、密码和 Gitea 实例域名。 + 根据需要替换数据库用户名、密码和 Gitea 实例域名。 -6. 确保用于验证数据库服务器证书的CA证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 +6. 确保用于验证数据库服务器证书的 CA 证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 -7. 在运行Gitea的服务器上，测试与数据库的连接： +7. 在运行 Gitea 的服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h example.db -p --ssl - ``` + ``` + mysql -u gitea -h example.db -p --ssl + ``` - 至此应该成功连接到数据库了。 + 至此应该成功连接到数据库了。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-binary.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-binary.md index 0e0fc871..31637ce6 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-binary.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-binary.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/install-from-binary - --- # 使用二进制文件安装 @@ -38,7 +37,7 @@ chmod +x gitea ## 验证 GPG 签名 -Gitea 对打包的二进制文件使用 [GPG密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 +Gitea 对打包的二进制文件使用 [GPG 密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 请根据对应文件名 `.asc` 中包含的校验码检验文件的一致性。 ```sh @@ -159,7 +158,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini **提示：** 我们不建议使用 SIGKILL 信号（`-9`），这会强制停止 Gitea 程序，但不会正确关闭队列、索引器等任务。 -请参阅下面的疑难解答说明，以在Gitea版本更新后修复损坏的仓库。 +请参阅下面的疑难解答说明，以在 Gitea 版本更新后修复损坏的仓库。 ## 排查故障 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-package.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-package.md index 65e9e0bb..a6b71de2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-package.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-package.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/install-from-package - --- # 使用包管理器安装 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-source.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-source.md index d7bd4eb7..7c68f281 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-source.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/from-source.md @@ -6,18 +6,17 @@ sidebar_position: 30 aliases: - /zh-cn/install-from-source - --- # 使用源代码安装 -首先你需要安装Golang，关于Golang的安装，参见[官方文档](https://golang.google.cn/doc/install)。 +首先你需要安装 Golang，关于 Golang 的安装，参见[官方文档](https://golang.google.cn/doc/install)。 -其次你需要[安装Node.js](https://nodejs.org/zh-cn/download/)，Node.js 和 npm 将用于构建 Gitea 前端。 +其次你需要[安装 Node.js](https://nodejs.org/zh-cn/download/)，Node.js 和 npm 将用于构建 Gitea 前端。 ## 下载 -你需要获取Gitea的源码，最方便的方式是使用 `git` 命令。执行以下命令： +你需要获取 Gitea 的源码，最方便的方式是使用 `git` 命令。执行以下命令： ``` git clone https://github.com/go-gitea/gitea @@ -53,8 +52,8 @@ git checkout @sourceVersion@ 按照您的编译需求，以下 tags 可以使用： -- `bindata`: 这个编译选项将会把运行Gitea所需的所有外部资源都打包到可执行文件中，这样部署将非常简单因为除了可执行程序将不再需要任何其他文件。 -- `sqlite sqlite_unlock_notify`: 这个编译选项将启用SQLite3数据库的支持，建议只在少数人使用时使用这个模式。 +- `bindata`: 这个编译选项将会把运行 Gitea 所需的所有外部资源都打包到可执行文件中，这样部署将非常简单因为除了可执行程序将不再需要任何其他文件。 +- `sqlite sqlite_unlock_notify`: 这个编译选项将启用 SQLite3 数据库的支持，建议只在少数人使用时使用这个模式。 - `pam`: 这个编译选项将会启用 PAM (Linux Pluggable Authentication Modules) 认证，如果你使用这一认证模式的话需要开启这个选项。 使用 bindata 可以打包资源文件到二进制可以使开发和测试更容易，你可以根据自己的需求决定是否打包资源文件。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-cloud-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-cloud-provider.md index 3df86aff..ebbe7831 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-cloud-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-cloud-provider.md @@ -15,9 +15,9 @@ Cloudron 使得在您的服务器上运行 Gitea，并保持其更新和安全 [![Install](/cloudron.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp) -Gitea软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). +Gitea 软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). -这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行Gitea。 +这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行 Gitea。 ## Linode diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-kubernetes.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-kubernetes.md index ddc3d68a..b127e830 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-kubernetes.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/on-kubernetes.md @@ -35,15 +35,15 @@ helm install gitea -f values.yaml gitea/gitea Gitea 附带了一个运行状况检查接口 `/api/healthz`，你可以像这样在 Kubernetes 中配置它： ```yaml - livenessProbe: - httpGet: - path: /api/healthz - port: http - initialDelaySeconds: 200 - timeoutSeconds: 5 - periodSeconds: 10 - successThreshold: 1 - failureThreshold: 10 +livenessProbe: + httpGet: + path: /api/healthz + port: http + initialDelaySeconds: 200 + timeoutSeconds: 5 + periodSeconds: 10 + successThreshold: 1 + failureThreshold: 10 ``` 成功的运行状况检查响应代码为 HTTP `200`，下面是示例： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/upgrade-from-gogs.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/upgrade-from-gogs.md index a8b1115e..6f7a02ec 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/upgrade-from-gogs.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/upgrade-from-gogs.md @@ -6,17 +6,16 @@ sidebar_position: 101 aliases: - /zh-cn/upgrade-from-gogs - --- # 从 Gogs 升级 -如果你正在运行Gogs 0.9.146以下版本，你可以平滑的升级到Gitea。该升级需要如下的步骤： +如果你正在运行 Gogs 0.9.146 以下版本，你可以平滑的升级到 Gitea。该升级需要如下的步骤： -* 停止 Gogs 的运行 -* 拷贝 Gogs 的配置文件 `custom/conf/app.ini` 到 Gitea 的相应位置。 -* 拷贝 Gitea 的 `options/` 到 Home 目录下。 -* 如果你还有更多的自定义内容，比如templates和localization文件，你需要手工合并你的修改到 Gitea 的 Options 下对应目录。 -* 拷贝 Gogs 的数据目录 `data/` 到 Gitea 相应位置。这个目录包含附件和头像文件。 -* 运行 Gitea -* 登录 Gitea 并进入 管理面板, 运行 `重新生成 '.ssh/authorized_keys' 文件（警告：不是 Gitea 的密钥也会被删除）` 和 `重新生成所有仓库的 Update 钩子（用于自定义配置文件被修改）`。 +- 停止 Gogs 的运行 +- 拷贝 Gogs 的配置文件 `custom/conf/app.ini` 到 Gitea 的相应位置。 +- 拷贝 Gitea 的 `options/` 到 Home 目录下。 +- 如果你还有更多的自定义内容，比如 templates 和 localization 文件，你需要手工合并你的修改到 Gitea 的 Options 下对应目录。 +- 拷贝 Gogs 的数据目录 `data/` 到 Gitea 相应位置。这个目录包含附件和头像文件。 +- 运行 Gitea +- 登录 Gitea 并进入 管理面板, 运行 `重新生成 '.ssh/authorized_keys' 文件（警告：不是 Gitea 的密钥也会被删除）` 和 `重新生成所有仓库的 Update 钩子（用于自定义配置文件被修改）`。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/windows-service.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/windows-service.md index 959ecce0..6d4fff35 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/windows-service.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/windows-service.md @@ -6,12 +6,11 @@ sidebar_position: 50 aliases: - /zh-cn/windows-service - --- -# 注册为Windows服务 +# 注册为 Windows 服务 -要注册为Windows服务，首先以Administrator身份运行 `cmd`，然后执行以下命令： +要注册为 Windows 服务，首先以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\"" @@ -19,11 +18,11 @@ sc create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\g 别忘了将 `C:\gitea` 替换成你的 Gitea 安装目录。 -之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000是默认端口）。 +之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000 是默认端口）。 -## 从Windows服务中删除 +## 从 Windows 服务中删除 -以Administrator身份运行 `cmd`，然后执行以下命令： +以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc delete gitea diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker-rootless.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker-rootless.md index 1dcd2d6b..be04d7e4 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker-rootless.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker-rootless.md @@ -45,7 +45,7 @@ services: - "2222:2222" ``` -请注意，卷应由在配置文件中指定的UID/GID的用户/组所有。默认情况下，Docker中的Gitea将使用uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： +请注意，卷应由在配置文件中指定的 UID/GID 的用户/组所有。默认情况下，Docker 中的 Gitea 将使用 uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： ```sh sudo chown 1000:1000 config/ data/ @@ -53,11 +53,11 @@ sudo chown 1000:1000 config/ data/ > 如果未为卷设置正确的权限，容器可能无法启动。 -对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 +对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x 是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 ## 自定义端口 -要将集成的SSH和Web服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 +要将集成的 SSH 和 Web 服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 ```diff version: "2" @@ -258,7 +258,7 @@ docker-compose up -d 除了上述的环境变量外，`app.ini` 中的任何设置都可以通过形式为 `GITEA__SECTION_NAME__KEY_NAME` 的环境变量进行设置或覆盖。这些设置在每次 Docker 容器启动时都会生效。完整信息请参考[这里](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini). -这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA__mailer__FROM、GITEA__mailer__HOST、GITEA__mailer__PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： +这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA**mailer**FROM、GITEA**mailer**HOST、GITEA**mailer**PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： ```bash ... diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker.md index 853edba7..75fd686d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/installation/with-docker.md @@ -6,7 +6,6 @@ sidebar_position: 70 aliases: - /zh-cn/install-with-docker - --- # 使用 Docker 安装 @@ -297,7 +296,7 @@ docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKE ``` ```yaml -... +--- services: server: environment: diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/agit-support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/agit-support.md index f496a0ec..c35b7f28 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/agit-support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/agit-support.md @@ -6,7 +6,6 @@ sidebar_position: 12 aliases: - /zh-cn/agit-setup - --- # AGit 设置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/clone-filter.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/clone-filter.md index f14b0375..90b6709c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/clone-filter.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/clone-filter.md @@ -5,7 +5,6 @@ slug: "clone-filters" sidebar_position: 25 aliases: - /zh-cn/clone-filters - --- # 克隆过滤器 (部分克隆) diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/incoming-email.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/incoming-email.md index 4ae55422..c91d1ae9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/incoming-email.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/incoming-email.md @@ -5,7 +5,6 @@ slug: "incoming-email" sidebar_position: 13 aliases: - /zh-cn/incoming-email - --- # 邮件接收 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/issue-pull-request-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/issue-pull-request-templates.md index 69a8b416..8e1f3905 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/issue-pull-request-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/issue-pull-request-templates.md @@ -100,16 +100,13 @@ Gitea 支持两种格式的模板：Markdown 和 YAML。 ```md --- - name: "Template Name" about: "This template is for testing!" title: "[TEST] " ref: "main" labels: - -- bug -- "help needed" - + - bug + - "help needed" --- This is the template! diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/labels.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/labels.md index 3f276403..f636ae7a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/labels.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/labels.md @@ -6,7 +6,6 @@ sidebar_position: 13 aliases: - /zh-cn/labels - --- # 标签 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/linked-references.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/linked-references.md index 4d0eadcf..45b46f29 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/linked-references.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/linked-references.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/automatically-linked-references - --- # 自动链接引用 @@ -93,11 +92,11 @@ aliases: - `m` - 分钟 - `h` - 小时 -- `d` - 天（相当于8小时） -- `w` - 周（相当于5天） -- `mo` - 月（相当于4周） +- `d` - 天（相当于 8 小时） +- `w` - 周（相当于 5 天） +- `mo` - 月（相当于 4 周） -用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示1小时10分钟。 +用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示 1 小时 10 分钟。 提交消息示例： @@ -118,26 +117,26 @@ Gitea 支持使用外部工单跟踪器，并可以在合并请求中创建对 下表说明了工单和合并请求的不同类型的交叉引用。在示例中，`User1/Repo1` 指的是使用引用的仓库，而 `UserZ/RepoZ` 表示另一个仓库。 -| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | -| ----------------------- | :-------------------: | :-------------------: | ------------------------------------------------ | -| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | -| **字母数字工单编号:** | - | - | - | -| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | +| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | +| ----------------------- | :------------------: | :------------------: | --------------------------------------------- | +| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | +| **字母数字工单编号:** | - | - | - | +| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | _最后一部分适用于使用字母数字格式的外部工单跟踪器的仓库。_ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/merge-message-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/merge-message-templates.md index ce141199..5447ff25 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/merge-message-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/merge-message-templates.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/merge-message-templates - --- # 合并消息模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/permissions.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/permissions.md index 0144d846..9412a58d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/permissions.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/permissions.md @@ -6,7 +6,6 @@ sidebar_position: 14 aliases: - /zh-cn/permissions - --- # 权限 @@ -17,31 +16,31 @@ Gitea 支持对仓库进行权限管理，这样您就可以为不同的人员 在 Gitea 中，我们将仓库的子模块称为 `单元（Unit）`。现在我们有以下几个单元。 -| 名称 | 描述 | 权限 | -| ----------------- | --------------------------------------------------- | ------------ | -| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | -| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | -| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | -| 发布 | 跟踪项目版本和下载。 | 读取 写入 | -| 维基 | 与协作者编写和共享文档。 | 读取 写入 | -| 外部维基 | 链接到外部维基。 | 读取 | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | -| 项目 | 模板仓库的 URL。 | 读取 写入 | -| 设置 | 管理仓库。 | 管理员 | +| 名称 | 描述 | 权限 | +| -------------- | ------------------------------ | --------- | +| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | +| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | +| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | +| 发布 | 跟踪项目版本和下载。 | 读取 写入 | +| 维基 | 与协作者编写和共享文档。 | 读取 写入 | +| 外部维基 | 链接到外部维基。 | 读取 | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | +| 项目 | 模板仓库的 URL。 | 读取 写入 | +| 设置 | 管理仓库。 | 管理员 | 通过不同的权限，用户可以在这些单元上执行不同的操作。 -| 名称 | 读取 | 写入 | 管理员 | -| ----------------- | -------------------------------------------------- | ------------------------------ | ------------------------- | -| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | -| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | -| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | -| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | -| 维基 | 查看维基页面。克隆维基仓库。 | 创建/编辑维基页面，推送更改。 | - | -| 外部维基 | 链接到外部维基。 | - | - | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | -| 项目 | 查看面板。 | 在面板之间移动工单。 | - | -| 设置 | - | - | 管理仓库 | +| 名称 | 读取 | 写入 | 管理员 | +| -------------- | -------------------------------- | ------------------------------ | -------- | +| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | +| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | +| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | +| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | +| 维基 | 查看维基页面。克隆维基仓库。 | 创建/编辑维基页面，推送更改。 | - | +| 外部维基 | 链接到外部维基。 | - | - | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | +| 项目 | 查看面板。 | 在面板之间移动工单。 | - | +| 设置 | - | - | 管理仓库 | 个人仓库和组织仓库之间的权限存在一些差异。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/protected-tags.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/protected-tags.md index e7467a40..3dbc6833 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/protected-tags.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/protected-tags.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/protected-tags - --- # 受保护的标签 @@ -28,17 +27,17 @@ aliases: 示例： -| 类型 | 模式受保护的标签 | 可能匹配的标签 | +| 类型 | 模式受保护的标签 | 可能匹配的标签 | | ----- | ------------------------ | --------------------------------------- | | Glob | `v*` | `v`，`v-1`，`version2` | -| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | +| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | | Glob | `*-release` | `2.1-release`，`final-release` | | Glob | `gitea` | 仅限 `gitea` | | Glob | `*gitea*` | `gitea`，`2.1-gitea`，`1_gitea-release` | | Glob | `{v,rel}-*` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Glob | `*` | 匹配所有可能的标签名称 | +| Glob | `*` | 匹配所有可能的标签名称 | | Regex | `/\Av/` | `v`，`v-1`，`version2` | -| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | +| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | | Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`，`v2.1.0` | | Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`，`v2.1`，`v1.2.34` | | Regex | `/-release\z/` | `2.1-release`，`final-release` | @@ -46,4 +45,4 @@ aliases: | Regex | `/\Agitea\z/` | 仅限 `gitea` | | Regex | `/^gitea$/` | 仅限 `gitea` | | Regex | `/\A(v\|rel)-/` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Regex | `/.+/` | 匹配所有可能的标签名称 | +| Regex | `/.+/` | 匹配所有可能的标签名称 | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/repo-mirror.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/repo-mirror.md index b208e920..c52e81d4 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/repo-mirror.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/repo-mirror.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/repo-mirror - --- # 仓库镜像 @@ -56,7 +55,7 @@ aliases: 要从 Gitea 设置镜像到 GitHub，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *public_repo* 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 +1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同，GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史，您也可以使用现有的远程仓库。 3. 在您的 Gitea 仓库设置中，填写**Git 远程仓库 URL**：`https://github.com//.git`。 4. 使用您的 GitHub 用户名填写**授权**字段，并将个人访问令牌作为**密码**。 @@ -69,7 +68,7 @@ aliases: 要从 Gitea 设置镜像到 GitLab，您需要按照以下步骤进行操作： -1. 创建具有 *write_repository* 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 +1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 2. 填写**Git 远程仓库 URL**：`https:////.git`。 3. 在**授权**字段中填写 `oauth2` 作为**用户名**，并将您的 GitLab 个人访问令牌作为**密码**。 4. 选择**添加推送镜像**以保存配置。 @@ -80,7 +79,7 @@ aliases: 要从 Gitea 设置镜像到 Bitbucket，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *Repository Write* 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 +1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 2. 填写**Git 远程仓库 URL**：`https://bitbucket.org//.git`。 3. 使用您的 Bitbucket 用户名填写**授权**字段，并将应用密码作为**密码**。 4. 选择**添加推送镜像**以保存配置。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/template-repositories.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/template-repositories.md index 7abe4d52..dc1f062b 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/template-repositories.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/template-repositories.md @@ -6,7 +6,6 @@ sidebar_position: 14 aliases: - /zh-cn/template-repositories - --- # 模板仓库 @@ -43,20 +42,20 @@ a/b/c/d.json 所有变量都必须采用`$VAR`或`${VAR}`的形式。要转义扩展，使用双重`$$`，例如`$$VAR`或`$${VAR}`。 -| 变量 | 扩展为 | 可转换 | -| -------------------- | --------------------------------------------------- | ------------- | -| REPO_NAME | 生成的仓库名称 | ✓ | -| TEMPLATE_NAME | 模板仓库名称 | ✓ | -| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | -| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | -| REPO_OWNER | 生成的仓库所有者 | ✓ | -| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | -| REPO_LINK | 生成的仓库链接 | ✘ | -| TEMPLATE_LINK | 模板仓库链接 | ✘ | -| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | -| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | -| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | -| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | +| 变量 | 扩展为 | 可转换 | +| -------------------- | ----------------------------- | ------ | +| REPO_NAME | 生成的仓库名称 | ✓ | +| TEMPLATE_NAME | 模板仓库名称 | ✓ | +| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | +| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | +| REPO_OWNER | 生成的仓库所有者 | ✓ | +| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | +| REPO_LINK | 生成的仓库链接 | ✘ | +| TEMPLATE_LINK | 模板仓库链接 | ✘ | +| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | +| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | +| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | +| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | ## 转换器 :robot: @@ -66,12 +65,12 @@ Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。 将 `go-sdk` 传递给可用的转换器的效果如下... -| 转换器 | 效果 | -| ----------- | ------------ | -| SNAKE | go_sdk | -| KEBAB | go-sdk | -| CAMEL | goSdk | -| PASCAL | GoSdk | -| LOWER | go-sdk | -| UPPER | GO-SDK | -| TITLE | Go-Sdk | +| 转换器 | 效果 | +| ------ | ------ | +| SNAKE | go_sdk | +| KEBAB | go-sdk | +| CAMEL | goSdk | +| PASCAL | GoSdk | +| LOWER | go-sdk | +| UPPER | GO-SDK | +| TITLE | Go-Sdk | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/webhooks.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/webhooks.md index 2358fca4..34e1ca76 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/webhooks.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.20/usage/webhooks.md @@ -8,7 +8,7 @@ aliases: # Webhooks -Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks还可以基于组织和整个系统进行配置。 +Gitea 支持用于仓库事件的 Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks 还可以基于组织和整个系统进行配置。 所有事件推送都是 POST 请求。目前支持： - Gitea (也可以是 GET 请求) @@ -30,7 +30,7 @@ Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置 ::: -以下是 Gitea 将发送给 payload URL的事件信息示例： +以下是 Gitea 将发送给 payload URL 的事件信息示例： ```http X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473 @@ -186,4 +186,4 @@ if (json_last_error() !== JSON_ERROR_NONE) { ## 授权头（Authorization header） -**从1.19版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 +**从 1.19 版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/adding-legal-pages.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/adding-legal-pages.md index be22cc86..2ab0f76e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/adding-legal-pages.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/adding-legal-pages.md @@ -6,7 +6,6 @@ sidebar_position: 110 aliases: - /zh-cn/adding-legal-pages - --- # 添加法律页面 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/authentication.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/authentication.md index 612d6341..4a4a8c9d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/authentication.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/authentication.md @@ -6,14 +6,13 @@ sidebar_position: 10 aliases: - /zh-cn/authentication - --- # 认证 ## 轻量级目录访问协议（Lightweight Directory Access Protocol，LDAP） -通过BindDN的LDAP和简单认证方式LDAP共享以下字段: +通过 BindDN 的 LDAP 和简单认证方式 LDAP 共享以下字段: - 认证名称 **(必选)** @@ -30,48 +29,52 @@ aliases: - 例如: LDAP `389`/ LDAPs `636` - 安全协议 (可选) - - 连接LDAP服务器时是否使用TLS协议。 + + - 连接 LDAP 服务器时是否使用 TLS 协议。 - 管理员过滤规则 (可选) - - 一个LDAP过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 + + - 一个 LDAP 过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 - 示例:`(objectClass=adminAccount)` - - 适用于Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` + - 适用于 Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` - 用户名属性（可选） - - 用户LDAP记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的Gitea账户用户名。若留空，则使用登录表单上提供的用户名。 - - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于Gitea账户名称，请参阅"用户过滤器"。 + - 用户 LDAP 记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的 Gitea 账户用户名。若留空，则使用登录表单上提供的用户名。 + - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于 Gitea 账户名称，请参阅"用户过滤器"。 - 示例:uid - - 适用于Microsoft Active Directory（AD）的示例:`sAMAccountName` + - 适用于 Microsoft Active Directory（AD）的示例:`sAMAccountName` - 名字属性（可选） - - 用户LDAP记录中包含用户名字的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户名字的属性。将用于填充他们的账户信息。 - 示例:givenName + - 姓氏属性（可选） - - 用户LDAP记录中包含用户姓氏的属性。将用于填充他们的账户信息。 + + - 用户 LDAP 记录中包含用户姓氏的属性。将用于填充他们的账户信息。 - 示例:`sn` - 电子邮件属性 **(必选)** - - 用户LDAP记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 - 示例:`mail` ### LDAP(via BindDN) 需要额外设置以下字段: -- 绑定DN (可选) +- 绑定 DN (可选) - - 搜索用户时绑定到LDAP服务器的DN。这可以留空以执行匿名搜索。 + - 搜索用户时绑定到 LDAP 服务器的 DN。这可以留空以执行匿名搜索。 - 示例: `cn=Search,dc=mydomain,dc=com` - 绑定密码 (可选) - - 上述指定的Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用SECRET_KEY进行加密存储。仍然建议确保Bind DN具有尽可能少的权限。 + - 上述指定的 Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用 SECRET_KEY 进行加密存储。仍然建议确保 Bind DN 具有尽可能少的权限。 - 用户搜索基准 **(必选)** - - 这是用于搜索用户帐户的LDAP基础路径. + - 这是用于搜索用户帐户的 LDAP 基础路径. - 示例: `ou=Users,dc=mydomain,dc=com` - 用户过滤规则 **(必选)** @@ -82,19 +85,19 @@ aliases: - 如需多次替换，应使用 `%[1]s`，例如在将提供的登录名与多个属性（如用户标识符、电子邮件甚至电话号码）进行匹配时。 - 示例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` - 启用用户同步 - - 这个选项启用了一个周期性任务，用于将Gitea用户与LDAP服务器进行同步。默认的同步周期是每24小时， - 但您可以在app.ini文件中进行更改。 + - 这个选项启用了一个周期性任务，用于将 Gitea 用户与 LDAP 服务器进行同步。默认的同步周期是每 24 小时， + 但您可以在 app.ini 文件中进行更改。 有关此部分的详细说明，请参阅[sample app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) - 的_cron.sync_external_users_ 部分的注释。前面提到的_User Search Base_和_User Filter_ - 设置将限制哪些用户可以使用Gitea以及哪些用户将被同步。 - 在初始运行任务时，将根据给定的设置创建所有与LDAP匹配的用户，因此在使用大型企业LDAP目录时需要小心。 + 的*cron.sync_external_users* 部分的注释。前面提到的*User Search Base*和*User Filter* + 设置将限制哪些用户可以使用 Gitea 以及哪些用户将被同步。 + 在初始运行任务时，将根据给定的设置创建所有与 LDAP 匹配的用户，因此在使用大型企业 LDAP 目录时需要小心。 ### LDAP(simple auth) 需要额外设置以下字段: -- 用户DN **(必选)** +- 用户 DN **(必选)** - 用作用户 DN 的模板。匹配参数 `%s` 将替换为登录表单中的登录名。 - 示例: `cn=%s,ou=Users,dc=mydomain,dc=com` @@ -111,11 +114,12 @@ aliases: - 示例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` -### 使用LDAP验证分组成员 +### 使用 LDAP 验证分组成员 使用以下字段: -- 群组搜索基础DN(可选) +- 群组搜索基础 DN(可选) + - 组使用的 LDAP DN。 - 示例: `ou=group,dc=mydomain,dc=com` @@ -135,43 +139,46 @@ aliases: ## 可插拔式认证模块(Pluggable Authentication Module,PAM) -这个过程启用了PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 -PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加到当前数据库中。为了与普通的Linux密码一起使用， -运行Gitea的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 +这个过程启用了 PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 +PAM 提供了一种机制，通过对用户进行 PAM 认证来自动将其添加到当前数据库中。为了与普通的 Linux 密码一起使用， +运行 Gitea 的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 -**注意**:如果用户已将SSH公钥添加到Gitea中，使用这些密钥可能会绕过登录检查系统。因此， -如果您希望禁用使用PAM进行身份验证的用户，应该在Gitea中手动禁用该账户，使用内置的用户管理功能。 +**注意**:如果用户已将 SSH 公钥添加到 Gitea 中，使用这些密钥可能会绕过登录检查系统。因此， +如果您希望禁用使用 PAM 进行身份验证的用户，应该在 Gitea 中手动禁用该账户，使用内置的用户管理功能。 1. 配置和安装准备. - - 建议您创建一个管理用户. - - 建议取消自动注册. + - 建议您创建一个管理用户. + - 建议取消自动注册. 1. 一旦数据库已初始化完成，使用新创建的管理员账户登录. 1. 导航至用户设置（右上角的图标），然后选择 -`Site Administration` -> `Authentication Sources`, 并选择 -`Add Authentication Source`. + `Site Administration` -> `Authentication Sources`, 并选择 + `Add Authentication Source`. 1. 填写字段如下: - - 认证类型:`PAM`。 - - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 - - PAM服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 - - PAM电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为gituse的用户， - 并且将此字段设置为mail.com，那么Gitea在验证一个GIT实例的用户时将期望user emai字段为gituser@mail.com[^2]。 + - 认证类型:`PAM`。 + - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 + - PAM 服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 + - PAM 电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为 gituse 的用户， + 并且将此字段设置为 mail.com，那么 Gitea 在验证一个 GIT 实例的用户时将期望 user emai 字段为gituser@mail.com[^2]。 **Note**: PAM 支持通过[build-time flags](installation/from-source.md#build)添加, -而官方提供的二进制文件通常不会默认启用此功能。PAM需要确保系统上有必要的libpam动态库，并且编译器可以访问必要的PAM开发头文件。 +而官方提供的二进制文件通常不会默认启用此功能。PAM 需要确保系统上有必要的 libpam 动态库，并且编译器可以访问必要的 PAM 开发头文件。 -[^1]: 例如，在Debian "Bullseye"上使用标准Linux登录，可以使用`common-session-noninteractive`。这个值对于其他版本的Debian， -包括Ubuntu和Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 +[^1]: + 例如，在 Debian "Bullseye"上使用标准 Linux 登录，可以使用`common-session-noninteractive`。这个值对于其他版本的 Debian， + 包括 Ubuntu 和 Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 -[^2]: **PAM的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到Gitea的Web界面。 +[^2]: **PAM 的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到 Gitea 的 Web 界面。 ## 简单邮件传输协议(Simple Mail Transfer Protocol,SMTP) 此选项允许 Gitea 以 Gitea 用户身份登录 SMTP 主机。请设置以下字段: - 身份验证名称 **(必选)** + - 分配给新授权方法的名称 - SMTP 验证类型 **(必选)** + - 用于连接 SMTP 主机的验证类型，plain 或 login - 主机名 **(必选)** @@ -191,7 +198,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 示例: `gitea.io,mydomain.com,mydomain2.com` - 强制使用 SMTPS - - 默认情况下将使用SMTPS连接到端口465.如果您希望将smtp用于其他端口，自行设置 + - 默认情况下将使用 SMTPS 连接到端口 465.如果您希望将 smtp 用于其他端口，自行设置 - 否则，如果服务器提供' STARTTLS '扩展名，则将使用此扩展名 - 跳过 TLS 验证 - 禁用 TLS 验证身份. @@ -202,7 +209,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 要使用 FreeIPA 凭据登录 Gitea，需要为 Gitea 创建一个绑定帐户。 创建一个绑定帐户: -- 在FreeIPA服务器上创建一个gitea.ldif文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 +- 在 FreeIPA 服务器上创建一个 gitea.ldif 文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 ```sh dn: uid=gitea,cn=sysaccounts,cn=etc,dc=example,dc=com @@ -215,33 +222,33 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 nsIdleTimeout: 0 ``` -- 导入LDIF文件（如果需要，请将localhost更改为IPA服务器）。系统会提示您输入Directory Manager的密码。: +- 导入 LDIF 文件（如果需要，请将 localhost 更改为 IPA 服务器）。系统会提示您输入 Directory Manager 的密码。: ```sh ldapmodify -h localhost -p 389 -x -D \ "cn=Directory Manager" -W -f gitea.ldif ``` -- 为`gitea_users`添加IPA组: +- 为`gitea_users`添加 IPA 组: ```sh ipa group-add --desc="Gitea Users" gitea_users ``` -- **提示**:对于IPA凭证错误，运行' kinit admin '并提供域管理帐户密码. -- 以管理员身份登录Gitea，点击Admin Panel下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 +- **提示**:对于 IPA 凭证错误，运行' kinit admin '并提供域管理帐户密码. +- 以管理员身份登录 Gitea，点击 Admin Panel 下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 ## SPNEGO with SSPI (Kerberos/NTLM, for Windows only) -Gitea支持通过Windows内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现SPNEGO单点登录认证（由RFC4559定义的方案），用于服务器的Web部分。SSPI仅在Windows环境中工作，即当服务器和客户端都在Windows操作系统上运行时。 +Gitea 支持通过 Windows 内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现 SPNEGO 单点登录认证（由 RFC4559 定义的方案），用于服务器的 Web 部分。SSPI 仅在 Windows 环境中工作，即当服务器和客户端都在 Windows 操作系统上运行时。 -在激活SSPI单点登录认证（SSO）之前，您需要准备您的环境: +在激活 SSPI 单点登录认证（SSO）之前，您需要准备您的环境: -- 在Active Directory中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在domain.local域下创建一个名为user的账户: -- 为运行gitea.exe的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为HTTP: +- 在 Active Directory 中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在 domain.local 域下创建一个名为 user 的账户: +- 为运行 gitea.exe 的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为 HTTP: - 以特权域用户（例如域管理员）的身份启动“命令提示符”或“PowerShell”。 - - 运行下面的命令，将host.domain.local替换为Web应用程序将运行的服务器的完全限定域名（FQDN），将domain\user替换为在前一步中创建的账户名称: + - 运行下面的命令，将 host.domain.local 替换为 Web 应用程序将运行的服务器的完全限定域名（FQDN），将 domain\user 替换为在前一步中创建的账户名称: ```sh setspn -A HTTP/host.domain.local domain\user @@ -250,22 +257,22 @@ Gitea支持通过Windows内置的安全支持提供程序接口（Security Suppo 在遵循上述步骤之前，请确保您按照以下流程进行操作: 1. 用之前创建的用户登录（如果已经登录，请先注销）。 -2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为Web应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 -3. 启动Web服务器（运行 `gitea.exe web`）。 -4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用SSPI认证。 +2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为 Web 应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 +3. 启动 Web 服务器（运行 `gitea.exe web`）。 +4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用 SSPI 认证。 5. 在域中的客户端计算机上，使用任何域用户登录（与运行`gitea.exe`的服务器不同）。 -6. 如果您使用Chrome或Edge浏览器，请将Web应用程序的URL添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 -7. 启动Chrome或Edge浏览器，导航到Gitea的FQDN URL（例如，`http://host.domain.local:3000`）。 -8. 在控制面板中点击“Sign In”按钮，然后选择SSPI，将会自动使用当前登录到计算机的用户进行登录。 +6. 如果您使用 Chrome 或 Edge 浏览器，请将 Web 应用程序的 URL 添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 +7. 启动 Chrome 或 Edge 浏览器，导航到 Gitea 的 FQDN URL（例如，`http://host.domain.local:3000`）。 +8. 在控制面板中点击“Sign In”按钮，然后选择 SSPI，将会自动使用当前登录到计算机的用户进行登录。 9. 如果无法正常工作，请确保: - - 您不是在运行`gitea.exe`的同一台服务器上运行Web浏览器。应该在与服务器不同的域加入计算机（客户端）上运行Web浏览器。如果客户端和服务器都在同一台计算机上运行，则NTLM将优先于Kerberos。 - - 主机上只有一个`HTTP/...`的SPN。 - - SPN中只包含主机名，不包含端口号。 - - 将Web应用程序的URL添加到"本地站点"。 - - 服务器和客户端的时钟差异不超过5分钟（取决于组策略）。 - - 在Internet Explorer中启用了"集成Windows身份验证"（在"高级设置"下）。 + - 您不是在运行`gitea.exe`的同一台服务器上运行 Web 浏览器。应该在与服务器不同的域加入计算机（客户端）上运行 Web 浏览器。如果客户端和服务器都在同一台计算机上运行，则 NTLM 将优先于 Kerberos。 + - 主机上只有一个`HTTP/...`的 SPN。 + - SPN 中只包含主机名，不包含端口号。 + - 将 Web 应用程序的 URL 添加到"本地站点"。 + - 服务器和客户端的时钟差异不超过 5 分钟（取决于组策略）。 + - 在 Internet Explorer 中启用了"集成 Windows 身份验证"（在"高级设置"下）。 -遵循这些步骤，您应该能够成功启用和使用SSPI单点登录认证（SSO）。 +遵循这些步骤，您应该能够成功启用和使用 SSPI 单点登录认证（SSO）。 ## 反向代理认证 @@ -282,7 +289,7 @@ ENABLE_REVERSE_PROXY_AUTHENTICATION = true 如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`，则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取，这样在自动创建用户时将使用这个字段作为用户全名，你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 -你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的IP地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 +你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 你可以通过以下配置为 API 启用此认证方法： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/backup-and-restore.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/backup-and-restore.md index aa2ec7dd..86c8c65e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/backup-and-restore.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/backup-and-restore.md @@ -6,16 +6,15 @@ sidebar_position: 11 aliases: - /zh-cn/backup-and-restore - --- # 备份与恢复 -Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个zip压缩文件。该压缩文件可以被用来进行数据恢复。 +Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 ## 备份命令 (`dump`) -先转到git用户的权限: `su git`. 再Gitea目录运行 `./gitea dump`。一般会显示类似如下的输出： +先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出： ``` 2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 @@ -28,11 +27,11 @@ Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一 最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容： -* `custom` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 -* `data` - 数据目录下的所有内容不包含使用文件session的文件。该目录包含 `attachments`, `avatars`, `lfs`, `indexers`, 如果使用sqlite 还会包含 sqlite 数据库文件。 -* `gitea-db.sql` - 数据库dump出来的 SQL。 -* `gitea-repo.zip` - Git仓库压缩文件。 -* `log/` - Logs文件，如果用作迁移不是必须的。 +- `custom` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 +- `data` - 数据目录下的所有内容不包含使用文件 session 的文件。该目录包含 `attachments`, `avatars`, `lfs`, `indexers`, 如果使用 sqlite 还会包含 sqlite 数据库文件。 +- `gitea-db.sql` - 数据库 dump 出来的 SQL。 +- `gitea-repo.zip` - Git 仓库压缩文件。 +- `log/` - Logs 文件，如果用作迁移不是必须的。 中间备份文件将会在临时目录进行创建，如果您要重新指定临时目录，可以用 `--tempdir` 参数，或者用 `TMPDIR` 环境变量。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/command-line.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/command-line.md index 163c9796..00c8e6fd 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/command-line.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/command-line.md @@ -6,7 +6,6 @@ sidebar_position: 1 aliases: - /zh-cn/command-line - --- # 命令行 @@ -62,7 +61,7 @@ aliases: - 选项： - `--email`：要删除的用户的电子邮件。 - `--username`：要删除的用户的用户名。 - - `--id`：要删除的用户的ID。 + - `--id`：要删除的用户的 ID。 - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 - 示例： - `gitea admin user delete --id 1` @@ -171,11 +170,11 @@ aliases: - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 - `--skip-local-2fa`：跳过 2FA 登录。 - `--active`：启用此认证源。 - 备注： - `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： - `--option`、`--option=true` 以启用选项 - `--option=false` 以禁用选项 - 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 - 示例： - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` - `update-smtp`： @@ -284,12 +283,12 @@ aliases: ### cert -生成自签名的SSL证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 - 选项： - - `--host value`：逗号分隔的主机名和IP地址列表，此证书适用于这些主机。支持使用通配符。必填。 - - `--ecdsa-curve value`：用于生成密钥的ECDSA曲线。可选。有效选项为P224、P256、P384、P521。 - - `--rsa-bits value`：要生成的RSA密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 @@ -298,18 +297,18 @@ aliases: ### dump -将所有文件和数据库导出到一个zip文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 - 选项： - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 - `--skip-repository`，`-R`：跳过仓库的导出。可选。 - `--skip-custom-dir`：跳过自定义目录的导出。可选。 - - `--skip-lfs-data`：跳过LFS数据的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 - `--skip-attachment-data`：跳过附件数据的导出。可选。 - `--skip-package-data`：跳过包数据的导出。可选。 - `--skip-log`：跳过日志数据的导出。可选。 - - `--database`，`-d`：指定数据库的SQL语法。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 - `--type`：设置导出的格式。可选。（默认值：zip） - 示例： @@ -402,19 +401,19 @@ gitea doctor recreate-table - 命令: - `shutdown`: 优雅地关闭运行中的进程 - - `restart`: 优雅地重新启动运行中的进程（对于Windows服务器尚未实现） + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） - `flush-queues`: 刷新运行中的进程中的队列 - 选项: - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） - - `--non-blocking`: 设置为true，以在返回之前不等待刷新完成 + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 - `logging`: 调整日志命令 - 命令: - `pause`: 暂停日志记录 - 注意: - - 如果日志级别低于此级别，日志级别将被临时提升为INFO。 - - Gitea将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 - `resume`: 恢复日志记录 - - `release-and-reopen`: 使Gitea释放和重新打开用于日志记录的文件和连接（相当于向Gitea发送SIGUSR1信号）。 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 - `remove name`: 删除指定的日志记录器 - 选项: - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） @@ -430,7 +429,7 @@ gitea doctor recreate-table - `--expression value`, `-e value`: 日志记录器的匹配表达式 - `--prefix value`, `-p value`: 日志记录器的前缀 - `--color`: 在日志中使用颜色 - - `--stderr`: 将控制台日志输出到stderr - 仅适用于控制台 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 - `file`: 添加文件日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" @@ -460,9 +459,9 @@ gitea doctor recreate-table - `--color`: 在日志中使用颜色 - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 - `--reconnect`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix或udp（默认为tcp） + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） - - `smtp`: 添加SMTP日志记录器 + - `smtp`: 添加 SMTP 日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md index 9e51aec1..e844df28 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/config-cheat-sheet.md @@ -6,13 +6,12 @@ sidebar_position: 30 aliases: - /zh-cn/config-cheat-sheet - --- # 配置说明 -这是针对Gitea配置文件的说明， -你可以了解Gitea的强大配置。 +这是针对 Gitea 配置文件的说明， +你可以了解 Gitea 的强大配置。 需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 如果是从发行版本完成的安装， @@ -23,7 +22,7 @@ aliases: [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。 标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 -在下面的默认值中,`$XYZ`代表环境变量`XYZ`的值(详见:`environment-to-ini`)。 _`XxYyZz`_是指默认配置的一部分列出的值。这些在 app.ini 文件中不起作用，仅在此处列出作为文档说明。 +在下面的默认值中,`$XYZ`代表环境变量`XYZ`的值(详见:`environment-to-ini`)。 *`XxYyZz`*是指默认配置的一部分列出的值。这些在 app.ini 文件中不起作用，仅在此处列出作为文档说明。 包含`#`或者`;`的变量必须使用引号(`` ` ``或者`""""`)包裹，否则会被解析为注释。 @@ -34,68 +33,68 @@ aliases: 这些值取决于环境，但构成了许多值的基础。当运行 `gitea help`或启动时，它们将 作为默认配置的一部分进行报告。它们在那里发出的顺序略有不同，但我们将按照设置的顺序在这里列出。 -- _`AppPath`_: Gitea二进制可执行文件的绝对路径 -- _`AppWorkPath`_: Gitea可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: +- _`AppPath`_: Gitea 二进制可执行文件的绝对路径 +- _`AppWorkPath`_: Gitea 可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: - `app.ini`中的`WORK_PATH`配置项 - - 启动Gitea时的`--work-path`命令行参数 + - 启动 Gitea 时的`--work-path`命令行参数 - `$GITEA_WORK_DIR`环境变量 - 在编译时设置的内置值（参见从源代码编译） - 默认为 _`AppPath`_ 的目录 - 如果上述任何路径为相对路径，将自动解析为相对于 _`AppPath`_ 目录的绝对路径 - _`CustomPath`_: 这是用于自定义模板和其他选项的基础目录。 -它是通过使用以下层次结构中的第一个设置的内容来确定的： + 它是通过使用以下层次结构中的第一个设置的内容来确定的： - 通过传递给二进制文件的`--custom-path`标志 - 环境变量 `$GITEA_CUSTOM` - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`AppWorkPath`_`/custom` - 如果上述任何路径是相对路径，则会相对于 _`AppWorkPath`_ 目录进行处理， - 使其变为绝对路径。 + 使其变为绝对路径。 - _`CustomConf`_: 这是指向`app.ini`文件的路径。 - 这是指向`app.ini`文件的路径。 - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`CustomPath`_`/conf/app.ini` - - 如果上述任何路径是相对路径，则会相对于_`CustomPath`_目录进行处理。 + - 如果上述任何路径是相对路径，则会相对于*`CustomPath`*目录进行处理。 -此外，还有_`StaticRootPath`_，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 +此外，还有*`StaticRootPath`*，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 ## Overall (`DEFAULT`) - `APP_NAME`: **Gitea: Git with a cup of tea** 应用名称，在网页的标题中显示。 -- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行Gitea的用户， +- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行 Gitea 的用户， 应当是一个专用的系统账户(非用户使用，推荐创建一个专用的`git`用户). 如果在你自己的个人电脑使用改成你自己的用户名。 - 该配置如果设置不正确，Gitea可能崩溃。 + 该配置如果设置不正确，Gitea 可能崩溃。 - `RUN_MODE`: **prod**: 应用的运行模式，对运行性能和问题排除有影响: `dev` 或者 `prod`,默认为 `prod`。 `dev`模式有助于开发和问题排查, 除设置为`dev` 外，均被视为 `prod`. - `WORK_PATH`: **_the-work-path_**: 工作目录, 前文有提及. ## 仓库 (`repository`) -- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放git工程的根目录，建议填绝对路径。 +- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放 git 工程的根目录，建议填绝对路径。 相对路径将被解析为**_`AppWorkPath`_/%(ROOT)s**. -- `SCRIPT_TYPE`: **bash**: 服务器支持的Shell类型，通常是`bash`， +- `SCRIPT_TYPE`: **bash**: 服务器支持的 Shell 类型，通常是`bash`， 但有些服务器也有可能是`sh`。 - `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 检测到的字符集的决定性顺序 - 如果检测到的字符集具有相等的置信度，则优先选择列表中较早出现的字符集，而不是较晚出现的字符集。添加“defaults”将会将未命名的字符集放置在该点。 -- `ANSI_CHARSET`: **_empty_**: 默认的ANSI字符集，用于覆盖非UTF-8字符集。 +- `ANSI_CHARSET`: **_empty_**: 默认的 ANSI 字符集，用于覆盖非 UTF-8 字符集。 - `FORCE_PRIVATE`: **false**: 强制使每个新仓库变为私有。 - `DEFAULT_PRIVATE`: **last**: 创建新仓库时默认为私有：`last`, `private`, `public`。 - `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送创建新仓库时默认为私有。 - `MAX_CREATION_LIMIT`: **-1**: 每个用户的全局仓库创建上限, - `-1` 代表无限制. + `-1` 代表无限制. - `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表顶部的指定许可证。 - 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 -- `DISABLE_HTTP_GIT`: **false**: 禁用HTTP协议与仓库进行 - 交互的能力。 -- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的SSH端口时，强制使用ssh://克隆URL， - 而不是scp-style uri。 -- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的URL作为https或ssh， - 默认为https。 + 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 +- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 协议与仓库进行 + 交互的能力。 +- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的 SSH 端口时，强制使用 ssh://克隆 URL， + 而不是 scp-style uri。 +- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的 URL 作为 https 或 ssh， + 默认为 https。 - `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用于 Access-Control-Allow-Origin 标头的值， -默认不提供。 -警告：如果您不提供正确的值，这可能对您的网站造成危害。 -- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 -- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到Gitea，并为用户自动创建它们。 -- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到Gitea，并为组织自动创建它们。 + 默认不提供。 + 警告：如果您不提供正确的值，这可能对您的网站造成危害。 +- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 +- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到 Gitea，并为用户自动创建它们。 +- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到 Gitea，并为组织自动创建它们。 - `DISABLED_REPO_UNITS`: **_empty_**: 逗号分隔的全局禁用的仓库单元列表。允许的值是：: \[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**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部wiki和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 +- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部 wiki 和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 - `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗号分隔的默认分叉仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 - `PREFIX_ARCHIVE_FILES`: **true**: 通过将存档文件放置在以仓库命名的目录中来添加前缀。 - `DISABLE_MIGRATIONS`: **false**: 禁用迁移功能。 @@ -109,15 +108,15 @@ aliases: ### 仓库 - 编辑器 (`repository.editor`) - `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中应该换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件进行换行，只需放置一个逗号。 -- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览API的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 +- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 ### 仓库 - 合并请求 (`repository.pull-request`) - `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取请求标题中用于标记工作正在进行中的前缀列表。 -这些前缀在不区分大小写的情况下进行匹配。 + 这些前缀在不区分大小写的情况下进行匹配。 - `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取请求评论中用于自动关闭相关问题的关键词列表。 - `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取请求评论中用于自动重新打开相关问题的 -关键词列表。 + 关键词列表。 - `DEFAULT_MERGE_STYLE`: **merge**: 设置创建仓库的默认合并方式，可选: `merge`, `rebase`, `rebase-merge`, `squash` - `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在默认合并消息中，对于`squash`提交，最多包括此数量的提交。设置为 -1 以包括所有提交。 - `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在默认的合并消息中，对于`squash`提交，限制提交消息的大小。设置为 `-1`以取消限制。仅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`为`true`时使用。 @@ -126,18 +125,18 @@ aliases: - `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在默认合并消息中，仅包括官方允许审查的审批者。 - `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在默认的 squash 合并消息中，包括构成拉取请求的所有提交的提交消息。 - `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者与作者不匹配，在合并提交消息中添加`co-authored-by`和`co-committed-by`标记。 -- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 +- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是 1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 ### 仓库 - 工单 (`repository.issue`) - `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合并请求或工单被锁定的原因列表。 -- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为0禁用固定工单。 +- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为 0 禁用固定工单。 ### 仓库 - 文件上传 (`repository.upload`) - `ENABLED`: **true**: 是否启用仓库文件上传。 -- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在Gitea重启的时候该目录会被清空)。 -- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 +- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在 Gitea 重启的时候该目录会被清空)。 +- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime 类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 - `FILE_MAX_SIZE`: **50**: 每个文件的最大大小(MB)。 - `MAX_FILES`: **5**: 每次上传的最大文件数。 @@ -159,10 +158,10 @@ aliases: - 除了 never 和 always 之外的选项可以组合为逗号分隔的列表。 - `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用于验证提交的默认信任模型。 - `collaborator`: 信任协作者密钥签名的签名。 - - `committer`: 信任与提交者匹配的签名（这与GitHub匹配，并会强制Gitea签名的提交具有Gitea作为提交者）。 + - `committer`: 信任与提交者匹配的签名（这与 GitHub 匹配，并会强制 Gitea 签名的提交具有 Gitea 作为提交者）。 - `collaboratorcommitter`: 信任与提交者匹配的协作者密钥签名的签名。 -- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对wiki提交进行签名。 -- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对CRUD操作进行签名。 +- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对 wiki 提交进行签名。 +- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对 CRUD 操作进行签名。 - 与上面相同的选项，增加了： - `parentsigned`: 仅在父提交进行了签名时才进行签名。 - `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 对合并操作进行签名。 @@ -175,7 +174,7 @@ aliases: - `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地仓库副本的路径。默认为 tmp/local-repo（内容在 Gitea 重新启动时被删除） -### 仓库 - MIME type mapping (`repository.mimetype_mapping`) +### 仓库 - MIME type mapping (`repository.mimetype_mapping`) 配置用于根据可下载文件的文件扩展名设置预期的 MIME 类型。配置以键值对的形式呈现，文件扩展名以`.`开头。 @@ -193,7 +192,7 @@ aliases: - `MAX_AGE`: **10m**: 缓存响应的最大时间 - `ALLOW_CREDENTIALS`: **false**: 允许带有凭据的请求 - `HEADERS`: **Content-Type,User-Agent**: 允许请求携带的头部 -- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP头部. +- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP 头部. ## 界面 (`ui`) @@ -202,24 +201,24 @@ aliases: - `MEMBERS_PAGING_NUM`: **20**: 组织成员页面每页显示的成员数量。 - `FEED_MAX_COMMIT_NUM`: **5**: 活动流页面显示的最大提交数量。 - `FEED_PAGING_NUM`: **20**: 活动流页面显示的最大活动数量。 -- `SITEMAP_PAGING_NUM`: **20**: 在单个子SiteMap中显示的项数。 -- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大commit数量。 +- `SITEMAP_PAGING_NUM`: **20**: 在单个子 SiteMap 中显示的项数。 +- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大 commit 数量。 - `CODE_COMMENT_LINES`: **4**: 在代码评论中能够显示的最大代码行数。 -- `DEFAULT_THEME`: **auto**: \[auto, gitea, arc-green\]: 在Gitea安装时候设置的默认主题。 +- `DEFAULT_THEME`: **auto**: \[auto, gitea, arc-green\]: 在 Gitea 安装时候设置的默认主题。 - `SHOW_USER_EMAIL`: **true**: 用户的电子邮件是否应该显示在`Explore Users`页面中。 -- `THEMES`: **auto,gitea,arc-green**: 所有可用的主题。允许用户选择个性化的主题， - 而不受DEFAULT_THEME 值的影响。 -- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为8MiB）。 +- `THEMES`: **auto,gitea,arc-green**: 所有可用的主题。允许用户选择个性化的主题， + 而不受 DEFAULT_THEME 值的影响。 +- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为 8MiB）。 - `REACTIONS`: 用户可以在问题（Issue）、Pull Request（PR）以及评论中选择的所有可选的反应。 - 这些值可以是表情符号别名（例如：:smile:）或Unicode表情符号。 - 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 -- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在utf8标准中定义的额外表情符号。 - 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， - 并将其添加到此配置中。 + 这些值可以是表情符号别名（例如：:smile:）或 Unicode 表情符号。 + 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 +- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。 + 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， + 并将其添加到此配置中。 - `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示用户的全名。如果没有设置全名，则将使用用户名。 - `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的仓库搜索中搜索描述。 - `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字并使用默认排序时，是否仅在探索页面上显示相关的仓库。 - 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 + 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 ### 界面 - 管理员 (`ui.admin`) @@ -247,11 +246,11 @@ aliases: ### 界面 - SVG Images (`ui.svg`) -- `ENABLE_RENDER`: **true**: 是否将SVG文件呈现为图像。如果禁用了SVG渲染，SVG文件将显示为文本，无法作为图像嵌入到Markdown文件中。 +- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈现为图像。如果禁用了 SVG 渲染，SVG 文件将显示为文本，无法作为图像嵌入到 Markdown 文件中。 ### 界面 - CSV Files (`ui.csv`) -- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将CSV文件呈现为表格的最大文件大小（将其设置为0表示没有限制）。 +- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将 CSV 文件呈现为表格的最大文件大小（将其设置为 0 表示没有限制）。 ## Markdown (`markdown`) @@ -261,10 +260,10 @@ aliases: - `ENABLE_HARD_LINE_BREAK_IN_DOCUMENTS`: **false**: 在文档中将软换行符呈现为硬换行符， 这意味着段落之间的单个换行符将导致换行， 并且不需要在段落后添加尾随空格来强制换行。 -- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在Markdown中呈现的附加URL超链接。 - 以http和https开头的URL始终显示。 - 如果此条目为空，则允许所有URL方案。 -- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为Markdown的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为Markdown，请只需放置一个逗号。 +- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在 Markdown 中呈现的附加 URL 超链接。 + 以 http 和 https 开头的 URL 始终显示。 + 如果此条目为空，则允许所有 URL 方案。 +- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为 Markdown，请只需放置一个逗号。 - `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作为数学块的检测。 ## 服务器 (`server`) @@ -276,27 +275,27 @@ aliases: - `PROXY_PROTOCOL_HEADER_TIMEOUT`: **5s**: 等待`PROXY`协议头的超时时间（设置为`0`表示没有超时）。 - `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受带有未知类型的`PROXY`协议头。 - `DOMAIN`: **localhost**: 此服务器的域名。 -- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**: - 覆盖自动生成的公共URL。 - 如果内部URL和外部URL不匹配（例如在Docker中），这很有用。 +- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP_PORT)s/**: + 覆盖自动生成的公共 URL。 + 如果内部 URL 和外部 URL 不匹配（例如在 Docker 中），这很有用。 - `STATIC_URL_PREFIX`: **_empty_**: - 覆盖此选项以从不同的URL请求静态资源。 - 这包括CSS文件、图片、JS文件和Web字体。 - 头像图片是动态资源，仍由Gitea提供。 - 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. - 请求会变成 `%(ROOT_URL)s/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` - 静态文件位于Gitea源代码仓库的`public/`目录中。 - 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 + 覆盖此选项以从不同的 URL 请求静态资源。 + 这包括 CSS 文件、图片、JS 文件和 Web 字体。 + 头像图片是动态资源，仍由 Gitea 提供。 + 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. + 请求会变成 `%(ROOT_URL)s/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` + 静态文件位于 Gitea 源代码仓库的`public/`目录中。 + 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 - `HTTP_ADDR`: **0.0.0.0**: HTTP 监听地址。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 - `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - 如果 `PROTOCOL` 设置为 `http+unix` 或 `fcgi+unix`，则应该是要使用的 Unix 套接字文件的名称。相对路径将相对于 _`AppWorkPath`_ 被转换为绝对路径。 - `HTTP_PORT`: **3000**: HTTP 监听端口。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 `HTTP_ADDR` 和 `HTTP_PORT` - 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的权限。 -- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: +- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: 用于访问网络服务的 Gitea 工作器（例如 SSH 更新）的本地（DMZ）URL。 在大多数情况下，您不需要更改默认值。 仅在您的 SSH 服务器节点与 HTTP 节点不同的情况下才修改它。对于不同的协议，默认值不同。如果 `PROTOCOL` @@ -305,15 +304,15 @@ aliases: `%(PROTOCOL)s://localhost:%(HTTP_PORT)s/`， 否则默认值为 `%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/`。 - `LOCAL_USE_PROXY_PROTOCOL`: **%(USE_PROXY_PROTOCOL)s**: 在进行本地连接时传递 PROXY 协议头。 - 如果本地连接将经过代理，请将其设置为 false。 + 如果本地连接将经过代理，请将其设置为 false。 - `PER_WRITE_TIMEOUT`: **30s**: 连接的任何写操作的超时时间。（将其设置为 -1 以禁用所有超时。） - `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 连接每写入 1 KB 的超时时间。 -- `DISABLE_SSH`: **false**: 当SSH不可用时禁用SSH功能。 -- `START_SSH_SERVER`: **false**: 启用时，使用内置的SSH服务器。 -- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置SSH服务器建立连接时，期望PROXY协议头。 -- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: 用于内置SSH服务器的用户名。 -- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)s**: 在克隆URL中显示的SSH用户名。这仅适用于自行配置SSH服务器的人；在大多数情况下，您希望将其留空并修改`BUILTIN_SSH_SERVER_USER`。 +- `DISABLE_SSH`: **false**: 当 SSH 不可用时禁用 SSH 功能。 +- `START_SSH_SERVER`: **false**: 启用时，使用内置的 SSH 服务器。 +- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置 SSH 服务器建立连接时，期望 PROXY 协议头。 +- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: 用于内置 SSH 服务器的用户名。 +- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)s**: 在克隆 URL 中显示的 SSH 用户名。这仅适用于自行配置 SSH 服务器的人；在大多数情况下，您希望将其留空并修改`BUILTIN_SSH_SERVER_USER`。 - `SSH_DOMAIN`: **%(DOMAIN)s**: 此服务器的域名，用于显示的克隆 URL。 - `SSH_PORT`: **22**: 显示在克隆 URL 中的 SSH 端口。 - `SSH_LISTEN_HOST`: **0.0.0.0**: 内置 SSH 服务器的监听地址。 @@ -406,7 +405,7 @@ aliases: ## 数据库 (`database`) - `DB_TYPE`: **mysql**: 数据库类型 \[mysql, postgres, mssql, sqlite3\]。 -- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或unix套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 +- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或 unix 套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 - `NAME`: **gitea**: 数据库名称。 - `USER`: **root**: 数据库用户名。 - `PASSWD`: **_empty_**: 数据库密码。如果密码包含特殊字符，请使用 \`your password\` 或 """your password"""。 @@ -440,15 +439,15 @@ aliases: ## 索引 (`indexer`) - `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型，当前支持：`bleve`、`db`、`elasticsearch` 或 `meilisearch`。 -- `ISSUE_INDEXER_CONN_STR`：****: 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 +- `ISSUE_INDEXER_CONN_STR`：\*\*\*\*: 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 - `ISSUE_INDEXER_NAME`：**gitea_issues**: 工单索引器名称，在 ISSUE_INDEXER_TYPE 为 elasticsearch 或 meilisearch 时可用。 -- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE_INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 _`AppWorkPath`_ 进行绝对路径化。 +- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE*INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 *`AppWorkPath`\_ 进行绝对路径化。 - `REPO_INDEXER_ENABLED`：**false**: 启用代码搜索（占用大量磁盘空间，约为存储库大小的 6 倍）。 - `REPO_INDEXER_REPO_TYPES`：**sources,forks,mirrors,templates**: 存储库索引器单元。要索引的项目可以是 `sources`、`forks`、`mirrors`、`templates` 或它们的任何组合，用逗号分隔。如果为空，则默认为仅 `sources`，如果要完全禁用，请参见 `REPO_INDEXER_ENABLED`。 - `REPO_INDEXER_TYPE`：**bleve**: 代码搜索引擎类型，可以为 `bleve` 或者 `elasticsearch`。 - `REPO_INDEXER_PATH`：**indexers/repos.bleve**: 用于代码搜索的索引文件。 -- `REPO_INDEXER_CONN_STR`：****: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` +- `REPO_INDEXER_CONN_STR`：\*\*\*\*: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` - `REPO_INDEXER_NAME`：**gitea_codes**: 代码索引器名称，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。 - `REPO_INDEXER_INCLUDE`：**empty**: 逗号分隔的 glob 模式列表（参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob)）以用于**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 扩展名的文件。空列表表示包括所有文件。 @@ -466,8 +465,8 @@ aliases: - `LENGTH`：**100000**: 通道队列阻塞之前的最大队列大小 - `BATCH_LENGTH`：**20**: 在传递给处理程序之前批处理数据 - `CONN_STR`：**redis://127.0.0.1:6379/0**: redis 队列类型的连接字符串。对于 `redis-cluster`，使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查询参数来设置选项。类似地，LevelDB 选项也可以使用：**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 进行设置，并将覆盖 `DATADIR`。 -- `QUEUE_NAME`：**_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 -- `SET_NAME`：**_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `QUEUE_NAME`：**\_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `SET_NAME`：**\_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 - `MAX_WORKERS`：**(dynamic)**: 队列的最大工作协程数。默认值为 "CpuNum/2"，限制在 1 到 10 之间。 Gitea 创建以下非唯一队列： @@ -497,20 +496,20 @@ Gitea 创建以下非唯一队列： - `SECRET_KEY`: **\<每次安装时随机生成\>**: 全局服务器安全密钥。这个密钥非常重要，如果丢失将无法解密加密的数据（例如 2FA）。 - `SECRET_KEY_URI`: **_empty_**: 与定义 `SECRET_KEY` 不同，此选项可用于使用存储在文件中的密钥（示例值：`file:/etc/gitea/secret_key`）。它不应该像 `SECRET_KEY` 一样容易丢失。 - `LOGIN_REMEMBER_DAYS`: **7**: Cookie 保存时间，单位为天。 -- `COOKIE_USERNAME`: **gitea\_awesome**: 保存用户名的 Cookie 名称。 -- `COOKIE_REMEMBER_NAME`: **gitea\_incredible**: 保存自动登录信息的 Cookie 名称。 +- `COOKIE_USERNAME`: **gitea_awesome**: 保存用户名的 Cookie 名称。 +- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自动登录信息的 Cookie 名称。 - `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理认证的 HTTP 头部名称，用于提供用户信息。 - `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理认证的 HTTP 头部名称，用于提供邮箱信息。 - `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理认证的 HTTP 头部名称，用于提供全名信息。 - `REVERSE_PROXY_LIMIT`: **1**: 解释 X-Forwarded-For 标头或 X-Real-IP 标头，并将其设置为请求的远程 IP。 - 可信代理计数。设置为零以不使用这些标头。 + 可信代理计数。设置为零以不使用这些标头。 - `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗号分隔的受信任代理服务器的 IP 地址和网络列表。使用 `*` 来信任全部。 - `DISABLE_GIT_HOOKS`: **true**: 设置为 `false` 以允许具有 Git 钩子权限的用户创建自定义 Git 钩子。 - 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 - 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 - 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 - 这可能对您的网站或操作系统造成危害。 - 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 + 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 + 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 + 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 + 这可能对您的网站或操作系统造成危害。 + 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 - `DISABLE_WEBHOOKS`: **false**: 设置为 `true` 以禁用 Webhooks 功能。 - `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 设置为 `false` 以允许本地用户在未设置 Gitea 环境的情况下推送到 Gitea 存储库。不建议这样做，如果您希望本地用户推送到 Gitea 存储库，应该适当地设置环境。 - `IMPORT_LOCAL_PATHS`: **false**: 设置为 `false` 以防止所有用户（包括管理员）从服务器上导入本地路径。 @@ -538,7 +537,7 @@ Gitea 创建以下非唯一队列： - lower - 使用一个或多个小写拉丁字符 - upper - 使用一个或多个大写拉丁字符 - digit - 使用一个或多个数字 - - spec - 使用一个或多个特殊字符，如 ``!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~`` + - spec - 使用一个或多个特殊字符，如 `` !"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ `` - off - 不检查密码复杂性 - `PASSWORD_CHECK_PWN`: **false**: 检查密码是否在 [HaveIBeenPwned](https://haveibeenpwned.com/Passwords) 中曝光。 - `SUCCESSFUL_TOKENS_CACHE_SIZE`: **20**: 缓存成功的令牌哈希。API 令牌在数据库中存储为 pbkdf2 哈希，但这意味着在存在多个 API 操作时可能会有显着的哈希负载。此缓存将在 LRU 缓存中存储成功的哈希令牌，以在性能和安全性之间保持平衡。 @@ -546,27 +545,27 @@ Gitea 创建以下非唯一队列： ## Camo (`camo`) - `ENABLED`: **false**: 启用媒体代理，目前仅支持图像。 -- `SERVER_URL`: **_empty_**: Camo服务器的URL，如果启用camo，则**必填**。 -- `HMAC_KEY`: **_empty_**: 为URL编码提供HMAC密钥，如果启用camo，则**必填**。 -- `ALLWAYS`: **false**: 设置为true以在HTTP和HTTPS内容上使用camo，否则仅代理非HTTPS URL。 +- `SERVER_URL`: **_empty_**: Camo 服务器的 URL，如果启用 camo，则**必填**。 +- `HMAC_KEY`: **_empty_**: 为 URL 编码提供 HMAC 密钥，如果启用 camo，则**必填**。 +- `ALLWAYS`: **false**: 设置为 true 以在 HTTP 和 HTTPS 内容上使用 camo，否则仅代理非 HTTPS URL。 ## OpenID (`openid`) -- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过OpenID进行身份验证。 -- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: 允许通过OpenID进行注册。 -- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于允许访问。 -- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于阻止访问。 +- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过 OpenID 进行身份验证。 +- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: 允许通过 OpenID 进行注册。 +- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于允许访问。 +- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于阻止访问。 ## OAuth2 Client (`oauth2_client`) -- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER\_EMAIL\_CONFIRM**: 设置此项以启用或禁用OAuth2自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） -- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的OpenID连接范围的列表。（`openid`已隐式添加） -- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的OAuth2用户自动创建用户帐户。 -- `USERNAME`: **nickname**: 新OAuth2帐户的用户名来源： - - userid - 使用userid / sub属性 - - nickname - 使用nickname属性 - - email - 使用email属性的用户名部分 -- `UPDATE_AVATAR`: **false**: 如果OAuth2提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 +- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER_EMAIL_CONFIRM**: 设置此项以启用或禁用 OAuth2 自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） +- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的 OpenID 连接范围的列表。（`openid`已隐式添加） +- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的 OAuth2 用户自动创建用户帐户。 +- `USERNAME`: **nickname**: 新 OAuth2 帐户的用户名来源： + - userid - 使用 userid / sub 属性 + - nickname - 使用 nickname 属性 + - email - 使用 email 属性的用户名部分 +- `UPDATE_AVATAR`: **false**: 如果 OAuth2 提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 - `ACCOUNT_LINKING`: **login**: 如果帐户/电子邮件已存在，如何处理： - disabled - 显示错误 - login - 显示帐户链接登录 @@ -579,54 +578,54 @@ Gitea 创建以下非唯一队列： - `REGISTER_EMAIL_CONFIRM`: **false**: 启用此项以要求通过邮件确认注册。需要启用`Mailer`。 - `REGISTER_MANUAL_CONFIRM`: **false**: 启用此项以手动确认新的注册。需要禁用`REGISTER_EMAIL_CONFIRM`。 - `DISABLE_REGISTRATION`: **false**: 禁用注册，之后只有管理员可以为用户创建帐户。 -- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过GitHub、OpenID Connect等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 -- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用API。 +- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过 GitHub、OpenID Connect 等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 +- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用 API。 - `ENABLE_NOTIFY_MAIL`: **false**: 启用此项以在发生某些情况（如创建问题）时向存储库的观察者发送电子邮件。需要启用`Mailer`。 -- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用HTTP BASIC和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌API端点。此外，这仅会禁用使用密码的BASIC身份验证，而不会禁用令牌或OAuth Basic。 +- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用 HTTP BASIC 和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌 API 端点。此外，这仅会禁用使用密码的 BASIC 身份验证，而不会禁用令牌或 OAuth Basic。 - `ENABLE_REVERSE_PROXY_AUTHENTICATION`: **false**: 启用此项以允许反向代理身份验证。 - `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION`: **false**: 启用此项以允许反向身份验证的自动注册。 - `ENABLE_REVERSE_PROXY_EMAIL`: **false**: 启用此项以允许使用提供的电子邮件而不是生成的电子邮件进行自动注册。 - `ENABLE_REVERSE_PROXY_FULL_NAME`: **false**: 启用此项以允许使用提供的全名进行自动注册。 - `ENABLE_CAPTCHA`: **false**: 启用此项以对注册使用验证码验证。 - `REQUIRE_CAPTCHA_FOR_LOGIN`: **false**: 启用此项以要求登录使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 -- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即GitHub、OpenID Connect等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 +- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即 GitHub、OpenID Connect 等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 - `CAPTCHA_TYPE`: **image**: \[image、recaptcha、hcaptcha、mcaptcha、cfturnstile\] -- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的密钥。 -- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的站点密钥。 -- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/**: 设置recaptcha网址，允许使用recaptcha net。 -- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的密钥。 -- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的站点密钥。 -- `MCAPTCHA_SECRET`: **""**: 访问您的mCaptcha实例以获取mCaptcha的密钥。 -- `MCAPTCHA_SITEKEY`: **""**: 访问您的mCaptcha实例以获取mCaptcha的站点密钥。 -- `MCAPTCHA_URL` **https://demo.mcaptcha.org/**: 设置mCaptcha的URL。 -- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的密钥。 -- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的站点密钥。 +- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的密钥。 +- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的站点密钥。 +- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/**: 设置 recaptcha 网址，允许使用 recaptcha net。 +- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的密钥。 +- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的站点密钥。 +- `MCAPTCHA_SECRET`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的密钥。 +- `MCAPTCHA_SITEKEY`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的站点密钥。 +- `MCAPTCHA_URL` **https://demo.mcaptcha.org/**: 设置 mCaptcha 的 URL。 +- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的密钥。 +- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的站点密钥。 - `DEFAULT_KEEP_EMAIL_PRIVATE`: **false**: 默认情况下，将用户设置为保持其电子邮件地址私有。 - `DEFAULT_ALLOW_CREATE_ORGANIZATION`: **true**: 默认情况下，允许新用户创建组织。 - `DEFAULT_USER_IS_RESTRICTED`: **false**: 默认情况下，为新用户分配受限权限。 - `DEFAULT_ENABLE_DEPENDENCIES`: **true**: 启用此项以默认启用依赖项。 - `ALLOW_CROSS_REPOSITORY_DEPENDENCIES` : **true** 启用此项以允许从用户被授予访问权限的任何存储库上进行依赖项操作。 -- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务URL。位置将作为转义的查询参数附加到URL中。 +- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务 URL。位置将作为转义的查询参数附加到 URL 中。 - `ENABLE_USER_HEATMAP`: **true**: 启用此项以在用户个人资料上显示热图。 - `ENABLE_TIMETRACKING`: **true**: 启用时间跟踪功能。 - `DEFAULT_ENABLE_TIMETRACKING`: **true**: 默认情况下，允许存储库默认使用时间跟踪。 - `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: 仅允许具有写权限的用户跟踪时间。 - `EMAIL_DOMAIN_ALLOWLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，只能用于在此实例上注册，支持通配符。 - `EMAIL_DOMAIN_BLOCKLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，不能用于在此实例上注册，支持通配符。 -- `SHOW_REGISTRATION_BUTTON`: **! DISABLE\_REGISTRATION**: 显示注册按钮 +- `SHOW_REGISTRATION_BUTTON`: **! DISABLE_REGISTRATION**: 显示注册按钮 - `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** 启用此项以显示里程碑仪表板页面 - 查看所有用户的里程碑 - `AUTO_WATCH_NEW_REPOS`: **true** 启用此项以在创建新存储库时让所有组织用户观看新存储库 - `AUTO_WATCH_ON_CHANGES`: **false** 启用此项以在首次提交后使用户观看存储库 - `DEFAULT_USER_VISIBILITY`: **public**: 为用户设置默认的可见性模式，可以是"public"、"limited"或"private"。 - `ALLOWED_USER_VISIBILITY_MODES`: **public,limited,private**: 设置用户可以具有的可见性模式 - `DEFAULT_ORG_VISIBILITY`: **public**: 为组织设置默认的可见性模式，可以是"public"、"limited"或"private"。 -- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为True。 -- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为True以强制仅通过Gitea进行注册。 -- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为True以强制仅使用第三方服务进行注册。 -- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将KeepEmailPrivate设置为True，则在Git日志中的用户电子邮件地址的域部分的值。DOMAIN解析为server.DOMAIN中的值。 - 用户的电子邮件将被替换为小写的用户名、"@"和NO_REPLY_ADDRESS的连接。 +- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为 True。 +- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅通过 Gitea 进行注册。 +- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅使用第三方服务进行注册。 +- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将 KeepEmailPrivate 设置为 True，则在 Git 日志中的用户电子邮件地址的域部分的值。DOMAIN 解析为 server.DOMAIN 中的值。 + 用户的电子邮件将被替换为小写的用户名、"@"和 NO_REPLY_ADDRESS 的连接。 - `USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0**: 用户删除后，评论将保留的最短时间。 -- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点URL方案 +- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点 URL 方案 ### Service - Explore (`service.explore`) @@ -635,12 +634,12 @@ Gitea 创建以下非唯一队列： ## SSH Minimum Key Sizes (`ssh.minimum_key_sizes`) -定义允许的算法及其最小密钥长度（使用-1来禁用某个类型）： +定义允许的算法及其最小密钥长度（使用-1 来禁用某个类型）： - `ED25519`：**256** - `ECDSA`：**256** -- `RSA`：**3071**: 我们在这里设置为2047，因为一个其他方面有效的3072 RSA密钥可能被报告为3071长度。 -- `DSA`：**-1**: 默认情况下禁用DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的SSHD提供者 +- `RSA`：**3071**: 我们在这里设置为 2047，因为一个其他方面有效的 3072 RSA 密钥可能被报告为 3071 长度。 +- `DSA`：**-1**: 默认情况下禁用 DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的 SSHD 提供者 ## Webhook (`webhook`) @@ -657,7 +656,7 @@ Gitea 创建以下非唯一队列： - `SKIP_TLS_VERIFY`: **false**: 允许不安全的证书。 - `PAGING_NUM`: **10**: 一页中显示的 Webhook 历史事件数量。 - `PROXY_URL`: **_empty_**: 代理服务器 URL，支持 http://、https://、socks://，留空将遵循环境的 http_proxy/https_proxy 设置。如果未提供，将使用全局代理设置。 -- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (*)；使用 ** 来匹配所有主机。如果未提供，将使用全局代理设置。 +- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (\*)；使用 \*\* 来匹配所有主机。如果未提供，将使用全局代理设置。 ## 邮件 (`mailer`) @@ -714,7 +713,7 @@ Gitea 创建以下非唯一队列： ## 缓存 (`cache`) - `ENABLED`: **true**: 是否启用缓存。 -- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的LRU缓存) +- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的 LRU 缓存) - `INTERVAL`: **60**: 垃圾回收间隔(秒)，只对`memory`和`towqueue`有效。 - `HOST`: **_empty_**: 缓存配置。`redis`, `redis-cluster`，`memcache`配置连接字符串;`twoqueue` 设置队列参数 - Redis: `redis://:macaron@127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` @@ -734,7 +733,7 @@ Gitea 创建以下非唯一队列： - `PROVIDER`: **memory**: 会话存储引擎 \[memory, file, redis, redis-cluster, db, mysql, couchbase, memcache, postgres\]。设置为 `db` 将会重用 `[database]` 的配置信息。 - `PROVIDER_CONFIG`: **data/sessions**: 对于文件，为根路径；对于 db，为空（将使用数据库配置）；对于其他引擎，为连接字符串。相对路径将根据 _`AppWorkPath`_ 绝对化。 - `COOKIE_SECURE`: **_empty_**: `true` 或 `false`。启用此选项以强制在所有会话访问中使用 HTTPS。如果没有设置，当 ROOT_URL 是 https 链接的时候默认设置为 true。 -- `COOKIE_NAME`: **i\_like\_gitea**: 用于会话 ID 的 cookie 名称。 +- `COOKIE_NAME`: **i_like_gitea**: 用于会话 ID 的 cookie 名称。 - `GC_INTERVAL_TIME`: **86400**: GC 间隔时间，以秒为单位。 - `SESSION_LIFE_TIME`: **86400**: 会话生命周期，以秒为单位，默认为 86400（1 天）。 - `DOMAIN`: **_empty_**: 设置 cookie 的域。 @@ -743,10 +742,10 @@ Gitea 创建以下非唯一队列： ## 图像 (`picture`) - `GRAVATAR_SOURCE`: **gravatar**: 头像来源，可以是 gravatar、duoshuo 或类似 http://cn.gravatar.com/avatar/ 的来源。 - `http://cn.gravatar.com/avatar/`。 + `http://cn.gravatar.com/avatar/`。 - `DISABLE_GRAVATAR`: **false**: 启用后，只使用内部头像。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `ENABLE_FEDERATED_AVATAR`: **false**: 启用头像联盟支持（参见 - [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 + [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `AVATAR_STORAGE_TYPE`: **default**: 在 `[storage.xxx]` 中定义的存储类型。默认为 `default`，如果没有 `[storage]` 部分，则将读取 `[storage]`，如果没有则将是 `local` 类型。 - `AVATAR_UPLOAD_PATH`: **data/avatars**: 存储用户头像图像文件的路径。 @@ -815,7 +814,7 @@ Gitea 创建以下非唯一队列： - 例如： - 在请求头中：X-Request-ID: **test-id-123** - 在 app.ini 中的配置：REQUEST_ID_HEADERS = X-Request-ID - - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... + - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... ### 日志子部分 (`log.`) @@ -851,13 +850,13 @@ Gitea 创建以下非唯一队列： ## 定时任务 (`cron`) -- `ENABLED`: **false**: 是否在后台运行定期任务。 +- `ENABLED`: **false**: 是否在后台运行定期任务。 - `RUN_AT_START`: **false**: 在应用程序启动时运行定时任务。 -- `NOTICE_ON_SUCCESS`: **false**: 设置为 true时，任务成功完成时将进行通知。 +- `NOTICE_ON_SUCCESS`: **false**: 设置为 true 时，任务成功完成时将进行通知。 - `SCHEDULE` 接受的格式: - - 完整的crontab语法规范, e.g. `* * * * * ?` - - 描述符e.g. `@midnight`, `@every 1h30m` ... + - 完整的 crontab 语法规范, e.g. `* * * * * ?` + - 描述符 e.g. `@midnight`, `@every 1h30m` ... - 更多详见: [cron documentation](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14) ### 基本定时任务 - 默认开启 @@ -866,31 +865,31 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 是否启用该定时任务。 - `RUN_AT_START`: **true**: 设置在服务启动时运行。 -- `SCHEDULE`: **@midnight**: 使用Cron语法的定时任务触发配置，例如 `@every 1h`。 +- `SCHEDULE`: **@midnight**: 使用 Cron 语法的定时任务触发配置，例如 `@every 1h`。 - `OLDER_THAN`: **24h**: 超过`OLDER_THAN`时间的存档将被删除，例如 `12h`。 #### 定时任务 - 更新镜像仓库 (`cron.update_mirrors`) -- `SCHEDULE`: **@every 10m**: 使用Cron语法的定时任务触发配置，例如 `@every 3h`。 -- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 -- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `SCHEDULE`: **@every 10m**: 使用 Cron 语法的定时任务触发配置，例如 `@every 3h`。 +- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 #### 定时任务 - 健康检查所有仓库 (`cron.repo_health_check`) -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库健康检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库健康检查。 - `TIMEOUT`: **60s**: 用于健康检查执行超时的时间持续语法。 - `ARGS`: **_empty_**: `git fsck` 命令的参数，例如 `--unreachable --tags`。在 http://git-scm.com/docs/git-fsck 上了解更多。 #### 定时任务 - 检查所有仓库统计 (`cron.check_repo_stats`) - `RUN_AT_START`: **true**: 在启动时运行仓库统计检查。 -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库统计检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库统计检查。 #### 定时任务 - 清理 hook_task 表 (`cron.cleanup_hook_task_table`) - `ENABLED`: **true**: 启用清理 hook_task 任务。 - `RUN_AT_START`: **false**: 在启动时运行清理 hook_task（如果启用）。 -- `SCHEDULE`: **@midnight**: Cron语法，用于清理 hook_task 表。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于清理 hook_task 表。 - `CLEANUP_TYPE` **OlderThan** OlderThan 或 PerWebhook 方法来清理 hook_task，可以按年龄（即 hook_task 记录传递多久）或按每个 Webhook 保留的数量（即每个 Webhook 保留最新的 x 个传递）来清理。 - `OLDER_THAN`: **168h**: 如果 CLEANUP_TYPE 设置为 OlderThan，则早于此表达式的任何传递的 hook_task 记录将被删除。 - `NUMBER_TO_KEEP`: **10**: 如果 CLEANUP_TYPE 设置为 PerWebhook，则 Webhook 的此数量 hook_task 记录将被保留（即保留最新的 x 个传递）。 @@ -900,7 +899,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 启用清理过期包任务。 - `RUN_AT_START`: **true**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 每次运行此任务时都会通知。 -- `SCHEDULE`: **@midnight**: Cron语法，用于任务。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于任务。 - `OLDER_THAN`: **24h**: 未引用的包数据创建超过 OLDER_THAN 时间的包将被删除。 #### Cron - 更新迁移海报 ID (`cron.update_migration_poster_id`) @@ -918,7 +917,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 - `TIMEOUT`: **60s**: 用于垃圾收集执行超时的时间持续语法。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 - `ARGS`: **_empty_**: `git gc` 命令的参数，例如 `--aggressive --auto`。默认值与 [git] -> GC_ARGS 相同。 @@ -928,95 +927,95 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新同步所有仓库的 pre-receive、update 和 post-receive 钩子 (`cron.resync_all_hooks`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新初始化所有缺失的 Git 仓库，但记录已存在 (`cron.reinit_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除所有缺少 Git 文件的仓库 (`cron.delete_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除生成的仓库头像 (`cron.delete_generated_repository_avatars`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 从数据库中删除所有旧的操作 (`cron.delete_old_actions`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1年），因为这是热力图的最大长度。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1 年），因为这是热力图的最大长度。 #### Cron - 从数据库中删除所有旧的系统通知 (`cron.delete_old_system_notices`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NO_SUCCESS_NOTICE`: **false**: 设置为 true 以关闭成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 - `OLDER_THAN`: **8760h**: 早于此表达式的任何系统通知都将从数据库中删除。 #### Cron - 在仓库中回收 LFS 指针 (`cron.gc_lfs`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 24h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认7天）的 LFSMetaObject。 -- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认3天）没有尝试过回收的 LFSMetaObject。 +- `SCHEDULE`: **@every 24h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认 7 天）的 LFSMetaObject。 +- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认 3 天）没有尝试过回收的 LFSMetaObject。 - `NUMBER_TO_CHECK_PER_REPO`: **100**: 每个仓库要检查的过期 LFSMetaObject 的最小数量。设置为 `0` 以始终检查所有。 # Git (`git`) -- `PATH`: **""**: Git可执行文件的路径。如果为空，Gitea将在PATH环境中搜索。 -- `HOME_PATH`: **%(APP_DATA_PATH)s/home**: Git的HOME目录。 - 此目录将用于包含Gitea的git调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认Gitea是在此环境中唯一运行的应用程序，您可以将其设置为Gitea用户的正常主目录。 +- `PATH`: **""**: Git 可执行文件的路径。如果为空，Gitea 将在 PATH 环境中搜索。 +- `HOME_PATH`: **%(APP_DATA_PATH)s/home**: Git 的 HOME 目录。 + 此目录将用于包含 Gitea 的 git 调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认 Gitea 是在此环境中唯一运行的应用程序，您可以将其设置为 Gitea 用户的正常主目录。 - `DISABLE_DIFF_HIGHLIGHT`: **false**: 禁用已添加和已删除更改的高亮显示。 -- `MAX_GIT_DIFF_LINES`: **1000**: 在diff视图中允许单个文件的最大行数。 -- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在diff视图中每行的最大字符数。 -- `MAX_GIT_DIFF_FILES`: **100**: 在diff视图中显示的最大文件数。 +- `MAX_GIT_DIFF_LINES`: **1000**: 在 diff 视图中允许单个文件的最大行数。 +- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在 diff 视图中每行的最大字符数。 +- `MAX_GIT_DIFF_FILES`: **100**: 在 diff 视图中显示的最大文件数。 - `COMMITS_RANGE_SIZE`: **50**: 设置默认的提交范围大小 - `BRANCHES_RANGE_SIZE`: **20**: 设置默认的分支范围大小 - `GC_ARGS`: **_empty_**: 命令`git gc`的参数，例如`--aggressive --auto`。更多信息请参见http://git-scm.com/docs/git-gc/ -- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用Git版本 >= 2.18时使用Git wire协议版本2，默认为true，当您始终希望使用Git wire协议版本1时设置为false。 - 要在使用OpenSSH服务器的情况下为通过SSH的Git启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的sshd_config文件中。 -- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用URL创建拉取请求（如果启用了该存储库的拉取请求） +- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用 Git 版本 >= 2.18 时使用 Git wire 协议版本 2，默认为 true，当您始终希望使用 Git wire 协议版本 1 时设置为 false。 + 要在使用 OpenSSH 服务器的情况下为通过 SSH 的 Git 启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的 sshd_config 文件中。 +- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用 URL 创建拉取请求（如果启用了该存储库的拉取请求） - `VERBOSE_PUSH`: **true**: 在处理推送时打印有关推送状态的信息。 - `VERBOSE_PUSH_DELAY`: **5s**: 仅在推送时间超过此延迟时才打印详细信息。 -- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于Go-Git），不要在内存中缓存大于此大小的对象。（设置为0以禁用。） -- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为false。 -- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行git。 +- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于 Go-Git），不要在内存中缓存大于此大小的对象。（设置为 0 以禁用。） +- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为 false。 +- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行 git。 ### Git - 超时设置 (`git.timeout`) -- `DEFAULT`: **360**: Git操作的默认超时时间，单位秒 +- `DEFAULT`: **360**: Git 操作的默认超时时间，单位秒 - `MIGRATE`: **600**: 在迁移外部存储库时的超时时间，单位秒 - `MIRROR`: **300**: 在镜像外部存储库时的超时时间，单位秒 - `CLONE`: **300**: 在存储库之间进行内部克隆的超时时间，单位秒 - `PULL`: **300**: 在存储库之间进行内部拉取的超时时间，单位秒 -- `GC`: **60**: git存储库GC的超时时间，单位秒 +- `GC`: **60**: git 存储库 GC 的超时时间，单位秒 ### Git - 配置选项 (`git.config`) -此部分中的键/值对将用作git配置。 -此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从git配置中删除。格式为`some.configKey = value`。 +此部分中的键/值对将用作 git 配置。 +此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从 git 配置中删除。格式为`some.configKey = value`。 - `diff.algorithm`: **histogram** - `core.logAllRefUpdates`: **true** @@ -1024,45 +1023,45 @@ Gitea 创建以下非唯一队列： ## 指标 (`metrics`) -- `ENABLED`: **false**: 启用/prometheus的metrics端点。 +- `ENABLED`: **false**: 启用/prometheus 的 metrics 端点。 - `ENABLED_ISSUE_BY_LABEL`: **false**: 启用按标签统计问题，格式为`gitea_issues_by_label{label="bug"} 2`。 - `ENABLED_ISSUE_BY_REPOSITORY`: **false**: 启用按存储库统计问题，格式为`gitea_issues_by_repository{repository="org/repo"} 5`。 -- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在prometheus参数`bearer_token`或`bearer_token_file`中使用。 +- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在 prometheus 参数`bearer_token`或`bearer_token_file`中使用。 ## API (`api`) -- `ENABLE_SWAGGER`: **true**: 启用API文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 -- `MAX_RESPONSE_ITEMS`: **50**: API分页的最大单页项目数。 -- `DEFAULT_PAGING_NUM`: **30**: API分页的默认分页数。 -- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API的默认单页项目数。 -- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API的默认最大文件大小。 +- `ENABLE_SWAGGER`: **true**: 启用 API 文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 +- `MAX_RESPONSE_ITEMS`: **50**: API 分页的最大单页项目数。 +- `DEFAULT_PAGING_NUM`: **30**: API 分页的默认分页数。 +- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API 的默认单页项目数。 +- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API 的默认最大文件大小。 ## OAuth2 (`oauth2`) -- `ENABLE`: **true**: 启用OAuth2提供者。 -- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2访问令牌的生命周期，以秒为单位。 -- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2刷新令牌的生命周期，以小时为单位。 +- `ENABLE`: **true**: 启用 OAuth2 提供者。 +- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2 访问令牌的生命周期，以秒为单位。 +- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2 刷新令牌的生命周期，以小时为单位。 - `INVALIDATE_REFRESH_TOKENS`：**false**: 检查刷新令牌是否已被使用。 -- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署OAuth2令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 -- `JWT_SECRET`：**_empty_**: OAuth2访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 -- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向Gitea提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 -- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署OAuth2令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含PKCS8格式的RSA或ECDSA私钥。如果不存在密钥，则将为您创建一个4096位密钥。 -- `MAX_TOKEN_LENGTH`：**32767**: 从OAuth2提供者接受的令牌/cookie的最大长度。 -- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager**: 在启动时预注册用于某些服务的OAuth应用程序。有关可用选项列表，请参阅[OAuth2文档](/development/oauth2-provider.md)。 +- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署 OAuth2 令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 +- `JWT_SECRET`：**_empty_**: OAuth2 访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 +- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向 Gitea 提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 +- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署 OAuth2 令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含 PKCS8 格式的 RSA 或 ECDSA 私钥。如果不存在密钥，则将为您创建一个 4096 位密钥。 +- `MAX_TOKEN_LENGTH`：**32767**: 从 OAuth2 提供者接受的令牌/cookie 的最大长度。 +- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager**: 在启动时预注册用于某些服务的 OAuth 应用程序。有关可用选项列表，请参阅[OAuth2 文档](/development/oauth2-provider.md)。 ## i18n (`i18n`) -- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: - 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 +- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: + 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 -- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: - 对应于各区域设置的可见名称。 +- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: + 对应于各区域设置的可见名称。 ## Markup (`markup`) -- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置Mermaid源的最大大小。(设为-1代表禁止) +- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置 Mermaid 源的最大大小。(设为-1 代表禁止) -gitea支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 +gitea 支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 ```ini [markup.asciidoc] @@ -1074,21 +1073,21 @@ IS_INPUT_FILE = false ``` - ENABLED：**false** 设置是否启动渲染器 -- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1等。 -- FILE_EXTENSIONS：**_empty_** 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 +- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1 等。 +- FILE*EXTENSIONS：\*\*\_empty*\*\* 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 - RENDER_COMMAND：用于渲染所有匹配的扩展名的外部命令。 - IS_INPUT_FILE：**false** 输入不是标准输入，而是一个在`RENDER_COMMAND`之后带有文件参数的文件。 - RENDER_CONTENT_MODE：**sanitized** 内容将如何呈现。 - - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些HTML标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 - - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致XSS攻击。 - - iframe：在单独的独立页面中呈现内容，并通过iframe嵌入到当前页面中。iframe处于禁用同源策略的沙箱模式，并且JS代码与父页面安全隔离。 + - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些 HTML 标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 + - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致 XSS 攻击。 + - iframe：在单独的独立页面中呈现内容，并通过 iframe 嵌入到当前页面中。iframe 处于禁用同源策略的沙箱模式，并且 JS 代码与父页面安全隔离。 两个特殊的环境变量会传递给渲染命令： -- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前URL前缀。用作链接的前缀。 -- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前URL前缀。用作图像路径的前缀。 +- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前 URL 前缀。用作链接的前缀。 +- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前 URL 前缀。用作图像路径的前缀。 -如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea支持自定义用于呈现的HTML的清理策略。下面的示例将支持来自pandoc的KaTeX输出。 +如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea 支持自定义用于呈现的 HTML 的清理策略。下面的示例将支持来自 pandoc 的 KaTeX 输出。 ```ini [markup.sanitizer.TeX] @@ -1103,18 +1102,18 @@ ALLOW_DATA_URI_IMAGES = true - `ELEMENT`：此策略适用于的元素。必须非空。 - `ALLOW_ATTR`：此策略允许的属性。必须非空。 - `REGEXP`：用于匹配属性内容的正则表达式。必须存在，但可以为空，以无条件允许此属性的白名单。 -- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据URI图像（``）。 +- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据 URI 图像（``）。 可以通过添加唯一的子节来定义多个清理规则，例如`[markup.sanitizer.TeX-2]`。 要仅为指定的外部渲染器应用清理规则，它们必须使用渲染器名称，例如`[markup.sanitizer.asciidoc.rule-1]`。 -如果规则在渲染器ini节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 +如果规则在渲染器 ini 节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 ## 代码高亮映射 (`highlight.mapping`) - `file_extension 比如 .toml`: **language 比如 ini**。文件扩展名到语言的映射覆盖。 - Gitea 将使用 `.gitattributes` 文件中的 `linguist-language` 或 `gitlab-language` 属性来对文件进行高亮显示，如果可用。 -如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 + 如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 ## 时间 (`time`) @@ -1281,28 +1280,28 @@ MINIO_INSECURE_SKIP_VERIFY = false 存储库归档存储的配置。当将`STORAGE_TYPE`设置为`xxx`时，它将继承默认的 `[storage]` 或 `[storage.xxx]` 配置。`PATH`的默认值是`data/repo-archive`，`MINIO_BASE_PATH`的默认值是`repo-archive/`。 -- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 -- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的URL以直接提供文件。目前，只有Minio/S3支持通过签名URL，本地不执行任何操作。 +- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 +- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，只有 Minio/S3 支持通过签名 URL，本地不执行任何操作。 - `PATH`: **./data/repo-archive**: 用于存储归档文件的位置，仅在`STORAGE_TYPE`为`local`时可用。 -- `MINIO_ENDPOINT`: **localhost:9000**: Minio端点，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_ACCESS_KEY_ID`: Minio的accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_SECRET_ACCESS_KEY`: Minio的secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BUCKET`: **gitea**: 用于存储归档的Minio存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的Minio位置，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的Minio基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_USE_SSL`: **false**: 启用Minio的SSL，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过Minio的SSL验证，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ENDPOINT`: **localhost:9000**: Minio 端点，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ACCESS_KEY_ID`: Minio 的 accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_SECRET_ACCESS_KEY`: Minio 的 secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET`: **gitea**: 用于存储归档的 Minio 存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的 Minio 位置，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的 Minio 基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_USE_SSL`: **false**: 启用 Minio 的 SSL，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过 Minio 的 SSL 验证，仅在`STORAGE_TYPE`为`minio`时可用。 ### 存储库归档 (`repo-archive`) -- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **repo-archive/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **repo-archive/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 ## 代理 (`proxy`) -- `PROXY_ENABLED`: **false**: 启用代理，如果为true，所有通过HTTP向外部的请求都将受到影响，如果为false，即使环境设置了http_proxy/https_proxy也不会使用 +- `PROXY_ENABLED`: **false**: 启用代理，如果为 true，所有通过 HTTP 向外部的请求都将受到影响，如果为 false，即使环境设置了 http_proxy/https_proxy 也不会使用 - `PROXY_URL`: **_empty_**: 代理服务器地址，支持 http://, https//, socks://，为空则不启用代理而使用环境变量中的 http_proxy/https_proxy -- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 * 号匹配符号， ** 表示匹配所有网站 +- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 \* 号匹配符号， \*\* 表示匹配所有网站 i.e. @@ -1316,8 +1315,8 @@ PROXY_HOSTS = *.github.com - `ENABLED`: **true**: 启用/禁用操作功能 - `DEFAULT_ACTIONS_URL`: **github**: 获取操作插件的默认平台，`github`表示`https://github.com`，`self`表示当前的 Gitea 实例。 -- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **actions_log/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **actions_log/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 `DEFAULT_ACTIONS_URL` 指示 Gitea 操作运行程序应该在哪里找到带有相对路径的操作。 例如，`uses: actions/checkout@v3` 表示 `https://github.com/actions/checkout@v3`，因为 `DEFAULT_ACTIONS_URL` 的值为 `github`。 @@ -1334,7 +1333,7 @@ PROXY_HOSTS = *.github.com ## 其他 (`other`) -- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示Gitea的版本。 +- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示 Gitea 的版本。 - `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: 在页脚显示模板执行的时间。 -- `ENABLE_SITEMAP`: **true**: 生成sitemap. -- `ENABLE_FEED`: **true**: 是否启用RSS/Atom +- `ENABLE_SITEMAP`: **true**: 生成 sitemap. +- `ENABLE_FEED`: **true**: 是否启用 RSS/Atom diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/customizing-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/customizing-gitea.md index bf55039f..1961a1f5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/customizing-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/customizing-gitea.md @@ -10,7 +10,7 @@ aliases: Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板等默认配置。 -如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为Linux文件系统标准。Gitea +如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为 Linux 文件系统标准。Gitea 将会自动创建包括 `custom/` 在内的必要应用目录，应用本身的配置存放在 `custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接，查看配置详情请移步： @@ -64,7 +64,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板 除了 `extra_links.tmpl` 和 `extra_tabs.tmpl`，您可以在您的 `custom/templates/custom/` 目录中存放一些其他有用的模板，例如： -- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义CSS文件 +- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义 CSS 文件 - `body_outer_pre.tmpl`，在 `` 标记开始处的模板 - `body_inner_pre.tmpl`，在顶部导航栏之前，但在主 container 内部的模板，例如添加一个 `
` - `body_inner_post.tmpl`，在主 container 结束处的模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/email-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/email-setup.md index 36eef39a..6655373e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/email-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/email-setup.md @@ -6,7 +6,6 @@ sidebar_position: 12 aliases: - /zh-cn/email-setup - --- # Email 设置 @@ -17,9 +16,9 @@ Gitea 具有邮件功能，用于发送事务性邮件（例如注册确认邮 使用 `sendmail` 命令作为邮件传输代理（mailer）。 -注意：对于在官方Gitea Docker镜像中使用，请使用SMTP版本进行配置（请参考下一节）。 +注意：对于在官方 Gitea Docker 镜像中使用，请使用 SMTP 版本进行配置（请参考下一节）。 -注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 +注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过 TLS 发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 ```ini title="app.ini" [mailer] @@ -56,9 +55,9 @@ PASSWD = `password` - 通过端口 587 的 STARTTLS（也称为 Opportunistic TLS）。初始连接是明文的，但如果服务器支持，则可以升级为 TLS。 - 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。 - 使用 `PROTOCOL=smtps` 进行强制的 SMTPS 连接。（这两种方式都被称为 Implicit TLS） -这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 + 这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 -请注意，自2018年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 +请注意，自 2018 年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 ### Gmail diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/environment-variables.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/environment-variables.md index d3101895..d5ee36a0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/environment-variables.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/environment-variables.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/environment-variables - --- # 环境变量清单 @@ -21,31 +20,31 @@ GITEA_CUSTOM=/home/gitea/custom ./gitea web 因为 Gitea 使用 Go 语言编写，因此它使用了一些相关的 Go 的配置参数： -* `GOOS` -* `GOARCH` -* [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) +- `GOOS` +- `GOARCH` +- [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable) 您可以在[官方文档](https://golang.org/cmd/go/#hdr-Environment_variables)中查阅这些配置参数的详细信息。 ## Gitea 的文件目录 -* `GITEA_WORK_DIR`：工作目录的绝对路径 -* `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录 -* `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 -* `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 +- `GITEA_WORK_DIR`：工作目录的绝对路径 +- `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 _custom_ 目录 +- `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 +- `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 ## 操作系统配置 -* `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 -* `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` -* `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 +- `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 +- `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` +- `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 ### 仅限于 Windows 的配置 -* `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` -* `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘） -* `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 +- `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` +- `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C 盘） +- `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 ## Miscellaneous -* `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 +- `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/external-renderers.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/external-renderers.md index 39efd2d5..47555316 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/external-renderers.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/external-renderers.md @@ -171,7 +171,8 @@ ALLOW_DATA_URI_IMAGES = true .markup.XXXXX body { color: #444; - font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", + serif; font-size: 12px; line-height: 1.7; padding: 1em; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/git-lfs-support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/git-lfs-support.md index 27b3ec6f..a5b8f6d3 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/git-lfs-support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/git-lfs-support.md @@ -6,7 +6,6 @@ sidebar_position: 12 aliases: - /zh-cn/git-lfs-setup - --- # Git LFS 设置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/logging-config.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/logging-config.md index e23663dc..004832c0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/logging-config.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/logging-config.md @@ -6,7 +6,6 @@ sidebar_position: 40 aliases: - /zh-cn/logging-configuration - --- # 日志配置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/mail-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/mail-templates.md index f7bf7acb..c4ed3b5e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/mail-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/mail-templates.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/mail-templates - --- # 邮件模板 @@ -20,18 +19,18 @@ aliases: 目前，以下通知事件使用模板： -| 操作名称 | 用途 | -| ----------- | ------------------------------------------------------------------------------------------------------------ | -| `new` | 创建了新的工单或合并请求。 | -| `comment` | 在现有工单或合并请求中创建了新的评论。 | -| `close` | 关闭了工单或合并请求。 | -| `reopen` | 重新打开了工单或合并请求。 | -| `review` | 在合并请求中进行审查的首要评论。 | -| `approve` | 对合并请求进行批准的首要评论。 | -| `reject` | 对合并请求提出更改请求的审查的首要评论。 | -| `code` | 关于合并请求的代码的单个评论。 | -| `assigned` | 用户被分配到工单或合并请求。 | -| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | +| 操作名称 | 用途 | +| ---------- | ---------------------------------------------------------------------- | +| `new` | 创建了新的工单或合并请求。 | +| `comment` | 在现有工单或合并请求中创建了新的评论。 | +| `close` | 关闭了工单或合并请求。 | +| `reopen` | 重新打开了工单或合并请求。 | +| `review` | 在合并请求中进行审查的首要评论。 | +| `approve` | 对合并请求进行批准的首要评论。 | +| `reject` | 对合并请求提出更改请求的审查的首要评论。 | +| `code` | 关于合并请求的代码的单个评论。 | +| `assigned` | 用户被分配到工单或合并请求。 | +| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | 特定消息类型的模板路径为： @@ -75,25 +74,25 @@ custom/templates/mail/pull/comment.tmpl 指定 _主题_ 部分是可选的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。 -_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： +_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://golang.org/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： -| 名称 | 类型 | 可用性 | 用途 | -| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | -| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | -| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | -| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | -| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | -| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | -| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | -| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | -| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | -| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | -| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | -| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | -| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | -| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | -| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | +| 名称 | 类型 | 可用性 | 用途 | +| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | +| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | +| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | +| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | +| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | +| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | +| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | +| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | +| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | +| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | +| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | +| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | +| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | +| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | +| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | 所有名称区分大小写。 @@ -110,7 +109,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t - 删除所有前导、尾随和多余的空格。 - 将字符串截断为前 256 个字母（字符）。 -如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用Gitea的**内部默认值**。 +如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用 Gitea 的**内部默认值**。 内部默认（回退）主题相当于： @@ -120,7 +119,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 例如：`Re: [mike/stuff] New color palette (#38)` -即使存在有效的主题模板，Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 +即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 ### 模板中的邮件正文部分 @@ -142,7 +141,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 如果模板无法呈现，则只有在发送邮件时才会注意到。 如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈现了任何内容，则将使用该内容，忽略其他内容。 -如果遇到问题，请检查 [Gitea的日志](../administration/logging-config.md) 以获取错误消息。 +如果遇到问题，请检查 [Gitea 的日志](../administration/logging-config.md) 以获取错误消息。 ## 示例 @@ -224,11 +223,11 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t > > #### 消息内容： > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > Mike, I think we should tone down the blues a little. > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > [在 Gitea 上查看](#)。 @@ -236,20 +235,22 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://golang.org/pkg/t 模板系统包含一些函数，可用于进一步处理和格式化消息。以下是其中一些函数的列表： -| 函数名 | 参数 | 可用于 | 用法 | -| ----------------- | ----------- | ------------ | --------------------------------------------------------------------------------- | -| `AppUrl` | - | 任何地方 | Gitea 的 URL | -| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | -| `AppDomain` | - | 任何地方 | Gitea 的主机名 | -| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | -| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 | -| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于 `.ReviewComments.RenderedContent` 等字段 | +| 函数名 | 参数 | 可用于 | 用法 | +| ---------------- | ----------- | ---------- | --------------------------------------------------------------------- | +| `AppUrl` | - | 任何地方 | Gitea 的 URL | +| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | +| `AppDomain` | - | 任何地方 | Gitea 的主机名 | +| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | +| `Str2html` | string | 仅正文部分 | 通过删除其中的 HTML 标签对文本进行清理 | +| `Safe` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于 `.ReviewComments.RenderedContent` 等字段 | 这些都是 _函数_，而不是元数据，因此必须按以下方式使用： ```html -像这样使用： {{Str2html "Escapetext"}} -或者这样使用： {{"Escapetext" | Str2html}} -或者这样使用： {{AppUrl}} -但不要像这样使用： {{.AppUrl}} +像这样使用： {{Str2html "Escapetext"}} 或者这样使用： {{"Escapetext" | Str2html}} 或者这样使用： {{AppUrl}} 但不要像这样使用： + {{.AppUrl}} ``` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/repo-indexer.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/repo-indexer.md index ea765c44..bd3c328d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/repo-indexer.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/repo-indexer.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/repo-indexer - --- # 仓库索引器 @@ -33,7 +32,7 @@ REPO_INDEXER_EXCLUDE = resources/bin/** ### 按路径选择要索引的文件 -Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 +Gitea 使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 限制文件列表可以防止索引被派生或无关的文件（例如 lss、sym、map 等）污染，从而使搜索结果更相关。这还有助于减小索引的大小。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/reverse-proxies.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/reverse-proxies.md index 54746f03..96db56ac 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/reverse-proxies.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/reverse-proxies.md @@ -6,7 +6,6 @@ sidebar_position: 16 aliases: - /zh-cn/reverse-proxies - --- # 反向代理 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/search-engines-indexation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/search-engines-indexation.md index 761b1d11..50b06ab5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/search-engines-indexation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/search-engines-indexation.md @@ -22,7 +22,7 @@ User-agent: * Disallow: / ``` -如果您将Gitea安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 +如果您将 Gitea 安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 ```txt User-agent: * diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/signing.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/signing.md index b7e2d403..fac88ed7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/signing.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/administration/signing.md @@ -69,7 +69,7 @@ MERGES = pubkey, twofa, basesigned, commitssigned 如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。 与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。 -如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则Gitea将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 +如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则 Gitea 将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 ::: ### `INITIAL_COMMIT` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-backend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-backend.md index 15e693ce..db7c1616 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-backend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-backend.md @@ -6,47 +6,46 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-backend - --- # 后端开发指南 ## 背景 -Gitea使用Golang作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 -例如，Gitea使用[Chi](https://github.com/go-chi/chi)作为基本的Web框架。[Xorm](https://xorm.io)是一个用于与数据库交互的ORM框架。 +Gitea 使用 Golang 作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 +例如，Gitea 使用[Chi](https://github.com/go-chi/chi)作为基本的 Web 框架。[Xorm](https://xorm.io)是一个用于与数据库交互的 ORM 框架。 因此，管理这些包非常重要。在开始编写后端代码之前，请参考以下准则。 ## 包设计准则 ### 包列表 -为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea后端分为以下几个部分： +为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea 后端分为以下几个部分： -- `build`：帮助构建Gitea的脚本。 -- `cmd`：包含所有Gitea的实际子命令，包括web、doctor、serv、hooks、admin等。`web`将启动Web服务。`serv`和`hooks`将被Git或OpenSSH调用。其他子命令可以帮助维护Gitea。 +- `build`：帮助构建 Gitea 的脚本。 +- `cmd`：包含所有 Gitea 的实际子命令，包括 web、doctor、serv、hooks、admin 等。`web`将启动 Web 服务。`serv`和`hooks`将被 Git 或 OpenSSH 调用。其他子命令可以帮助维护 Gitea。 - `tests`：常用的测试函数 - `tests/integration`：集成测试，用于测试后端回归。 - `tests/e2e`：端到端测试，用于测试前端和后端的兼容性和视觉回归。 -- `models`：包含由xorm用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他Gitea代码的依赖关系。在某些情况下，比如日志记录时可以例外。 - - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从models/中调用。 +- `models`：包含由 xorm 用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他 Gitea 代码的依赖关系。在某些情况下，比如日志记录时可以例外。 + - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从 models/中调用。 - `models/fixtures`：单元测试和集成测试中使用的示例数据。一个`yml`文件表示一个将在测试开始时加载到数据库中的表。 - - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的PR**必须**包含一个迁移步骤。 -- `modules`：在Gitea中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于models的模块，因为它们依赖于数据库。 - - `modules/setting`：存储从ini文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 - - `modules/git`：用于与`Git`命令行或Gogit包交互的包。 -- `public`：编译后的前端文件（JavaScript、图像、CSS等） -- `routers`：处理服务器请求。由于它使用其他Gitea包来处理请求，因此其他包（models、modules或services）不能依赖于routers。 - - `routers/api`：包含`/api/v1`相关路由，用于处理RESTful API请求。 + - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的 PR**必须**包含一个迁移步骤。 +- `modules`：在 Gitea 中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于 models 的模块，因为它们依赖于数据库。 + - `modules/setting`：存储从 ini 文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 + - `modules/git`：用于与`Git`命令行或 Gogit 包交互的包。 +- `public`：编译后的前端文件（JavaScript、图像、CSS 等） +- `routers`：处理服务器请求。由于它使用其他 Gitea 包来处理请求，因此其他包（models、modules 或 services）不能依赖于 routers。 + - `routers/api`：包含`/api/v1`相关路由，用于处理 RESTful API 请求。 - `routers/install`：只能在系统处于安装模式（INSTALL_LOCK=false）时响应。 - `routers/private`：仅由内部子命令调用，特别是`serv`和`hooks`。 - - `routers/web`：处理来自Web浏览器或Git SMART HTTP协议的HTTP请求。 + - `routers/web`：处理来自 Web 浏览器或 Git SMART HTTP 协议的 HTTP 请求。 - `services`：用于常见路由操作或命令执行的支持函数。使用`models`和`modules`来处理请求。 -- `templates`：用于生成HTML输出的Golang模板。 +- `templates`：用于生成 HTML 输出的 Golang 模板。 ### 包依赖关系 -由于Golang不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 +由于 Golang 不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 `cmd` -> `routers` -> `services` -> `models` -> `modules` @@ -91,18 +90,18 @@ func UpdateIssue(ctx context.Context, repoID int64) error { ### 导入别名 -由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个Go文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 +由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个 Go 文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 例如：`import user_service "code.gitea.io/gitea/services/user"` ### 重要注意事项 - 永远不要写成`x.Update(exemplar)`，而没有明确的`WHERE`子句： - - 这将导致表中的所有行都被使用exemplar的非零值进行更新，包括ID。 + - 这将导致表中的所有行都被使用 exemplar 的非零值进行更新，包括 ID。 - 通常应该写成`x.ID(id).Update(exemplar)`。 -- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而ID是预设的： - - 对于MSSQL变体，你将需要执行``SET IDENTITY_INSERT `table` ON``（否则迁移将失败） - - 对于PostgreSQL，你还需要更新ID序列，否则迁移将悄无声息地通过，但后续的插入将失败： - ``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)`` +- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而 ID 是预设的： + - 对于 MSSQL 变体，你将需要执行`` SET IDENTITY_INSERT `table` ON ``（否则迁移将失败） + - 对于 PostgreSQL，你还需要更新 ID 序列，否则迁移将悄无声息地通过，但后续的插入将失败： + `` SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false) `` ### 未来的任务 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-frontend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-frontend.md index 6716d5f5..785ad1f0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-frontend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-frontend.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-frontend - --- # 前端开发指南 @@ -19,10 +18,10 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 源文件可以在以下目录中找到： -* **CSS 样式**： `web_src/css/` -* **JavaScript 文件**： `web_src/js/` -* **Vue 组件**： `web_src/js/components/` -* **Go HTML 模板**： `templates/` +- **CSS 样式**： `web_src/css/` +- **JavaScript 文件**： `web_src/js/` +- **Vue 组件**： `web_src/js/components/` +- **Go HTML 模板**： `templates/` ## 通用准则 @@ -31,9 +30,9 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ## Gitea 特定准则： 1. 每个功能（Fomantic-UI/jQuery 模块）应放在单独的文件/目录中。 -2. HTML 的 id 和 class 应使用 kebab-case，最好包含2-3个与功能相关的关键词。 -3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含2-3个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 -4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有2-3个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 +2. HTML 的 id 和 class 应使用 kebab-case，最好包含 2-3 个与功能相关的关键词。 +3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含 2-3 个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 +4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有 2-3 个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 5. 后端可以通过使用`ctx.PageData["myModuleData"] = map[]{}`将复杂数据传递给前端，但不要将整个模型暴露给前端，以避免泄露敏感数据。 6. 简单页面和与 SEO 相关的页面使用 Go HTML 模板渲染生成静态的 Fomantic-UI HTML 输出。复杂页面可以使用 Vue3。 7. 明确变量类型，优先使用`elem.disabled = true`而不是`elem.setAttribute('disabled', 'anything')`，优先使用`$el.prop('checked', var === 'yes')`而不是`$el.prop('checked', var)`。 @@ -45,8 +44,8 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ### 可访问性 / ARIA -在历史上，Gitea大量使用了可访问性不友好的框架 Fomantic UI。 -Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`aria.md`）， +在历史上，Gitea 大量使用了可访问性不友好的框架 Fomantic UI。 +Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见`aria.js`和`aria.md`）， 但仍然存在许多问题需要大量的工作和时间来修复。 ### 框架使用 @@ -56,14 +55,14 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 推荐的实现方式： -* Vue + Vanilla JS -* Fomantic-UI（jQuery） -* Vanilla JS +- Vue + Vanilla JS +- Fomantic-UI（jQuery） +- Vanilla JS 不推荐的实现方式： -* Vue + Fomantic-UI（jQuery） -* jQuery + Vanilla JS +- Vue + Fomantic-UI（jQuery） +- jQuery + Vanilla JS 为了保持界面一致，Vue 组件可以使用 Fomantic-UI 的 CSS 类。 尽管不建议混合使用不同的框架， @@ -82,7 +81,7 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 如果我们想在非异步上下文中调用`async`函数， 建议使用`const _promise = asyncFoo()`来告诉读者 -这是有意为之的，我们想调用异步函数并忽略Promise。 +这是有意为之的，我们想调用异步函数并忽略 Promise。 一些 lint 规则和 IDE 也会在未处理返回的 Promise 时发出警告。 ### HTML 属性和 dataset @@ -90,31 +89,41 @@ Gitea使用一些补丁使Fomantic UI更具可访问性（参见`aria.js`和`ari 禁止使用`dataset`，它的驼峰命名行为使得搜索属性变得困难。 然而，仍然存在一些特殊情况，因此当前的准则是： -* 对于旧代码： - * 应将`$.data()`重构为`$.attr()`。 - * 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 +- 对于旧代码： -* 对于新代码： - * 不应使用`node.dataset`，而应使用`node.getAttribute`。 - * 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 + - 应将`$.data()`重构为`$.attr()`。 + - 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 + +- 对于新代码： + - 不应使用`node.dataset`，而应使用`node.getAttribute`。 + - 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 ### 显示/隐藏元素 -* 推荐在Vue组件中使用`v-if`和`v-show`来显示/隐藏元素。 -* Go 模板代码应使用 Gitea 的 `.gt-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.gt-hidden`的注释以获取更多详细信息。 +- 推荐在 Vue 组件中使用`v-if`和`v-show`来显示/隐藏元素。 +- Go 模板代码应使用 Gitea 的 `.gt-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.gt-hidden`的注释以获取更多详细信息。 ### Go HTML 模板中的样式和属性 建议使用以下方式： ```html -
+
``` 而不是： ```html -
+
``` 以使代码更易读。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-refactoring.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-refactoring.md index fbc4ae49..589efe64 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-refactoring.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/guidelines-refactoring.md @@ -6,38 +6,37 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-refactoring - --- # 重构指南 ## 背景 -自2014年2月12日编写了第一行代码以来，Gitea已经发展成为一个庞大的项目。 +自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成为一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多过时的机制，许多框架混合在一起，一些遗留代码可能会导致错误并阻碍新功能的开发。 -为了使代码库更易于维护，使Gitea变得更好，开发人员应牢记使用现代机制来重构旧代码。 +为了使代码库更易于维护，使 Gitea 变得更好，开发人员应牢记使用现代机制来重构旧代码。 本文档是关于重构代码库的指南集合。 ## 重构建议 -* 设计更多关于未来的内容，而不仅仅解决当前问题。 -* 减少模糊性，减少冲突，提高可维护性。 -* 描述重构，例如： - * 为什么需要重构。 - * 如何解决旧问题。 - * 重构的优点/缺点是什么。 -* 只做必要的更改，尽量保留旧逻辑。 -* 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个PR中完成。 -* 如果存在分歧，应该请TOC（技术监督委员会）参与决策。 -* 添加必要的测试以确保重构的正确性。 -* 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 +- 设计更多关于未来的内容，而不仅仅解决当前问题。 +- 减少模糊性，减少冲突，提高可维护性。 +- 描述重构，例如： + - 为什么需要重构。 + - 如何解决旧问题。 + - 重构的优点/缺点是什么。 +- 只做必要的更改，尽量保留旧逻辑。 +- 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。 +- 如果存在分歧，应该请 TOC（技术监督委员会）参与决策。 +- 添加必要的测试以确保重构的正确性。 +- 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 ## 审查和合并建议 -* 重构的PR不应该长时间保持打开状态（通常为7天），应尽快进行审查。 -* 重构的PR应尽快合并，不应被其他PR阻塞。 -* 如果TOC没有异议，重构的PR可以在7天后由一名核心成员（非作者）批准后合并。 -* 如果最终结果良好，容忍一些不完美/临时的步骤。 -* 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 +- 重构的 PR 不应该长时间保持打开状态（通常为 7 天），应尽快进行审查。 +- 重构的 PR 应尽快合并，不应被其他 PR 阻塞。 +- 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合并。 +- 如果最终结果良好，容忍一些不完美/临时的步骤。 +- 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/localization.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/localization.md index 455b4531..296c579f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/localization.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/contributing/localization.md @@ -6,14 +6,13 @@ sidebar_position: 70 aliases: - /zh-cn/localization - --- # 本地化 -Gitea的本地化是通过我们的[Crowdin项目](https://crowdin.com/project/gitea)进行的。 +Gitea 的本地化是通过我们的[Crowdin 项目](https://crowdin.com/project/gitea)进行的。 -对于对**英语翻译**的更改，可以发出pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 +对于对**英语翻译**的更改，可以发出 pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 有关对**非英语**翻译的更改，请参阅上面的 Crowdin 项目。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/hacking-on-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/hacking-on-gitea.md index 590b1263..045d3ae0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/hacking-on-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/hacking-on-gitea.md @@ -6,7 +6,7 @@ aliases: - /zh-cn/hacking-on-gitea --- -# 玩转Gitea +# 玩转 Gitea ## 快速入门 @@ -16,7 +16,7 @@ aliases: ## 安装 Golang -您需要 [安装 go]( https://golang.org/doc/install ) 并设置您的 go 环境。 +您需要 [安装 go](https://golang.org/doc/install) 并设置您的 go 环境。 接下来，[使用 npm 安装 Node.js](https://nodejs.org/en/download/) ，这是构建 JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @minNodeVersion@ @@ -24,12 +24,12 @@ JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @mi **注意** ：当执行需要外部工具的 make 任务时，比如 `make watch-backend`，Gitea 会自动下载并构建这些必要的组件。为了能够使用这些，你必须 -将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把go bin目录添加到可执行路径你必须手动 +将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把 go bin 目录添加到可执行路径你必须手动 指定可执行程序路径。 -**注意2** ：Go版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 +**注意 2** ：Go 版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 格式化源代码。然而，`gofmt` 的结果可能因 `go` 的版本而有差异。因此推荐安装我们持续集成使用 -的 Go版本。截至上次更新，Go 版本应该是 @goVersion@。 +的 Go 版本。截至上次更新，Go 版本应该是 @goVersion@。 ## 安装 Make @@ -55,15 +55,15 @@ sudo yum install make Make 的这三个发行版都可以在 Windows 上运行： -- [单个二进制构建]( http://www.equation.com/servlet/equation.cmd?fa=make )。复制到某处并添加到 `PATH`。 +- [单个二进制构建](http://www.equation.com/servlet/equation.cmd?fa=make)。复制到某处并添加到 `PATH`。 - [32 位版本](http://www.equation.com/ftpdir/make/32/make.exe) - [64 位版本](http://www.equation.com/ftpdir/make/64/make.exe) - [MinGW-w64](https://www.mingw-w64.org) / [MSYS2](https://www.msys2.org/)。 - MSYS2 是一个工具和库的集合，为您提供一个易于使用的环境来构建、安装和运行本机 Windows 软件，它包括 MinGW-w64。 - 在 MingGW-w64 中，二进制文件称为 `mingw32-make.exe` 而不是 `make.exe`。将 `bin` 文件夹添加到 `PATH`。 - 在 MSYS2 中，您可以直接使用 `make`。请参阅 [MSYS2 移植](https://www.msys2.org/wiki/Porting/)。 - - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 _beginthread 一样。 -- [Chocolatey包管理器]( https://chocolatey.org/packages/make )。运行`choco install make` + - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 \_beginthread 一样。 +- [Chocolatey 包管理器](https://chocolatey.org/packages/make)。运行`choco install make` **注意** ：如果您尝试在 Windows 命令提示符下使用 make 进行构建，您可能会遇到问题。建议使用上述提示（Git bash 或 MinGW），但是如果您只有命令提示符（或可能是 PowerShell），则可以使用 [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) 命令，例如 `set TAGS=bindata`。 @@ -75,7 +75,7 @@ Make 的这三个发行版都可以在 Windows 上运行： git clone https://github.com/go-gitea/gitea ``` -（自从go modules出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） +（自从 go modules 出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） ## 派生 Gitea @@ -196,7 +196,7 @@ SVG 图标是使用 `make svg` 目标构建的，该目标将 `build/generate-sv ### 构建 Logo -Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 +Gitea Logo 的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 通过更新 `assets/logo.svg` 并运行 `make generate-images`，同样的过程也可用于从 SVG 源文件生成自定义 Logo PNG。忽略 gitea 编译选项将仅更新用户指定的 LOGO 文件。 @@ -205,7 +205,7 @@ Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 创建新的 API 路由或修改现有的 API 路由时，您**必须** 更新和/或创建 [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/) 这些使用 [go-swagger](https://goswagger.io/) 评论的文档。 -[规范]( https://goswagger.io/use/spec.html#annotation-syntax )中描述了这些注释的结构。 +[规范](https://goswagger.io/use/spec.html#annotation-syntax)中描述了这些注释的结构。 如果您想了解更多有关 Swagger 结构的信息，可以查看 [Swagger 2.0 文档](https://swagger.io/docs/specification/2-0/basic-structure/) 或与添加新 API 端点的先前 PR 进行比较，例如 [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20) @@ -239,7 +239,7 @@ make swagger-check 并到[配置备忘单](../administration/config-cheat-sheet.md) 在 `docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到 -### 更改Logo +### 更改 Logo 更改 Gitea Logo SVG 时，您将需要运行并提交结果的： @@ -291,7 +291,7 @@ TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite 我们的持续集成将测试代码是否通过了单元测试，并且所有支持的数据库都将在 Docker 环境中通过集成测试。 还将测试从几个最新版本的 Gitea 迁移。 -请在PR中附带提交适当的单元测试和集成测试。 +请在 PR 中附带提交适当的单元测试和集成测试。 ## 网站文档 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/integrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/integrations.md index 052a8734..049d0bba 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/integrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/integrations.md @@ -8,7 +8,7 @@ aliases: # 集成 -Gitea拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 +Gitea 拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 我们正在[awesome-gitea](https://gitea.com/gitea/awesome-gitea)上整理一个列表来跟踪这些集成！ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/migrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/migrations.md index b92449e6..60cad1ab 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/migrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/migrations.md @@ -8,24 +8,24 @@ aliases: # 迁移接口 -完整迁移功能在Gitea 1.9.0版本中引入。它定义了两个接口，用于支持从其他Git托管平台迁移存储库数据到Gitea，或者在将来将Gitea数据迁移到其他Git托管平台。 +完整迁移功能在 Gitea 1.9.0 版本中引入。它定义了两个接口，用于支持从其他 Git 托管平台迁移存储库数据到 Gitea，或者在将来将 Gitea 数据迁移到其他 Git 托管平台。 -目前已实现了从GitHub、GitLab和其他Gitea实例的迁移。 +目前已实现了从 GitHub、GitLab 和其他 Gitea 实例的迁移。 -首先，Gitea在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 +首先，Gitea 在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 ## 下载器接口 -要从新的Git托管平台迁移，需要进行两个步骤的更新。 +要从新的 Git 托管平台迁移，需要进行两个步骤的更新。 - 您应该实现一个`Downloader`，用于获取存储库信息。 -- 您应该实现一个`DownloaderFactory`，用于检测URL是否匹配，并创建上述的`Downloader`。 +- 您应该实现一个`DownloaderFactory`，用于检测 URL 是否匹配，并创建上述的`Downloader`。 - 您需要在`init()`中通过`RegisterDownloaderFactory`注册`DownloaderFactory`。 您可以在[downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go)中找到这些接口。 ## 上传器接口 -目前，只实现了`GiteaLocalUploader`，因此我们只能通过此Uploader将下载的数据保存到本地的Gitea实例。目前不支持其他上传器。 +目前，只实现了`GiteaLocalUploader`，因此我们只能通过此 Uploader 将下载的数据保存到本地的 Gitea 实例。目前不支持其他上传器。 您可以在[uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go)中找到这些接口。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/oauth2-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/oauth2-provider.md index da39853f..66dd333d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/oauth2-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/development/oauth2-provider.md @@ -33,40 +33,40 @@ Gitea 支持作为 OAuth2 提供者，允许第三方应用程序在用户同意 Gitea 支持以下令牌范围: -| 名称 | 介绍 | -| ---- | ----------- | -| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | -| **repo** | 完全控制所有存储库 | -|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | -|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | -| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | -|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | -|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | -| **admin:org** | 授予对组织设置的完全访问权限 | -|     **write:org** | 授予对组织设置的读/写访问权限 | -|     **read:org** | 授予对组织设置的只读访问权限 | -| **admin:public_key** | 授予公钥管理的完全访问权限 | -|     **write:public_key** | 授予对公钥的读/写访问权限 | -|     **read:public_key** | 授予对公钥的只读访问权限 | -| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | -| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | -| **notification** | 授予对通知的完全访问权限 | -| **user** | 授予对用户个人资料信息的完全访问权限 | -|     **read:user** | 授予对用户个人资料的读取权限 | -|     **user:email** | 授予对用户电子邮件地址的读取权限 | -|     **user:follow** | 授予访问权限以关注/取消关注用户 | -| **delete_repo** | 授予删除存储库的权限 | -| **package** | 授予对托管包的完全访问权限 | -|     **write:package** | 授予对包的读/写访问权限 | -|     **read:package** | 授予对包的读取权限 | -|     **delete:package** | 授予对包的删除权限 | -| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | -|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | -|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | -| **admin:application** | 授予应用程序管理的完全访问权限 | -|     **write:application** | 授予应用程序管理的读/写访问权限 | -|     **read:application** | 授予应用程序管理的读取权限 | -| **sudo** | 允许以站点管理员身份执行操作 | +| 名称 | 介绍 | +| ---------------------------------------- | --------------------------------------------------------------- | +| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | +| **repo** | 完全控制所有存储库 | +|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | +|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | +| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | +|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | +|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | +| **admin:org** | 授予对组织设置的完全访问权限 | +|     **write:org** | 授予对组织设置的读/写访问权限 | +|     **read:org** | 授予对组织设置的只读访问权限 | +| **admin:public_key** | 授予公钥管理的完全访问权限 | +|     **write:public_key** | 授予对公钥的读/写访问权限 | +|     **read:public_key** | 授予对公钥的只读访问权限 | +| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | +| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | +| **notification** | 授予对通知的完全访问权限 | +| **user** | 授予对用户个人资料信息的完全访问权限 | +|     **read:user** | 授予对用户个人资料的读取权限 | +|     **user:email** | 授予对用户电子邮件地址的读取权限 | +|     **user:follow** | 授予访问权限以关注/取消关注用户 | +| **delete_repo** | 授予删除存储库的权限 | +| **package** | 授予对托管包的完全访问权限 | +|     **write:package** | 授予对包的读/写访问权限 | +|     **read:package** | 授予对包的读取权限 | +|     **delete:package** | 授予对包的删除权限 | +| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | +|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | +|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | +| **admin:application** | 授予应用程序管理的完全访问权限 | +|     **write:application** | 授予应用程序管理的读/写访问权限 | +|     **read:application** | 授予应用程序管理的读取权限 | +| **sudo** | 允许以站点管理员身份执行操作 | ## 客户端类型 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/faq.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/faq.md index 1eb2c066..9d40f1fc 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/faq.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/faq.md @@ -12,128 +12,128 @@ aliases: 有关更多帮助资源，请查看所有[支持选项](help/support.md)。 -## 1.x和1.x.x下载之间的区别 +## 1.x 和 1.x.x 下载之间的区别 -以1.7.x版本为例。 +以 1.7.x 版本为例。 -**注意：**此示例也适用于Docker镜像！ +**注意：**此示例也适用于 Docker 镜像！ -在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个1.7目录，以及1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5和1.7.6的目录。 +在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个 1.7 目录，以及 1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5 和 1.7.6 的目录。 -1.7目录和1.7.0目录是**不同**的。1.7目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 +1.7 目录和 1.7.0 目录是**不同**的。1.7 目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 -然而，1.7.0目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 +然而，1.7.0 目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 -这意味着1.x的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 +这意味着 1.x 的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 -另一方面，1.x.x的下载应该永远不会改变。 +另一方面，1.x.x 的下载应该永远不会改变。 -## 如何从Gogs/GitHub等迁移到Gitea +## 如何从 Gogs/GitHub 等迁移到 Gitea -要从Gogs迁移到Gitea： +要从 Gogs 迁移到 Gitea： -- [Gogs版本0.9.146或更低](installation/upgrade-from-gogs.md) -- [Gogs版本0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) +- [Gogs 版本 0.9.146 或更低](installation/upgrade-from-gogs.md) +- [Gogs 版本 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) -要从GitHub迁移到Gitea，您可以使用Gitea内置的迁移表单。 +要从 GitHub 迁移到 Gitea，您可以使用 Gitea 内置的迁移表单。 为了迁移诸如问题、拉取请求等项目，您需要至少输入您的用户名。 [Example (requires login)](https://try.gitea.io/repo/migrate) -要从GitLab迁移到Gitea，您可以使用这个非关联的工具： +要从 GitLab 迁移到 Gitea，您可以使用这个非关联的工具： https://github.com/loganinak/MigrateGitlabToGogs -## Gitea存储文件的位置 +## Gitea 存储文件的位置 - _`AppWorkPath`_ - `--work-path`标志 - 或者环境变量`GITEA_WORK_DIR` - 或者在构建时设置的内置值 - - 或者包含Gitea二进制文件的目录 + - 或者包含 Gitea 二进制文件的目录 - `%(APP_DATA_PATH)`（数据库、索引器等的默认路径） - `app.ini`中的`APP_DATA_PATH` - - 或者_`AppWorkPath`_`/data` + - 或者*`AppWorkPath`*`/data` - _`CustomPath`_（自定义模板） - `--custom-path`标志 - 或者环境变量`GITEA_CUSTOM` - 或者在构建时设置的内置值 - - 或者_`AppWorkPath`_`/custom` + - 或者*`AppWorkPath`*`/custom` - HomeDir - Unix：环境变量`HOME` - Windows：环境变量`USERPROFILE`，或者环境变量`HOMEDRIVE`+`HOMEPATH` - RepoRootPath - `app.ini`中\[repository]部分的`ROOT`（如果是绝对路径） - - 否则_`AppWorkPath`_`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） + - 否则*`AppWorkPath`*`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） - 默认值为`%(APP_DATA_PATH)/gitea-repositories` - INI（配置文件） - `--config`标志 - 或者在构建时设置的可能内置值 - 或者 _`CustomPath`_`/conf/app.ini` -- SQLite数据库 - - app.ini中database部分的PATH +- SQLite 数据库 + - app.ini 中 database 部分的 PATH - 或者`%(APP_DATA_PATH)/gitea.db` -## 看不到克隆URL或克隆URL不正确 +## 看不到克隆 URL 或克隆 URL 不正确 有几个地方可能会导致显示不正确。 1. 如果使用反向代理，请确保按照[反向代理指南](../administration/reverse-proxies.md)中的正确说明进行设置。 2. 确保在`app.ini`的`server`部分中正确设置了`ROOT_URL`。 -如果某些克隆选项未显示（HTTP/S或SSH），可以在`app.ini中` +如果某些克隆选项未显示（HTTP/S 或 SSH），可以在`app.ini中` -- `DISABLE_HTTP_GIT`: 如果设为true, 将会没有HTTP/HTTPS链接 -- `DISABLE_SSH`: 如果设为true, 将会没有SSH链接 -- `SSH_EXPOSE_ANONYMOUS`: 如果设为false, SSH链接将会对匿名用户隐藏 +- `DISABLE_HTTP_GIT`: 如果设为 true, 将会没有 HTTP/HTTPS 链接 +- `DISABLE_SSH`: 如果设为 true, 将会没有 SSH 链接 +- `SSH_EXPOSE_ANONYMOUS`: 如果设为 false, SSH 链接将会对匿名用户隐藏 ## 文件上传失败：413 Request Entity Too Large 当反向代理限制文件上传大小时，会出现此错误。 -有关使用nginx解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 +有关使用 nginx 解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 ## 自定义模板无法加载或运行错误 -Gitea的自定义模板必须将其添加到正确的位置，否则Gitea将无法找到并使用自定义模板。 +Gitea 的自定义模板必须将其添加到正确的位置，否则 Gitea 将无法找到并使用自定义模板。 模板的正确路径应该相对于`CustomPath`。 1. 要找到`CustomPath`，请在站点管理 -> 配置 中查找自定义文件根路径。 - 如果找不到，请尝试`echo $GITEA_CUSTOM`。 + 如果找不到，请尝试`echo $GITEA_CUSTOM`。 2. 如果仍然找不到，默认值可以被[计算](faq.md#Gitea存储文件的位置) -3. 如果仍然找不到路径，则可以参考[自定义Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 +3. 如果仍然找不到路径，则可以参考[自定义 Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 -## Gitea是否有"GitHub/GitLab Pages"功能？ +## Gitea 是否有"GitHub/GitLab Pages"功能？ -Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供静态页面，以避免CSRF安全风险。 +Gitea 不提供内置的 Pages 服务器。您需要一个专用的域名来提供静态页面，以避免 CSRF 安全风险。 -对于简单的用法，您可以使用反向代理来重写和提供Gitea的原始文件URL中的静态内容。 +对于简单的用法，您可以使用反向代理来重写和提供 Gitea 的原始文件 URL 中的静态内容。 还有一些已经可用的第三方服务，比如独立[pages server](https://codeberg.org/Codeberg/pages-server)的或[caddy plugin](https://github.com/42wim/caddy-gitea)，可以提供所需的功能。 ## 活跃用户与禁止登录用户 -在Gitea中，"活跃用户"是指通过电子邮件激活其帐户的用户。 +在 Gitea 中，"活跃用户"是指通过电子邮件激活其帐户的用户。 -"禁止登录用户"是指不允许再登录到Gitea的用户。 +"禁止登录用户"是指不允许再登录到 Gitea 的用户。 ## 设置日志记录 - [官方文档](../administration/logging-config.md) -## 什么是Swagger？ +## 什么是 Swagger？ -[Swagger](https://swagger.io/) 是Gitea用于其API文档的工具。 +[Swagger](https://swagger.io/) 是 Gitea 用于其 API 文档的工具。 -所有Gitea实例都有内置的API，无法完全禁用它。 -但是，您可以在app.ini的api部分将ENABLE_SWAGGER设置为false，以禁用其文档显示。 -有关更多信息，请参阅Gitea的[API文档](development/api-usage.md)。 +所有 Gitea 实例都有内置的 API，无法完全禁用它。 +但是，您可以在 app.ini 的 api 部分将 ENABLE_SWAGGER 设置为 false，以禁用其文档显示。 +有关更多信息，请参阅 Gitea 的[API 文档](development/api-usage.md)。 -您可以在上查看最新的API（例如）https://try.gitea.io/api/swagger +您可以在上查看最新的 API（例如）https://try.gitea.io/api/swagger 您还可以在上查看`swagger.json`文件的示例 https://try.gitea.io/swagger.v1.json @@ -144,7 +144,7 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 有多种方法可以组合使用来防止垃圾邮件发送者： 1. 通过设置电子邮件域名的白名单或黑名单。 -2. 通过设置一些域名或者OpenID白名单（见下文）。 +2. 通过设置一些域名或者 OpenID 白名单（见下文）。 3. 在您的`app.ini`中将`ENABLE_CAPTCHA`设置为`true`，并正确配置`RECAPTCHA_SECRET`和 `RECAPTCHA_SITEKEY`。 4. 将`DISABLE_REGISTRATION`设置为`true`，并通过 [CLI](../administration/command-line.md)、[API](development/api-usage.md) 或 Gitea 的管理界面创建新用户。 @@ -185,13 +185,13 @@ Gitea 目前支持三个官方主题，分别是 `gitea`（亮色）、`arc-gree 通过将`arc-blue`添加到`app.ini`中的`THEMES`列表中，允许用户使用该主题 -## SSHD vs 内建SSH +## SSHD vs 内建 SSH -SSHD是大多数Unix系统上内建的SSH服务器。 +SSHD 是大多数 Unix 系统上内建的 SSH 服务器。 -Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 +Gitea 还提供了自己的 SSH 服务器，用于在 SSHD 不可用时使用。 -## Gitea运行缓慢 +## Gitea 运行缓慢 导致此问题的最常见原因是加载联合头像。 @@ -201,21 +201,21 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 ## 无法创建仓库/文件 -请确保Gitea具有足够的权限来写入其主目录和数据目录。 +请确保 Gitea 具有足够的权限来写入其主目录和数据目录。 参见[AppDataPath 和 RepoRootPath](faq.md#Gitea存储文件的位置) -**适用于Arch用户的注意事项：**在撰写本文时，Arch软件包的systemd文件包含了以下行： +**适用于 Arch 用户的注意事项：**在撰写本文时，Arch 软件包的 systemd 文件包含了以下行： `ReadWritePaths=/etc/gitea/app.ini` -这将使得Gitea无法写入其他路径。 +这将使得 Gitea 无法写入其他路径。 ## 翻译不正确/如何添加更多翻译 -我们当前的翻译是在我们的[Crowdin项目](https://crowdin.com/project/gitea)上众包进行的 +我们当前的翻译是在我们的[Crowdin 项目](https://crowdin.com/project/gitea)上众包进行的 -无论您想要更改翻译还是添加新的翻译，都需要在Crowdin集成中进行，因为所有翻译都会被CI覆盖。 +无论您想要更改翻译还是添加新的翻译，都需要在 Crowdin 集成中进行，因为所有翻译都会被 CI 覆盖。 ## 推送钩子/ Webhook / Actions 未运行 @@ -223,15 +223,15 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 这可能是由于以下原因： -1. Git钩子不同步：在站点管理面板上运行“重新同步所有仓库的pre-receive、update和post-receive钩子” -2. Git仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由NAS挂载），请确保文件系统支持`chmod a+x any-script` -3. 如果您使用的是Docker，请确保Docker Server（而不是客户端）的版本 >= 20.10.6 +1. Git 钩子不同步：在站点管理面板上运行“重新同步所有仓库的 pre-receive、update 和 post-receive 钩子” +2. Git 仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由 NAS 挂载），请确保文件系统支持`chmod a+x any-script` +3. 如果您使用的是 Docker，请确保 Docker Server（而不是客户端）的版本 >= 20.10.6 -## SSH问题 +## SSH 问题 如果无法通过`ssh`访问仓库，但`https`正常工作，请考虑以下情况。 -首先，请确保您可以通过SSH访问Gitea。 +首先，请确保您可以通过 SSH 访问 Gitea。 `ssh git@myremote.example` @@ -259,16 +259,18 @@ fatal: Could not read from remote repository. - 在客户端： - 确保公钥和私钥已添加到正确的 Gitea 用户。 - - 确保远程 URL 中没有任何问题。特别是，请确保∂ - Git 用户（@ 之前的部分）的名称拼写正确。 + - 确保远程 URL 中没有任何问题。特别是，请确保 ∂ + Git 用户（@ 之前的部分）的名称拼写正确。 - 确保客户端机器上的公钥和私钥正确无误。 - 在服务器上： + - 确保存储库存在并且命名正确。 - 检查系统用户主目录中的 `.ssh` 目录的权限。 - 验证正确的公钥是否已添加到 `.ssh/authorized_keys` 中。 尝试在 Gitea 管理面板上运行 `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)`。 + - 查看 Gitea 日志。 - 查看 /var/log/auth（或类似的文件）。 - 检查存储库的权限。 @@ -340,7 +342,9 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 - 使用[管理 CLI 命令](../administration/command-line.md#admin)。 请注意，大多数命令还需要一个[全局标志](../administration/command-line.md#全局选项)来指向正确的配置。 + - 作为**用户**，您可以更改密码... + - 在您的账户的`设置 -> 账户`页面（此方法**需要**您知道当前密码）。 - 使用`忘记密码`链接。 @@ -350,7 +354,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 在 Gitea 版本 `1.11` 中，我们转换为使用[goldmark](https://github.com/yuin/goldmark)进行 Markdown 渲染，它符合[CommonMark](https://commonmark.org/)标准。 -如果您在版本`1.11`之前的Markdown正常工作，但在升级后无法正常工作，请仔细阅读CommonMark规范，看看问题是由错误还是非兼容的语法引起的。 +如果您在版本`1.11`之前的 Markdown 正常工作，但在升级后无法正常工作，请仔细阅读 CommonMark 规范，看看问题是由错误还是非兼容的语法引起的。 如果是后者，通常规范中会列出一种符合标准的替代方法。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/support.md index 2d255ea8..90df6718 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/help/support.md @@ -13,4 +13,4 @@ aliases: - 到 [GitHub Issue](https://github.com/go-gitea/gitea/issues) 提问(因为项目维护人员来自世界各地，为保证沟通顺畅，请使用英文提问) - 中文问题到 [Gitea 论坛](https://discourse.gitea.io/c/5-category/5) 提问 - 访问 [Discord Gitea 聊天室 - 英文](https://discord.gg/Gitea) -- 加入 QQ群 328432459 获得进一步的支持 +- 加入 QQ 群 328432459 获得进一步的支持 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/comparison.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/comparison.md index ae9ca785..68d6c795 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/comparison.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/comparison.md @@ -14,68 +14,68 @@ aliases: _表格中的符号含义:_ -* _✓ - 支持_ +- _✓ - 支持_ -* _⁄ - 部分支持_ +- _⁄ - 部分支持_ -* _✘ - 不支持_ +- _✘ - 不支持_ -* _⚙️ - 由第三方服务或插件支持_ +- _⚙️ - 由第三方服务或插件支持_ #### 主要特性 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------- | -------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | -| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | -| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | -| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | -| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | -| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | -| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | -| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | -| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | -| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | -| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | -| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | -| Markdown绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Markdown数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | +| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | +| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | +| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | +| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | +| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | +| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | +| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | +| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | +| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | +| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | +| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | +| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | +| Markdown 绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Markdown 数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | #### 代码管理 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------------ | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | -| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | -| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | -| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | -| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | -| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | -| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | +| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | +| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | +| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | +| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | +| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | +| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | #### 工单管理 @@ -93,7 +93,7 @@ _表格中的符号含义:_ | 工单批处理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单看板 | [✓](https://github.com/go-gitea/gitea/pull/8346) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 从工单创建分支 | ✘ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单全局搜索 | [✘](https://github.com/go-gitea/gitea/issues/2434) | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单依赖关系 | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | @@ -115,7 +115,7 @@ _表格中的符号含义:_ | Pull/Merge requests 模板 | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | | 查看 Cherry-picking 的更改 | [✓](https://github.com/go-gitea/gitea/issues/5158) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 下载 Patch | ✓ | ✘ | ✓ | ✓ | ✓ | [/](https://jira.atlassian.com/plugins/servlet/mobile#issue/BCLOUD-8323) | ✘ | -| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | +| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | #### 第三方集成 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/database-preparation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/database-preparation.md index 91fac649..5926e727 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/database-preparation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/database-preparation.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/database-prep - --- # 数据库准备 @@ -21,149 +20,149 @@ aliases: 1. 对于远程数据库设置，您需要让 MySQL 监听您的 IP 地址。编辑数据库实例上的 `/etc/mysql/my.cnf` 文件中的 `bind-address` 选项为： - ```ini - bind-address = 203.0.113.3 - ``` + ```ini + bind-address = 203.0.113.3 + ``` 2. 在数据库实例上，使用 `root` 用户登录到数据库控制台： - ``` - mysql -u root -p - ``` + ``` + mysql -u root -p + ``` - 按提示输入密码。 + 按提示输入密码。 3. 创建一个将被 Gitea 使用的数据库用户，并使用密码进行身份验证。以下示例中使用了 `'gitea'` 作为密码。请为您的实例使用一个安全密码。 - 对于本地数据库： + 对于本地数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea' IDENTIFIED BY 'gitea'; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; + ``` - 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 + 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 - 根据需要替换上述用户名和密码。 + 根据需要替换上述用户名和密码。 4. 使用 UTF-8 字符集和排序规则创建数据库。确保使用 `**utf8mb4**` 字符集，而不是 `utf8`，因为前者支持 _Basic Multilingual Plane_ 之外的所有 Unicode 字符（包括表情符号）。排序规则根据您预期的内容选择。如果不确定，可以使用 `unicode_ci` 或 `general_ci`。 - ```sql - CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci'; - ``` + ```sql + CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_unicode_ci'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 5. 将数据库上的所有权限授予上述创建的数据库用户。 - 对于本地数据库： + 对于本地数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; + FLUSH PRIVILEGES; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; + FLUSH PRIVILEGES; + ``` 6. 通过 exit 退出数据库控制台。 7. 在您的 Gitea 服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h 203.0.113.3 -p giteadb - ``` + ``` + mysql -u gitea -h 203.0.113.3 -p giteadb + ``` - 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 -h 选项。 + 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 -h 选项。 - 到此您应该能够连接到数据库了。 + 到此您应该能够连接到数据库了。 ## PostgreSQL 1. 对于远程数据库设置，通过编辑数据库实例上的 postgresql.conf 文件中的 listen_addresses 将 PostgreSQL 配置为监听您的 IP 地址： - ```ini - listen_addresses = 'localhost, 203.0.113.3' - ``` + ```ini + listen_addresses = 'localhost, 203.0.113.3' + ``` 2. PostgreSQL 默认使用 `md5` 质询-响应加密方案进行密码身份验证。现在这个方案不再被认为是安全的。改用 SCRAM-SHA-256 方案，通过编辑数据库服务器上的` postgresql.conf` 配置文件： - ```ini - password_encryption = scram-sha-256 - ``` + ```ini + password_encryption = scram-sha-256 + ``` - 重启 PostgreSQL 以应用该设置。 + 重启 PostgreSQL 以应用该设置。 3. 在数据库服务器上，以超级用户身份登录到数据库控制台： - ``` - su -c "psql" - postgres - ``` + ``` + su -c "psql" - postgres + ``` 4. 创建具有登录权限和密码的数据库用户（在 PostgreSQL 术语中称为角色）。请使用安全的、强密码，而不是下面的 `'gitea'`： - ```sql - CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; - ``` + ```sql + CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; + ``` - 根据需要替换用户名和密码。 + 根据需要替换用户名和密码。 5. 使用 UTF-8 字符集创建数据库，并由之前创建的数据库用户拥有。可以根据预期内容使用任何 `libc` 排序规则，使用 `LC_COLLATE` 和 `LC_CTYPE` 参数指定： - ```sql - CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; - ``` + ```sql + CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 6. 通过将以下身份验证规则添加到 `pg_hba.conf`，允许数据库用户访问上面创建的数据库。 - 对于本地数据库： + 对于本地数据库： - ```ini - local giteadb gitea scram-sha-256 - ``` + ```ini + local giteadb gitea scram-sha-256 + ``` - 对于远程数据库： + 对于远程数据库： - ```ini - host giteadb gitea 192.0.2.10/32 scram-sha-256 - ``` + ```ini + host giteadb gitea 192.0.2.10/32 scram-sha-256 + ``` - 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 + 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 - 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 + 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 - 重启 PostgreSQL 以应用新的身份验证规则。 + 重启 PostgreSQL 以应用新的身份验证规则。 7. 在您的 Gitea 服务器上，测试与数据库的连接。 - 对于本地数据库： + 对于本地数据库： - ``` - psql -U gitea -d giteadb - ``` + ``` + psql -U gitea -d giteadb + ``` - 对于远程数据库： + 对于远程数据库： - ``` - psql "postgres://gitea@203.0.113.3/giteadb" - ``` + ``` + psql "postgres://gitea@203.0.113.3/giteadb" + ``` - 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 + 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 - 您应该会被提示输入数据库用户的密码，并连接到数据库。 + 您应该会被提示输入数据库用户的密码，并连接到数据库。 ## 使用 TLS 进行数据库连接 @@ -182,116 +181,116 @@ Gitea 使用的 PostgreSQL 驱动程序支持双向 TLS。在双向 TLS 中， 1. 在数据库实例所在的服务器上，放置以下凭据： - - `/path/to/postgresql.crt`: 数据库实例证书 - - `/path/to/postgresql.key`: 数据库实例私钥 - - `/path/to/root.crt`: 用于验证客户端证书的CA证书链 + - `/path/to/postgresql.crt`: 数据库实例证书 + - `/path/to/postgresql.key`: 数据库实例私钥 + - `/path/to/root.crt`: 用于验证客户端证书的 CA 证书链 2. 在 `postgresql.conf` 中添加以下选项： - ```ini - ssl = on - ssl_ca_file = '/path/to/root.crt' - ssl_cert_file = '/path/to/postgresql.crt' - ssl_key_file = '/path/to/postgresql.key' - ssl_min_protocol_version = 'TLSv1.2' - ``` + ```ini + ssl = on + ssl_ca_file = '/path/to/root.crt' + ssl_cert_file = '/path/to/postgresql.crt' + ssl_key_file = '/path/to/postgresql.key' + ssl_min_protocol_version = 'TLSv1.2' + ``` 3. 根据 PostgreSQL 的要求，调整凭据的所有权和权限： - ``` - chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - ``` + ``` + chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + ``` -4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过SSL连接，并要求客户端证书验证。 +4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过 SSL 连接，并要求客户端证书验证。 - 对于PostgreSQL 12： + 对于 PostgreSQL 12： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full + ``` - 对于PostgreSQL 11及更早版本： + 对于 PostgreSQL 11 及更早版本： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 + ``` - 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 + 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 5. 重新启动 PostgreSQL 以应用上述配置。 6. 在运行 Gitea 实例的服务器上，将以下凭据放置在运行 Gitea 的用户的主目录下（例如 `git`）： - - `~/.postgresql/postgresql.crt`: 数据库客户端证书 - - `~/.postgresql/postgresql.key`: 数据库客户端私钥 - - `~/.postgresql/root.crt`: 用于验证服务器证书的CA证书链 + - `~/.postgresql/postgresql.crt`: 数据库客户端证书 + - `~/.postgresql/postgresql.key`: 数据库客户端私钥 + - `~/.postgresql/root.crt`: 用于验证服务器证书的 CA 证书链 - 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 + 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 7. 根据需要调整凭据、所有权和权限： - ``` - chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - ``` + ``` + chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + ``` 8. 测试与数据库的连接： - ``` - psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" - ``` + ``` + psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" + ``` - 您将被提示输入数据库用户的密码，然后连接到数据库。 + 您将被提示输入数据库用户的密码，然后连接到数据库。 ### MySQL/MariaDB TLS -虽然 Gitea 使用的MySQL驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 +虽然 Gitea 使用的 MySQL 驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 -在单向TLS中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 +在单向 TLS 中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 1. 在数据库实例上放置以下凭据： - - `/path/to/mysql.crt`: 数据库实例证书 - - `/path/to/mysql.key`: 数据库实例密钥 - - `/path/to/ca.crt`: CA证书链。在单向TLS中不使用此文件，但用于验证双向TLS中的客户端证书。 + - `/path/to/mysql.crt`: 数据库实例证书 + - `/path/to/mysql.key`: 数据库实例密钥 + - `/path/to/ca.crt`: CA 证书链。在单向 TLS 中不使用此文件，但用于验证双向 TLS 中的客户端证书。 2. 将以下选项添加到 `my.cnf`： - ```ini - [mysqld] - ssl-ca = /path/to/ca.crt - ssl-cert = /path/to/mysql.crt - ssl-key = /path/to/mysql.key - tls-version = TLSv1.2,TLSv1.3 - ``` + ```ini + [mysqld] + ssl-ca = /path/to/ca.crt + ssl-cert = /path/to/mysql.crt + ssl-key = /path/to/mysql.key + tls-version = TLSv1.2,TLSv1.3 + ``` 3. 调整凭据的所有权和权限： - ``` - chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - ``` + ``` + chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + ``` -4. 重新启动MySQL以应用设置。 +4. 重新启动 MySQL 以应用设置。 5. Gitea 的数据库用户可能已经创建过，但只会对运行 Gitea 的服务器的 IP 地址进行身份验证。要对其域名进行身份验证，请重新创建用户，并设置其需要通过 TLS 连接到数据库： - ```sql - DROP USER 'gitea'@'192.0.2.10'; - CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + DROP USER 'gitea'@'192.0.2.10'; + CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; + FLUSH PRIVILEGES; + ``` - 根据需要替换数据库用户名、密码和 Gitea 实例域名。 + 根据需要替换数据库用户名、密码和 Gitea 实例域名。 -6. 确保用于验证数据库服务器证书的CA证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 +6. 确保用于验证数据库服务器证书的 CA 证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 -7. 在运行Gitea的服务器上，测试与数据库的连接： +7. 在运行 Gitea 的服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h example.db -p --ssl - ``` + ``` + mysql -u gitea -h example.db -p --ssl + ``` - 至此应该成功连接到数据库了。 + 至此应该成功连接到数据库了。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-binary.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-binary.md index 855e8ce4..6d8e1b16 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-binary.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-binary.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/install-from-binary - --- # 使用二进制文件安装 @@ -38,7 +37,7 @@ chmod +x gitea ## 验证 GPG 签名 -Gitea 对打包的二进制文件使用 [GPG密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 +Gitea 对打包的二进制文件使用 [GPG 密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 请根据对应文件名 `.asc` 中包含的校验码检验文件的一致性。 ```sh @@ -169,7 +168,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini **提示：** 我们不建议使用 SIGKILL 信号（`-9`），这会强制停止 Gitea 程序，但不会正确关闭队列、索引器等任务。 -请参阅下面的疑难解答说明，以在Gitea版本更新后修复损坏的仓库。 +请参阅下面的疑难解答说明，以在 Gitea 版本更新后修复损坏的仓库。 ## 排查故障 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-package.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-package.md index 16f26b20..2bf61284 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-package.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-package.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/install-from-package - --- # 官方包管理器 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-source.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-source.md index 91c16081..749d3ee9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-source.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/from-source.md @@ -6,12 +6,11 @@ sidebar_position: 30 aliases: - /zh-cn/install-from-source - --- # 使用源代码安装 -你需要 [安装Go](https://golang.google.cn/doc/install) 并正确设置Go环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 +你需要 [安装 Go](https://golang.google.cn/doc/install) 并正确设置 Go 环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 接下来，[安装 Node.js 和 npm](https://nodejs.org/zh-cn/download/)， 这是构建 JavaScript 和 CSS 文件所需的。最低支持的 Node.js 版本是 @minNodeVersion@，建议使用最新的 LTS 版本。 @@ -36,7 +35,7 @@ git branch -a git checkout @sourceBranch@ ``` -要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID是 `2663 `）： +要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID 是 `2663 `）： ```bash git fetch origin pull/xyz/head:pr-xyz @@ -58,7 +57,7 @@ git checkout @sourceVersion@ # or git checkout pr-xyz - `node` @minNodeVersion@ 或更高版本，并且安装 `npm`, 请参阅 [这里](https://nodejs.org/zh-cn/download/) - `make`, 请参阅 [这里](development/hacking-on-gitea.md) -为了尽可能简化编译过程，提供了各种 [make任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 +为了尽可能简化编译过程，提供了各种 [make 任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 根据你的构建需求，以下 tags 可以使用： @@ -106,7 +105,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite 尽管在开发时这些值很有用，但可能与下游用户的偏好冲突。 -一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行Gitea之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： +一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行 Gitea 之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： - 要设置`CustomPath`，请使用`LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.CustomPath=custom-path\""` - 对于`CustomConf`，应该使用`-X \"code.gitea.io/gitea/modules/setting.CustomConf=conf.ini\"` @@ -122,7 +121,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite `go`编译器工具链支持将代码交叉编译到不同的目标架构上。请参考[`GOOS`和`GOARCH`环境变量](https://golang.org/doc/install/source#environment) 以获取支持的目标列表。如果您想为性能较弱的系统（如树莓派）构建 Gitea，交叉编译非常有用。 -要使用构建标签（`TAGS`）进行交叉编译Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 +要使用构建标签（`TAGS`）进行交叉编译 Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 在没有任何标签的情况下，交叉编译的 Gitea 为 Linux ARM64 版本： @@ -130,7 +129,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite GOOS=linux GOARCH=arm64 make build ``` -要交叉编译 Linux ARM64 下的Gitea，这是推荐的构建标签： +要交叉编译 Linux ARM64 下的 Gitea，这是推荐的构建标签： ``` CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sqlite_unlock_notify" make build diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-cloud-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-cloud-provider.md index a1a52574..9de5c7a0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-cloud-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-cloud-provider.md @@ -6,7 +6,6 @@ sidebar_position: 90 aliases: - /zh-cn/install-on-cloud-provider - --- # 在云服务器上安装 Gitea @@ -18,9 +17,9 @@ Cloudron 使得在您的服务器上运行 Gitea，并保持其更新和安全 [![Install](/cloudron.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp) -Gitea软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). +Gitea 软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). -这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行Gitea。 +这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行 Gitea。 ## Linode diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-kubernetes.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-kubernetes.md index 4a09ff69..fba544ce 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-kubernetes.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/on-kubernetes.md @@ -6,7 +6,6 @@ sidebar_position: 80 aliases: - /zh-cn/install-on-kubernetes - --- # 在 Kubernetes 中安装 Gitea @@ -38,15 +37,15 @@ helm install gitea -f values.yaml gitea/gitea Gitea 附带了一个运行状况检查接口 `/api/healthz`，你可以像这样在 Kubernetes 中配置它： ```yaml - livenessProbe: - httpGet: - path: /api/healthz - port: http - initialDelaySeconds: 200 - timeoutSeconds: 5 - periodSeconds: 10 - successThreshold: 1 - failureThreshold: 10 +livenessProbe: + httpGet: + path: /api/healthz + port: http + initialDelaySeconds: 200 + timeoutSeconds: 5 + periodSeconds: 10 + successThreshold: 1 + failureThreshold: 10 ``` 成功的运行状况检查响应代码为 HTTP `200`，下面是示例： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/upgrade-from-gogs.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/upgrade-from-gogs.md index d38199f4..9bbd1cd9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/upgrade-from-gogs.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/upgrade-from-gogs.md @@ -8,52 +8,52 @@ aliases: # 从 Gogs 升级 -如果你正在运行Gogs 0.9.146以下版本，你可以平滑的升级到Gitea。该升级需要如下的步骤： +如果你正在运行 Gogs 0.9.146 以下版本，你可以平滑的升级到 Gitea。该升级需要如下的步骤： -* 使用 `gogs backup` 创建 Gogs 备份。这会创建一个名为 `gogs-backup-[时间戳].zip` 的文件，其中包含所有重要的 Gogs 数据。如果您将来想要返回到 `gogs`，您会需要这个备份文件。 -* 从 [下载页面](https://dl.gitea.com/gitea/) 下载适用于目标平台的文件。应该选择 `1.0.x` 版本。从 `gogs` 迁移到其他任何版本是不可能的。 -* 将二进制文件放置在所需的安装位置。 -* 将 `gogs/custom/conf/app.ini` 复制到 `gitea/custom/conf/app.ini`。 -* 将 `gogs/custom/` 中的自定义 `templates, public` 复制到 `gitea/custom/`。 -* 对于其他自定义文件夹，例如 `gogs/custom/conf` 中的 `gitignore, label, license, locale, readme`，将它们复制到 `gitea/custom/options`。 -* 将 `gogs/data/` 复制到 `gitea/data/`。其中包含问题附件和头像。 -* 使用 `gitea web` 启动 Gitea 进行验证。 -* 在 UI 上进入 Gitea 管理面板，运行 `Rewrite '.ssh/authorized_keys' file`。 -* 启动每个主要版本的二进制文件（例如 `1.1.4` → `1.2.3` → `1.3.4` → `1.4.2` → 等）以迁移数据库。 -* 如果自定义或配置路径已更改，请运行 `Rewrite all update hook of repositories`。 +- 使用 `gogs backup` 创建 Gogs 备份。这会创建一个名为 `gogs-backup-[时间戳].zip` 的文件，其中包含所有重要的 Gogs 数据。如果您将来想要返回到 `gogs`，您会需要这个备份文件。 +- 从 [下载页面](https://dl.gitea.com/gitea/) 下载适用于目标平台的文件。应该选择 `1.0.x` 版本。从 `gogs` 迁移到其他任何版本是不可能的。 +- 将二进制文件放置在所需的安装位置。 +- 将 `gogs/custom/conf/app.ini` 复制到 `gitea/custom/conf/app.ini`。 +- 将 `gogs/custom/` 中的自定义 `templates, public` 复制到 `gitea/custom/`。 +- 对于其他自定义文件夹，例如 `gogs/custom/conf` 中的 `gitignore, label, license, locale, readme`，将它们复制到 `gitea/custom/options`。 +- 将 `gogs/data/` 复制到 `gitea/data/`。其中包含问题附件和头像。 +- 使用 `gitea web` 启动 Gitea 进行验证。 +- 在 UI 上进入 Gitea 管理面板，运行 `Rewrite '.ssh/authorized_keys' file`。 +- 启动每个主要版本的二进制文件（例如 `1.1.4` → `1.2.3` → `1.3.4` → `1.4.2` → 等）以迁移数据库。 +- 如果自定义或配置路径已更改，请运行 `Rewrite all update hook of repositories`。 ## 更改特定于 Gogs 的信息 -* 将 `gogs-repositories/` 重命名为 `gitea-repositories/` -* 将 `gogs-data/` 重命名为 `gitea-data/` -* 在 `gitea/custom/conf/app.ini` 中进行更改： -从: +- 将 `gogs-repositories/` 重命名为 `gitea-repositories/` +- 将 `gogs-data/` 重命名为 `gitea-data/` +- 在 `gitea/custom/conf/app.ini` 中进行更改： + 从: - ```ini - [database] - PATH = /home/:USER/gogs/data/:DATABASE.db - [attachment] - PATH = /home/:USER/gogs-data/attachments - [picture] - AVATAR_UPLOAD_PATH = /home/:USER/gogs-data/avatars - [log] - ROOT_PATH = /home/:USER/gogs/log - ``` +```ini + [database] + PATH = /home/:USER/gogs/data/:DATABASE.db + [attachment] + PATH = /home/:USER/gogs-data/attachments + [picture] + AVATAR_UPLOAD_PATH = /home/:USER/gogs-data/avatars + [log] + ROOT_PATH = /home/:USER/gogs/log +``` 到: - ```ini - [database] - PATH = /home/:USER/gitea/data/:DATABASE.db - [attachment] - PATH = /home/:USER/gitea-data/attachments - [picture] - AVATAR_UPLOAD_PATH = /home/:USER/gitea-data/avatars - [log] - ROOT_PATH = /home/:USER/gitea/log - ``` +```ini +[database] +PATH = /home/:USER/gitea/data/:DATABASE.db +[attachment] +PATH = /home/:USER/gitea-data/attachments +[picture] +AVATAR_UPLOAD_PATH = /home/:USER/gitea-data/avatars +[log] +ROOT_PATH = /home/:USER/gitea/log +``` -* 使用 `gitea web` 启动 Gitea 进行验证 +- 使用 `gitea web` 启动 Gitea 进行验证 ## 升级到最新版本的 `gitea` @@ -72,7 +72,7 @@ aliases: ## 故障排除 -* 如果在 `gitea/custom/templates` 文件夹中遇到与自定义模板相关的错误，请尝试逐个移除引发错误的模板。 +- 如果在 `gitea/custom/templates` 文件夹中遇到与自定义模板相关的错误，请尝试逐个移除引发错误的模板。 它们可能与 Gitea 或更新不兼容。 ## 将 Gitea 添加到 Unix 的启动项 @@ -81,12 +81,12 @@ aliases: 对于使用 systemd 的发行版： -* 将更新后的脚本复制到 `/etc/systemd/system/gitea.service` -* 使用以下命令将服务添加到启动项：`sudo systemctl enable gitea` -* 禁用旧的 gogs 启动脚本：`sudo systemctl disable gogs` +- 将更新后的脚本复制到 `/etc/systemd/system/gitea.service` +- 使用以下命令将服务添加到启动项：`sudo systemctl enable gitea` +- 禁用旧的 gogs 启动脚本：`sudo systemctl disable gogs` 对于使用 SysVinit 的发行版： -* 将更新后的脚本复制到 `/etc/init.d/gitea` -* 使用以下命令将服务添加到启动项：`sudo rc-update add gitea` -* 禁用旧的 gogs 启动脚本：`sudo rc-update del gogs` +- 将更新后的脚本复制到 `/etc/init.d/gitea` +- 使用以下命令将服务添加到启动项：`sudo rc-update add gitea` +- 禁用旧的 gogs 启动脚本：`sudo rc-update del gogs` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/windows-service.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/windows-service.md index 3e649a19..dcd8e6ea 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/windows-service.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/windows-service.md @@ -6,7 +6,6 @@ sidebar_position: 50 aliases: - /zh-cn/windows-service - --- # 准备工作 @@ -30,9 +29,9 @@ COMPUTERNAME 是从命令行中运行 `echo %COMPUTERNAME%` 后得到的响应 PATH = c:/gitea/data/gitea.db ``` -# 注册为Windows服务 +# 注册为 Windows 服务 -要注册为Windows服务，首先以Administrator身份运行 `cmd`，然后执行以下命令： +要注册为 Windows 服务，首先以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\"" @@ -40,7 +39,7 @@ sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \" 别忘了将 `C:\gitea` 替换成你的 Gitea 安装目录。 -之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000是默认端口）。 +之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000 是默认端口）。 ## 添加启动依赖项 @@ -52,9 +51,9 @@ sc.exe config gitea depend= mariadb 这将确保在 Windows 计算机重新启动时，将延迟自动启动 Gitea，直到数据库准备就绪，从而减少启动失败的情况。 -## 从Windows服务中删除 +## 从 Windows 服务中删除 -以Administrator身份运行 `cmd`，然后执行以下命令： +以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc.exe delete gitea diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker-rootless.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker-rootless.md index 1dcd2d6b..be04d7e4 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker-rootless.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker-rootless.md @@ -45,7 +45,7 @@ services: - "2222:2222" ``` -请注意，卷应由在配置文件中指定的UID/GID的用户/组所有。默认情况下，Docker中的Gitea将使用uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： +请注意，卷应由在配置文件中指定的 UID/GID 的用户/组所有。默认情况下，Docker 中的 Gitea 将使用 uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： ```sh sudo chown 1000:1000 config/ data/ @@ -53,11 +53,11 @@ sudo chown 1000:1000 config/ data/ > 如果未为卷设置正确的权限，容器可能无法启动。 -对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 +对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x 是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 ## 自定义端口 -要将集成的SSH和Web服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 +要将集成的 SSH 和 Web 服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 ```diff version: "2" @@ -258,7 +258,7 @@ docker-compose up -d 除了上述的环境变量外，`app.ini` 中的任何设置都可以通过形式为 `GITEA__SECTION_NAME__KEY_NAME` 的环境变量进行设置或覆盖。这些设置在每次 Docker 容器启动时都会生效。完整信息请参考[这里](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini). -这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA__mailer__FROM、GITEA__mailer__HOST、GITEA__mailer__PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： +这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA**mailer**FROM、GITEA**mailer**HOST、GITEA**mailer**PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： ```bash ... diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker.md index 0cd5e6b3..3a9938ed 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/installation/with-docker.md @@ -6,7 +6,6 @@ sidebar_position: 70 aliases: - /zh-cn/install-with-docker - --- # 使用 Docker 安装 @@ -299,7 +298,7 @@ docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKE ``` ```yaml -... +--- services: server: environment: diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/agit-support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/agit-support.md index 15ad451a..8db4ba09 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/agit-support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/agit-support.md @@ -6,7 +6,6 @@ sidebar_position: 12 aliases: - /zh-cn/agit-setup - --- # AGit 设置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/clone-filter.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/clone-filter.md index f14b0375..90b6709c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/clone-filter.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/clone-filter.md @@ -5,7 +5,6 @@ slug: "clone-filters" sidebar_position: 25 aliases: - /zh-cn/clone-filters - --- # 克隆过滤器 (部分克隆) diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/incoming-email.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/incoming-email.md index 4ae55422..c91d1ae9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/incoming-email.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/incoming-email.md @@ -5,7 +5,6 @@ slug: "incoming-email" sidebar_position: 13 aliases: - /zh-cn/incoming-email - --- # 邮件接收 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/issue-pull-request-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/issue-pull-request-templates.md index 69a8b416..8e1f3905 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/issue-pull-request-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/issue-pull-request-templates.md @@ -100,16 +100,13 @@ Gitea 支持两种格式的模板：Markdown 和 YAML。 ```md --- - name: "Template Name" about: "This template is for testing!" title: "[TEST] " ref: "main" labels: - -- bug -- "help needed" - + - bug + - "help needed" --- This is the template! diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/linked-references.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/linked-references.md index 8648e403..fcd81851 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/linked-references.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/linked-references.md @@ -90,11 +90,11 @@ aliases: - `m` - 分钟 - `h` - 小时 -- `d` - 天（相当于8小时） -- `w` - 周（相当于5天） -- `mo` - 月（相当于4周） +- `d` - 天（相当于 8 小时） +- `w` - 周（相当于 5 天） +- `mo` - 月（相当于 4 周） -用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示1小时10分钟。 +用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示 1 小时 10 分钟。 提交消息示例： @@ -115,26 +115,26 @@ Gitea 支持使用外部工单跟踪器，并可以在合并请求中创建对 下表说明了工单和合并请求的不同类型的交叉引用。在示例中，`User1/Repo1` 指的是使用引用的仓库，而 `UserZ/RepoZ` 表示另一个仓库。 -| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | -| ----------------------- | :-------------------: | :-------------------: | ------------------------------------------------ | -| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | -| **字母数字工单编号:** | - | - | - | -| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | +| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | +| ----------------------- | :------------------: | :------------------: | --------------------------------------------- | +| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | +| **字母数字工单编号:** | - | - | - | +| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | _最后一部分适用于使用字母数字格式的外部工单跟踪器的仓库。_ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/merge-message-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/merge-message-templates.md index ce141199..5447ff25 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/merge-message-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/merge-message-templates.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/merge-message-templates - --- # 合并消息模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/permissions.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/permissions.md index edd0dd06..f45ba047 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/permissions.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/permissions.md @@ -6,7 +6,6 @@ sidebar_position: 14 aliases: - /zh-cn/permissions - --- # 权限 @@ -17,35 +16,35 @@ Gitea 支持对仓库进行权限管理，这样您就可以为不同的人员 在 Gitea 中，我们将仓库的子模块称为 `单元（Unit）`。现在我们有以下几个单元。 -| 名称 | 描述 | 权限 | -| ----------------- | --------------------------------------------------- | ------------ | -| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | -| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | -| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | -| 发布 | 跟踪项目版本和下载。 | 读取 写入 | -| 百科 | 与协作者编写和共享文档。 | 读取 写入 | -| 外部百科 | 链接到外部维基。 | 读取 | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | -| 项目 | 模板仓库的 URL。 | 读取 写入 | -| 包 | 链接到仓库 | 读取 写入 | -| Actions | 审查Actions日志或重启/取消工作流 | 读取 写入 | -| 设置 | 管理仓库。 | 管理员 | +| 名称 | 描述 | 权限 | +| -------------- | ---------------------------------- | --------- | +| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | +| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | +| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | +| 发布 | 跟踪项目版本和下载。 | 读取 写入 | +| 百科 | 与协作者编写和共享文档。 | 读取 写入 | +| 外部百科 | 链接到外部维基。 | 读取 | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | +| 项目 | 模板仓库的 URL。 | 读取 写入 | +| 包 | 链接到仓库 | 读取 写入 | +| Actions | 审查 Actions 日志或重启/取消工作流 | 读取 写入 | +| 设置 | 管理仓库。 | 管理员 | 通过不同的权限，用户可以在这些单元上执行不同的操作。 -| 名称 | 读取 | 写入 | 管理员 | -| ----------------- | -------------------------------------------------- | ------------------------------ | ------------------------- | -| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | -| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | -| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | -| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | -| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | -| 外部百科 | 链接到外部百科。 | - | - | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | -| 项目 | 查看面板。 | 在面板之间移动工单。 | - | -| 包 | 查看包 | 上传/删除包 | - | -| Actions | 查看 Actions日志 | 同意 / 取消 / 重启 | - | -| 设置 | - | - | 管理仓库 | +| 名称 | 读取 | 写入 | 管理员 | +| -------------- | -------------------------------- | ------------------------------ | -------- | +| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | +| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | +| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | +| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | +| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | +| 外部百科 | 链接到外部百科。 | - | - | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | +| 项目 | 查看面板。 | 在面板之间移动工单。 | - | +| 包 | 查看包 | 上传/删除包 | - | +| Actions | 查看 Actions 日志 | 同意 / 取消 / 重启 | - | +| 设置 | - | - | 管理仓库 | 个人仓库和组织仓库之间的权限存在一些差异。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/protected-tags.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/protected-tags.md index e7467a40..3dbc6833 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/protected-tags.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/protected-tags.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/protected-tags - --- # 受保护的标签 @@ -28,17 +27,17 @@ aliases: 示例： -| 类型 | 模式受保护的标签 | 可能匹配的标签 | +| 类型 | 模式受保护的标签 | 可能匹配的标签 | | ----- | ------------------------ | --------------------------------------- | | Glob | `v*` | `v`，`v-1`，`version2` | -| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | +| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | | Glob | `*-release` | `2.1-release`，`final-release` | | Glob | `gitea` | 仅限 `gitea` | | Glob | `*gitea*` | `gitea`，`2.1-gitea`，`1_gitea-release` | | Glob | `{v,rel}-*` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Glob | `*` | 匹配所有可能的标签名称 | +| Glob | `*` | 匹配所有可能的标签名称 | | Regex | `/\Av/` | `v`，`v-1`，`version2` | -| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | +| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | | Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`，`v2.1.0` | | Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`，`v2.1`，`v1.2.34` | | Regex | `/-release\z/` | `2.1-release`，`final-release` | @@ -46,4 +45,4 @@ aliases: | Regex | `/\Agitea\z/` | 仅限 `gitea` | | Regex | `/^gitea$/` | 仅限 `gitea` | | Regex | `/\A(v\|rel)-/` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Regex | `/.+/` | 匹配所有可能的标签名称 | +| Regex | `/.+/` | 匹配所有可能的标签名称 | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/pull-request.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/pull-request.md index 6fe38f58..3546f719 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/pull-request.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/pull-request.md @@ -6,7 +6,6 @@ sidebar_position: 13 aliases: - /zh-cn/pull-request - --- # 合并请求 @@ -20,15 +19,15 @@ aliases: 要创建合并请求，您需要遵循以下步骤： 1. **Fork 仓库** - 如果您没有直接对仓库进行更改的权限，您需要将仓库 fork 到您自己的账户中。 -这将创建一个您可以对其进行更改的仓库副本。 + 这将创建一个您可以对其进行更改的仓库副本。 2. **创建分支（可选）** - 在 fork 的仓库中创建一个新分支，该分支包含您要提出的更改。 -给分支取一个描述性的名称，以指示更改的内容。 + 给分支取一个描述性的名称，以指示更改的内容。 3. **进行更改** - 进行您想要的更改，提交并将其推送到 fork 的仓库中。 4. **创建合并请求** - 转到原始仓库并转到“合并请求”选项卡。单击“新建合并请求”按钮，并将您的新分支选择为源分支。 -为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 + 为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 ## 评审合并请求 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/repo-mirror.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/repo-mirror.md index de66d67a..8827acf7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/repo-mirror.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/repo-mirror.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/repo-mirror - --- # 仓库镜像 @@ -56,7 +55,7 @@ aliases: 要从 Gitea 设置镜像到 GitHub，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *public_repo* 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 +1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同，GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史，您也可以使用现有的远程仓库。 3. 在您的 Gitea 仓库设置中，填写**Git 远程仓库 URL**：`https://github.com//.git`。 4. 使用您的 GitHub 用户名填写**授权**字段，并将个人访问令牌作为**密码**。 @@ -69,7 +68,7 @@ aliases: 要从 Gitea 设置镜像到 GitLab，您需要按照以下步骤进行操作： -1. 创建具有 *write_repository* 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 +1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 2. 填写**Git 远程仓库 URL**：`https:////.git`。 3. 在**授权**字段中填写 `oauth2` 作为**用户名**，并将您的 GitLab 个人访问令牌作为**密码**。 4. 选择**添加推送镜像**以保存配置。 @@ -80,7 +79,7 @@ aliases: 要从 Gitea 设置镜像到 Bitbucket，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *Repository Write* 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 +1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 2. 填写**Git 远程仓库 URL**：`https://bitbucket.org//.git`。 3. 使用您的 Bitbucket 用户名填写**授权**字段，并将应用密码作为**密码**。 4. 选择**添加推送镜像**以保存配置。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/template-repositories.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/template-repositories.md index 543e3260..9108a2c7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/template-repositories.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/template-repositories.md @@ -6,7 +6,6 @@ sidebar_position: 14 aliases: - /zh-cn/template-repositories - --- # 模板仓库 @@ -45,20 +44,20 @@ a/b/c/d.json 所有变量都必须采用`$VAR`或`${VAR}`的形式。要转义扩展，使用双重`$$`，例如`$$VAR`或`$${VAR}`。 -| 变量 | 扩展为 | 可转换 | -| -------------------- | --------------------------------------------------- | ------------- | -| REPO_NAME | 生成的仓库名称 | ✓ | -| TEMPLATE_NAME | 模板仓库名称 | ✓ | -| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | -| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | -| REPO_OWNER | 生成的仓库所有者 | ✓ | -| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | -| REPO_LINK | 生成的仓库链接 | ✘ | -| TEMPLATE_LINK | 模板仓库链接 | ✘ | -| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | -| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | -| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | -| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | +| 变量 | 扩展为 | 可转换 | +| -------------------- | ----------------------------- | ------ | +| REPO_NAME | 生成的仓库名称 | ✓ | +| TEMPLATE_NAME | 模板仓库名称 | ✓ | +| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | +| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | +| REPO_OWNER | 生成的仓库所有者 | ✓ | +| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | +| REPO_LINK | 生成的仓库链接 | ✘ | +| TEMPLATE_LINK | 模板仓库链接 | ✘ | +| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | +| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | +| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | +| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | ## 转换器 :robot: @@ -68,12 +67,12 @@ Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。 将 `go-sdk` 传递给可用的转换器的效果如下... -| 转换器 | 效果 | -| ----------- | ------------ | -| SNAKE | go_sdk | -| KEBAB | go-sdk | -| CAMEL | goSdk | -| PASCAL | GoSdk | -| LOWER | go-sdk | -| UPPER | GO-SDK | -| TITLE | Go-Sdk | +| 转换器 | 效果 | +| ------ | ------ | +| SNAKE | go_sdk | +| KEBAB | go-sdk | +| CAMEL | goSdk | +| PASCAL | GoSdk | +| LOWER | go-sdk | +| UPPER | GO-SDK | +| TITLE | Go-Sdk | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/webhooks.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/webhooks.md index 71bc36ea..fc7ddb50 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/webhooks.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.21/usage/webhooks.md @@ -6,12 +6,11 @@ sidebar_position: 30 aliases: - /zh-cn/webhooks - --- # Webhooks -Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks还可以基于组织和整个系统进行配置。 +Gitea 支持用于仓库事件的 Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks 还可以基于组织和整个系统进行配置。 所有事件推送都是 POST 请求。目前支持： - Gitea (也可以是 GET 请求) @@ -29,7 +28,7 @@ Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置 **警告**：自 Gitea 1.13.0 版起，payload 中的 `secret` 字段已被弃用，并将在 1.14.0 版中移除：https://github.com/go-gitea/gitea/issues/11755 -以下是 Gitea 将发送给 payload URL的事件信息示例： +以下是 Gitea 将发送给 payload URL 的事件信息示例： ```http X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473 @@ -185,4 +184,4 @@ if (json_last_error() !== JSON_ERROR_NONE) { ### 授权头（Authorization header） -**从1.19版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 +**从 1.19 版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/authentication.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/authentication.md index 58d3bdf3..dd297fe1 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/authentication.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/authentication.md @@ -6,14 +6,13 @@ sidebar_position: 10 aliases: - /zh-cn/authentication - --- # 认证 ## 轻量级目录访问协议（Lightweight Directory Access Protocol，LDAP） -通过BindDN的LDAP和简单认证方式LDAP共享以下字段: +通过 BindDN 的 LDAP 和简单认证方式 LDAP 共享以下字段: - 认证名称 **(必选)** @@ -30,48 +29,52 @@ aliases: - 例如: LDAP `389`/ LDAPs `636` - 安全协议 (可选) - - 连接LDAP服务器时是否使用TLS协议。 + + - 连接 LDAP 服务器时是否使用 TLS 协议。 - 管理员过滤规则 (可选) - - 一个LDAP过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 + + - 一个 LDAP 过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 - 示例:`(objectClass=adminAccount)` - - 适用于Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` + - 适用于 Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` - 用户名属性（可选） - - 用户LDAP记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的Gitea账户用户名。若留空，则使用登录表单上提供的用户名。 - - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于Gitea账户名称，请参阅"用户过滤器"。 + - 用户 LDAP 记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的 Gitea 账户用户名。若留空，则使用登录表单上提供的用户名。 + - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于 Gitea 账户名称，请参阅"用户过滤器"。 - 示例:uid - - 适用于Microsoft Active Directory（AD）的示例:`sAMAccountName` + - 适用于 Microsoft Active Directory（AD）的示例:`sAMAccountName` - 名字属性（可选） - - 用户LDAP记录中包含用户名字的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户名字的属性。将用于填充他们的账户信息。 - 示例:givenName + - 姓氏属性（可选） - - 用户LDAP记录中包含用户姓氏的属性。将用于填充他们的账户信息。 + + - 用户 LDAP 记录中包含用户姓氏的属性。将用于填充他们的账户信息。 - 示例:`sn` - 电子邮件属性 **(必选)** - - 用户LDAP记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 - 示例:`mail` ### LDAP(via BindDN) 需要额外设置以下字段: -- 绑定DN (可选) +- 绑定 DN (可选) - - 搜索用户时绑定到LDAP服务器的DN。这可以留空以执行匿名搜索。 + - 搜索用户时绑定到 LDAP 服务器的 DN。这可以留空以执行匿名搜索。 - 示例: `cn=Search,dc=mydomain,dc=com` - 绑定密码 (可选) - - 上述指定的Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用SECRET_KEY进行加密存储。仍然建议确保Bind DN具有尽可能少的权限。 + - 上述指定的 Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用 SECRET_KEY 进行加密存储。仍然建议确保 Bind DN 具有尽可能少的权限。 - 用户搜索基准 **(必选)** - - 这是用于搜索用户帐户的LDAP基础路径. + - 这是用于搜索用户帐户的 LDAP 基础路径. - 示例: `ou=Users,dc=mydomain,dc=com` - 用户过滤规则 **(必选)** @@ -82,19 +85,19 @@ aliases: - 如需多次替换，应使用 `%[1]s`，例如在将提供的登录名与多个属性（如用户标识符、电子邮件甚至电话号码）进行匹配时。 - 示例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` - 启用用户同步 - - 这个选项启用了一个周期性任务，用于将Gitea用户与LDAP服务器进行同步。默认的同步周期是每24小时， - 但您可以在app.ini文件中进行更改。 + - 这个选项启用了一个周期性任务，用于将 Gitea 用户与 LDAP 服务器进行同步。默认的同步周期是每 24 小时， + 但您可以在 app.ini 文件中进行更改。 有关此部分的详细说明，请参阅[sample app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) - 的_cron.sync_external_users_ 部分的注释。前面提到的_User Search Base_和_User Filter_ - 设置将限制哪些用户可以使用Gitea以及哪些用户将被同步。 - 在初始运行任务时，将根据给定的设置创建所有与LDAP匹配的用户，因此在使用大型企业LDAP目录时需要小心。 + 的*cron.sync_external_users* 部分的注释。前面提到的*User Search Base*和*User Filter* + 设置将限制哪些用户可以使用 Gitea 以及哪些用户将被同步。 + 在初始运行任务时，将根据给定的设置创建所有与 LDAP 匹配的用户，因此在使用大型企业 LDAP 目录时需要小心。 ### LDAP(simple auth) 需要额外设置以下字段: -- 用户DN **(必选)** +- 用户 DN **(必选)** - 用作用户 DN 的模板。匹配参数 `%s` 将替换为登录表单中的登录名。 - 示例: `cn=%s,ou=Users,dc=mydomain,dc=com` @@ -111,11 +114,12 @@ aliases: - 示例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` -### 使用LDAP验证分组成员 +### 使用 LDAP 验证分组成员 使用以下字段: -- 群组搜索基础DN(可选) +- 群组搜索基础 DN(可选) + - 组使用的 LDAP DN。 - 示例: `ou=group,dc=mydomain,dc=com` @@ -135,43 +139,46 @@ aliases: ## 可插拔式认证模块(Pluggable Authentication Module,PAM) -这个过程启用了PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 -PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加到当前数据库中。为了与普通的Linux密码一起使用， -运行Gitea的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 +这个过程启用了 PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 +PAM 提供了一种机制，通过对用户进行 PAM 认证来自动将其添加到当前数据库中。为了与普通的 Linux 密码一起使用， +运行 Gitea 的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 -**注意**:如果用户已将SSH公钥添加到Gitea中，使用这些密钥可能会绕过登录检查系统。因此， -如果您希望禁用使用PAM进行身份验证的用户，应该在Gitea中手动禁用该账户，使用内置的用户管理功能。 +**注意**:如果用户已将 SSH 公钥添加到 Gitea 中，使用这些密钥可能会绕过登录检查系统。因此， +如果您希望禁用使用 PAM 进行身份验证的用户，应该在 Gitea 中手动禁用该账户，使用内置的用户管理功能。 1. 配置和安装准备. - - 建议您创建一个管理用户. - - 建议取消自动注册. + - 建议您创建一个管理用户. + - 建议取消自动注册. 1. 一旦数据库已初始化完成，使用新创建的管理员账户登录. 1. 导航至用户设置（右上角的图标），然后选择 -`Site Administration` -> `Authentication Sources`, 并选择 -`Add Authentication Source`. + `Site Administration` -> `Authentication Sources`, 并选择 + `Add Authentication Source`. 1. 填写字段如下: - - 认证类型:`PAM`。 - - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 - - PAM服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 - - PAM电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为gituse的用户， - 并且将此字段设置为mail.com，那么Gitea在验证一个GIT实例的用户时将期望user emai字段为gituser@mail.com[^2]。 + - 认证类型:`PAM`。 + - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 + - PAM 服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 + - PAM 电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为 gituse 的用户， + 并且将此字段设置为 mail.com，那么 Gitea 在验证一个 GIT 实例的用户时将期望 user emai 字段为gituser@mail.com[^2]。 **Note**: PAM 支持通过[build-time flags](installation/from-source.md#build)添加, -而官方提供的二进制文件通常不会默认启用此功能。PAM需要确保系统上有必要的libpam动态库，并且编译器可以访问必要的PAM开发头文件。 +而官方提供的二进制文件通常不会默认启用此功能。PAM 需要确保系统上有必要的 libpam 动态库，并且编译器可以访问必要的 PAM 开发头文件。 -[^1]: 例如，在Debian "Bullseye"上使用标准Linux登录，可以使用`common-session-noninteractive`。这个值对于其他版本的Debian， -包括Ubuntu和Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 +[^1]: + 例如，在 Debian "Bullseye"上使用标准 Linux 登录，可以使用`common-session-noninteractive`。这个值对于其他版本的 Debian， + 包括 Ubuntu 和 Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 -[^2]: **PAM的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到Gitea的Web界面。 +[^2]: **PAM 的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到 Gitea 的 Web 界面。 ## 简单邮件传输协议(Simple Mail Transfer Protocol,SMTP) 此选项允许 Gitea 以 Gitea 用户身份登录 SMTP 主机。请设置以下字段: - 身份验证名称 **(必选)** + - 分配给新授权方法的名称 - SMTP 验证类型 **(必选)** + - 用于连接 SMTP 主机的验证类型，plain 或 login - 主机名 **(必选)** @@ -191,7 +198,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 示例: `gitea.com,mydomain.com,mydomain2.com` - 强制使用 SMTPS - - 默认情况下将使用SMTPS连接到端口465.如果您希望将smtp用于其他端口，自行设置 + - 默认情况下将使用 SMTPS 连接到端口 465.如果您希望将 smtp 用于其他端口，自行设置 - 否则，如果服务器提供' STARTTLS '扩展名，则将使用此扩展名 - 跳过 TLS 验证 - 禁用 TLS 验证身份. @@ -202,7 +209,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 要使用 FreeIPA 凭据登录 Gitea，需要为 Gitea 创建一个绑定帐户。 创建一个绑定帐户: -- 在FreeIPA服务器上创建一个gitea.ldif文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 +- 在 FreeIPA 服务器上创建一个 gitea.ldif 文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 ```sh dn: uid=gitea,cn=sysaccounts,cn=etc,dc=example,dc=com @@ -215,33 +222,33 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 nsIdleTimeout: 0 ``` -- 导入LDIF文件（如果需要，请将localhost更改为IPA服务器）。系统会提示您输入Directory Manager的密码。: +- 导入 LDIF 文件（如果需要，请将 localhost 更改为 IPA 服务器）。系统会提示您输入 Directory Manager 的密码。: ```sh ldapmodify -h localhost -p 389 -x -D \ "cn=Directory Manager" -W -f gitea.ldif ``` -- 为`gitea_users`添加IPA组: +- 为`gitea_users`添加 IPA 组: ```sh ipa group-add --desc="Gitea Users" gitea_users ``` -- **提示**:对于IPA凭证错误，运行' kinit admin '并提供域管理帐户密码. -- 以管理员身份登录Gitea，点击Admin Panel下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 +- **提示**:对于 IPA 凭证错误，运行' kinit admin '并提供域管理帐户密码. +- 以管理员身份登录 Gitea，点击 Admin Panel 下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 ## SPNEGO with SSPI (Kerberos/NTLM, for Windows only) -Gitea支持通过Windows内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现SPNEGO单点登录认证（由RFC4559定义的方案），用于服务器的Web部分。SSPI仅在Windows环境中工作，即当服务器和客户端都在Windows操作系统上运行时。 +Gitea 支持通过 Windows 内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现 SPNEGO 单点登录认证（由 RFC4559 定义的方案），用于服务器的 Web 部分。SSPI 仅在 Windows 环境中工作，即当服务器和客户端都在 Windows 操作系统上运行时。 -在激活SSPI单点登录认证（SSO）之前，您需要准备您的环境: +在激活 SSPI 单点登录认证（SSO）之前，您需要准备您的环境: -- 在Active Directory中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在domain.local域下创建一个名为user的账户: -- 为运行gitea.exe的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为HTTP: +- 在 Active Directory 中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在 domain.local 域下创建一个名为 user 的账户: +- 为运行 gitea.exe 的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为 HTTP: - 以特权域用户（例如域管理员）的身份启动“命令提示符”或“PowerShell”。 - - 运行下面的命令，将host.domain.local替换为Web应用程序将运行的服务器的完全限定域名（FQDN），将domain\user替换为在前一步中创建的账户名称: + - 运行下面的命令，将 host.domain.local 替换为 Web 应用程序将运行的服务器的完全限定域名（FQDN），将 domain\user 替换为在前一步中创建的账户名称: ```sh setspn -A HTTP/host.domain.local domain\user @@ -250,22 +257,22 @@ Gitea支持通过Windows内置的安全支持提供程序接口（Security Suppo 在遵循上述步骤之前，请确保您按照以下流程进行操作: 1. 用之前创建的用户登录（如果已经登录，请先注销）。 -2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为Web应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 -3. 启动Web服务器（运行 `gitea.exe web`）。 -4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用SSPI认证。 +2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为 Web 应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 +3. 启动 Web 服务器（运行 `gitea.exe web`）。 +4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用 SSPI 认证。 5. 在域中的客户端计算机上，使用任何域用户登录（与运行`gitea.exe`的服务器不同）。 -6. 如果您使用Chrome或Edge浏览器，请将Web应用程序的URL添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 -7. 启动Chrome或Edge浏览器，导航到Gitea的FQDN URL（例如，`http://host.domain.local:3000`）。 -8. 在控制面板中点击“Sign In”按钮，然后选择SSPI，将会自动使用当前登录到计算机的用户进行登录。 +6. 如果您使用 Chrome 或 Edge 浏览器，请将 Web 应用程序的 URL 添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 +7. 启动 Chrome 或 Edge 浏览器，导航到 Gitea 的 FQDN URL（例如，`http://host.domain.local:3000`）。 +8. 在控制面板中点击“Sign In”按钮，然后选择 SSPI，将会自动使用当前登录到计算机的用户进行登录。 9. 如果无法正常工作，请确保: - - 您不是在运行`gitea.exe`的同一台服务器上运行Web浏览器。应该在与服务器不同的域加入计算机（客户端）上运行Web浏览器。如果客户端和服务器都在同一台计算机上运行，则NTLM将优先于Kerberos。 - - 主机上只有一个`HTTP/...`的SPN。 - - SPN中只包含主机名，不包含端口号。 - - 将Web应用程序的URL添加到"本地站点"。 - - 服务器和客户端的时钟差异不超过5分钟（取决于组策略）。 - - 在Internet Explorer中启用了"集成Windows身份验证"（在"高级设置"下）。 + - 您不是在运行`gitea.exe`的同一台服务器上运行 Web 浏览器。应该在与服务器不同的域加入计算机（客户端）上运行 Web 浏览器。如果客户端和服务器都在同一台计算机上运行，则 NTLM 将优先于 Kerberos。 + - 主机上只有一个`HTTP/...`的 SPN。 + - SPN 中只包含主机名，不包含端口号。 + - 将 Web 应用程序的 URL 添加到"本地站点"。 + - 服务器和客户端的时钟差异不超过 5 分钟（取决于组策略）。 + - 在 Internet Explorer 中启用了"集成 Windows 身份验证"（在"高级设置"下）。 -遵循这些步骤，您应该能够成功启用和使用SSPI单点登录认证（SSO）。 +遵循这些步骤，您应该能够成功启用和使用 SSPI 单点登录认证（SSO）。 ## 反向代理认证 @@ -282,7 +289,7 @@ ENABLE_REVERSE_PROXY_AUTHENTICATION = true 如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`，则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取，这样在自动创建用户时将使用这个字段作为用户全名，你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 -你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的IP地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 +你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 你可以通过以下配置为 API 启用此认证方法： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/backup-and-restore.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/backup-and-restore.md index 9c2736e3..717da330 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/backup-and-restore.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/backup-and-restore.md @@ -6,12 +6,11 @@ sidebar_position: 11 aliases: - /zh-cn/backup-and-restore - --- # 备份与恢复 -Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个zip压缩文件。该压缩文件可以被用来进行数据恢复。 +Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 ## 备份一致性 @@ -21,7 +20,7 @@ Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都 ## 备份命令 (`dump`) -先转到git用户的权限: `su git`. 再Gitea目录运行 `./gitea dump`。一般会显示类似如下的输出： +先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出： ``` 2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 @@ -34,12 +33,12 @@ Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都 最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容： -* `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 -* `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 -* `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 -* `repos/` - 仓库目录的完整副本。 -* `gitea-db.sql` - 数据库dump出来的 SQL。 -* `log/` - Logs文件，如果用作迁移不是必须的。 +- `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 +- `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 +- `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 +- `repos/` - 仓库目录的完整副本。 +- `gitea-db.sql` - 数据库 dump 出来的 SQL。 +- `log/` - Logs 文件，如果用作迁移不是必须的。 中间备份文件将会在临时目录进行创建，如果您要重新指定临时目录，可以用 `--tempdir` 参数，或者用 `TMPDIR` 环境变量。 @@ -54,7 +53,7 @@ mysqldump -u$USER -p$PASS --database $DATABASE > gitea-db.sql pg_dump -U $USER $DATABASE > gitea-db.sql ``` -### 使用Docker （`dump`） +### 使用 Docker （`dump`） 在使用 Docker 时，使用 `dump` 命令有一些注意事项。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/cmd-embedded.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/cmd-embedded.md index 0d1b2de9..ddadaa73 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/cmd-embedded.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/cmd-embedded.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/cmd-embedded - --- # 嵌入资源提取工具 @@ -31,7 +30,7 @@ gitea embedded list [--include-vendored] [patterns...] - 列出所有模板文件，无论在哪个虚拟目录下：`**.tmpl` - 列出所有邮件模板文件：`templates/mail/**.tmpl` -列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` + 列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` 不要忘记为模式使用引号，因为空格、`*` 和其他字符可能对命令行解释器有特殊含义。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/command-line.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/command-line.md index b2de405a..d35f37c2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/command-line.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/command-line.md @@ -59,7 +59,7 @@ aliases: - 选项： - `--email`：要删除的用户的电子邮件。 - `--username`：要删除的用户的用户名。 - - `--id`：要删除的用户的ID。 + - `--id`：要删除的用户的 ID。 - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 - 示例： - `gitea admin user delete --id 1` @@ -168,11 +168,11 @@ aliases: - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 - `--skip-local-2fa`：跳过 2FA 登录。 - `--active`：启用此认证源。 - 备注： - `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： - `--option`、`--option=true` 以启用选项 - `--option=false` 以禁用选项 - 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 - 示例： - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` - `update-smtp`： @@ -281,12 +281,12 @@ aliases: ### cert -生成自签名的SSL证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 - 选项： - - `--host value`：逗号分隔的主机名和IP地址列表，此证书适用于这些主机。支持使用通配符。必填。 - - `--ecdsa-curve value`：用于生成密钥的ECDSA曲线。可选。有效选项为P224、P256、P384、P521。 - - `--rsa-bits value`：要生成的RSA密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 @@ -295,18 +295,18 @@ aliases: ### dump -将所有文件和数据库导出到一个zip文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 - 选项： - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 - `--skip-repository`，`-R`：跳过仓库的导出。可选。 - `--skip-custom-dir`：跳过自定义目录的导出。可选。 - - `--skip-lfs-data`：跳过LFS数据的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 - `--skip-attachment-data`：跳过附件数据的导出。可选。 - `--skip-package-data`：跳过包数据的导出。可选。 - `--skip-log`：跳过日志数据的导出。可选。 - - `--database`，`-d`：指定数据库的SQL语法。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 - `--type`：设置导出的格式。可选。（默认值：zip） - 示例： @@ -399,19 +399,19 @@ gitea doctor recreate-table - 命令: - `shutdown`: 优雅地关闭运行中的进程 - - `restart`: 优雅地重新启动运行中的进程（对于Windows服务器尚未实现） + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） - `flush-queues`: 刷新运行中的进程中的队列 - 选项: - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） - - `--non-blocking`: 设置为true，以在返回之前不等待刷新完成 + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 - `logging`: 调整日志命令 - 命令: - `pause`: 暂停日志记录 - 注意: - - 如果日志级别低于此级别，日志级别将被临时提升为INFO。 - - Gitea将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 - `resume`: 恢复日志记录 - - `release-and-reopen`: 使Gitea释放和重新打开用于日志记录的文件和连接（相当于向Gitea发送SIGUSR1信号）。 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 - `remove name`: 删除指定的日志记录器 - 选项: - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） @@ -427,7 +427,7 @@ gitea doctor recreate-table - `--expression value`, `-e value`: 日志记录器的匹配表达式 - `--prefix value`, `-p value`: 日志记录器的前缀 - `--color`: 在日志中使用颜色 - - `--stderr`: 将控制台日志输出到stderr - 仅适用于控制台 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 - `file`: 添加文件日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" @@ -457,9 +457,9 @@ gitea doctor recreate-table - `--color`: 在日志中使用颜色 - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 - `--reconnect`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix或udp（默认为tcp） + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） - - `smtp`: 添加SMTP日志记录器 + - `smtp`: 添加 SMTP 日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md index 976d83c0..1ad6363b 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/config-cheat-sheet.md @@ -6,13 +6,12 @@ sidebar_position: 30 aliases: - /zh-cn/config-cheat-sheet - --- # 配置说明 -这是针对Gitea配置文件的说明， -你可以了解Gitea的强大配置。 +这是针对 Gitea 配置文件的说明， +你可以了解 Gitea 的强大配置。 需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 如果是从发行版本完成的安装， @@ -23,7 +22,7 @@ aliases: [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。 标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 -在下面的默认值中,`$XYZ`代表环境变量`XYZ`的值(详见:`environment-to-ini`)。 _`XxYyZz`_是指默认配置的一部分列出的值。这些在 app.ini 文件中不起作用，仅在此处列出作为文档说明。 +在下面的默认值中,`$XYZ`代表环境变量`XYZ`的值(详见:`environment-to-ini`)。 *`XxYyZz`*是指默认配置的一部分列出的值。这些在 app.ini 文件中不起作用，仅在此处列出作为文档说明。 包含`#`或者`;`的变量必须使用引号(`` ` ``或者`""""`)包裹，否则会被解析为注释。 @@ -34,68 +33,68 @@ aliases: 这些值取决于环境，但构成了许多值的基础。当运行 `gitea help`或启动时，它们将 作为默认配置的一部分进行报告。它们在那里发出的顺序略有不同，但我们将按照设置的顺序在这里列出。 -- _`AppPath`_: Gitea二进制可执行文件的绝对路径 -- _`AppWorkPath`_: Gitea可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: +- _`AppPath`_: Gitea 二进制可执行文件的绝对路径 +- _`AppWorkPath`_: Gitea 可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: - `app.ini`中的`WORK_PATH`配置项 - - 启动Gitea时的`--work-path`命令行参数 + - 启动 Gitea 时的`--work-path`命令行参数 - `$GITEA_WORK_DIR`环境变量 - 在编译时设置的内置值（参见从源代码编译） - 默认为 _`AppPath`_ 的目录 - 如果上述任何路径为相对路径，将自动解析为相对于 _`AppPath`_ 目录的绝对路径 - _`CustomPath`_: 这是用于自定义模板和其他选项的基础目录。 -它是通过使用以下层次结构中的第一个设置的内容来确定的： + 它是通过使用以下层次结构中的第一个设置的内容来确定的： - 通过传递给二进制文件的`--custom-path`标志 - 环境变量 `$GITEA_CUSTOM` - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`AppWorkPath`_`/custom` - 如果上述任何路径是相对路径，则会相对于 _`AppWorkPath`_ 目录进行处理， - 使其变为绝对路径。 + 使其变为绝对路径。 - _`CustomConf`_: 这是指向`app.ini`文件的路径。 - 这是指向`app.ini`文件的路径。 - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`CustomPath`_`/conf/app.ini` - - 如果上述任何路径是相对路径，则会相对于_`CustomPath`_目录进行处理。 + - 如果上述任何路径是相对路径，则会相对于*`CustomPath`*目录进行处理。 -此外，还有_`StaticRootPath`_，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 +此外，还有*`StaticRootPath`*，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 ## Overall (`DEFAULT`) - `APP_NAME`: **Gitea: Git with a cup of tea** 应用名称，在网页的标题中显示。 -- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行Gitea的用户， +- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行 Gitea 的用户， 应当是一个专用的系统账户(非用户使用，推荐创建一个专用的`git`用户). 如果在你自己的个人电脑使用改成你自己的用户名。 - 该配置如果设置不正确，Gitea可能崩溃。 + 该配置如果设置不正确，Gitea 可能崩溃。 - `RUN_MODE`: **prod**: 应用的运行模式，对运行性能和问题排除有影响: `dev` 或者 `prod`,默认为 `prod`。 `dev`模式有助于开发和问题排查, 除设置为`dev` 外，均被视为 `prod`. - `WORK_PATH`: **_the-work-path_**: 工作目录, 前文有提及. ## 仓库 (`repository`) -- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放git工程的根目录，建议填绝对路径。 +- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放 git 工程的根目录，建议填绝对路径。 相对路径将被解析为**_`AppWorkPath`_/%(ROOT)s**. -- `SCRIPT_TYPE`: **bash**: 服务器支持的Shell类型，通常是`bash`， +- `SCRIPT_TYPE`: **bash**: 服务器支持的 Shell 类型，通常是`bash`， 但有些服务器也有可能是`sh`。 - `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 检测到的字符集的决定性顺序 - 如果检测到的字符集具有相等的置信度，则优先选择列表中较早出现的字符集，而不是较晚出现的字符集。添加“defaults”将会将未命名的字符集放置在该点。 -- `ANSI_CHARSET`: **_empty_**: 默认的ANSI字符集，用于覆盖非UTF-8字符集。 +- `ANSI_CHARSET`: **_empty_**: 默认的 ANSI 字符集，用于覆盖非 UTF-8 字符集。 - `FORCE_PRIVATE`: **false**: 强制使每个新仓库变为私有。 - `DEFAULT_PRIVATE`: **last**: 创建新仓库时默认为私有：`last`, `private`, `public`。 - `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送创建新仓库时默认为私有。 - `MAX_CREATION_LIMIT`: **-1**: 每个用户的全局仓库创建上限, - `-1` 代表无限制. + `-1` 代表无限制. - `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表顶部的指定许可证。 - 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 -- `DISABLE_HTTP_GIT`: **false**: 禁用HTTP协议与仓库进行 - 交互的能力。 -- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的SSH端口时，强制使用ssh://克隆URL， - 而不是scp-style uri。 -- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的URL作为https或ssh， - 默认为https。 + 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 +- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 协议与仓库进行 + 交互的能力。 +- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的 SSH 端口时，强制使用 ssh://克隆 URL， + 而不是 scp-style uri。 +- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的 URL 作为 https 或 ssh， + 默认为 https。 - `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用于 Access-Control-Allow-Origin 标头的值， -默认不提供。 -警告：如果您不提供正确的值，这可能对您的网站造成危害。 -- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 -- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到Gitea，并为用户自动创建它们。 -- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到Gitea，并为组织自动创建它们。 + 默认不提供。 + 警告：如果您不提供正确的值，这可能对您的网站造成危害。 +- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 +- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到 Gitea，并为用户自动创建它们。 +- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到 Gitea，并为组织自动创建它们。 - `DISABLED_REPO_UNITS`: **_empty_**: 逗号分隔的全局禁用的仓库单元列表。允许的值是：: \[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,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部wiki和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 +- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部 wiki 和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 - `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗号分隔的默认分叉仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 - `PREFIX_ARCHIVE_FILES`: **true**: 通过将存档文件放置在以仓库命名的目录中来添加前缀。 - `DISABLE_MIGRATIONS`: **false**: 禁用迁移功能。 @@ -109,15 +108,15 @@ aliases: ### 仓库 - 编辑器 (`repository.editor`) - `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中应该换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件进行换行，只需放置一个逗号。 -- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览API的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 +- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 ### 仓库 - 合并请求 (`repository.pull-request`) - `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取请求标题中用于标记工作正在进行中的前缀列表。 -这些前缀在不区分大小写的情况下进行匹配。 + 这些前缀在不区分大小写的情况下进行匹配。 - `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取请求评论中用于自动关闭相关问题的关键词列表。 - `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取请求评论中用于自动重新打开相关问题的 -关键词列表。 + 关键词列表。 - `DEFAULT_MERGE_STYLE`: **merge**: 设置创建仓库的默认合并方式，可选: `merge`, `rebase`, `rebase-merge`, `squash`, `fast-forward-only` - `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在默认合并消息中，对于`squash`提交，最多包括此数量的提交。设置为 -1 以包括所有提交。 - `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在默认的合并消息中，对于`squash`提交，限制提交消息的大小。设置为 `-1`以取消限制。仅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`为`true`时使用。 @@ -126,18 +125,18 @@ aliases: - `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在默认合并消息中，仅包括官方允许审查的审批者。 - `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在默认的 squash 合并消息中，包括构成拉取请求的所有提交的提交消息。 - `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者与作者不匹配，在合并提交消息中添加`co-authored-by`和`co-committed-by`标记。 -- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 +- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是 1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 ### 仓库 - 工单 (`repository.issue`) - `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合并请求或工单被锁定的原因列表。 -- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为0禁用固定工单。 +- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为 0 禁用固定工单。 ### 仓库 - 文件上传 (`repository.upload`) - `ENABLED`: **true**: 是否启用仓库文件上传。 -- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在Gitea重启的时候该目录会被清空)。 -- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 +- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在 Gitea 重启的时候该目录会被清空)。 +- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime 类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 - `FILE_MAX_SIZE`: **50**: 每个文件的最大大小(MB)。 - `MAX_FILES`: **5**: 每次上传的最大文件数。 @@ -159,10 +158,10 @@ aliases: - 除了 never 和 always 之外的选项可以组合为逗号分隔的列表。 - `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用于验证提交的默认信任模型。 - `collaborator`: 信任协作者密钥签名的签名。 - - `committer`: 信任与提交者匹配的签名（这与GitHub匹配，并会强制Gitea签名的提交具有Gitea作为提交者）。 + - `committer`: 信任与提交者匹配的签名（这与 GitHub 匹配，并会强制 Gitea 签名的提交具有 Gitea 作为提交者）。 - `collaboratorcommitter`: 信任与提交者匹配的协作者密钥签名的签名。 -- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对wiki提交进行签名。 -- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对CRUD操作进行签名。 +- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对 wiki 提交进行签名。 +- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对 CRUD 操作进行签名。 - 与上面相同的选项，增加了： - `parentsigned`: 仅在父提交进行了签名时才进行签名。 - `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 对合并操作进行签名。 @@ -175,7 +174,7 @@ aliases: - `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地仓库副本的路径。默认为 tmp/local-repo（内容在 Gitea 重新启动时被删除） -### 仓库 - MIME type mapping (`repository.mimetype_mapping`) +### 仓库 - MIME type mapping (`repository.mimetype_mapping`) 配置用于根据可下载文件的文件扩展名设置预期的 MIME 类型。配置以键值对的形式呈现，文件扩展名以`.`开头。 @@ -193,7 +192,7 @@ aliases: - `MAX_AGE`: **10m**: 缓存响应的最大时间 - `ALLOW_CREDENTIALS`: **false**: 允许带有凭据的请求 - `HEADERS`: **Content-Type,User-Agent**: 允许请求携带的头部 -- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP头部. +- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP 头部. ## 界面 (`ui`) @@ -202,23 +201,23 @@ aliases: - `MEMBERS_PAGING_NUM`: **20**: 组织成员页面每页显示的成员数量。 - `FEED_MAX_COMMIT_NUM`: **5**: 活动流页面显示的最大提交数量。 - `FEED_PAGING_NUM`: **20**: 活动流页面显示的最大活动数量。 -- `SITEMAP_PAGING_NUM`: **20**: 在单个子SiteMap中显示的项数。 -- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大commit数量。 +- `SITEMAP_PAGING_NUM`: **20**: 在单个子 SiteMap 中显示的项数。 +- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大 commit 数量。 - `CODE_COMMENT_LINES`: **4**: 在代码评论中能够显示的最大代码行数。 -- `DEFAULT_THEME`: **gitea-auto**: 在Gitea安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 +- `DEFAULT_THEME`: **gitea-auto**: 在 Gitea 安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 - `SHOW_USER_EMAIL`: **true**: 用户的电子邮件是否应该显示在`Explore Users`页面中。 -- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， -- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为8MiB）。 +- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， +- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为 8MiB）。 - `REACTIONS`: 用户可以在问题（Issue）、Pull Request（PR）以及评论中选择的所有可选的反应。 - 这些值可以是表情符号别名（例如：:smile:）或Unicode表情符号。 - 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 -- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在utf8标准中定义的额外表情符号。 - 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， - 并将其添加到此配置中。 + 这些值可以是表情符号别名（例如：:smile:）或 Unicode 表情符号。 + 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 +- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。 + 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， + 并将其添加到此配置中。 - `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示用户的全名。如果没有设置全名，则将使用用户名。 - `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的仓库搜索中搜索描述。 - `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字并使用默认排序时，是否仅在探索页面上显示相关的仓库。 - 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 + 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 ### 界面 - 管理员 (`ui.admin`) @@ -246,11 +245,11 @@ aliases: ### 界面 - SVG Images (`ui.svg`) -- `ENABLE_RENDER`: **true**: 是否将SVG文件呈现为图像。如果禁用了SVG渲染，SVG文件将显示为文本，无法作为图像嵌入到Markdown文件中。 +- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈现为图像。如果禁用了 SVG 渲染，SVG 文件将显示为文本，无法作为图像嵌入到 Markdown 文件中。 ### 界面 - CSV Files (`ui.csv`) -- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将CSV文件呈现为表格的最大文件大小（将其设置为0表示没有限制）。 +- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将 CSV 文件呈现为表格的最大文件大小（将其设置为 0 表示没有限制）。 ## Markdown (`markdown`) @@ -260,10 +259,10 @@ aliases: - `ENABLE_HARD_LINE_BREAK_IN_DOCUMENTS`: **false**: 在文档中将软换行符呈现为硬换行符， 这意味着段落之间的单个换行符将导致换行， 并且不需要在段落后添加尾随空格来强制换行。 -- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在Markdown中呈现的附加URL超链接。 - 以http和https开头的URL始终显示。 - 如果此条目为空，则允许所有URL方案。 -- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为Markdown的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为Markdown，请只需放置一个逗号。 +- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在 Markdown 中呈现的附加 URL 超链接。 + 以 http 和 https 开头的 URL 始终显示。 + 如果此条目为空，则允许所有 URL 方案。 +- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为 Markdown，请只需放置一个逗号。 - `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作为数学块的检测。 ## 服务器 (`server`) @@ -275,27 +274,27 @@ aliases: - `PROXY_PROTOCOL_HEADER_TIMEOUT`: **5s**: 等待`PROXY`协议头的超时时间（设置为`0`表示没有超时）。 - `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受带有未知类型的`PROXY`协议头。 - `DOMAIN`: **localhost**: 此服务器的域名。 -- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**: - 覆盖自动生成的公共URL。 - 如果内部URL和外部URL不匹配（例如在Docker中），这很有用。 +- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP_PORT)s/**: + 覆盖自动生成的公共 URL。 + 如果内部 URL 和外部 URL 不匹配（例如在 Docker 中），这很有用。 - `STATIC_URL_PREFIX`: **_empty_**: - 覆盖此选项以从不同的URL请求静态资源。 - 这包括CSS文件、图片、JS文件和Web字体。 - 头像图片是动态资源，仍由Gitea提供。 - 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. - 请求会变成 `%(ROOT_URL)s/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` - 静态文件位于Gitea源代码仓库的`public/`目录中。 - 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 + 覆盖此选项以从不同的 URL 请求静态资源。 + 这包括 CSS 文件、图片、JS 文件和 Web 字体。 + 头像图片是动态资源，仍由 Gitea 提供。 + 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. + 请求会变成 `%(ROOT_URL)s/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` + 静态文件位于 Gitea 源代码仓库的`public/`目录中。 + 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 - `HTTP_ADDR`: **0.0.0.0**: HTTP 监听地址。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 - `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - 如果 `PROTOCOL` 设置为 `http+unix` 或 `fcgi+unix`，则应该是要使用的 Unix 套接字文件的名称。相对路径将相对于 _`AppWorkPath`_ 被转换为绝对路径。 - `HTTP_PORT`: **3000**: HTTP 监听端口。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 `HTTP_ADDR` 和 `HTTP_PORT` - 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的权限。 -- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: +- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: 用于访问网络服务的 Gitea 工作器（例如 SSH 更新）的本地（DMZ）URL。 在大多数情况下，您不需要更改默认值。 仅在您的 SSH 服务器节点与 HTTP 节点不同的情况下才修改它。对于不同的协议，默认值不同。如果 `PROTOCOL` @@ -304,15 +303,15 @@ aliases: `%(PROTOCOL)s://localhost:%(HTTP_PORT)s/`， 否则默认值为 `%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/`。 - `LOCAL_USE_PROXY_PROTOCOL`: **%(USE_PROXY_PROTOCOL)s**: 在进行本地连接时传递 PROXY 协议头。 - 如果本地连接将经过代理，请将其设置为 false。 + 如果本地连接将经过代理，请将其设置为 false。 - `PER_WRITE_TIMEOUT`: **30s**: 连接的任何写操作的超时时间。（将其设置为 -1 以禁用所有超时。） - `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 连接每写入 1 KB 的超时时间。 -- `DISABLE_SSH`: **false**: 当SSH不可用时禁用SSH功能。 -- `START_SSH_SERVER`: **false**: 启用时，使用内置的SSH服务器。 -- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置SSH服务器建立连接时，期望PROXY协议头。 -- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: 用于内置SSH服务器的用户名。 -- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)s**: 在克隆URL中显示的SSH用户名。这仅适用于自行配置SSH服务器的人；在大多数情况下，您希望将其留空并修改`BUILTIN_SSH_SERVER_USER`。 +- `DISABLE_SSH`: **false**: 当 SSH 不可用时禁用 SSH 功能。 +- `START_SSH_SERVER`: **false**: 启用时，使用内置的 SSH 服务器。 +- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置 SSH 服务器建立连接时，期望 PROXY 协议头。 +- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: 用于内置 SSH 服务器的用户名。 +- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)s**: 在克隆 URL 中显示的 SSH 用户名。这仅适用于自行配置 SSH 服务器的人；在大多数情况下，您希望将其留空并修改`BUILTIN_SSH_SERVER_USER`。 - `SSH_DOMAIN`: **%(DOMAIN)s**: 此服务器的域名，用于显示的克隆 URL。 - `SSH_PORT`: **22**: 显示在克隆 URL 中的 SSH 端口。 - `SSH_LISTEN_HOST`: **0.0.0.0**: 内置 SSH 服务器的监听地址。 @@ -405,7 +404,7 @@ aliases: ## 数据库 (`database`) - `DB_TYPE`: **mysql**: 数据库类型 \[mysql, postgres, mssql, sqlite3\]。 -- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或unix套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 +- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或 unix 套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 - `NAME`: **gitea**: 数据库名称。 - `USER`: **root**: 数据库用户名。 - `PASSWD`: **_empty_**: 数据库密码。如果密码包含特殊字符，请使用 \`your password\` 或 """your password"""。 @@ -439,15 +438,15 @@ aliases: ## 索引 (`indexer`) - `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型，当前支持：`bleve`、`db`、`elasticsearch` 或 `meilisearch`。 -- `ISSUE_INDEXER_CONN_STR`：****: 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 +- `ISSUE_INDEXER_CONN_STR`：\*\*\*\*: 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 - `ISSUE_INDEXER_NAME`：**gitea_issues**: 工单索引器名称，在 ISSUE_INDEXER_TYPE 为 elasticsearch 或 meilisearch 时可用。 -- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE_INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 _`AppWorkPath`_ 进行绝对路径化。 +- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE*INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 *`AppWorkPath`\_ 进行绝对路径化。 - `REPO_INDEXER_ENABLED`：**false**: 启用代码搜索（占用大量磁盘空间，约为存储库大小的 6 倍）。 - `REPO_INDEXER_REPO_TYPES`：**sources,forks,mirrors,templates**: 存储库索引器单元。要索引的项目可以是 `sources`、`forks`、`mirrors`、`templates` 或它们的任何组合，用逗号分隔。如果为空，则默认为仅 `sources`，如果要完全禁用，请参见 `REPO_INDEXER_ENABLED`。 - `REPO_INDEXER_TYPE`：**bleve**: 代码搜索引擎类型，可以为 `bleve` 或者 `elasticsearch`。 - `REPO_INDEXER_PATH`：**indexers/repos.bleve**: 用于代码搜索的索引文件。 -- `REPO_INDEXER_CONN_STR`：****: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` +- `REPO_INDEXER_CONN_STR`：\*\*\*\*: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` - `REPO_INDEXER_NAME`：**gitea_codes**: 代码索引器名称，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。 - `REPO_INDEXER_INCLUDE`：**empty**: 逗号分隔的 glob 模式列表（参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob)）以用于**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 扩展名的文件。空列表表示包括所有文件。 @@ -465,8 +464,8 @@ aliases: - `LENGTH`：**100000**: 通道队列阻塞之前的最大队列大小 - `BATCH_LENGTH`：**20**: 在传递给处理程序之前批处理数据 - `CONN_STR`：**redis://127.0.0.1:6379/0**: redis 队列类型的连接字符串。对于 `redis-cluster`，使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查询参数来设置选项。类似地，LevelDB 选项也可以使用：**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 进行设置，并将覆盖 `DATADIR`。 -- `QUEUE_NAME`：**_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 -- `SET_NAME`：**_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `QUEUE_NAME`：**\_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `SET_NAME`：**\_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 - `MAX_WORKERS`：**(dynamic)**: 队列的最大工作协程数。默认值为 "CpuNum/2"，限制在 1 到 10 之间。 Gitea 创建以下非唯一队列： @@ -490,8 +489,8 @@ Gitea 创建以下非唯一队列： - `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: 用户电子邮件通知的默认配置（用户可配置）。选项：enabled、onmention、disabled - `DISABLE_REGULAR_ORG_CREATION`: **false**: 禁止普通（非管理员）用户创建组织。 - `USER_DISABLED_FEATURES`:**_empty_** 禁用的用户特性，当前允许为空或者 `deletion`，`manage_ssh_keys`， `manage_gpg_keys` 未来可以增加更多设置。 - - `deletion`: 用户不能通过界面或者API删除他自己。 - - `manage_ssh_keys`: 用户不能通过界面或者API配置SSH Keys。 + - `deletion`: 用户不能通过界面或者 API 删除他自己。 + - `manage_ssh_keys`: 用户不能通过界面或者 API 配置 SSH Keys。 - `manage_gpg_keys`: 用户不能配置 GPG 密钥。 ## 安全性 (`security`) @@ -500,19 +499,19 @@ Gitea 创建以下非唯一队列： - `SECRET_KEY`: **\<每次安装时随机生成\>**: 全局服务器安全密钥。这个密钥非常重要，如果丢失将无法解密加密的数据（例如 2FA）。 - `SECRET_KEY_URI`: **_empty_**: 与定义 `SECRET_KEY` 不同，此选项可用于使用存储在文件中的密钥（示例值：`file:/etc/gitea/secret_key`）。它不应该像 `SECRET_KEY` 一样容易丢失。 - `LOGIN_REMEMBER_DAYS`: **31**: 在要求重新登录之前，记住用户的登录状态多长时间（以天为单位）。 -- `COOKIE_REMEMBER_NAME`: **gitea\_incredible**: 保存自动登录信息的 Cookie 名称。 +- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自动登录信息的 Cookie 名称。 - `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理认证的 HTTP 头部名称，用于提供用户信息。 - `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理认证的 HTTP 头部名称，用于提供邮箱信息。 - `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理认证的 HTTP 头部名称，用于提供全名信息。 - `REVERSE_PROXY_LIMIT`: **1**: 解释 X-Forwarded-For 标头或 X-Real-IP 标头，并将其设置为请求的远程 IP。 - 可信代理计数。设置为零以不使用这些标头。 + 可信代理计数。设置为零以不使用这些标头。 - `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗号分隔的受信任代理服务器的 IP 地址和网络列表。使用 `*` 来信任全部。 - `DISABLE_GIT_HOOKS`: **true**: 设置为 `false` 以允许具有 Git 钩子权限的用户创建自定义 Git 钩子。 - 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 - 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 - 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 - 这可能对您的网站或操作系统造成危害。 - 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 + 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 + 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 + 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 + 这可能对您的网站或操作系统造成危害。 + 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 - `DISABLE_WEBHOOKS`: **false**: 设置为 `true` 以禁用 Webhooks 功能。 - `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 设置为 `false` 以允许本地用户在未设置 Gitea 环境的情况下推送到 Gitea 存储库。不建议这样做，如果您希望本地用户推送到 Gitea 存储库，应该适当地设置环境。 - `IMPORT_LOCAL_PATHS`: **false**: 设置为 `false` 以防止所有用户（包括管理员）从服务器上导入本地路径。 @@ -540,7 +539,7 @@ Gitea 创建以下非唯一队列： - lower - 使用一个或多个小写拉丁字符 - upper - 使用一个或多个大写拉丁字符 - digit - 使用一个或多个数字 - - spec - 使用一个或多个特殊字符，如 ``!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~`` + - spec - 使用一个或多个特殊字符，如 `` !"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ `` - off - 不检查密码复杂性 - `PASSWORD_CHECK_PWN`: **false**: 检查密码是否在 [HaveIBeenPwned](https://haveibeenpwned.com/Passwords) 中曝光。 - `SUCCESSFUL_TOKENS_CACHE_SIZE`: **20**: 缓存成功的令牌哈希。API 令牌在数据库中存储为 pbkdf2 哈希，但这意味着在存在多个 API 操作时可能会有显着的哈希负载。此缓存将在 LRU 缓存中存储成功的哈希令牌，以在性能和安全性之间保持平衡。 @@ -548,27 +547,27 @@ Gitea 创建以下非唯一队列： ## Camo (`camo`) - `ENABLED`: **false**: 启用媒体代理，目前仅支持图像。 -- `SERVER_URL`: **_empty_**: Camo服务器的URL，如果启用camo，则**必填**。 -- `HMAC_KEY`: **_empty_**: 为URL编码提供HMAC密钥，如果启用camo，则**必填**。 -- `ALLWAYS`: **false**: 设置为true以在HTTP和HTTPS内容上使用camo，否则仅代理非HTTPS URL。 +- `SERVER_URL`: **_empty_**: Camo 服务器的 URL，如果启用 camo，则**必填**。 +- `HMAC_KEY`: **_empty_**: 为 URL 编码提供 HMAC 密钥，如果启用 camo，则**必填**。 +- `ALLWAYS`: **false**: 设置为 true 以在 HTTP 和 HTTPS 内容上使用 camo，否则仅代理非 HTTPS URL。 ## OpenID (`openid`) -- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过OpenID进行身份验证。 -- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: 允许通过OpenID进行注册。 -- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于允许访问。 -- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于阻止访问。 +- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过 OpenID 进行身份验证。 +- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: 允许通过 OpenID 进行注册。 +- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于允许访问。 +- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于阻止访问。 ## OAuth2 Client (`oauth2_client`) -- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER\_EMAIL\_CONFIRM**: 设置此项以启用或禁用OAuth2自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） -- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的OpenID连接范围的列表。（`openid`已隐式添加） -- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的OAuth2用户自动创建用户帐户。 -- `USERNAME`: **nickname**: 新OAuth2帐户的用户名来源： - - userid - 使用userid / sub属性 - - nickname - 使用nickname属性 - - email - 使用email属性的用户名部分 -- `UPDATE_AVATAR`: **false**: 如果OAuth2提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 +- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER_EMAIL_CONFIRM**: 设置此项以启用或禁用 OAuth2 自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） +- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的 OpenID 连接范围的列表。（`openid`已隐式添加） +- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的 OAuth2 用户自动创建用户帐户。 +- `USERNAME`: **nickname**: 新 OAuth2 帐户的用户名来源： + - userid - 使用 userid / sub 属性 + - nickname - 使用 nickname 属性 + - email - 使用 email 属性的用户名部分 +- `UPDATE_AVATAR`: **false**: 如果 OAuth2 提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 - `ACCOUNT_LINKING`: **login**: 如果帐户/电子邮件已存在，如何处理： - disabled - 显示错误 - login - 显示帐户链接登录 @@ -581,54 +580,54 @@ Gitea 创建以下非唯一队列： - `REGISTER_EMAIL_CONFIRM`: **false**: 启用此项以要求通过邮件确认注册。需要启用`Mailer`。 - `REGISTER_MANUAL_CONFIRM`: **false**: 启用此项以手动确认新的注册。需要禁用`REGISTER_EMAIL_CONFIRM`。 - `DISABLE_REGISTRATION`: **false**: 禁用注册，之后只有管理员可以为用户创建帐户。 -- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过GitHub、OpenID Connect等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 -- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用API。 +- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过 GitHub、OpenID Connect 等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 +- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用 API。 - `ENABLE_NOTIFY_MAIL`: **false**: 启用此项以在发生某些情况（如创建问题）时向存储库的观察者发送电子邮件。需要启用`Mailer`。 -- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用HTTP BASIC和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌API端点。此外，这仅会禁用使用密码的BASIC身份验证，而不会禁用令牌或OAuth Basic。 +- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用 HTTP BASIC 和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌 API 端点。此外，这仅会禁用使用密码的 BASIC 身份验证，而不会禁用令牌或 OAuth Basic。 - `ENABLE_REVERSE_PROXY_AUTHENTICATION`: **false**: 启用此项以允许反向代理身份验证。 - `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION`: **false**: 启用此项以允许反向身份验证的自动注册。 - `ENABLE_REVERSE_PROXY_EMAIL`: **false**: 启用此项以允许使用提供的电子邮件而不是生成的电子邮件进行自动注册。 - `ENABLE_REVERSE_PROXY_FULL_NAME`: **false**: 启用此项以允许使用提供的全名进行自动注册。 - `ENABLE_CAPTCHA`: **false**: 启用此项以对注册使用验证码验证。 - `REQUIRE_CAPTCHA_FOR_LOGIN`: **false**: 启用此项以要求登录使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 -- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即GitHub、OpenID Connect等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 +- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即 GitHub、OpenID Connect 等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 - `CAPTCHA_TYPE`: **image**: \[image、recaptcha、hcaptcha、mcaptcha、cfturnstile\] -- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的密钥。 -- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的站点密钥。 -- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/**: 设置recaptcha网址，允许使用recaptcha net。 -- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的密钥。 -- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的站点密钥。 -- `MCAPTCHA_SECRET`: **""**: 访问您的mCaptcha实例以获取mCaptcha的密钥。 -- `MCAPTCHA_SITEKEY`: **""**: 访问您的mCaptcha实例以获取mCaptcha的站点密钥。 -- `MCAPTCHA_URL` **https://demo.mcaptcha.org/**: 设置mCaptcha的URL。 -- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的密钥。 -- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的站点密钥。 +- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的密钥。 +- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的站点密钥。 +- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/**: 设置 recaptcha 网址，允许使用 recaptcha net。 +- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的密钥。 +- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的站点密钥。 +- `MCAPTCHA_SECRET`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的密钥。 +- `MCAPTCHA_SITEKEY`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的站点密钥。 +- `MCAPTCHA_URL` **https://demo.mcaptcha.org/**: 设置 mCaptcha 的 URL。 +- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的密钥。 +- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的站点密钥。 - `DEFAULT_KEEP_EMAIL_PRIVATE`: **false**: 默认情况下，将用户设置为保持其电子邮件地址私有。 - `DEFAULT_ALLOW_CREATE_ORGANIZATION`: **true**: 默认情况下，允许新用户创建组织。 - `DEFAULT_USER_IS_RESTRICTED`: **false**: 默认情况下，为新用户分配受限权限。 - `DEFAULT_ENABLE_DEPENDENCIES`: **true**: 启用此项以默认启用依赖项。 - `ALLOW_CROSS_REPOSITORY_DEPENDENCIES` : **true** 启用此项以允许从用户被授予访问权限的任何存储库上进行依赖项操作。 -- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务URL。位置将作为转义的查询参数附加到URL中。 +- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务 URL。位置将作为转义的查询参数附加到 URL 中。 - `ENABLE_USER_HEATMAP`: **true**: 启用此项以在用户个人资料上显示热图。 - `ENABLE_TIMETRACKING`: **true**: 启用时间跟踪功能。 - `DEFAULT_ENABLE_TIMETRACKING`: **true**: 默认情况下，允许存储库默认使用时间跟踪。 - `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: 仅允许具有写权限的用户跟踪时间。 - `EMAIL_DOMAIN_ALLOWLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，只能用于在此实例上注册，支持通配符。 - `EMAIL_DOMAIN_BLOCKLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，不能用于在此实例上注册，支持通配符。 -- `SHOW_REGISTRATION_BUTTON`: **! DISABLE\_REGISTRATION**: 显示注册按钮 +- `SHOW_REGISTRATION_BUTTON`: **! DISABLE_REGISTRATION**: 显示注册按钮 - `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** 启用此项以显示里程碑仪表板页面 - 查看所有用户的里程碑 - `AUTO_WATCH_NEW_REPOS`: **true** 启用此项以在创建新存储库时让所有组织用户观看新存储库 - `AUTO_WATCH_ON_CHANGES`: **false** 启用此项以在首次提交后使用户观看存储库 - `DEFAULT_USER_VISIBILITY`: **public**: 为用户设置默认的可见性模式，可以是"public"、"limited"或"private"。 - `ALLOWED_USER_VISIBILITY_MODES`: **public,limited,private**: 设置用户可以具有的可见性模式 - `DEFAULT_ORG_VISIBILITY`: **public**: 为组织设置默认的可见性模式，可以是"public"、"limited"或"private"。 -- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为True。 -- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为True以强制仅通过Gitea进行注册。 -- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为True以强制仅使用第三方服务进行注册。 -- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将KeepEmailPrivate设置为True，则在Git日志中的用户电子邮件地址的域部分的值。DOMAIN解析为server.DOMAIN中的值。 - 用户的电子邮件将被替换为小写的用户名、"@"和NO_REPLY_ADDRESS的连接。 +- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为 True。 +- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅通过 Gitea 进行注册。 +- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅使用第三方服务进行注册。 +- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将 KeepEmailPrivate 设置为 True，则在 Git 日志中的用户电子邮件地址的域部分的值。DOMAIN 解析为 server.DOMAIN 中的值。 + 用户的电子邮件将被替换为小写的用户名、"@"和 NO_REPLY_ADDRESS 的连接。 - `USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0**: 用户删除后，评论将保留的最短时间。 -- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点URL方案 +- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点 URL 方案 ### Service - Explore (`service.explore`) @@ -637,12 +636,12 @@ Gitea 创建以下非唯一队列： ## SSH Minimum Key Sizes (`ssh.minimum_key_sizes`) -定义允许的算法及其最小密钥长度（使用-1来禁用某个类型）： +定义允许的算法及其最小密钥长度（使用-1 来禁用某个类型）： - `ED25519`：**256** - `ECDSA`：**256** -- `RSA`：**3071**: 我们在这里设置为2047，因为一个其他方面有效的3072 RSA密钥可能被报告为3071长度。 -- `DSA`：**-1**: 默认情况下禁用DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的SSHD提供者 +- `RSA`：**3071**: 我们在这里设置为 2047，因为一个其他方面有效的 3072 RSA 密钥可能被报告为 3071 长度。 +- `DSA`：**-1**: 默认情况下禁用 DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的 SSHD 提供者 ## Webhook (`webhook`) @@ -659,7 +658,7 @@ Gitea 创建以下非唯一队列： - `SKIP_TLS_VERIFY`: **false**: 允许不安全的证书。 - `PAGING_NUM`: **10**: 一页中显示的 Webhook 历史事件数量。 - `PROXY_URL`: **_empty_**: 代理服务器 URL，支持 http://、https://、socks://，留空将遵循环境的 http_proxy/https_proxy 设置。如果未提供，将使用全局代理设置。 -- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (*)；使用 ** 来匹配所有主机。如果未提供，将使用全局代理设置。 +- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (\*)；使用 \*\* 来匹配所有主机。如果未提供，将使用全局代理设置。 ## 邮件 (`mailer`) @@ -715,7 +714,7 @@ Gitea 创建以下非唯一队列： ## 缓存 (`cache`) -- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的LRU缓存) +- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的 LRU 缓存) - `INTERVAL`: **60**: 垃圾回收间隔(秒)，只对`memory`和`towqueue`有效。 - `HOST`: **_empty_**: 缓存配置。`redis`, `redis-cluster`，`memcache`配置连接字符串;`twoqueue` 设置队列参数 - Redis: `redis://:macaron@127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` @@ -734,7 +733,7 @@ Gitea 创建以下非唯一队列： - `PROVIDER`: **memory**: 会话存储引擎 \[memory, file, redis, redis-cluster, db, mysql, couchbase, memcache, postgres\]。设置为 `db` 将会重用 `[database]` 的配置信息。 - `PROVIDER_CONFIG`: **data/sessions**: 对于文件，为根路径；对于 db，为空（将使用数据库配置）；对于其他引擎，为连接字符串。相对路径将根据 _`AppWorkPath`_ 绝对化。 - `COOKIE_SECURE`: **_empty_**: `true` 或 `false`。启用此选项以强制在所有会话访问中使用 HTTPS。如果没有设置，当 ROOT_URL 是 https 链接的时候默认设置为 true。 -- `COOKIE_NAME`: **i\_like\_gitea**: 用于会话 ID 的 cookie 名称。 +- `COOKIE_NAME`: **i_like_gitea**: 用于会话 ID 的 cookie 名称。 - `GC_INTERVAL_TIME`: **86400**: GC 间隔时间，以秒为单位。 - `SESSION_LIFE_TIME`: **86400**: 会话生命周期，以秒为单位，默认为 86400（1 天）。 - `DOMAIN`: **_empty_**: 设置 cookie 的域。 @@ -743,10 +742,10 @@ Gitea 创建以下非唯一队列： ## 图像 (`picture`) - `GRAVATAR_SOURCE`: **gravatar**: 头像来源，可以是 gravatar、duoshuo 或类似 http://cn.gravatar.com/avatar/ 的来源。 - `http://cn.gravatar.com/avatar/`。 + `http://cn.gravatar.com/avatar/`。 - `DISABLE_GRAVATAR`: **false**: 启用后，只使用内部头像。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `ENABLE_FEDERATED_AVATAR`: **false**: 启用头像联盟支持（参见 - [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 + [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `AVATAR_STORAGE_TYPE`: **default**: 在 `[storage.xxx]` 中定义的存储类型。默认为 `default`，如果没有 `[storage]` 部分，则将读取 `[storage]`，如果没有则将是 `local` 类型。 - `AVATAR_UPLOAD_PATH`: **data/avatars**: 存储用户头像图像文件的路径。 @@ -815,7 +814,7 @@ Gitea 创建以下非唯一队列： - 例如： - 在请求头中：X-Request-ID: **test-id-123** - 在 app.ini 中的配置：REQUEST_ID_HEADERS = X-Request-ID - - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... + - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... ### 日志子部分 (`log.`) @@ -851,13 +850,13 @@ Gitea 创建以下非唯一队列： ## 定时任务 (`cron`) -- `ENABLED`: **false**: 是否在后台运行定期任务。 +- `ENABLED`: **false**: 是否在后台运行定期任务。 - `RUN_AT_START`: **false**: 在应用程序启动时运行定时任务。 -- `NOTICE_ON_SUCCESS`: **false**: 设置为 true时，任务成功完成时将进行通知。 +- `NOTICE_ON_SUCCESS`: **false**: 设置为 true 时，任务成功完成时将进行通知。 - `SCHEDULE` 接受的格式: - - 完整的crontab语法规范, e.g. `* * * * * ?` - - 描述符e.g. `@midnight`, `@every 1h30m` ... + - 完整的 crontab 语法规范, e.g. `* * * * * ?` + - 描述符 e.g. `@midnight`, `@every 1h30m` ... - 更多详见: [cron documentation](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14) ### 基本定时任务 - 默认开启 @@ -866,31 +865,31 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 是否启用该定时任务。 - `RUN_AT_START`: **true**: 设置在服务启动时运行。 -- `SCHEDULE`: **@midnight**: 使用Cron语法的定时任务触发配置，例如 `@every 1h`。 +- `SCHEDULE`: **@midnight**: 使用 Cron 语法的定时任务触发配置，例如 `@every 1h`。 - `OLDER_THAN`: **24h**: 超过`OLDER_THAN`时间的存档将被删除，例如 `12h`。 #### 定时任务 - 更新镜像仓库 (`cron.update_mirrors`) -- `SCHEDULE`: **@every 10m**: 使用Cron语法的定时任务触发配置，例如 `@every 3h`。 -- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 -- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `SCHEDULE`: **@every 10m**: 使用 Cron 语法的定时任务触发配置，例如 `@every 3h`。 +- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 #### 定时任务 - 健康检查所有仓库 (`cron.repo_health_check`) -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库健康检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库健康检查。 - `TIMEOUT`: **60s**: 用于健康检查执行超时的时间持续语法。 - `ARGS`: **_empty_**: `git fsck` 命令的参数，例如 `--unreachable --tags`。在 http://git-scm.com/docs/git-fsck 上了解更多。 #### 定时任务 - 检查所有仓库统计 (`cron.check_repo_stats`) - `RUN_AT_START`: **true**: 在启动时运行仓库统计检查。 -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库统计检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库统计检查。 #### 定时任务 - 清理 hook_task 表 (`cron.cleanup_hook_task_table`) - `ENABLED`: **true**: 启用清理 hook_task 任务。 - `RUN_AT_START`: **false**: 在启动时运行清理 hook_task（如果启用）。 -- `SCHEDULE`: **@midnight**: Cron语法，用于清理 hook_task 表。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于清理 hook_task 表。 - `CLEANUP_TYPE` **OlderThan** OlderThan 或 PerWebhook 方法来清理 hook_task，可以按年龄（即 hook_task 记录传递多久）或按每个 Webhook 保留的数量（即每个 Webhook 保留最新的 x 个传递）来清理。 - `OLDER_THAN`: **168h**: 如果 CLEANUP_TYPE 设置为 OlderThan，则早于此表达式的任何传递的 hook_task 记录将被删除。 - `NUMBER_TO_KEEP`: **10**: 如果 CLEANUP_TYPE 设置为 PerWebhook，则 Webhook 的此数量 hook_task 记录将被保留（即保留最新的 x 个传递）。 @@ -900,7 +899,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 启用清理过期包任务。 - `RUN_AT_START`: **true**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 每次运行此任务时都会通知。 -- `SCHEDULE`: **@midnight**: Cron语法，用于任务。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于任务。 - `OLDER_THAN`: **24h**: 未引用的包数据创建超过 OLDER_THAN 时间的包将被删除。 #### Cron - 更新迁移海报 ID (`cron.update_migration_poster_id`) @@ -918,7 +917,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 - `TIMEOUT`: **60s**: 用于垃圾收集执行超时的时间持续语法。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 - `ARGS`: **_empty_**: `git gc` 命令的参数，例如 `--aggressive --auto`。默认值与 [git] -> GC_ARGS 相同。 @@ -928,95 +927,95 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新同步所有仓库的 pre-receive、update 和 post-receive 钩子 (`cron.resync_all_hooks`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新初始化所有缺失的 Git 仓库，但记录已存在 (`cron.reinit_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除所有缺少 Git 文件的仓库 (`cron.delete_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除生成的仓库头像 (`cron.delete_generated_repository_avatars`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 从数据库中删除所有旧的操作 (`cron.delete_old_actions`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1年），因为这是热力图的最大长度。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1 年），因为这是热力图的最大长度。 #### Cron - 从数据库中删除所有旧的系统通知 (`cron.delete_old_system_notices`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NO_SUCCESS_NOTICE`: **false**: 设置为 true 以关闭成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 - `OLDER_THAN`: **8760h**: 早于此表达式的任何系统通知都将从数据库中删除。 #### Cron - 在仓库中回收 LFS 指针 (`cron.gc_lfs`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 24h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认7天）的 LFSMetaObject。 -- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认3天）没有尝试过回收的 LFSMetaObject。 +- `SCHEDULE`: **@every 24h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认 7 天）的 LFSMetaObject。 +- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认 3 天）没有尝试过回收的 LFSMetaObject。 - `NUMBER_TO_CHECK_PER_REPO`: **100**: 每个仓库要检查的过期 LFSMetaObject 的最小数量。设置为 `0` 以始终检查所有。 ## Git (`git`) -- `PATH`: **""**: Git可执行文件的路径。如果为空，Gitea将在PATH环境中搜索。 -- `HOME_PATH`: **%(APP_DATA_PATH)s/home**: Git的HOME目录。 - 此目录将用于包含Gitea的git调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认Gitea是在此环境中唯一运行的应用程序，您可以将其设置为Gitea用户的正常主目录。 +- `PATH`: **""**: Git 可执行文件的路径。如果为空，Gitea 将在 PATH 环境中搜索。 +- `HOME_PATH`: **%(APP_DATA_PATH)s/home**: Git 的 HOME 目录。 + 此目录将用于包含 Gitea 的 git 调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认 Gitea 是在此环境中唯一运行的应用程序，您可以将其设置为 Gitea 用户的正常主目录。 - `DISABLE_DIFF_HIGHLIGHT`: **false**: 禁用已添加和已删除更改的高亮显示。 -- `MAX_GIT_DIFF_LINES`: **1000**: 在diff视图中允许单个文件的最大行数。 -- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在diff视图中每行的最大字符数。 -- `MAX_GIT_DIFF_FILES`: **100**: 在diff视图中显示的最大文件数。 +- `MAX_GIT_DIFF_LINES`: **1000**: 在 diff 视图中允许单个文件的最大行数。 +- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在 diff 视图中每行的最大字符数。 +- `MAX_GIT_DIFF_FILES`: **100**: 在 diff 视图中显示的最大文件数。 - `COMMITS_RANGE_SIZE`: **50**: 设置默认的提交范围大小 - `BRANCHES_RANGE_SIZE`: **20**: 设置默认的分支范围大小 - `GC_ARGS`: **_empty_**: 命令`git gc`的参数，例如`--aggressive --auto`。更多信息请参见http://git-scm.com/docs/git-gc/ -- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用Git版本 >= 2.18时使用Git wire协议版本2，默认为true，当您始终希望使用Git wire协议版本1时设置为false。 - 要在使用OpenSSH服务器的情况下为通过SSH的Git启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的sshd_config文件中。 -- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用URL创建拉取请求（如果启用了该存储库的拉取请求） +- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用 Git 版本 >= 2.18 时使用 Git wire 协议版本 2，默认为 true，当您始终希望使用 Git wire 协议版本 1 时设置为 false。 + 要在使用 OpenSSH 服务器的情况下为通过 SSH 的 Git 启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的 sshd_config 文件中。 +- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用 URL 创建拉取请求（如果启用了该存储库的拉取请求） - `VERBOSE_PUSH`: **true**: 在处理推送时打印有关推送状态的信息。 - `VERBOSE_PUSH_DELAY`: **5s**: 仅在推送时间超过此延迟时才打印详细信息。 -- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于Go-Git），不要在内存中缓存大于此大小的对象。（设置为0以禁用。） -- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为false。 -- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行git。 +- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于 Go-Git），不要在内存中缓存大于此大小的对象。（设置为 0 以禁用。） +- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为 false。 +- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行 git。 ### Git - 超时设置 (`git.timeout`) -- `DEFAULT`: **360**: Git操作的默认超时时间，单位秒 +- `DEFAULT`: **360**: Git 操作的默认超时时间，单位秒 - `MIGRATE`: **600**: 在迁移外部存储库时的超时时间，单位秒 - `MIRROR`: **300**: 在镜像外部存储库时的超时时间，单位秒 - `CLONE`: **300**: 在存储库之间进行内部克隆的超时时间，单位秒 - `PULL`: **300**: 在存储库之间进行内部拉取的超时时间，单位秒 -- `GC`: **60**: git存储库GC的超时时间，单位秒 +- `GC`: **60**: git 存储库 GC 的超时时间，单位秒 ### Git - 配置选项 (`git.config`) -此部分中的键/值对将用作git配置。 -此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从git配置中删除。格式为`some.configKey = value`。 +此部分中的键/值对将用作 git 配置。 +此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从 git 配置中删除。格式为`some.configKey = value`。 - `diff.algorithm`: **histogram** - `core.logAllRefUpdates`: **true** @@ -1024,45 +1023,45 @@ Gitea 创建以下非唯一队列： ## 指标 (`metrics`) -- `ENABLED`: **false**: 启用/prometheus的metrics端点。 +- `ENABLED`: **false**: 启用/prometheus 的 metrics 端点。 - `ENABLED_ISSUE_BY_LABEL`: **false**: 启用按标签统计问题，格式为`gitea_issues_by_label{label="bug"} 2`。 - `ENABLED_ISSUE_BY_REPOSITORY`: **false**: 启用按存储库统计问题，格式为`gitea_issues_by_repository{repository="org/repo"} 5`。 -- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在prometheus参数`bearer_token`或`bearer_token_file`中使用。 +- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在 prometheus 参数`bearer_token`或`bearer_token_file`中使用。 ## API (`api`) -- `ENABLE_SWAGGER`: **true**: 启用API文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 -- `MAX_RESPONSE_ITEMS`: **50**: API分页的最大单页项目数。 -- `DEFAULT_PAGING_NUM`: **30**: API分页的默认分页数。 -- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API的默认单页项目数。 -- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API的默认最大文件大小。 +- `ENABLE_SWAGGER`: **true**: 启用 API 文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 +- `MAX_RESPONSE_ITEMS`: **50**: API 分页的最大单页项目数。 +- `DEFAULT_PAGING_NUM`: **30**: API 分页的默认分页数。 +- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API 的默认单页项目数。 +- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API 的默认最大文件大小。 ## OAuth2 (`oauth2`) -- `ENABLED`: **true**: 启用OAuth2提供者。 -- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2访问令牌的生命周期，以秒为单位。 -- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2刷新令牌的生命周期，以小时为单位。 +- `ENABLED`: **true**: 启用 OAuth2 提供者。 +- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2 访问令牌的生命周期，以秒为单位。 +- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2 刷新令牌的生命周期，以小时为单位。 - `INVALIDATE_REFRESH_TOKENS`：**false**: 检查刷新令牌是否已被使用。 -- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署OAuth2令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 -- `JWT_SECRET`：**_empty_**: OAuth2访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 -- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向Gitea提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 -- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署OAuth2令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含PKCS8格式的RSA或ECDSA私钥。如果不存在密钥，则将为您创建一个4096位密钥。 -- `MAX_TOKEN_LENGTH`：**32767**: 从OAuth2提供者接受的令牌/cookie的最大长度。 -- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager, tea**: 在启动时预注册用于某些服务的OAuth应用程序。有关可用选项列表，请参阅[OAuth2文档](/development/oauth2-provider.md)。 +- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署 OAuth2 令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 +- `JWT_SECRET`：**_empty_**: OAuth2 访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 +- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向 Gitea 提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 +- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署 OAuth2 令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含 PKCS8 格式的 RSA 或 ECDSA 私钥。如果不存在密钥，则将为您创建一个 4096 位密钥。 +- `MAX_TOKEN_LENGTH`：**32767**: 从 OAuth2 提供者接受的令牌/cookie 的最大长度。 +- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager, tea**: 在启动时预注册用于某些服务的 OAuth 应用程序。有关可用选项列表，请参阅[OAuth2 文档](/development/oauth2-provider.md)。 ## i18n (`i18n`) -- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: - 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 +- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: + 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 -- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: - 对应于各区域设置的可见名称。 +- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: + 对应于各区域设置的可见名称。 ## Markup (`markup`) -- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置Mermaid源的最大大小。(设为-1代表禁止) +- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置 Mermaid 源的最大大小。(设为-1 代表禁止) -gitea支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 +gitea 支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 ```ini [markup.asciidoc] @@ -1074,21 +1073,21 @@ IS_INPUT_FILE = false ``` - ENABLED：**false** 设置是否启动渲染器 -- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1等。 -- FILE_EXTENSIONS：**_empty_** 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 +- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1 等。 +- FILE*EXTENSIONS：\*\*\_empty*\*\* 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 - RENDER_COMMAND：用于渲染所有匹配的扩展名的外部命令。 - IS_INPUT_FILE：**false** 输入不是标准输入，而是一个在`RENDER_COMMAND`之后带有文件参数的文件。 - RENDER_CONTENT_MODE：**sanitized** 内容将如何呈现。 - - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些HTML标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 - - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致XSS攻击。 - - iframe：在单独的独立页面中呈现内容，并通过iframe嵌入到当前页面中。iframe处于禁用同源策略的沙箱模式，并且JS代码与父页面安全隔离。 + - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些 HTML 标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 + - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致 XSS 攻击。 + - iframe：在单独的独立页面中呈现内容，并通过 iframe 嵌入到当前页面中。iframe 处于禁用同源策略的沙箱模式，并且 JS 代码与父页面安全隔离。 两个特殊的环境变量会传递给渲染命令： -- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前URL前缀。用作链接的前缀。 -- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前URL前缀。用作图像路径的前缀。 +- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前 URL 前缀。用作链接的前缀。 +- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前 URL 前缀。用作图像路径的前缀。 -如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea支持自定义用于呈现的HTML的清理策略。下面的示例将支持来自pandoc的KaTeX输出。 +如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea 支持自定义用于呈现的 HTML 的清理策略。下面的示例将支持来自 pandoc 的 KaTeX 输出。 ```ini [markup.sanitizer.TeX] @@ -1103,18 +1102,18 @@ ALLOW_DATA_URI_IMAGES = true - `ELEMENT`：此策略适用于的元素。必须非空。 - `ALLOW_ATTR`：此策略允许的属性。必须非空。 - `REGEXP`：用于匹配属性内容的正则表达式。必须存在，但可以为空，以无条件允许此属性的白名单。 -- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据URI图像（``）。 +- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据 URI 图像（``）。 可以通过添加唯一的子节来定义多个清理规则，例如`[markup.sanitizer.TeX-2]`。 要仅为指定的外部渲染器应用清理规则，它们必须使用渲染器名称，例如`[markup.sanitizer.asciidoc.rule-1]`。 -如果规则在渲染器ini节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 +如果规则在渲染器 ini 节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 ## 代码高亮映射 (`highlight.mapping`) - `file_extension 比如 .toml`: **language 比如 ini**。文件扩展名到语言的映射覆盖。 - Gitea 将使用 `.gitattributes` 文件中的 `linguist-language` 或 `gitlab-language` 属性来对文件进行高亮显示，如果可用。 -如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 + 如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 ## 时间 (`time`) @@ -1197,7 +1196,7 @@ ALLOW_DATA_URI_IMAGES = true ## 存储 (`storage`) -默认的附件、lfs、头像、仓库头像、仓库归档、软件包、操作日志、artifacts 的存储配置。推荐仅仅配置此 section 并让其它的section 从此配置项继承。 +默认的附件、lfs、头像、仓库头像、仓库归档、软件包、操作日志、artifacts 的存储配置。推荐仅仅配置此 section 并让其它的 section 从此配置项继承。 - `STORAGE_TYPE`：**local**: 存储类型，`local` 表示本地磁盘，`minio` 表示 S3 兼容的对象存储服务。 - `SERVE_DIRECT`：**false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，仅支持通过签名的 URL 提供 Minio/S3，本地不执行任何操作。 @@ -1281,28 +1280,28 @@ MINIO_INSECURE_SKIP_VERIFY = false 存储库归档存储的配置。当将`STORAGE_TYPE`设置为`xxx`时，它将继承默认的 `[storage]` 或 `[storage.xxx]` 配置。`PATH`的默认值是`data/repo-archive`，`MINIO_BASE_PATH`的默认值是`repo-archive/`。 -- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 -- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的URL以直接提供文件。目前，只有Minio/S3支持通过签名URL，本地不执行任何操作。 +- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 +- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，只有 Minio/S3 支持通过签名 URL，本地不执行任何操作。 - `PATH`: **./data/repo-archive**: 用于存储归档文件的位置，仅在`STORAGE_TYPE`为`local`时可用。 -- `MINIO_ENDPOINT`: **localhost:9000**: Minio端点，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_ACCESS_KEY_ID`: Minio的accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_SECRET_ACCESS_KEY`: Minio的secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BUCKET`: **gitea**: 用于存储归档的Minio存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的Minio位置，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的Minio基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_USE_SSL`: **false**: 启用Minio的SSL，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过Minio的SSL验证，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ENDPOINT`: **localhost:9000**: Minio 端点，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ACCESS_KEY_ID`: Minio 的 accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_SECRET_ACCESS_KEY`: Minio 的 secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET`: **gitea**: 用于存储归档的 Minio 存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的 Minio 位置，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的 Minio 基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_USE_SSL`: **false**: 启用 Minio 的 SSL，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过 Minio 的 SSL 验证，仅在`STORAGE_TYPE`为`minio`时可用。 ### 存储库归档 (`repo-archive`) -- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **repo-archive/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **repo-archive/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 ## 代理 (`proxy`) -- `PROXY_ENABLED`: **false**: 启用代理，如果为true，所有通过HTTP向外部的请求都将受到影响，如果为false，即使环境设置了http_proxy/https_proxy也不会使用 +- `PROXY_ENABLED`: **false**: 启用代理，如果为 true，所有通过 HTTP 向外部的请求都将受到影响，如果为 false，即使环境设置了 http_proxy/https_proxy 也不会使用 - `PROXY_URL`: **_empty_**: 代理服务器地址，支持 http://, https//, socks://，为空则不启用代理而使用环境变量中的 http_proxy/https_proxy -- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 * 号匹配符号， ** 表示匹配所有网站 +- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 \* 号匹配符号， \*\* 表示匹配所有网站 i.e. @@ -1316,8 +1315,8 @@ PROXY_HOSTS = *.github.com - `ENABLED`: **true**: 启用/禁用操作功能 - `DEFAULT_ACTIONS_URL`: **github**: 获取操作插件的默认平台，`github`表示`https://github.com`，`self`表示当前的 Gitea 实例。 -- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **actions_log/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **actions_log/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 `DEFAULT_ACTIONS_URL` 指示 Gitea 操作运行程序应该在哪里找到带有相对路径的操作。 例如，`uses: actions/checkout@v4` 表示 `https://github.com/actions/checkout@v4`，因为 `DEFAULT_ACTIONS_URL` 的值为 `github`。 @@ -1334,8 +1333,8 @@ PROXY_HOSTS = *.github.com ## 其他 (`other`) -- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示Gitea的版本。 +- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示 Gitea 的版本。 - `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: 在页脚显示模板执行的时间。 - `SHOW_FOOTER_POWERED_BY`: **true**: 在页脚显示“由...提供动力”的文本。 -- `ENABLE_SITEMAP`: **true**: 生成sitemap. -- `ENABLE_FEED`: **true**: 是否启用RSS/Atom +- `ENABLE_SITEMAP`: **true**: 生成 sitemap. +- `ENABLE_FEED`: **true**: 是否启用 RSS/Atom diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/customizing-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/customizing-gitea.md index 1461a1bb..ca1daea3 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/customizing-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/customizing-gitea.md @@ -6,14 +6,13 @@ sidebar_position: 100 aliases: - /zh-cn/customizing-gitea - --- # 自定义 Gitea 配置 Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板等默认配置。 -如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为Linux文件系统标准。Gitea +如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为 Linux 文件系统标准。Gitea 将会自动创建包括 `custom/` 在内的必要应用目录，应用本身的配置存放在 `custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接，查看配置详情请移步： @@ -67,7 +66,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板 除了 `extra_links.tmpl` 和 `extra_tabs.tmpl`，您可以在您的 `custom/templates/custom/` 目录中存放一些其他有用的模板，例如： -- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义CSS文件 +- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义 CSS 文件 - `body_outer_pre.tmpl`，在 `` 标记开始处的模板 - `body_inner_pre.tmpl`，在顶部导航栏之前，但在主 container 内部的模板，例如添加一个 `
` - `body_inner_post.tmpl`，在主 container 结束处的模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/email-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/email-setup.md index 36eef39a..6655373e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/email-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/email-setup.md @@ -6,7 +6,6 @@ sidebar_position: 12 aliases: - /zh-cn/email-setup - --- # Email 设置 @@ -17,9 +16,9 @@ Gitea 具有邮件功能，用于发送事务性邮件（例如注册确认邮 使用 `sendmail` 命令作为邮件传输代理（mailer）。 -注意：对于在官方Gitea Docker镜像中使用，请使用SMTP版本进行配置（请参考下一节）。 +注意：对于在官方 Gitea Docker 镜像中使用，请使用 SMTP 版本进行配置（请参考下一节）。 -注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 +注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过 TLS 发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 ```ini title="app.ini" [mailer] @@ -56,9 +55,9 @@ PASSWD = `password` - 通过端口 587 的 STARTTLS（也称为 Opportunistic TLS）。初始连接是明文的，但如果服务器支持，则可以升级为 TLS。 - 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。 - 使用 `PROTOCOL=smtps` 进行强制的 SMTPS 连接。（这两种方式都被称为 Implicit TLS） -这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 + 这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 -请注意，自2018年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 +请注意，自 2018 年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 ### Gmail diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/environment-variables.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/environment-variables.md index 4708c519..2b6ba501 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/environment-variables.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/environment-variables.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/environment-variables - --- # 环境变量清单 @@ -21,31 +20,31 @@ GITEA_CUSTOM=/home/gitea/custom ./gitea web 因为 Gitea 使用 Go 语言编写，因此它使用了一些相关的 Go 的配置参数： -* `GOOS` -* `GOARCH` -* [`GOPATH`](https://go.dev/cmd/go/#hdr-GOPATH_environment_variable) +- `GOOS` +- `GOARCH` +- [`GOPATH`](https://go.dev/cmd/go/#hdr-GOPATH_environment_variable) 您可以在[官方文档](https://go.dev/cmd/go/#hdr-Environment_variables)中查阅这些配置参数的详细信息。 ## Gitea 的文件目录 -* `GITEA_WORK_DIR`：工作目录的绝对路径 -* `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录 -* `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 -* `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 +- `GITEA_WORK_DIR`：工作目录的绝对路径 +- `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 _custom_ 目录 +- `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 +- `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 ## 操作系统配置 -* `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 -* `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` -* `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 +- `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 +- `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` +- `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 ### 仅限于 Windows 的配置 -* `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` -* `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘） -* `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 +- `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` +- `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C 盘） +- `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 ## Miscellaneous -* `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 +- `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/external-renderers.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/external-renderers.md index 6fcfffcc..13faf02f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/external-renderers.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/external-renderers.md @@ -6,7 +6,6 @@ sidebar_position: 60 aliases: - /zh-cn/external-renderers - --- # 外部渲染器 @@ -172,7 +171,8 @@ ALLOW_DATA_URI_IMAGES = true .markup.XXXXX body { color: #444; - font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", + serif; font-size: 12px; line-height: 1.7; padding: 1em; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/logging-config.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/logging-config.md index e23663dc..004832c0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/logging-config.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/logging-config.md @@ -6,7 +6,6 @@ sidebar_position: 40 aliases: - /zh-cn/logging-configuration - --- # 日志配置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/mail-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/mail-templates.md index 23d2ec43..e7e8b65d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/mail-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/mail-templates.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/mail-templates - --- # 邮件模板 @@ -20,18 +19,18 @@ aliases: 目前，以下通知事件使用模板： -| 操作名称 | 用途 | -| ----------- | ------------------------------------------------------------------------------------------------------------ | -| `new` | 创建了新的工单或合并请求。 | -| `comment` | 在现有工单或合并请求中创建了新的评论。 | -| `close` | 关闭了工单或合并请求。 | -| `reopen` | 重新打开了工单或合并请求。 | -| `review` | 在合并请求中进行审查的首要评论。 | -| `approve` | 对合并请求进行批准的首要评论。 | -| `reject` | 对合并请求提出更改请求的审查的首要评论。 | -| `code` | 关于合并请求的代码的单个评论。 | -| `assigned` | 用户被分配到工单或合并请求。 | -| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | +| 操作名称 | 用途 | +| ---------- | ---------------------------------------------------------------------- | +| `new` | 创建了新的工单或合并请求。 | +| `comment` | 在现有工单或合并请求中创建了新的评论。 | +| `close` | 关闭了工单或合并请求。 | +| `reopen` | 重新打开了工单或合并请求。 | +| `review` | 在合并请求中进行审查的首要评论。 | +| `approve` | 对合并请求进行批准的首要评论。 | +| `reject` | 对合并请求提出更改请求的审查的首要评论。 | +| `code` | 关于合并请求的代码的单个评论。 | +| `assigned` | 用户被分配到工单或合并请求。 | +| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | 特定消息类型的模板路径为： @@ -75,25 +74,25 @@ custom/templates/mail/pull/comment.tmpl 指定 _主题_ 部分是可选的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。 -_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： +_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： -| 名称 | 类型 | 可用性 | 用途 | -| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | -| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | -| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | -| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | -| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | -| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | -| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | -| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | -| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | -| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | -| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | -| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | -| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | -| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | -| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | +| 名称 | 类型 | 可用性 | 用途 | +| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | +| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | +| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | +| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | +| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | +| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | +| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | +| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | +| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | +| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | +| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | +| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | +| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | +| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | +| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | 所有名称区分大小写。 @@ -110,7 +109,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ - 删除所有前导、尾随和多余的空格。 - 将字符串截断为前 256 个字母（字符）。 -如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用Gitea的**内部默认值**。 +如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用 Gitea 的**内部默认值**。 内部默认（回退）主题相当于： @@ -120,7 +119,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 例如：`Re: [mike/stuff] New color palette (#38)` -即使存在有效的主题模板，Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 +即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 ### 模板中的邮件正文部分 @@ -142,7 +141,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 如果模板无法呈现，则只有在发送邮件时才会注意到。 如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈现了任何内容，则将使用该内容，忽略其他内容。 -如果遇到问题，请检查 [Gitea的日志](../administration/logging-config.md) 以获取错误消息。 +如果遇到问题，请检查 [Gitea 的日志](../administration/logging-config.md) 以获取错误消息。 ## 示例 @@ -224,11 +223,11 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ > > #### 消息内容 > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > Mike, I think we should tone down the blues a little. > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > [在 Gitea 上查看](#)。 @@ -236,20 +235,22 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 模板系统包含一些函数，可用于进一步处理和格式化消息。以下是其中一些函数的列表： -| 函数名 | 参数 | 可用于 | 用法 | -|------------------| ----------- | ------------ | ------------------------------ | -| `AppUrl` | - | 任何地方 | Gitea 的 URL | -| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | -| `AppDomain` | - | 任何地方 | Gitea 的主机名 | -| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | -| `SanitizeHTML` | string | 仅正文部分 | 通过删除其中的危险 HTML 标签对文本进行清理 | -| `SafeHTML` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于输出原始的 HTML 内容 | +| 函数名 | 参数 | 可用于 | 用法 | +| ---------------- | ----------- | ---------- | ------------------------------------------------ | +| `AppUrl` | - | 任何地方 | Gitea 的 URL | +| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | +| `AppDomain` | - | 任何地方 | Gitea 的主机名 | +| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | +| `SanitizeHTML` | string | 仅正文部分 | 通过删除其中的危险 HTML 标签对文本进行清理 | +| `SafeHTML` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于输出原始的 HTML 内容 | 这些都是 _函数_，而不是元数据，因此必须按以下方式使用： ```html -像这样使用： {{SanitizeHTML "Escapetext"}} -或者这样使用： {{"Escapetext" | SanitizeHTML}} -或者这样使用： {{AppUrl}} -但不要像这样使用： {{.AppUrl}} +像这样使用： {{SanitizeHTML "Escapetext"}} 或者这样使用： {{"Escapetext" | SanitizeHTML}} 或者这样使用： {{AppUrl}} 但不要像这样使用： + {{.AppUrl}} ``` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/repo-indexer.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/repo-indexer.md index ea765c44..bd3c328d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/repo-indexer.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/repo-indexer.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/repo-indexer - --- # 仓库索引器 @@ -33,7 +32,7 @@ REPO_INDEXER_EXCLUDE = resources/bin/** ### 按路径选择要索引的文件 -Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 +Gitea 使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 限制文件列表可以防止索引被派生或无关的文件（例如 lss、sym、map 等）污染，从而使搜索结果更相关。这还有助于减小索引的大小。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/reverse-proxies.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/reverse-proxies.md index 5b393dda..52b43598 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/reverse-proxies.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/reverse-proxies.md @@ -6,7 +6,6 @@ sidebar_position: 16 aliases: - /zh-cn/reverse-proxies - --- # 反向代理 @@ -232,7 +231,7 @@ git.example.com { 1. 在 IIS 中设置一个空网页，比如命名为 `Gitea Proxy`。 2. 根据[微软社区中为 IIS 设置 URL 重写的指南](https://techcommunity.microsoft.com/t5/iis-support-blog/setup-iis-with-url-rewrite-as-a-reverse-proxy-for-real-world/ba-p/846222#M343)的前两步进行配置，也就是： -- 使用 Microsoft Web Platform Installer 5.1 (WebPI) 安装 Application Request Routing（简称ARR），或者在 [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing) 下载这个插件。 +- 使用 Microsoft Web Platform Installer 5.1 (WebPI) 安装 Application Request Routing（简称 ARR），或者在 [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing) 下载这个插件。 - 一但这个模块被安装到 IIS 上，你将会在 IIS 管理控制台看到一个叫做 URL Rewrite 的新图标。 - 打开 IIS 管理控制台，在左边的列表中点击 `Gitea Proxy` 网页。在中间选中并且双击 URL Rewrite 的图标来加载 URL 重写的面板。 - 在管理控制台的右边选择 `Add Rule` 操作，并且在 `Inbound and Outbound Rules` 分类中选择 `Reverse Proxy Rule`。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/search-engines-indexation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/search-engines-indexation.md index fd281848..47824449 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/search-engines-indexation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/search-engines-indexation.md @@ -6,7 +6,6 @@ sidebar_position: 60 aliases: - /zh-cn/search-engines-indexation - --- # 搜索引擎索引 @@ -25,7 +24,7 @@ User-agent: * Disallow: / ``` -如果您将Gitea安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 +如果您将 Gitea 安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 ```txt User-agent: * diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/signing.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/signing.md index b7e2d403..fac88ed7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/signing.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/administration/signing.md @@ -69,7 +69,7 @@ MERGES = pubkey, twofa, basesigned, commitssigned 如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。 与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。 -如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则Gitea将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 +如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置。，否则 Gitea 将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 ::: ### `INITIAL_COMMIT` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-backend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-backend.md index 15e693ce..db7c1616 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-backend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-backend.md @@ -6,47 +6,46 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-backend - --- # 后端开发指南 ## 背景 -Gitea使用Golang作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 -例如，Gitea使用[Chi](https://github.com/go-chi/chi)作为基本的Web框架。[Xorm](https://xorm.io)是一个用于与数据库交互的ORM框架。 +Gitea 使用 Golang 作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 +例如，Gitea 使用[Chi](https://github.com/go-chi/chi)作为基本的 Web 框架。[Xorm](https://xorm.io)是一个用于与数据库交互的 ORM 框架。 因此，管理这些包非常重要。在开始编写后端代码之前，请参考以下准则。 ## 包设计准则 ### 包列表 -为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea后端分为以下几个部分： +为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea 后端分为以下几个部分： -- `build`：帮助构建Gitea的脚本。 -- `cmd`：包含所有Gitea的实际子命令，包括web、doctor、serv、hooks、admin等。`web`将启动Web服务。`serv`和`hooks`将被Git或OpenSSH调用。其他子命令可以帮助维护Gitea。 +- `build`：帮助构建 Gitea 的脚本。 +- `cmd`：包含所有 Gitea 的实际子命令，包括 web、doctor、serv、hooks、admin 等。`web`将启动 Web 服务。`serv`和`hooks`将被 Git 或 OpenSSH 调用。其他子命令可以帮助维护 Gitea。 - `tests`：常用的测试函数 - `tests/integration`：集成测试，用于测试后端回归。 - `tests/e2e`：端到端测试，用于测试前端和后端的兼容性和视觉回归。 -- `models`：包含由xorm用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他Gitea代码的依赖关系。在某些情况下，比如日志记录时可以例外。 - - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从models/中调用。 +- `models`：包含由 xorm 用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他 Gitea 代码的依赖关系。在某些情况下，比如日志记录时可以例外。 + - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从 models/中调用。 - `models/fixtures`：单元测试和集成测试中使用的示例数据。一个`yml`文件表示一个将在测试开始时加载到数据库中的表。 - - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的PR**必须**包含一个迁移步骤。 -- `modules`：在Gitea中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于models的模块，因为它们依赖于数据库。 - - `modules/setting`：存储从ini文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 - - `modules/git`：用于与`Git`命令行或Gogit包交互的包。 -- `public`：编译后的前端文件（JavaScript、图像、CSS等） -- `routers`：处理服务器请求。由于它使用其他Gitea包来处理请求，因此其他包（models、modules或services）不能依赖于routers。 - - `routers/api`：包含`/api/v1`相关路由，用于处理RESTful API请求。 + - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的 PR**必须**包含一个迁移步骤。 +- `modules`：在 Gitea 中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于 models 的模块，因为它们依赖于数据库。 + - `modules/setting`：存储从 ini 文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 + - `modules/git`：用于与`Git`命令行或 Gogit 包交互的包。 +- `public`：编译后的前端文件（JavaScript、图像、CSS 等） +- `routers`：处理服务器请求。由于它使用其他 Gitea 包来处理请求，因此其他包（models、modules 或 services）不能依赖于 routers。 + - `routers/api`：包含`/api/v1`相关路由，用于处理 RESTful API 请求。 - `routers/install`：只能在系统处于安装模式（INSTALL_LOCK=false）时响应。 - `routers/private`：仅由内部子命令调用，特别是`serv`和`hooks`。 - - `routers/web`：处理来自Web浏览器或Git SMART HTTP协议的HTTP请求。 + - `routers/web`：处理来自 Web 浏览器或 Git SMART HTTP 协议的 HTTP 请求。 - `services`：用于常见路由操作或命令执行的支持函数。使用`models`和`modules`来处理请求。 -- `templates`：用于生成HTML输出的Golang模板。 +- `templates`：用于生成 HTML 输出的 Golang 模板。 ### 包依赖关系 -由于Golang不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 +由于 Golang 不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 `cmd` -> `routers` -> `services` -> `models` -> `modules` @@ -91,18 +90,18 @@ func UpdateIssue(ctx context.Context, repoID int64) error { ### 导入别名 -由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个Go文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 +由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个 Go 文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 例如：`import user_service "code.gitea.io/gitea/services/user"` ### 重要注意事项 - 永远不要写成`x.Update(exemplar)`，而没有明确的`WHERE`子句： - - 这将导致表中的所有行都被使用exemplar的非零值进行更新，包括ID。 + - 这将导致表中的所有行都被使用 exemplar 的非零值进行更新，包括 ID。 - 通常应该写成`x.ID(id).Update(exemplar)`。 -- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而ID是预设的： - - 对于MSSQL变体，你将需要执行``SET IDENTITY_INSERT `table` ON``（否则迁移将失败） - - 对于PostgreSQL，你还需要更新ID序列，否则迁移将悄无声息地通过，但后续的插入将失败： - ``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)`` +- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而 ID 是预设的： + - 对于 MSSQL 变体，你将需要执行`` SET IDENTITY_INSERT `table` ON ``（否则迁移将失败） + - 对于 PostgreSQL，你还需要更新 ID 序列，否则迁移将悄无声息地通过，但后续的插入将失败： + `` SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false) `` ### 未来的任务 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-frontend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-frontend.md index 7ab179b7..0cf9fc69 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-frontend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-frontend.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-frontend - --- # 前端开发指南 @@ -19,10 +18,10 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 源文件可以在以下目录中找到： -* **CSS 样式**： `web_src/css/` -* **JavaScript 文件**： `web_src/js/` -* **Vue 组件**： `web_src/js/components/` -* **Go HTML 模板**： `templates/` +- **CSS 样式**： `web_src/css/` +- **JavaScript 文件**： `web_src/js/` +- **Vue 组件**： `web_src/js/components/` +- **Go HTML 模板**： `templates/` ## 通用准则 @@ -31,9 +30,9 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ## Gitea 特定准则 1. 每个功能（Fomantic-UI/jQuery 模块）应放在单独的文件/目录中。 -2. HTML 的 id 和 class 应使用 kebab-case，最好包含2-3个与功能相关的关键词。 -3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含2-3个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 -4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有2-3个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 +2. HTML 的 id 和 class 应使用 kebab-case，最好包含 2-3 个与功能相关的关键词。 +3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含 2-3 个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 +4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有 2-3 个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 5. 后端可以通过使用`ctx.PageData["myModuleData"] = map[]{}`将复杂数据传递给前端，但不要将整个模型暴露给前端，以避免泄露敏感数据。 6. 简单页面和与 SEO 相关的页面使用 Go HTML 模板渲染生成静态的 Fomantic-UI HTML 输出。复杂页面可以使用 Vue3。 7. 明确变量类型，优先使用`elem.disabled = true`而不是`elem.setAttribute('disabled', 'anything')`，优先使用`$el.prop('checked', var === 'yes')`而不是`$el.prop('checked', var)`。 @@ -42,11 +41,11 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 10. 避免在一个事件监听器中混合不同的事件，优先为每个事件使用独立的事件监听器。 11. 推荐使用自定义事件名称前缀`ce-`。 12. 建议使用 Tailwind CSS，它可以通过 `tw-` 前缀获得，例如 `tw-relative`. Gitea 自身的助手类 CSS 使用 `gt-` 前缀（`gt-word-break`），Gitea 自身的私有框架级 CSS 类使用 `g-` 前缀（`g-modal-confirm`）。 -13. 尽量避免内联脚本和样式，建议将JS代码放入JS文件中并使用CSS类。如果内联脚本和样式不可避免，请解释无法避免的原因。 +13. 尽量避免内联脚本和样式，建议将 JS 代码放入 JS 文件中并使用 CSS 类。如果内联脚本和样式不可避免，请解释无法避免的原因。 ### 可访问性 / ARIA -在历史上，Gitea大量使用了可访问性不友好的框架 Fomantic UI。 +在历史上，Gitea 大量使用了可访问性不友好的框架 Fomantic UI。 Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`）， 但仍然存在许多问题需要大量的工作和时间来修复。 @@ -57,16 +56,16 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 推荐的实现方式： -* Vue + Vanilla JS -* Fomantic-UI（jQuery） -* htmx （部分页面重新加载其他静态组件） -* Vanilla JS +- Vue + Vanilla JS +- Fomantic-UI（jQuery） +- htmx （部分页面重新加载其他静态组件） +- Vanilla JS 不推荐的实现方式： -* Vue + Fomantic-UI（jQuery） -* jQuery + Vanilla JS -* htmx + 任何其他需要大量 JavaScript 代码或不必要的功能，如 htmx 脚本 (`hx-on`) +- Vue + Fomantic-UI（jQuery） +- jQuery + Vanilla JS +- htmx + 任何其他需要大量 JavaScript 代码或不必要的功能，如 htmx 脚本 (`hx-on`) 为了保持界面一致，Vue 组件可以使用 Fomantic-UI 的 CSS 类。 尽管不建议混合使用不同的框架， @@ -86,7 +85,7 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 如果我们想在非异步上下文中调用`async`函数， 建议使用`const _promise = asyncFoo()`来告诉读者 -这是有意为之的，我们想调用异步函数并忽略Promise。 +这是有意为之的，我们想调用异步函数并忽略 Promise。 一些 lint 规则和 IDE 也会在未处理返回的 Promise 时发出警告。 ### 获取数据 @@ -100,31 +99,41 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 禁止使用`dataset`，它的驼峰命名行为使得搜索属性变得困难。 然而，仍然存在一些特殊情况，因此当前的准则是： -* 对于旧代码： - * 应将`$.data()`重构为`$.attr()`。 - * 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 +- 对于旧代码： -* 对于新代码： - * 不应使用`node.dataset`，而应使用`node.getAttribute`。 - * 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 + - 应将`$.data()`重构为`$.attr()`。 + - 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 + +- 对于新代码： + - 不应使用`node.dataset`，而应使用`node.getAttribute`。 + - 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 ### 显示/隐藏元素 -* 推荐在Vue组件中使用`v-if`和`v-show`来显示/隐藏元素。 -* Go 模板代码应使用 `.tw-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.tw-hidden`的注释以获取更多详细信息。 +- 推荐在 Vue 组件中使用`v-if`和`v-show`来显示/隐藏元素。 +- Go 模板代码应使用 `.tw-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.tw-hidden`的注释以获取更多详细信息。 ### Go HTML 模板中的样式和属性 建议使用以下方式： ```html -
+
``` 而不是： ```html -
+
``` 以使代码更易读。 @@ -137,6 +146,6 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） Gitea 现在正在使用 Vue3。我们决定不引入 JSX，以保持 HTML 代码和 JavaScript 代码分离。 -### UI示例 +### UI 示例 Gitea 使用一些自制的 UI 元素并自定义其他元素，以将它们更好地集成到通用 UI 方法中。当在开发模式（`RUN_MODE=dev`）下运行 Gitea 时，在 `http(s)://your-gitea-url:port/devtest` 下会提供一个包含一些标准化 UI 示例的页面。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-refactoring.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-refactoring.md index fbc4ae49..589efe64 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-refactoring.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/guidelines-refactoring.md @@ -6,38 +6,37 @@ sidebar_position: 20 aliases: - /zh-cn/guidelines-refactoring - --- # 重构指南 ## 背景 -自2014年2月12日编写了第一行代码以来，Gitea已经发展成为一个庞大的项目。 +自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成为一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多过时的机制，许多框架混合在一起，一些遗留代码可能会导致错误并阻碍新功能的开发。 -为了使代码库更易于维护，使Gitea变得更好，开发人员应牢记使用现代机制来重构旧代码。 +为了使代码库更易于维护，使 Gitea 变得更好，开发人员应牢记使用现代机制来重构旧代码。 本文档是关于重构代码库的指南集合。 ## 重构建议 -* 设计更多关于未来的内容，而不仅仅解决当前问题。 -* 减少模糊性，减少冲突，提高可维护性。 -* 描述重构，例如： - * 为什么需要重构。 - * 如何解决旧问题。 - * 重构的优点/缺点是什么。 -* 只做必要的更改，尽量保留旧逻辑。 -* 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个PR中完成。 -* 如果存在分歧，应该请TOC（技术监督委员会）参与决策。 -* 添加必要的测试以确保重构的正确性。 -* 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 +- 设计更多关于未来的内容，而不仅仅解决当前问题。 +- 减少模糊性，减少冲突，提高可维护性。 +- 描述重构，例如： + - 为什么需要重构。 + - 如何解决旧问题。 + - 重构的优点/缺点是什么。 +- 只做必要的更改，尽量保留旧逻辑。 +- 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。 +- 如果存在分歧，应该请 TOC（技术监督委员会）参与决策。 +- 添加必要的测试以确保重构的正确性。 +- 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 ## 审查和合并建议 -* 重构的PR不应该长时间保持打开状态（通常为7天），应尽快进行审查。 -* 重构的PR应尽快合并，不应被其他PR阻塞。 -* 如果TOC没有异议，重构的PR可以在7天后由一名核心成员（非作者）批准后合并。 -* 如果最终结果良好，容忍一些不完美/临时的步骤。 -* 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 +- 重构的 PR 不应该长时间保持打开状态（通常为 7 天），应尽快进行审查。 +- 重构的 PR 应尽快合并，不应被其他 PR 阻塞。 +- 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合并。 +- 如果最终结果良好，容忍一些不完美/临时的步骤。 +- 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/localization.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/localization.md index 455b4531..296c579f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/localization.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/contributing/localization.md @@ -6,14 +6,13 @@ sidebar_position: 70 aliases: - /zh-cn/localization - --- # 本地化 -Gitea的本地化是通过我们的[Crowdin项目](https://crowdin.com/project/gitea)进行的。 +Gitea 的本地化是通过我们的[Crowdin 项目](https://crowdin.com/project/gitea)进行的。 -对于对**英语翻译**的更改，可以发出pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 +对于对**英语翻译**的更改，可以发出 pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 有关对**非英语**翻译的更改，请参阅上面的 Crowdin 项目。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/hacking-on-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/hacking-on-gitea.md index d59fb19a..2bf82e9a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/hacking-on-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/hacking-on-gitea.md @@ -16,7 +16,7 @@ aliases: ## 安装 Golang -您需要 [安装 go]( https://go.dev/doc/install ) 并设置您的 go 环境。 +您需要 [安装 go](https://go.dev/doc/install) 并设置您的 go 环境。 接下来，[使用 npm 安装 Node.js](https://nodejs.org/en/download/) ，这是构建 JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @minNodeVersion@ @@ -24,12 +24,12 @@ JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @mi **注意** ：当执行需要外部工具的 make 任务时，比如 `make watch-backend`，Gitea 会自动下载并构建这些必要的组件。为了能够使用这些，你必须 -将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把go bin目录添加到可执行路径你必须手动 +将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把 go bin 目录添加到可执行路径你必须手动 指定可执行程序路径。 -**注意2** ：Go版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 +**注意 2** ：Go 版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 格式化源代码。然而，`gofmt` 的结果可能因 `go` 的版本而有差异。因此推荐安装我们持续集成使用 -的 Go版本。截至上次更新，Go 版本应该是 @goVersion@。 +的 Go 版本。截至上次更新，Go 版本应该是 @goVersion@。 ## 安装 Make @@ -55,15 +55,15 @@ sudo yum install make Make 的这三个发行版都可以在 Windows 上运行： -- [单个二进制构建]( http://www.equation.com/servlet/equation.cmd?fa=make )。复制到某处并添加到 `PATH`。 +- [单个二进制构建](http://www.equation.com/servlet/equation.cmd?fa=make)。复制到某处并添加到 `PATH`。 - [32 位版本](http://www.equation.com/ftpdir/make/32/make.exe) - [64 位版本](http://www.equation.com/ftpdir/make/64/make.exe) - [MinGW-w64](https://www.mingw-w64.org) / [MSYS2](https://www.msys2.org/)。 - MSYS2 是一个工具和库的集合，为您提供一个易于使用的环境来构建、安装和运行本机 Windows 软件，它包括 MinGW-w64。 - 在 MingGW-w64 中，二进制文件称为 `mingw32-make.exe` 而不是 `make.exe`。将 `bin` 文件夹添加到 `PATH`。 - 在 MSYS2 中，您可以直接使用 `make`。请参阅 [MSYS2 移植](https://www.msys2.org/wiki/Porting/)。 - - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 _beginthread 一样。 -- [Chocolatey包管理器]( https://chocolatey.org/packages/make )。运行`choco install make` + - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 \_beginthread 一样。 +- [Chocolatey 包管理器](https://chocolatey.org/packages/make)。运行`choco install make` **注意** ：如果您尝试在 Windows 命令提示符下使用 make 进行构建，您可能会遇到问题。建议使用上述提示（Git bash 或 MinGW），但是如果您只有命令提示符（或可能是 PowerShell），则可以使用 [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) 命令，例如 `set TAGS=bindata`。 @@ -75,7 +75,7 @@ Make 的这三个发行版都可以在 Windows 上运行： git clone https://github.com/go-gitea/gitea ``` -（自从go modules出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） +（自从 go modules 出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） ## 派生 Gitea @@ -196,7 +196,7 @@ SVG 图标是使用 `make svg` 命令构建的，该命令将图标资源编译 ### 构建 Logo -Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 +Gitea Logo 的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 通过更新 `assets/logo.svg` 并运行 `make generate-images`，同样的过程也可用于从 SVG 源文件生成自定义 Logo PNG。忽略 gitea 编译选项将仅更新用户指定的 LOGO 文件。 @@ -205,7 +205,7 @@ Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 创建新的 API 路由或修改现有的 API 路由时，您**必须** 更新和/或创建 [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/) 这些使用 [go-swagger](https://goswagger.io/) 评论的文档。 -[规范]( https://goswagger.io/use/spec.html#annotation-syntax )中描述了这些注释的结构。 +[规范](https://goswagger.io/use/spec.html#annotation-syntax)中描述了这些注释的结构。 如果您想了解更多有关 Swagger 结构的信息，可以查看 [Swagger 2.0 文档](https://swagger.io/docs/specification/2-0/basic-structure/) 或与添加新 API 端点的先前 PR 进行比较，例如 [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20) @@ -239,7 +239,7 @@ make swagger-check 并到[配置备忘单](../administration/config-cheat-sheet.md) 在 `docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到 -### 更改Logo +### 更改 Logo 更改 Gitea Logo SVG 时，您将需要运行并提交结果的： @@ -291,7 +291,7 @@ TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite 我们的持续集成将测试代码是否通过了单元测试，并且所有支持的数据库都将在 Docker 环境中通过集成测试。 还将测试从几个最新版本的 Gitea 迁移。 -请在PR中附带提交适当的单元测试和集成测试。 +请在 PR 中附带提交适当的单元测试和集成测试。 ## 网站文档 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/integrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/integrations.md index 052a8734..049d0bba 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/integrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/integrations.md @@ -8,7 +8,7 @@ aliases: # 集成 -Gitea拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 +Gitea 拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 我们正在[awesome-gitea](https://gitea.com/gitea/awesome-gitea)上整理一个列表来跟踪这些集成！ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/migrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/migrations.md index b92449e6..60cad1ab 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/migrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/migrations.md @@ -8,24 +8,24 @@ aliases: # 迁移接口 -完整迁移功能在Gitea 1.9.0版本中引入。它定义了两个接口，用于支持从其他Git托管平台迁移存储库数据到Gitea，或者在将来将Gitea数据迁移到其他Git托管平台。 +完整迁移功能在 Gitea 1.9.0 版本中引入。它定义了两个接口，用于支持从其他 Git 托管平台迁移存储库数据到 Gitea，或者在将来将 Gitea 数据迁移到其他 Git 托管平台。 -目前已实现了从GitHub、GitLab和其他Gitea实例的迁移。 +目前已实现了从 GitHub、GitLab 和其他 Gitea 实例的迁移。 -首先，Gitea在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 +首先，Gitea 在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 ## 下载器接口 -要从新的Git托管平台迁移，需要进行两个步骤的更新。 +要从新的 Git 托管平台迁移，需要进行两个步骤的更新。 - 您应该实现一个`Downloader`，用于获取存储库信息。 -- 您应该实现一个`DownloaderFactory`，用于检测URL是否匹配，并创建上述的`Downloader`。 +- 您应该实现一个`DownloaderFactory`，用于检测 URL 是否匹配，并创建上述的`Downloader`。 - 您需要在`init()`中通过`RegisterDownloaderFactory`注册`DownloaderFactory`。 您可以在[downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go)中找到这些接口。 ## 上传器接口 -目前，只实现了`GiteaLocalUploader`，因此我们只能通过此Uploader将下载的数据保存到本地的Gitea实例。目前不支持其他上传器。 +目前，只实现了`GiteaLocalUploader`，因此我们只能通过此 Uploader 将下载的数据保存到本地的 Gitea 实例。目前不支持其他上传器。 您可以在[uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go)中找到这些接口。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/oauth2-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/oauth2-provider.md index da39853f..66dd333d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/oauth2-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/development/oauth2-provider.md @@ -33,40 +33,40 @@ Gitea 支持作为 OAuth2 提供者，允许第三方应用程序在用户同意 Gitea 支持以下令牌范围: -| 名称 | 介绍 | -| ---- | ----------- | -| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | -| **repo** | 完全控制所有存储库 | -|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | -|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | -| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | -|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | -|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | -| **admin:org** | 授予对组织设置的完全访问权限 | -|     **write:org** | 授予对组织设置的读/写访问权限 | -|     **read:org** | 授予对组织设置的只读访问权限 | -| **admin:public_key** | 授予公钥管理的完全访问权限 | -|     **write:public_key** | 授予对公钥的读/写访问权限 | -|     **read:public_key** | 授予对公钥的只读访问权限 | -| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | -| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | -| **notification** | 授予对通知的完全访问权限 | -| **user** | 授予对用户个人资料信息的完全访问权限 | -|     **read:user** | 授予对用户个人资料的读取权限 | -|     **user:email** | 授予对用户电子邮件地址的读取权限 | -|     **user:follow** | 授予访问权限以关注/取消关注用户 | -| **delete_repo** | 授予删除存储库的权限 | -| **package** | 授予对托管包的完全访问权限 | -|     **write:package** | 授予对包的读/写访问权限 | -|     **read:package** | 授予对包的读取权限 | -|     **delete:package** | 授予对包的删除权限 | -| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | -|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | -|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | -| **admin:application** | 授予应用程序管理的完全访问权限 | -|     **write:application** | 授予应用程序管理的读/写访问权限 | -|     **read:application** | 授予应用程序管理的读取权限 | -| **sudo** | 允许以站点管理员身份执行操作 | +| 名称 | 介绍 | +| ---------------------------------------- | --------------------------------------------------------------- | +| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | +| **repo** | 完全控制所有存储库 | +|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | +|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | +| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | +|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | +|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | +| **admin:org** | 授予对组织设置的完全访问权限 | +|     **write:org** | 授予对组织设置的读/写访问权限 | +|     **read:org** | 授予对组织设置的只读访问权限 | +| **admin:public_key** | 授予公钥管理的完全访问权限 | +|     **write:public_key** | 授予对公钥的读/写访问权限 | +|     **read:public_key** | 授予对公钥的只读访问权限 | +| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | +| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | +| **notification** | 授予对通知的完全访问权限 | +| **user** | 授予对用户个人资料信息的完全访问权限 | +|     **read:user** | 授予对用户个人资料的读取权限 | +|     **user:email** | 授予对用户电子邮件地址的读取权限 | +|     **user:follow** | 授予访问权限以关注/取消关注用户 | +| **delete_repo** | 授予删除存储库的权限 | +| **package** | 授予对托管包的完全访问权限 | +|     **write:package** | 授予对包的读/写访问权限 | +|     **read:package** | 授予对包的读取权限 | +|     **delete:package** | 授予对包的删除权限 | +| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | +|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | +|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | +| **admin:application** | 授予应用程序管理的完全访问权限 | +|     **write:application** | 授予应用程序管理的读/写访问权限 | +|     **read:application** | 授予应用程序管理的读取权限 | +| **sudo** | 允许以站点管理员身份执行操作 | ## 客户端类型 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/faq.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/faq.md index dece1fd3..6deb90e3 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/faq.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/faq.md @@ -6,7 +6,6 @@ sidebar_position: 5 aliases: - /zh-cn/faq - --- # 常见问题 @@ -15,127 +14,127 @@ aliases: 有关更多帮助资源，请查看所有[支持选项](help/support.md)。 -## 1.x和1.x.x下载之间的区别 +## 1.x 和 1.x.x 下载之间的区别 -以1.7.x版本为例。 +以 1.7.x 版本为例。 -**注意：**此示例也适用于Docker镜像！ +**注意：**此示例也适用于 Docker 镜像！ -在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个1.7目录，以及1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5和1.7.6的目录。 +在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个 1.7 目录，以及 1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5 和 1.7.6 的目录。 -1.7目录和1.7.0目录是**不同**的。1.7目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 +1.7 目录和 1.7.0 目录是**不同**的。1.7 目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 -然而，1.7.0目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 +然而，1.7.0 目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 -这意味着1.x的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 +这意味着 1.x 的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 -另一方面，1.x.x的下载应该永远不会改变。 +另一方面，1.x.x 的下载应该永远不会改变。 -## 如何从Gogs/GitHub等迁移到Gitea +## 如何从 Gogs/GitHub 等迁移到 Gitea -要从Gogs迁移到Gitea： +要从 Gogs 迁移到 Gitea： -- [Gogs版本0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) +- [Gogs 版本 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) -要从GitHub迁移到Gitea，您可以使用Gitea内置的迁移表单。 +要从 GitHub 迁移到 Gitea，您可以使用 Gitea 内置的迁移表单。 为了迁移诸如问题、拉取请求等项目，您需要至少输入您的用户名。 [Example (requires login)](https://demo.gitea.com/repo/migrate) -要从GitLab迁移到Gitea，您可以使用这个非关联的工具： +要从 GitLab 迁移到 Gitea，您可以使用这个非关联的工具： https://github.com/loganinak/MigrateGitlabToGogs -## Gitea存储文件的位置 +## Gitea 存储文件的位置 - _`AppWorkPath`_ - `--work-path`标志 - 或者环境变量`GITEA_WORK_DIR` - 或者在构建时设置的内置值 - - 或者包含Gitea二进制文件的目录 + - 或者包含 Gitea 二进制文件的目录 - `%(APP_DATA_PATH)`（数据库、索引器等的默认路径） - `app.ini`中的`APP_DATA_PATH` - - 或者_`AppWorkPath`_`/data` + - 或者*`AppWorkPath`*`/data` - _`CustomPath`_（自定义模板） - `--custom-path`标志 - 或者环境变量`GITEA_CUSTOM` - 或者在构建时设置的内置值 - - 或者_`AppWorkPath`_`/custom` + - 或者*`AppWorkPath`*`/custom` - HomeDir - Unix：环境变量`HOME` - Windows：环境变量`USERPROFILE`，或者环境变量`HOMEDRIVE`+`HOMEPATH` - RepoRootPath - `app.ini`中\[repository]部分的`ROOT`（如果是绝对路径） - - 否则_`AppWorkPath`_`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） + - 否则*`AppWorkPath`*`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） - 默认值为`%(APP_DATA_PATH)/gitea-repositories` - INI（配置文件） - `--config`标志 - 或者在构建时设置的可能内置值 - 或者 _`CustomPath`_`/conf/app.ini` -- SQLite数据库 - - app.ini中database部分的PATH +- SQLite 数据库 + - app.ini 中 database 部分的 PATH - 或者`%(APP_DATA_PATH)/gitea.db` -## 看不到克隆URL或克隆URL不正确 +## 看不到克隆 URL 或克隆 URL 不正确 有几个地方可能会导致显示不正确。 1. 如果使用反向代理，请确保按照[反向代理指南](../administration/reverse-proxies.md)中的正确说明进行设置。 2. 确保在`app.ini`的`server`部分中正确设置了`ROOT_URL`。 -如果某些克隆选项未显示（HTTP/S或SSH），可以在`app.ini中` +如果某些克隆选项未显示（HTTP/S 或 SSH），可以在`app.ini中` -- `DISABLE_HTTP_GIT`: 如果设为true, 将会没有HTTP/HTTPS链接 -- `DISABLE_SSH`: 如果设为true, 将会没有SSH链接 -- `SSH_EXPOSE_ANONYMOUS`: 如果设为false, SSH链接将会对匿名用户隐藏 +- `DISABLE_HTTP_GIT`: 如果设为 true, 将会没有 HTTP/HTTPS 链接 +- `DISABLE_SSH`: 如果设为 true, 将会没有 SSH 链接 +- `SSH_EXPOSE_ANONYMOUS`: 如果设为 false, SSH 链接将会对匿名用户隐藏 ## 文件上传失败：413 Request Entity Too Large 当反向代理限制文件上传大小时，会出现此错误。 -有关使用nginx解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 +有关使用 nginx 解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 ## 自定义模板无法加载或运行错误 -Gitea的自定义模板必须将其添加到正确的位置，否则Gitea将无法找到并使用自定义模板。 +Gitea 的自定义模板必须将其添加到正确的位置，否则 Gitea 将无法找到并使用自定义模板。 模板的正确路径应该相对于`CustomPath`。 1. 要找到`CustomPath`，请在站点管理 -> 配置 中查找自定义文件根路径。 - 如果找不到，请尝试`echo $GITEA_CUSTOM`。 + 如果找不到，请尝试`echo $GITEA_CUSTOM`。 2. 如果仍然找不到，默认值可以被[计算](faq.md#Gitea存储文件的位置) -3. 如果仍然找不到路径，则可以参考[自定义Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 +3. 如果仍然找不到路径，则可以参考[自定义 Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 -## Gitea是否有"GitHub/GitLab Pages"功能？ +## Gitea 是否有"GitHub/GitLab Pages"功能？ -Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供静态页面，以避免CSRF安全风险。 +Gitea 不提供内置的 Pages 服务器。您需要一个专用的域名来提供静态页面，以避免 CSRF 安全风险。 -对于简单的用法，您可以使用反向代理来重写和提供Gitea的原始文件URL中的静态内容。 +对于简单的用法，您可以使用反向代理来重写和提供 Gitea 的原始文件 URL 中的静态内容。 还有一些已经可用的第三方服务，比如独立[pages server](https://codeberg.org/Codeberg/pages-server)的或[caddy plugin](https://github.com/42wim/caddy-gitea)，可以提供所需的功能。 ## 活跃用户与禁止登录用户 -在Gitea中，"活跃用户"是指通过电子邮件激活其帐户的用户。 +在 Gitea 中，"活跃用户"是指通过电子邮件激活其帐户的用户。 -"禁止登录用户"是指不允许再登录到Gitea的用户。 +"禁止登录用户"是指不允许再登录到 Gitea 的用户。 ## 设置日志记录 - [官方文档](../administration/logging-config.md) -## 什么是Swagger？ +## 什么是 Swagger？ -[Swagger](https://swagger.io/) 是Gitea用于其API文档的工具。 +[Swagger](https://swagger.io/) 是 Gitea 用于其 API 文档的工具。 -所有Gitea实例都有内置的API，无法完全禁用它。 -但是，您可以在app.ini的api部分将ENABLE_SWAGGER设置为false，以禁用其文档显示。 -有关更多信息，请参阅Gitea的[API文档](development/api-usage.md)。 +所有 Gitea 实例都有内置的 API，无法完全禁用它。 +但是，您可以在 app.ini 的 api 部分将 ENABLE_SWAGGER 设置为 false，以禁用其文档显示。 +有关更多信息，请参阅 Gitea 的[API 文档](development/api-usage.md)。 -您可以在上查看最新的API（例如）https://gitea.com/api/swagger +您可以在上查看最新的 API（例如）https://gitea.com/api/swagger 您还可以在上查看`swagger.json`文件的示例 https://gitea.com/swagger.v1.json @@ -146,7 +145,7 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 有多种方法可以组合使用来防止垃圾邮件发送者： 1. 通过设置电子邮件域名的白名单或黑名单。 -2. 通过设置一些域名或者OpenID白名单（见下文）。 +2. 通过设置一些域名或者 OpenID 白名单（见下文）。 3. 在您的`app.ini`中将`ENABLE_CAPTCHA`设置为`true`，并正确配置`RECAPTCHA_SECRET`和 `RECAPTCHA_SITEKEY`。 4. 将`DISABLE_REGISTRATION`设置为`true`，并通过 [CLI](../administration/command-line.md)、[API](development/api-usage.md) 或 Gitea 的管理界面创建新用户。 @@ -176,13 +175,13 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 使用 [Fail2Ban](../administration/fail2ban-setup.md) 监视并阻止基于日志模式的自动登录尝试或其他恶意行为。 -## SSHD vs 内建SSH +## SSHD vs 内建 SSH -SSHD是大多数Unix系统上内建的SSH服务器。 +SSHD 是大多数 Unix 系统上内建的 SSH 服务器。 -Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 +Gitea 还提供了自己的 SSH 服务器，用于在 SSHD 不可用时使用。 -## Gitea运行缓慢 +## Gitea 运行缓慢 导致此问题的最常见原因是加载联合头像。 @@ -192,21 +191,21 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 ## 无法创建仓库/文件 -请确保Gitea具有足够的权限来写入其主目录和数据目录。 +请确保 Gitea 具有足够的权限来写入其主目录和数据目录。 参见[AppDataPath 和 RepoRootPath](faq.md#Gitea存储文件的位置) -**适用于Arch用户的注意事项：**在撰写本文时，Arch软件包的systemd文件包含了以下行： +**适用于 Arch 用户的注意事项：**在撰写本文时，Arch 软件包的 systemd 文件包含了以下行： `ReadWritePaths=/etc/gitea/app.ini` -这将使得Gitea无法写入其他路径。 +这将使得 Gitea 无法写入其他路径。 ## 翻译不正确/如何添加更多翻译 -我们当前的翻译是在我们的[Crowdin项目](https://crowdin.com/project/gitea)上众包进行的 +我们当前的翻译是在我们的[Crowdin 项目](https://crowdin.com/project/gitea)上众包进行的 -无论您想要更改翻译还是添加新的翻译，都需要在Crowdin集成中进行，因为所有翻译都会被CI覆盖。 +无论您想要更改翻译还是添加新的翻译，都需要在 Crowdin 集成中进行，因为所有翻译都会被 CI 覆盖。 ## 推送钩子/ Webhook / Actions 未运行 @@ -214,15 +213,15 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 这可能是由于以下原因： -1. Git钩子不同步：在站点管理面板上运行“重新同步所有仓库的pre-receive、update和post-receive钩子” -2. Git仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由NAS挂载），请确保文件系统支持`chmod a+x any-script` -3. 如果您使用的是Docker，请确保Docker Server（而不是客户端）的版本 >= 20.10.6 +1. Git 钩子不同步：在站点管理面板上运行“重新同步所有仓库的 pre-receive、update 和 post-receive 钩子” +2. Git 仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由 NAS 挂载），请确保文件系统支持`chmod a+x any-script` +3. 如果您使用的是 Docker，请确保 Docker Server（而不是客户端）的版本 >= 20.10.6 -## SSH问题 +## SSH 问题 如果无法通过`ssh`访问仓库，但`https`正常工作，请考虑以下情况。 -首先，请确保您可以通过SSH访问Gitea。 +首先，请确保您可以通过 SSH 访问 Gitea。 `ssh git@myremote.example` @@ -250,16 +249,18 @@ fatal: Could not read from remote repository. - 在客户端： - 确保公钥和私钥已添加到正确的 Gitea 用户。 - - 确保远程 URL 中没有任何问题。特别是，请确保∂ - Git 用户（@ 之前的部分）的名称拼写正确。 + - 确保远程 URL 中没有任何问题。特别是，请确保 ∂ + Git 用户（@ 之前的部分）的名称拼写正确。 - 确保客户端机器上的公钥和私钥正确无误。 - 在服务器上： + - 确保存储库存在并且命名正确。 - 检查系统用户主目录中的 `.ssh` 目录的权限。 - 验证正确的公钥是否已添加到 `.ssh/authorized_keys` 中。 尝试在 Gitea 管理面板上运行 `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)`。 + - 查看 Gitea 日志。 - 查看 /var/log/auth（或类似的文件）。 - 检查存储库的权限。 @@ -331,7 +332,9 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 - 使用[管理 CLI 命令](../administration/command-line.md#admin)。 请注意，大多数命令还需要一个[全局标志](../administration/command-line.md#全局选项)来指向正确的配置。 + - 作为**用户**，您可以更改密码... + - 在您的账户的`设置 -> 账户`页面（此方法**需要**您知道当前密码）。 - 使用`忘记密码`链接。 @@ -341,7 +344,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 在 Gitea 版本 `1.11` 中，我们转换为使用[goldmark](https://github.com/yuin/goldmark)进行 Markdown 渲染，它符合[CommonMark](https://commonmark.org/)标准。 -如果您在版本`1.11`之前的Markdown正常工作，但在升级后无法正常工作，请仔细阅读CommonMark规范，看看问题是由错误还是非兼容的语法引起的。 +如果您在版本`1.11`之前的 Markdown 正常工作，但在升级后无法正常工作，请仔细阅读 CommonMark 规范，看看问题是由错误还是非兼容的语法引起的。 如果是后者，通常规范中会列出一种符合标准的替代方法。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/support.md index 97e952c8..2717f67e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/help/support.md @@ -67,5 +67,5 @@ ENABLE_PPROF = true 2. 重新启动 Gitea -3. 尝试触发bug，当请求卡住一段时间，使用或浏览器访问：获取堆栈跟踪。 -`curl http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` +3. 尝试触发 bug，当请求卡住一段时间，使用或浏览器访问：获取堆栈跟踪。 + `curl http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/comparison.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/comparison.md index 21bf1afc..db2c6840 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/comparison.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/comparison.md @@ -6,7 +6,6 @@ sidebar_position: 5 aliases: - /zh-cn/comparison - --- # 对比 Gitea 与其它 Git 托管工具 @@ -17,68 +16,68 @@ aliases: _表格中的符号含义:_ -* _✓ - 支持_ +- _✓ - 支持_ -* _⁄ - 部分支持_ +- _⁄ - 部分支持_ -* _✘ - 不支持_ +- _✘ - 不支持_ -* _⚙️ - 由第三方服务或插件支持_ +- _⚙️ - 由第三方服务或插件支持_ #### 主要特性 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------- | -------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | -| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | -| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | -| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | -| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | -| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | -| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | -| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | -| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | -| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | -| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | -| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | -| Markdown绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Markdown数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | +| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | +| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | +| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | +| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | +| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | +| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | +| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | +| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | +| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | +| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | +| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | +| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | +| Markdown 绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Markdown 数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | #### 代码管理 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------------ | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | -| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | -| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | -| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | -| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | -| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | -| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | +| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | +| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | +| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | +| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | +| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | +| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | #### 工单管理 @@ -96,7 +95,7 @@ _表格中的符号含义:_ | 工单批处理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单看板 | [✓](https://github.com/go-gitea/gitea/pull/8346) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 从工单创建分支 | ✘ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单全局搜索 | [✘](https://github.com/go-gitea/gitea/issues/2434) | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单依赖关系 | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | @@ -118,7 +117,7 @@ _表格中的符号含义:_ | Pull/Merge requests 模板 | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | | 查看 Cherry-picking 的更改 | [✓](https://github.com/go-gitea/gitea/issues/5158) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 下载 Patch | ✓ | ✘ | ✓ | ✓ | ✓ | [/](https://jira.atlassian.com/plugins/servlet/mobile#issue/BCLOUD-8323) | ✘ | -| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | +| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | #### 第三方集成 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/database-preparation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/database-preparation.md index 4cc981ae..245d5b11 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/database-preparation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/database-preparation.md @@ -6,7 +6,6 @@ sidebar_position: 10 aliases: - /zh-cn/database-prep - --- # 数据库准备 @@ -23,153 +22,153 @@ aliases: 1. 对于远程数据库设置，您需要让 MySQL 监听您的 IP 地址。编辑数据库实例上的 `/etc/mysql/my.cnf` 文件中的 `bind-address` 选项为： - ```ini - bind-address = 203.0.113.3 - ``` + ```ini + bind-address = 203.0.113.3 + ``` 2. 在数据库实例上，使用 `root` 用户登录到数据库控制台： - ``` - mysql -u root -p - ``` + ``` + mysql -u root -p + ``` - 按提示输入密码。 + 按提示输入密码。 3. 创建一个将被 Gitea 使用的数据库用户，并使用密码进行身份验证。以下示例中使用了 `'gitea'` 作为密码。请为您的实例使用一个安全密码。 - 对于本地数据库： + 对于本地数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea' IDENTIFIED BY 'gitea'; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; + ``` - 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 + 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 - 根据需要替换上述用户名和密码。 + 根据需要替换上述用户名和密码。 4. 使用 UTF-8 字符集和大小写敏感的排序规则创建数据库。 - `utf8mb4_bin` 是 MySQL/MariaDB 的通用排序规则。 - Gitea 启动后会尝试把数据库修改为更合适的字符集 (`utf8mb4_0900_as_cs` 或者 `uca1400_as_cs`) 并在可能的情况下更改数据库。 - 如果你想指定自己的字符集规则，可以在 `app.ini` 中设置 `[database].CHARSET_COLLATION`。 + `utf8mb4_bin` 是 MySQL/MariaDB 的通用排序规则。 + Gitea 启动后会尝试把数据库修改为更合适的字符集 (`utf8mb4_0900_as_cs` 或者 `uca1400_as_cs`) 并在可能的情况下更改数据库。 + 如果你想指定自己的字符集规则，可以在 `app.ini` 中设置 `[database].CHARSET_COLLATION`。 - ```sql - CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin'; - ``` + ```sql + CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 5. 将数据库上的所有权限授予上述创建的数据库用户。 - 对于本地数据库： + 对于本地数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; + FLUSH PRIVILEGES; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; + FLUSH PRIVILEGES; + ``` 6. 通过 `exit` 退出数据库控制台。 7. 在您的 Gitea 服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h 203.0.113.3 -p giteadb - ``` + ``` + mysql -u gitea -h 203.0.113.3 -p giteadb + ``` - 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 `-h` 选项。 + 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 `-h` 选项。 - 到此您应该能够连接到数据库了。 + 到此您应该能够连接到数据库了。 ## PostgreSQL 1. 对于远程数据库设置，通过编辑数据库实例上的 postgresql.conf 文件中的 `listen_addresses` 将 `PostgreSQL` 配置为监听您的 IP 地址： - ```ini - listen_addresses = 'localhost, 203.0.113.3' - ``` + ```ini + listen_addresses = 'localhost, 203.0.113.3' + ``` 2. PostgreSQL 默认使用 `md5` 质询-响应加密方案进行密码身份验证。现在这个方案不再被认为是安全的。改用 SCRAM-SHA-256 方案，通过编辑数据库服务器上的` postgresql.conf` 配置文件： - ```ini - password_encryption = scram-sha-256 - ``` + ```ini + password_encryption = scram-sha-256 + ``` - 重启 PostgreSQL 以应用该设置。 + 重启 PostgreSQL 以应用该设置。 3. 在数据库服务器上，以超级用户身份登录到数据库控制台： - ``` - su -c "psql" - postgres - ``` + ``` + su -c "psql" - postgres + ``` 4. 创建具有登录权限和密码的数据库用户（在 PostgreSQL 术语中称为角色）。请使用安全的、强密码，而不是下面的 `'gitea'`： - ```sql - CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; - ``` + ```sql + CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; + ``` - 根据需要替换用户名和密码。 + 根据需要替换用户名和密码。 5. 使用 UTF-8 字符集创建数据库，并由之前创建的数据库用户拥有。可以根据预期内容使用任何 `libc` 排序规则，使用 `LC_COLLATE` 和 `LC_CTYPE` 参数指定： - ```sql - CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; - ``` + ```sql + CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 6. 通过将以下身份验证规则添加到 `pg_hba.conf`，允许数据库用户访问上面创建的数据库。 - 对于本地数据库： + 对于本地数据库： - ```ini - local giteadb gitea scram-sha-256 - ``` + ```ini + local giteadb gitea scram-sha-256 + ``` - 对于远程数据库： + 对于远程数据库： - ```ini - host giteadb gitea 192.0.2.10/32 scram-sha-256 - ``` + ```ini + host giteadb gitea 192.0.2.10/32 scram-sha-256 + ``` - 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 + 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 - 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 + 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 - 重启 PostgreSQL 以应用新的身份验证规则。 + 重启 PostgreSQL 以应用新的身份验证规则。 7. 在您的 Gitea 服务器上，测试与数据库的连接。 - 对于本地数据库： + 对于本地数据库： - ``` - psql -U gitea -d giteadb - ``` + ``` + psql -U gitea -d giteadb + ``` - 对于远程数据库： + 对于远程数据库： - ``` - psql "postgres://gitea@203.0.113.3/giteadb" - ``` + ``` + psql "postgres://gitea@203.0.113.3/giteadb" + ``` - 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 + 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 - 您应该会被提示输入数据库用户的密码，并连接到数据库。 + 您应该会被提示输入数据库用户的密码，并连接到数据库。 ## 使用 TLS 进行数据库连接 @@ -188,116 +187,116 @@ Gitea 使用的 PostgreSQL 驱动程序支持双向 TLS。在双向 TLS 中， 1. 在数据库实例所在的服务器上，放置以下凭据： - - `/path/to/postgresql.crt`: 数据库实例证书 - - `/path/to/postgresql.key`: 数据库实例私钥 - - `/path/to/root.crt`: 用于验证客户端证书的CA证书链 + - `/path/to/postgresql.crt`: 数据库实例证书 + - `/path/to/postgresql.key`: 数据库实例私钥 + - `/path/to/root.crt`: 用于验证客户端证书的 CA 证书链 2. 在 `postgresql.conf` 中添加以下选项： - ```ini - ssl = on - ssl_ca_file = '/path/to/root.crt' - ssl_cert_file = '/path/to/postgresql.crt' - ssl_key_file = '/path/to/postgresql.key' - ssl_min_protocol_version = 'TLSv1.2' - ``` + ```ini + ssl = on + ssl_ca_file = '/path/to/root.crt' + ssl_cert_file = '/path/to/postgresql.crt' + ssl_key_file = '/path/to/postgresql.key' + ssl_min_protocol_version = 'TLSv1.2' + ``` 3. 根据 PostgreSQL 的要求，调整凭据的所有权和权限： - ``` - chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - ``` + ``` + chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + ``` -4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过SSL连接，并要求客户端证书验证。 +4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过 SSL 连接，并要求客户端证书验证。 - 对于PostgreSQL 12： + 对于 PostgreSQL 12： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full + ``` - 对于PostgreSQL 11及更早版本： + 对于 PostgreSQL 11 及更早版本： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 + ``` - 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 + 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 5. 重新启动 PostgreSQL 以应用上述配置。 6. 在运行 Gitea 实例的服务器上，将以下凭据放置在运行 Gitea 的用户的主目录下（例如 `git`）： - - `~/.postgresql/postgresql.crt`: 数据库客户端证书 - - `~/.postgresql/postgresql.key`: 数据库客户端私钥 - - `~/.postgresql/root.crt`: 用于验证服务器证书的CA证书链 + - `~/.postgresql/postgresql.crt`: 数据库客户端证书 + - `~/.postgresql/postgresql.key`: 数据库客户端私钥 + - `~/.postgresql/root.crt`: 用于验证服务器证书的 CA 证书链 - 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 + 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 7. 根据需要调整凭据、所有权和权限： - ``` - chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - ``` + ``` + chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + ``` 8. 测试与数据库的连接： - ``` - psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" - ``` + ``` + psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" + ``` - 您将被提示输入数据库用户的密码，然后连接到数据库。 + 您将被提示输入数据库用户的密码，然后连接到数据库。 ### MySQL/MariaDB TLS -虽然 Gitea 使用的MySQL驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 +虽然 Gitea 使用的 MySQL 驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 -在单向TLS中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 +在单向 TLS 中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 1. 在数据库实例上放置以下凭据： - - `/path/to/mysql.crt`: 数据库实例证书 - - `/path/to/mysql.key`: 数据库实例密钥 - - `/path/to/ca.crt`: CA证书链。在单向TLS中不使用此文件，但用于验证双向TLS中的客户端证书。 + - `/path/to/mysql.crt`: 数据库实例证书 + - `/path/to/mysql.key`: 数据库实例密钥 + - `/path/to/ca.crt`: CA 证书链。在单向 TLS 中不使用此文件，但用于验证双向 TLS 中的客户端证书。 2. 将以下选项添加到 `my.cnf`： - ```ini - [mysqld] - ssl-ca = /path/to/ca.crt - ssl-cert = /path/to/mysql.crt - ssl-key = /path/to/mysql.key - tls-version = TLSv1.2,TLSv1.3 - ``` + ```ini + [mysqld] + ssl-ca = /path/to/ca.crt + ssl-cert = /path/to/mysql.crt + ssl-key = /path/to/mysql.key + tls-version = TLSv1.2,TLSv1.3 + ``` 3. 调整凭据的所有权和权限： - ``` - chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - ``` + ``` + chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + ``` -4. 重新启动MySQL以应用设置。 +4. 重新启动 MySQL 以应用设置。 5. Gitea 的数据库用户可能已经创建过，但只会对运行 Gitea 的服务器的 IP 地址进行身份验证。要对其域名进行身份验证，请重新创建用户，并设置其需要通过 TLS 连接到数据库： - ```sql - DROP USER 'gitea'@'192.0.2.10'; - CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + DROP USER 'gitea'@'192.0.2.10'; + CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; + FLUSH PRIVILEGES; + ``` - 根据需要替换数据库用户名、密码和 Gitea 实例域名。 + 根据需要替换数据库用户名、密码和 Gitea 实例域名。 -6. 确保用于验证数据库服务器证书的CA证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 +6. 确保用于验证数据库服务器证书的 CA 证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 -7. 在运行Gitea的服务器上，测试与数据库的连接： +7. 在运行 Gitea 的服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h example.db -p --ssl - ``` + ``` + mysql -u gitea -h example.db -p --ssl + ``` - 至此应该成功连接到数据库了。 + 至此应该成功连接到数据库了。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-binary.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-binary.md index 855e8ce4..6d8e1b16 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-binary.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-binary.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/install-from-binary - --- # 使用二进制文件安装 @@ -38,7 +37,7 @@ chmod +x gitea ## 验证 GPG 签名 -Gitea 对打包的二进制文件使用 [GPG密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 +Gitea 对打包的二进制文件使用 [GPG 密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 请根据对应文件名 `.asc` 中包含的校验码检验文件的一致性。 ```sh @@ -169,7 +168,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini **提示：** 我们不建议使用 SIGKILL 信号（`-9`），这会强制停止 Gitea 程序，但不会正确关闭队列、索引器等任务。 -请参阅下面的疑难解答说明，以在Gitea版本更新后修复损坏的仓库。 +请参阅下面的疑难解答说明，以在 Gitea 版本更新后修复损坏的仓库。 ## 排查故障 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-package.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-package.md index 16f26b20..2bf61284 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-package.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-package.md @@ -6,7 +6,6 @@ sidebar_position: 20 aliases: - /zh-cn/install-from-package - --- # 官方包管理器 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-source.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-source.md index fe576847..eb22ca10 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-source.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/from-source.md @@ -6,12 +6,11 @@ sidebar_position: 30 aliases: - /zh-cn/install-from-source - --- # 使用源代码安装 -你需要 [安装Go](https://golang.google.cn/doc/install) 并正确设置Go环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 +你需要 [安装 Go](https://golang.google.cn/doc/install) 并正确设置 Go 环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 接下来，[安装 Node.js 和 npm](https://nodejs.org/zh-cn/download/)， 这是构建 JavaScript 和 CSS 文件所需的。最低支持的 Node.js 版本是 @minNodeVersion@，建议使用最新的 LTS 版本。 @@ -36,7 +35,7 @@ git branch -a git checkout @sourceBranch@ ``` -要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID是 `2663 `）： +要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID 是 `2663 `）： ```bash git fetch origin pull/xyz/head:pr-xyz @@ -58,7 +57,7 @@ git checkout @sourceVersion@ # or git checkout pr-xyz - `node` @minNodeVersion@ 或更高版本，并且安装 `npm`, 请参阅 [这里](https://nodejs.org/zh-cn/download/) - `make`, 请参阅 [这里](development/hacking-on-gitea.md) -为了尽可能简化编译过程，提供了各种 [make任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 +为了尽可能简化编译过程，提供了各种 [make 任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 根据你的构建需求，以下 tags 可以使用： @@ -106,7 +105,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite 尽管在开发时这些值很有用，但可能与下游用户的偏好冲突。 -一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行Gitea之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： +一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行 Gitea 之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： - 要设置`CustomPath`，请使用`LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.CustomPath=custom-path\""` - 对于`CustomConf`，应该使用`-X \"code.gitea.io/gitea/modules/setting.CustomConf=conf.ini\"` @@ -122,7 +121,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite `go`编译器工具链支持将代码交叉编译到不同的目标架构上。请参考[`GOOS`和`GOARCH`环境变量](https://go.dev/doc/install/source#environment) 以获取支持的目标列表。如果您想为性能较弱的系统（如树莓派）构建 Gitea，交叉编译非常有用。 -要使用构建标签（`TAGS`）进行交叉编译Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 +要使用构建标签（`TAGS`）进行交叉编译 Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 在没有任何标签的情况下，交叉编译的 Gitea 为 Linux ARM64 版本： @@ -130,7 +129,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite GOOS=linux GOARCH=arm64 make build ``` -要交叉编译 Linux ARM64 下的Gitea，这是推荐的构建标签： +要交叉编译 Linux ARM64 下的 Gitea，这是推荐的构建标签： ``` CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sqlite_unlock_notify" make build @@ -216,6 +215,6 @@ make build 默认情况下，gitea 会为前端文件生成精简的 Source Map 以节省空间。 这可以通过“ENABLE_SOURCEMAP”环境变量进行控制： -- `ENABLE_SOURCEMAP=true` 生成所有Source Map，这是开发版本的默认设置 -- `ENABLE_SOURCEMAP=reduced` 生成有限的Source Map，这是生产版本的默认设置 -- `ENABLE_SOURCEMAP=false` 不生成Source Map +- `ENABLE_SOURCEMAP=true` 生成所有 Source Map，这是开发版本的默认设置 +- `ENABLE_SOURCEMAP=reduced` 生成有限的 Source Map，这是生产版本的默认设置 +- `ENABLE_SOURCEMAP=false` 不生成 Source Map diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-cloud-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-cloud-provider.md index a1a52574..9de5c7a0 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-cloud-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-cloud-provider.md @@ -6,7 +6,6 @@ sidebar_position: 90 aliases: - /zh-cn/install-on-cloud-provider - --- # 在云服务器上安装 Gitea @@ -18,9 +17,9 @@ Cloudron 使得在您的服务器上运行 Gitea，并保持其更新和安全 [![Install](/cloudron.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp) -Gitea软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). +Gitea 软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). -这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行Gitea。 +这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行 Gitea。 ## Linode diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-kubernetes.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-kubernetes.md index 4a09ff69..fba544ce 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-kubernetes.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/on-kubernetes.md @@ -6,7 +6,6 @@ sidebar_position: 80 aliases: - /zh-cn/install-on-kubernetes - --- # 在 Kubernetes 中安装 Gitea @@ -38,15 +37,15 @@ helm install gitea -f values.yaml gitea/gitea Gitea 附带了一个运行状况检查接口 `/api/healthz`，你可以像这样在 Kubernetes 中配置它： ```yaml - livenessProbe: - httpGet: - path: /api/healthz - port: http - initialDelaySeconds: 200 - timeoutSeconds: 5 - periodSeconds: 10 - successThreshold: 1 - failureThreshold: 10 +livenessProbe: + httpGet: + path: /api/healthz + port: http + initialDelaySeconds: 200 + timeoutSeconds: 5 + periodSeconds: 10 + successThreshold: 1 + failureThreshold: 10 ``` 成功的运行状况检查响应代码为 HTTP `200`，下面是示例： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/windows-service.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/windows-service.md index cb174026..b4943496 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/windows-service.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/windows-service.md @@ -6,7 +6,6 @@ sidebar_position: 50 aliases: - /zh-cn/windows-service - --- ## 准备工作 @@ -30,9 +29,9 @@ COMPUTERNAME 是从命令行中运行 `echo %COMPUTERNAME%` 后得到的响应 PATH = c:/gitea/data/gitea.db ``` -## 注册为Windows服务 +## 注册为 Windows 服务 -要注册为Windows服务，首先以Administrator身份运行 `cmd`，然后执行以下命令： +要注册为 Windows 服务，首先以 Administrator 身份运行 `cmd`，然后执行以下命令： ```sh sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\"" @@ -40,7 +39,7 @@ sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \" 别忘了将 `C:\gitea` 替换成你的 Gitea 安装目录。 -之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000是默认端口）。 +之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000 是默认端口）。 ### 服务启动类型 @@ -61,9 +60,9 @@ sc.exe config gitea depend= mariadb 这将确保在 Windows 计算机重新启动时，将延迟自动启动 Gitea，直到数据库准备就绪，从而减少启动失败的情况。 -## 从Windows服务中删除 +## 从 Windows 服务中删除 -以Administrator身份运行 `cmd`，然后执行以下命令： +以 Administrator 身份运行 `cmd`，然后执行以下命令： ```sh sc.exe delete gitea diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker-rootless.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker-rootless.md index 1dcd2d6b..be04d7e4 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker-rootless.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker-rootless.md @@ -45,7 +45,7 @@ services: - "2222:2222" ``` -请注意，卷应由在配置文件中指定的UID/GID的用户/组所有。默认情况下，Docker中的Gitea将使用uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： +请注意，卷应由在配置文件中指定的 UID/GID 的用户/组所有。默认情况下，Docker 中的 Gitea 将使用 uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： ```sh sudo chown 1000:1000 config/ data/ @@ -53,11 +53,11 @@ sudo chown 1000:1000 config/ data/ > 如果未为卷设置正确的权限，容器可能无法启动。 -对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 +对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x 是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 ## 自定义端口 -要将集成的SSH和Web服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 +要将集成的 SSH 和 Web 服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 ```diff version: "2" @@ -258,7 +258,7 @@ docker-compose up -d 除了上述的环境变量外，`app.ini` 中的任何设置都可以通过形式为 `GITEA__SECTION_NAME__KEY_NAME` 的环境变量进行设置或覆盖。这些设置在每次 Docker 容器启动时都会生效。完整信息请参考[这里](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini). -这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA__mailer__FROM、GITEA__mailer__HOST、GITEA__mailer__PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： +这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA**mailer**FROM、GITEA**mailer**HOST、GITEA**mailer**PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： ```bash ... diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker.md index 0cd5e6b3..3a9938ed 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/installation/with-docker.md @@ -6,7 +6,6 @@ sidebar_position: 70 aliases: - /zh-cn/install-with-docker - --- # 使用 Docker 安装 @@ -299,7 +298,7 @@ docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKE ``` ```yaml -... +--- services: server: environment: diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/agit-support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/agit-support.md index 15ad451a..8db4ba09 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/agit-support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/agit-support.md @@ -6,7 +6,6 @@ sidebar_position: 12 aliases: - /zh-cn/agit-setup - --- # AGit 设置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/clone-filter.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/clone-filter.md index f14b0375..90b6709c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/clone-filter.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/clone-filter.md @@ -5,7 +5,6 @@ slug: "clone-filters" sidebar_position: 25 aliases: - /zh-cn/clone-filters - --- # 克隆过滤器 (部分克隆) diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/issue-pull-request-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/issue-pull-request-templates.md index 69a8b416..8e1f3905 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/issue-pull-request-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/issue-pull-request-templates.md @@ -100,16 +100,13 @@ Gitea 支持两种格式的模板：Markdown 和 YAML。 ```md --- - name: "Template Name" about: "This template is for testing!" title: "[TEST] " ref: "main" labels: - -- bug -- "help needed" - + - bug + - "help needed" --- This is the template! diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/labels.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/labels.md index 3f276403..f636ae7a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/labels.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/labels.md @@ -6,7 +6,6 @@ sidebar_position: 13 aliases: - /zh-cn/labels - --- # 标签 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/linked-references.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/linked-references.md index 38010092..0a9a82e3 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/linked-references.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/linked-references.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/automatically-linked-references - --- # 自动链接引用 @@ -93,11 +92,11 @@ aliases: - `m` - 分钟 - `h` - 小时 -- `d` - 天（相当于8小时） -- `w` - 周（相当于5天） -- `mo` - 月（相当于4周） +- `d` - 天（相当于 8 小时） +- `w` - 周（相当于 5 天） +- `mo` - 月（相当于 4 周） -用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示1小时10分钟。 +用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示 1 小时 10 分钟。 提交消息示例： @@ -118,26 +117,26 @@ Gitea 支持使用外部工单跟踪器，并可以在合并请求中创建对 下表说明了工单和合并请求的不同类型的交叉引用。在示例中，`User1/Repo1` 指的是使用引用的仓库，而 `UserZ/RepoZ` 表示另一个仓库。 -| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | -| ----------------------- | :-------------------: | :-------------------: | ------------------------------------------------ | -| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | -| **字母数字工单编号:** | - | - | - | -| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | +| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | +| ----------------------- | :------------------: | :------------------: | --------------------------------------------- | +| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | +| **字母数字工单编号:** | - | - | - | +| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | _最后一部分适用于使用字母数字格式的外部工单跟踪器的仓库。_ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/merge-message-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/merge-message-templates.md index ce141199..5447ff25 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/merge-message-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/merge-message-templates.md @@ -6,7 +6,6 @@ sidebar_position: 15 aliases: - /zh-cn/merge-message-templates - --- # 合并消息模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/permissions.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/permissions.md index edd0dd06..f45ba047 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/permissions.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/permissions.md @@ -6,7 +6,6 @@ sidebar_position: 14 aliases: - /zh-cn/permissions - --- # 权限 @@ -17,35 +16,35 @@ Gitea 支持对仓库进行权限管理，这样您就可以为不同的人员 在 Gitea 中，我们将仓库的子模块称为 `单元（Unit）`。现在我们有以下几个单元。 -| 名称 | 描述 | 权限 | -| ----------------- | --------------------------------------------------- | ------------ | -| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | -| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | -| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | -| 发布 | 跟踪项目版本和下载。 | 读取 写入 | -| 百科 | 与协作者编写和共享文档。 | 读取 写入 | -| 外部百科 | 链接到外部维基。 | 读取 | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | -| 项目 | 模板仓库的 URL。 | 读取 写入 | -| 包 | 链接到仓库 | 读取 写入 | -| Actions | 审查Actions日志或重启/取消工作流 | 读取 写入 | -| 设置 | 管理仓库。 | 管理员 | +| 名称 | 描述 | 权限 | +| -------------- | ---------------------------------- | --------- | +| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | +| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | +| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | +| 发布 | 跟踪项目版本和下载。 | 读取 写入 | +| 百科 | 与协作者编写和共享文档。 | 读取 写入 | +| 外部百科 | 链接到外部维基。 | 读取 | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | +| 项目 | 模板仓库的 URL。 | 读取 写入 | +| 包 | 链接到仓库 | 读取 写入 | +| Actions | 审查 Actions 日志或重启/取消工作流 | 读取 写入 | +| 设置 | 管理仓库。 | 管理员 | 通过不同的权限，用户可以在这些单元上执行不同的操作。 -| 名称 | 读取 | 写入 | 管理员 | -| ----------------- | -------------------------------------------------- | ------------------------------ | ------------------------- | -| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | -| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | -| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | -| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | -| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | -| 外部百科 | 链接到外部百科。 | - | - | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | -| 项目 | 查看面板。 | 在面板之间移动工单。 | - | -| 包 | 查看包 | 上传/删除包 | - | -| Actions | 查看 Actions日志 | 同意 / 取消 / 重启 | - | -| 设置 | - | - | 管理仓库 | +| 名称 | 读取 | 写入 | 管理员 | +| -------------- | -------------------------------- | ------------------------------ | -------- | +| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | +| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | +| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | +| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | +| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | +| 外部百科 | 链接到外部百科。 | - | - | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | +| 项目 | 查看面板。 | 在面板之间移动工单。 | - | +| 包 | 查看包 | 上传/删除包 | - | +| Actions | 查看 Actions 日志 | 同意 / 取消 / 重启 | - | +| 设置 | - | - | 管理仓库 | 个人仓库和组织仓库之间的权限存在一些差异。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/protected-tags.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/protected-tags.md index e7467a40..3dbc6833 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/protected-tags.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/protected-tags.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/protected-tags - --- # 受保护的标签 @@ -28,17 +27,17 @@ aliases: 示例： -| 类型 | 模式受保护的标签 | 可能匹配的标签 | +| 类型 | 模式受保护的标签 | 可能匹配的标签 | | ----- | ------------------------ | --------------------------------------- | | Glob | `v*` | `v`，`v-1`，`version2` | -| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | +| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | | Glob | `*-release` | `2.1-release`，`final-release` | | Glob | `gitea` | 仅限 `gitea` | | Glob | `*gitea*` | `gitea`，`2.1-gitea`，`1_gitea-release` | | Glob | `{v,rel}-*` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Glob | `*` | 匹配所有可能的标签名称 | +| Glob | `*` | 匹配所有可能的标签名称 | | Regex | `/\Av/` | `v`，`v-1`，`version2` | -| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | +| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | | Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`，`v2.1.0` | | Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`，`v2.1`，`v1.2.34` | | Regex | `/-release\z/` | `2.1-release`，`final-release` | @@ -46,4 +45,4 @@ aliases: | Regex | `/\Agitea\z/` | 仅限 `gitea` | | Regex | `/^gitea$/` | 仅限 `gitea` | | Regex | `/\A(v\|rel)-/` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Regex | `/.+/` | 匹配所有可能的标签名称 | +| Regex | `/.+/` | 匹配所有可能的标签名称 | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/pull-request.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/pull-request.md index 6fe38f58..3546f719 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/pull-request.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/pull-request.md @@ -6,7 +6,6 @@ sidebar_position: 13 aliases: - /zh-cn/pull-request - --- # 合并请求 @@ -20,15 +19,15 @@ aliases: 要创建合并请求，您需要遵循以下步骤： 1. **Fork 仓库** - 如果您没有直接对仓库进行更改的权限，您需要将仓库 fork 到您自己的账户中。 -这将创建一个您可以对其进行更改的仓库副本。 + 这将创建一个您可以对其进行更改的仓库副本。 2. **创建分支（可选）** - 在 fork 的仓库中创建一个新分支，该分支包含您要提出的更改。 -给分支取一个描述性的名称，以指示更改的内容。 + 给分支取一个描述性的名称，以指示更改的内容。 3. **进行更改** - 进行您想要的更改，提交并将其推送到 fork 的仓库中。 4. **创建合并请求** - 转到原始仓库并转到“合并请求”选项卡。单击“新建合并请求”按钮，并将您的新分支选择为源分支。 -为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 + 为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 ## 评审合并请求 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/repo-mirror.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/repo-mirror.md index de66d67a..8827acf7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/repo-mirror.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/repo-mirror.md @@ -6,7 +6,6 @@ sidebar_position: 45 aliases: - /zh-cn/repo-mirror - --- # 仓库镜像 @@ -56,7 +55,7 @@ aliases: 要从 Gitea 设置镜像到 GitHub，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *public_repo* 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 +1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同，GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史，您也可以使用现有的远程仓库。 3. 在您的 Gitea 仓库设置中，填写**Git 远程仓库 URL**：`https://github.com//.git`。 4. 使用您的 GitHub 用户名填写**授权**字段，并将个人访问令牌作为**密码**。 @@ -69,7 +68,7 @@ aliases: 要从 Gitea 设置镜像到 GitLab，您需要按照以下步骤进行操作： -1. 创建具有 *write_repository* 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 +1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 2. 填写**Git 远程仓库 URL**：`https:////.git`。 3. 在**授权**字段中填写 `oauth2` 作为**用户名**，并将您的 GitLab 个人访问令牌作为**密码**。 4. 选择**添加推送镜像**以保存配置。 @@ -80,7 +79,7 @@ aliases: 要从 Gitea 设置镜像到 Bitbucket，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *Repository Write* 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 +1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 2. 填写**Git 远程仓库 URL**：`https://bitbucket.org//.git`。 3. 使用您的 Bitbucket 用户名填写**授权**字段，并将应用密码作为**密码**。 4. 选择**添加推送镜像**以保存配置。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/template-repositories.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/template-repositories.md index 543e3260..9108a2c7 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/template-repositories.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/template-repositories.md @@ -6,7 +6,6 @@ sidebar_position: 14 aliases: - /zh-cn/template-repositories - --- # 模板仓库 @@ -45,20 +44,20 @@ a/b/c/d.json 所有变量都必须采用`$VAR`或`${VAR}`的形式。要转义扩展，使用双重`$$`，例如`$$VAR`或`$${VAR}`。 -| 变量 | 扩展为 | 可转换 | -| -------------------- | --------------------------------------------------- | ------------- | -| REPO_NAME | 生成的仓库名称 | ✓ | -| TEMPLATE_NAME | 模板仓库名称 | ✓ | -| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | -| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | -| REPO_OWNER | 生成的仓库所有者 | ✓ | -| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | -| REPO_LINK | 生成的仓库链接 | ✘ | -| TEMPLATE_LINK | 模板仓库链接 | ✘ | -| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | -| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | -| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | -| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | +| 变量 | 扩展为 | 可转换 | +| -------------------- | ----------------------------- | ------ | +| REPO_NAME | 生成的仓库名称 | ✓ | +| TEMPLATE_NAME | 模板仓库名称 | ✓ | +| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | +| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | +| REPO_OWNER | 生成的仓库所有者 | ✓ | +| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | +| REPO_LINK | 生成的仓库链接 | ✘ | +| TEMPLATE_LINK | 模板仓库链接 | ✘ | +| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | +| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | +| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | +| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | ## 转换器 :robot: @@ -68,12 +67,12 @@ Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。 将 `go-sdk` 传递给可用的转换器的效果如下... -| 转换器 | 效果 | -| ----------- | ------------ | -| SNAKE | go_sdk | -| KEBAB | go-sdk | -| CAMEL | goSdk | -| PASCAL | GoSdk | -| LOWER | go-sdk | -| UPPER | GO-SDK | -| TITLE | Go-Sdk | +| 转换器 | 效果 | +| ------ | ------ | +| SNAKE | go_sdk | +| KEBAB | go-sdk | +| CAMEL | goSdk | +| PASCAL | GoSdk | +| LOWER | go-sdk | +| UPPER | GO-SDK | +| TITLE | Go-Sdk | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/webhooks.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/webhooks.md index 60a983dc..89654a9e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/webhooks.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.22/usage/webhooks.md @@ -6,12 +6,11 @@ sidebar_position: 30 aliases: - /zh-cn/webhooks - --- # Webhooks -Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks还可以基于组织和整个系统进行配置。 +Gitea 支持用于仓库事件的 Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks 还可以基于组织和整个系统进行配置。 所有事件推送都是 POST 请求。目前支持： - Gitea (也可以是 GET 请求) @@ -29,7 +28,7 @@ Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置 **警告**：自 Gitea 1.13.0 版起，payload 中的 `secret` 字段已被弃用，并将在 1.14.0 版中移除：https://github.com/go-gitea/gitea/issues/11755 -以下是 Gitea 将发送给 payload URL的事件信息示例： +以下是 Gitea 将发送给 payload URL 的事件信息示例： ```php X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473 @@ -185,4 +184,4 @@ if (json_last_error() !== JSON_ERROR_NONE) { ### 授权头（Authorization header） -**从1.19版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 +**从 1.19 版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/adding-legal-pages.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/adding-legal-pages.md index c04ed27b..2649e795 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/adding-legal-pages.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/adding-legal-pages.md @@ -5,7 +5,6 @@ sidebar_position: 110 aliases: - /zh-cn/adding-legal-pages - --- # 添加法律页面 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/authentication.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/authentication.md index fe9e812b..c7fdd375 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/authentication.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/authentication.md @@ -10,7 +10,7 @@ aliases: ## 轻量级目录访问协议（Lightweight Directory Access Protocol，LDAP） -通过BindDN的LDAP和简单认证方式LDAP共享以下字段: +通过 BindDN 的 LDAP 和简单认证方式 LDAP 共享以下字段: - 认证名称 **(必选)** @@ -27,48 +27,52 @@ aliases: - 例如: LDAP `389`/ LDAPs `636` - 安全协议 (可选) - - 连接LDAP服务器时是否使用TLS协议。 + + - 连接 LDAP 服务器时是否使用 TLS 协议。 - 管理员过滤规则 (可选) - - 一个LDAP过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 + + - 一个 LDAP 过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 - 示例:`(objectClass=adminAccount)` - - 适用于Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` + - 适用于 Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` - 用户名属性（可选） - - 用户LDAP记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的Gitea账户用户名。若留空，则使用登录表单上提供的用户名。 - - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于Gitea账户名称，请参阅"用户过滤器"。 + - 用户 LDAP 记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的 Gitea 账户用户名。若留空，则使用登录表单上提供的用户名。 + - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于 Gitea 账户名称，请参阅"用户过滤器"。 - 示例:uid - - 适用于Microsoft Active Directory（AD）的示例:`sAMAccountName` + - 适用于 Microsoft Active Directory（AD）的示例:`sAMAccountName` - 名字属性（可选） - - 用户LDAP记录中包含用户名字的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户名字的属性。将用于填充他们的账户信息。 - 示例:givenName + - 姓氏属性（可选） - - 用户LDAP记录中包含用户姓氏的属性。将用于填充他们的账户信息。 + + - 用户 LDAP 记录中包含用户姓氏的属性。将用于填充他们的账户信息。 - 示例:`sn` - 电子邮件属性 **(必选)** - - 用户LDAP记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 + - 用户 LDAP 记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 - 示例:`mail` ### LDAP(via BindDN) 需要额外设置以下字段: -- 绑定DN (可选) +- 绑定 DN (可选) - - 搜索用户时绑定到LDAP服务器的DN。这可以留空以执行匿名搜索。 + - 搜索用户时绑定到 LDAP 服务器的 DN。这可以留空以执行匿名搜索。 - 示例: `cn=Search,dc=mydomain,dc=com` - 绑定密码 (可选) - - 上述指定的Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用SECRET_KEY进行加密存储。仍然建议确保Bind DN具有尽可能少的权限。 + - 上述指定的 Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用 SECRET_KEY 进行加密存储。仍然建议确保 Bind DN 具有尽可能少的权限。 - 用户搜索基准 **(必选)** - - 这是用于搜索用户帐户的LDAP基础路径. + - 这是用于搜索用户帐户的 LDAP 基础路径. - 示例: `ou=Users,dc=mydomain,dc=com` - 用户过滤规则 **(必选)** @@ -79,19 +83,19 @@ aliases: - 如需多次替换，应使用 `%[1]s`，例如在将提供的登录名与多个属性（如用户标识符、电子邮件甚至电话号码）进行匹配时。 - 示例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` - 启用用户同步 - - 这个选项启用了一个周期性任务，用于将Gitea用户与LDAP服务器进行同步。默认的同步周期是每24小时， - 但您可以在app.ini文件中进行更改。 + - 这个选项启用了一个周期性任务，用于将 Gitea 用户与 LDAP 服务器进行同步。默认的同步周期是每 24 小时， + 但您可以在 app.ini 文件中进行更改。 有关此部分的详细说明，请参阅[sample app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) - 的_cron.sync_external_users_ 部分的注释。前面提到的_User Search Base_和_User Filter_ - 设置将限制哪些用户可以使用Gitea以及哪些用户将被同步。 - 在初始运行任务时，将根据给定的设置创建所有与LDAP匹配的用户，因此在使用大型企业LDAP目录时需要小心。 + 的*cron.sync_external_users* 部分的注释。前面提到的*User Search Base*和*User Filter* + 设置将限制哪些用户可以使用 Gitea 以及哪些用户将被同步。 + 在初始运行任务时，将根据给定的设置创建所有与 LDAP 匹配的用户，因此在使用大型企业 LDAP 目录时需要小心。 ### LDAP(simple auth) 需要额外设置以下字段: -- 用户DN **(必选)** +- 用户 DN **(必选)** - 用作用户 DN 的模板。匹配参数 `%s` 将替换为登录表单中的登录名。 - 示例: `cn=%s,ou=Users,dc=mydomain,dc=com` @@ -108,11 +112,12 @@ aliases: - 示例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` -### 使用LDAP验证分组成员 +### 使用 LDAP 验证分组成员 使用以下字段: -- 群组搜索基础DN(可选) +- 群组搜索基础 DN(可选) + - 组使用的 LDAP DN。 - 示例: `ou=group,dc=mydomain,dc=com` @@ -132,43 +137,46 @@ aliases: ## 可插拔式认证模块(Pluggable Authentication Module,PAM) -这个过程启用了PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 -PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加到当前数据库中。为了与普通的Linux密码一起使用， -运行Gitea的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 +这个过程启用了 PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 +PAM 提供了一种机制，通过对用户进行 PAM 认证来自动将其添加到当前数据库中。为了与普通的 Linux 密码一起使用， +运行 Gitea 的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 -**注意**:如果用户已将SSH公钥添加到Gitea中，使用这些密钥可能会绕过登录检查系统。因此， -如果您希望禁用使用PAM进行身份验证的用户，应该在Gitea中手动禁用该账户，使用内置的用户管理功能。 +**注意**:如果用户已将 SSH 公钥添加到 Gitea 中，使用这些密钥可能会绕过登录检查系统。因此， +如果您希望禁用使用 PAM 进行身份验证的用户，应该在 Gitea 中手动禁用该账户，使用内置的用户管理功能。 1. 配置和安装准备. - - 建议您创建一个管理用户. - - 建议取消自动注册. + - 建议您创建一个管理用户. + - 建议取消自动注册. 1. 一旦数据库已初始化完成，使用新创建的管理员账户登录. 1. 导航至用户设置（右上角的图标），然后选择 -`Site Administration` -> `Authentication Sources`, 并选择 -`Add Authentication Source`. + `Site Administration` -> `Authentication Sources`, 并选择 + `Add Authentication Source`. 1. 填写字段如下: - - 认证类型:`PAM`。 - - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 - - PAM服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 - - PAM电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为gituse的用户， - 并且将此字段设置为mail.com，那么Gitea在验证一个GIT实例的用户时将期望user emai字段为gituser@mail.com[^2]。 + - 认证类型:`PAM`。 + - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 + - PAM 服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 + - PAM 电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为 gituse 的用户， + 并且将此字段设置为 mail.com，那么 Gitea 在验证一个 GIT 实例的用户时将期望 user emai 字段为gituser@mail.com[^2]。 **Note**: PAM 支持通过[build-time flags](installation/from-source.md#build)添加, -而官方提供的二进制文件通常不会默认启用此功能。PAM需要确保系统上有必要的libpam动态库，并且编译器可以访问必要的PAM开发头文件。 +而官方提供的二进制文件通常不会默认启用此功能。PAM 需要确保系统上有必要的 libpam 动态库，并且编译器可以访问必要的 PAM 开发头文件。 -[^1]: 例如，在Debian "Bullseye"上使用标准Linux登录，可以使用`common-session-noninteractive`。这个值对于其他版本的Debian， -包括Ubuntu和Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 +[^1]: + 例如，在 Debian "Bullseye"上使用标准 Linux 登录，可以使用`common-session-noninteractive`。这个值对于其他版本的 Debian， + 包括 Ubuntu 和 Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 -[^2]: **PAM的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到Gitea的Web界面。 +[^2]: **PAM 的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到 Gitea 的 Web 界面。 ## 简单邮件传输协议(Simple Mail Transfer Protocol,SMTP) 此选项允许 Gitea 以 Gitea 用户身份登录 SMTP 主机。请设置以下字段: - 身份验证名称 **(必选)** + - 分配给新授权方法的名称 - SMTP 验证类型 **(必选)** + - 用于连接 SMTP 主机的验证类型，plain 或 login - 主机名 **(必选)** @@ -188,7 +196,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 示例: `gitea.com,mydomain.com,mydomain2.com` - 强制使用 SMTPS - - 默认情况下将使用SMTPS连接到端口465.如果您希望将smtp用于其他端口，自行设置 + - 默认情况下将使用 SMTPS 连接到端口 465.如果您希望将 smtp 用于其他端口，自行设置 - 否则，如果服务器提供' STARTTLS '扩展名，则将使用此扩展名 - 跳过 TLS 验证 - 禁用 TLS 验证身份. @@ -199,7 +207,7 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 - 要使用 FreeIPA 凭据登录 Gitea，需要为 Gitea 创建一个绑定帐户。 创建一个绑定帐户: -- 在FreeIPA服务器上创建一个gitea.ldif文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 +- 在 FreeIPA 服务器上创建一个 gitea.ldif 文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 ```sh dn: uid=gitea,cn=sysaccounts,cn=etc,dc=example,dc=com @@ -212,33 +220,33 @@ PAM提供了一种机制，通过对用户进行PAM认证来自动将其添加 nsIdleTimeout: 0 ``` -- 导入LDIF文件（如果需要，请将localhost更改为IPA服务器）。系统会提示您输入Directory Manager的密码。: +- 导入 LDIF 文件（如果需要，请将 localhost 更改为 IPA 服务器）。系统会提示您输入 Directory Manager 的密码。: ```sh ldapmodify -h localhost -p 389 -x -D \ "cn=Directory Manager" -W -f gitea.ldif ``` -- 为`gitea_users`添加IPA组: +- 为`gitea_users`添加 IPA 组: ```sh ipa group-add --desc="Gitea Users" gitea_users ``` -- **提示**:对于IPA凭证错误，运行' kinit admin '并提供域管理帐户密码. -- 以管理员身份登录Gitea，点击Admin Panel下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 +- **提示**:对于 IPA 凭证错误，运行' kinit admin '并提供域管理帐户密码. +- 以管理员身份登录 Gitea，点击 Admin Panel 下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 ## SPNEGO with SSPI (Kerberos/NTLM, for Windows only) -Gitea支持通过Windows内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现SPNEGO单点登录认证（由RFC4559定义的方案），用于服务器的Web部分。SSPI仅在Windows环境中工作，即当服务器和客户端都在Windows操作系统上运行时。 +Gitea 支持通过 Windows 内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现 SPNEGO 单点登录认证（由 RFC4559 定义的方案），用于服务器的 Web 部分。SSPI 仅在 Windows 环境中工作，即当服务器和客户端都在 Windows 操作系统上运行时。 -在激活SSPI单点登录认证（SSO）之前，您需要准备您的环境: +在激活 SSPI 单点登录认证（SSO）之前，您需要准备您的环境: -- 在Active Directory中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在domain.local域下创建一个名为user的账户: -- 为运行gitea.exe的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为HTTP: +- 在 Active Directory 中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在 domain.local 域下创建一个名为 user 的账户: +- 为运行 gitea.exe 的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为 HTTP: - 以特权域用户（例如域管理员）的身份启动“命令提示符”或“PowerShell”。 - - 运行下面的命令，将host.domain.local替换为Web应用程序将运行的服务器的完全限定域名（FQDN），将domain\user替换为在前一步中创建的账户名称: + - 运行下面的命令，将 host.domain.local 替换为 Web 应用程序将运行的服务器的完全限定域名（FQDN），将 domain\user 替换为在前一步中创建的账户名称: ```sh setspn -A HTTP/host.domain.local domain\user @@ -247,22 +255,22 @@ Gitea支持通过Windows内置的安全支持提供程序接口（Security Suppo 在遵循上述步骤之前，请确保您按照以下流程进行操作: 1. 用之前创建的用户登录（如果已经登录，请先注销）。 -2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为Web应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 -3. 启动Web服务器（运行 `gitea.exe web`）。 -4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用SSPI认证。 +2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为 Web 应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 +3. 启动 Web 服务器（运行 `gitea.exe web`）。 +4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用 SSPI 认证。 5. 在域中的客户端计算机上，使用任何域用户登录（与运行`gitea.exe`的服务器不同）。 -6. 如果您使用Chrome或Edge浏览器，请将Web应用程序的URL添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 -7. 启动Chrome或Edge浏览器，导航到Gitea的FQDN URL（例如，`http://host.domain.local:3000`）。 -8. 在控制面板中点击“Sign In”按钮，然后选择SSPI，将会自动使用当前登录到计算机的用户进行登录。 +6. 如果您使用 Chrome 或 Edge 浏览器，请将 Web 应用程序的 URL 添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 +7. 启动 Chrome 或 Edge 浏览器，导航到 Gitea 的 FQDN URL（例如，`http://host.domain.local:3000`）。 +8. 在控制面板中点击“Sign In”按钮，然后选择 SSPI，将会自动使用当前登录到计算机的用户进行登录。 9. 如果无法正常工作，请确保: - - 您不是在运行`gitea.exe`的同一台服务器上运行Web浏览器。应该在与服务器不同的域加入计算机（客户端）上运行Web浏览器。如果客户端和服务器都在同一台计算机上运行，则NTLM将优先于Kerberos。 - - 主机上只有一个`HTTP/...`的SPN。 - - SPN中只包含主机名，不包含端口号。 - - 将Web应用程序的URL添加到"本地站点"。 - - 服务器和客户端的时钟差异不超过5分钟（取决于组策略）。 - - 在Internet Explorer中启用了"集成Windows身份验证"（在"高级设置"下）。 + - 您不是在运行`gitea.exe`的同一台服务器上运行 Web 浏览器。应该在与服务器不同的域加入计算机（客户端）上运行 Web 浏览器。如果客户端和服务器都在同一台计算机上运行，则 NTLM 将优先于 Kerberos。 + - 主机上只有一个`HTTP/...`的 SPN。 + - SPN 中只包含主机名，不包含端口号。 + - 将 Web 应用程序的 URL 添加到"本地站点"。 + - 服务器和客户端的时钟差异不超过 5 分钟（取决于组策略）。 + - 在 Internet Explorer 中启用了"集成 Windows 身份验证"（在"高级设置"下）。 -遵循这些步骤，您应该能够成功启用和使用SSPI单点登录认证（SSO）。 +遵循这些步骤，您应该能够成功启用和使用 SSPI 单点登录认证（SSO）。 ## 反向代理认证 @@ -279,7 +287,7 @@ ENABLE_REVERSE_PROXY_AUTHENTICATION = true 如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`，则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取，这样在自动创建用户时将使用这个字段作为用户全名，你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 -你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的IP地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 +你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 你可以通过以下配置为 API 启用此认证方法： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/backup-and-restore.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/backup-and-restore.md index c0e840f8..73ce7c6a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/backup-and-restore.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/backup-and-restore.md @@ -5,12 +5,11 @@ sidebar_position: 11 aliases: - /zh-cn/backup-and-restore - --- # 备份与恢复 -Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个zip压缩文件。该压缩文件可以被用来进行数据恢复。 +Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 ## 备份一致性 @@ -20,7 +19,7 @@ Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都 ## 备份命令 (`dump`) -先转到git用户的权限: `su git`. 再Gitea目录运行 `./gitea dump`。一般会显示类似如下的输出： +先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出： ``` 2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 @@ -33,12 +32,12 @@ Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都 最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容： -* `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 -* `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 -* `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 -* `repos/` - 仓库目录的完整副本。 -* `gitea-db.sql` - 数据库dump出来的 SQL。 -* `log/` - Logs文件，如果用作迁移不是必须的。 +- `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 +- `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 +- `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 +- `repos/` - 仓库目录的完整副本。 +- `gitea-db.sql` - 数据库 dump 出来的 SQL。 +- `log/` - Logs 文件，如果用作迁移不是必须的。 中间备份文件将会在临时目录进行创建，如果您要重新指定临时目录，可以用 `--tempdir` 参数，或者用 `TMPDIR` 环境变量。 @@ -53,7 +52,7 @@ mysqldump -u$USER -p$PASS --database $DATABASE > gitea-db.sql pg_dump -U $USER $DATABASE > gitea-db.sql ``` -### 使用Docker （`dump`） +### 使用 Docker （`dump`） 在使用 Docker 时，使用 `dump` 命令有一些注意事项。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/cmd-embedded.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/cmd-embedded.md index fc037aaf..a2d2dc7e 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/cmd-embedded.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/cmd-embedded.md @@ -5,7 +5,6 @@ sidebar_position: 20 aliases: - /zh-cn/cmd-embedded - --- # 嵌入资源提取工具 @@ -30,7 +29,7 @@ gitea embedded list [--include-vendored] [patterns...] - 列出所有模板文件，无论在哪个虚拟目录下：`**.tmpl` - 列出所有邮件模板文件：`templates/mail/**.tmpl` -列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` + 列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` 不要忘记为模式使用引号，因为空格、`*` 和其他字符可能对命令行解释器有特殊含义。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/command-line.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/command-line.md index a9791e92..e7a563cb 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/command-line.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/command-line.md @@ -5,7 +5,6 @@ sidebar_position: 1 aliases: - /zh-cn/command-line - --- # 命令行 @@ -61,7 +60,7 @@ aliases: - 选项： - `--email`：要删除的用户的电子邮件。 - `--username`：要删除的用户的用户名。 - - `--id`：要删除的用户的ID。 + - `--id`：要删除的用户的 ID。 - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 - 示例： - `gitea admin user delete --id 1` @@ -170,11 +169,11 @@ aliases: - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 - `--skip-local-2fa`：跳过 2FA 登录。 - `--active`：启用此认证源。 - 备注： - `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： - `--option`、`--option=true` 以启用选项 - `--option=false` 以禁用选项 - 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 - 示例： - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` - `update-smtp`： @@ -283,12 +282,12 @@ aliases: ### cert -生成自签名的SSL证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 - 选项： - - `--host value`：逗号分隔的主机名和IP地址列表，此证书适用于这些主机。支持使用通配符。必填。 - - `--ecdsa-curve value`：用于生成密钥的ECDSA曲线。可选。有效选项为P224、P256、P384、P521。 - - `--rsa-bits value`：要生成的RSA密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 @@ -297,18 +296,18 @@ aliases: ### dump -将所有文件和数据库导出到一个zip文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 - 选项： - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 - `--skip-repository`，`-R`：跳过仓库的导出。可选。 - `--skip-custom-dir`：跳过自定义目录的导出。可选。 - - `--skip-lfs-data`：跳过LFS数据的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 - `--skip-attachment-data`：跳过附件数据的导出。可选。 - `--skip-package-data`：跳过包数据的导出。可选。 - `--skip-log`：跳过日志数据的导出。可选。 - - `--database`，`-d`：指定数据库的SQL语法。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 - `--type`：设置导出的格式。可选。（默认值：zip） - 示例： @@ -401,19 +400,19 @@ gitea doctor recreate-table - 命令: - `shutdown`: 优雅地关闭运行中的进程 - - `restart`: 优雅地重新启动运行中的进程（对于Windows服务器尚未实现） + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） - `flush-queues`: 刷新运行中的进程中的队列 - 选项: - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） - - `--non-blocking`: 设置为true，以在返回之前不等待刷新完成 + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 - `logging`: 调整日志命令 - 命令: - `pause`: 暂停日志记录 - 注意: - - 如果日志级别低于此级别，日志级别将被临时提升为INFO。 - - Gitea将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 - `resume`: 恢复日志记录 - - `release-and-reopen`: 使Gitea释放和重新打开用于日志记录的文件和连接（相当于向Gitea发送SIGUSR1信号）。 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 - `remove name`: 删除指定的日志记录器 - 选项: - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） @@ -429,7 +428,7 @@ gitea doctor recreate-table - `--expression value`, `-e value`: 日志记录器的匹配表达式 - `--prefix value`, `-p value`: 日志记录器的前缀 - `--color`: 在日志中使用颜色 - - `--stderr`: 将控制台日志输出到stderr - 仅适用于控制台 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 - `file`: 添加文件日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" @@ -459,9 +458,9 @@ gitea doctor recreate-table - `--color`: 在日志中使用颜色 - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 - `--reconnect`, `-r`: 连接中断时重新连接主机 - - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix或udp（默认为tcp） + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） - - `smtp`: 添加SMTP日志记录器 + - `smtp`: 添加 SMTP 日志记录器 - 选项: - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/config-cheat-sheet.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/config-cheat-sheet.md index 95888efa..669292f1 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/config-cheat-sheet.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/config-cheat-sheet.md @@ -5,13 +5,12 @@ sidebar_position: 30 aliases: - /zh-cn/config-cheat-sheet - --- # 配置说明 -这是针对Gitea配置文件的说明， -你可以了解Gitea的强大配置。 +这是针对 Gitea 配置文件的说明， +你可以了解 Gitea 的强大配置。 需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 如果是从发行版本完成的安装， @@ -22,7 +21,7 @@ aliases: [ini](https://github.com/go-ini/ini/#recursive-values) 这里的说明。 标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 -在下面的默认值中,`$XYZ`代表环境变量`XYZ`的值(详见:`environment-to-ini`)。 _`XxYyZz`_是指默认配置的一部分列出的值。这些在 app.ini 文件中不起作用，仅在此处列出作为文档说明。 +在下面的默认值中,`$XYZ`代表环境变量`XYZ`的值(详见:`environment-to-ini`)。 *`XxYyZz`*是指默认配置的一部分列出的值。这些在 app.ini 文件中不起作用，仅在此处列出作为文档说明。 包含`#`或者`;`的变量必须使用引号(`` ` ``或者`""""`)包裹，否则会被解析为注释。 @@ -33,69 +32,69 @@ aliases: 这些值取决于环境，但构成了许多值的基础。当运行 `gitea help`或启动时，它们将 作为默认配置的一部分进行报告。它们在那里发出的顺序略有不同，但我们将按照设置的顺序在这里列出。 -- _`AppPath`_: Gitea二进制可执行文件的绝对路径 -- _`AppWorkPath`_: Gitea可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: +- _`AppPath`_: Gitea 二进制可执行文件的绝对路径 +- _`AppWorkPath`_: Gitea 可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: - `app.ini`中的`WORK_PATH`配置项 - - 启动Gitea时的`--work-path`命令行参数 + - 启动 Gitea 时的`--work-path`命令行参数 - `$GITEA_WORK_DIR`环境变量 - 在编译时设置的内置值（参见从源代码编译） - 默认为 _`AppPath`_ 的目录 - 如果上述任何路径为相对路径，将自动解析为相对于 _`AppPath`_ 目录的绝对路径 - _`CustomPath`_: 这是用于自定义模板和其他选项的基础目录。 -它是通过使用以下层次结构中的第一个设置的内容来确定的： + 它是通过使用以下层次结构中的第一个设置的内容来确定的： - 通过传递给二进制文件的`--custom-path`标志 - 环境变量 `$GITEA_CUSTOM` - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`AppWorkPath`_`/custom` - 如果上述任何路径是相对路径，则会相对于 _`AppWorkPath`_ 目录进行处理， - 使其变为绝对路径。 + 使其变为绝对路径。 - _`CustomConf`_: 这是指向`app.ini`文件的路径。 - 这是指向`app.ini`文件的路径。 - 在构建时设置的内置值（参见从源代码构建） - 否则，默认为 _`CustomPath`_`/conf/app.ini` - - 如果上述任何路径是相对路径，则会相对于_`CustomPath`_目录进行处理。 + - 如果上述任何路径是相对路径，则会相对于*`CustomPath`*目录进行处理。 -此外，还有_`StaticRootPath`_，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 +此外，还有*`StaticRootPath`*，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 ## Overall (`DEFAULT`) - `APP_NAME`: **Gitea: Git with a cup of tea** 应用名称，在网页的标题中显示。 -- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行Gitea的用户， +- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行 Gitea 的用户， 应当是一个专用的系统账户(非用户使用，推荐创建一个专用的`git`用户). 如果在你自己的个人电脑使用改成你自己的用户名。 - 该配置如果设置不正确，Gitea可能崩溃。 + 该配置如果设置不正确，Gitea 可能崩溃。 - `RUN_MODE`: **prod**: 应用的运行模式，对运行性能和问题排除有影响: `dev` 或者 `prod`,默认为 `prod`。 `dev`模式有助于开发和问题排查, 除设置为`dev` 外，均被视为 `prod`. - `WORK_PATH`: **_the-work-path_**: 工作目录, 前文有提及. ## 仓库 (`repository`) -- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放git工程的根目录，建议填绝对路径。 +- `ROOT`: **%(APP_DATA_PATH)s/gitea-repositories**: 存放 git 工程的根目录，建议填绝对路径。 相对路径将被解析为**_`AppWorkPath`_/%(ROOT)s**. -- `SCRIPT_TYPE`: **bash**: 服务器支持的Shell类型，通常是`bash`， +- `SCRIPT_TYPE`: **bash**: 服务器支持的 Shell 类型，通常是`bash`， 但有些服务器也有可能是`sh`。 - `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 检测到的字符集的决定性顺序 - 如果检测到的字符集具有相等的置信度，则优先选择列表中较早出现的字符集，而不是较晚出现的字符集。添加“defaults”将会将未命名的字符集放置在该点。 -- `ANSI_CHARSET`: **_empty_**: 默认的ANSI字符集，用于覆盖非UTF-8字符集。 +- `ANSI_CHARSET`: **_empty_**: 默认的 ANSI 字符集，用于覆盖非 UTF-8 字符集。 - `FORCE_PRIVATE`: **false**: 强制使每个新仓库变为私有。 - `DEFAULT_PRIVATE`: **last**: 创建新仓库时默认为私有。 - \[last, private, public\] + \[last, private, public\] - `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送创建新仓库时默认为私有。 - `MAX_CREATION_LIMIT`: **-1**: 每个用户的全局仓库创建上限, - `-1` 代表无限制. + `-1` 代表无限制. - `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表顶部的指定许可证。 - 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 -- `DISABLE_HTTP_GIT`: **false**: 禁用HTTP协议与仓库进行 - 交互的能力。 -- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的SSH端口时，强制使用ssh://克隆URL， - 而不是scp-style uri。 -- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的URL作为https或ssh， - 默认为https。 + 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 +- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 协议与仓库进行 + 交互的能力。 +- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的 SSH 端口时，强制使用 ssh://克隆 URL， + 而不是 scp-style uri。 +- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的 URL 作为 https 或 ssh， + 默认为 https。 - `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用于 Access-Control-Allow-Origin 标头的值， -默认不提供。 -警告：如果您不提供正确的值，这可能对您的网站造成危害。 -- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 -- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到Gitea，并为用户自动创建它们。 -- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到Gitea，并为组织自动创建它们。 + 默认不提供。 + 警告：如果您不提供正确的值，这可能对您的网站造成危害。 +- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 +- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到 Gitea，并为用户自动创建它们。 +- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到 Gitea，并为组织自动创建它们。 - `DISABLED_REPO_UNITS`: **_empty_**: 逗号分隔的全局禁用的仓库单元列表。允许的值是：: \[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,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部wiki和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 +- `DEFAULT_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部 wiki 和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 - `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗号分隔的默认分叉仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 - `DEFAULT_MIRROR_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认镜像仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 - `DEFAULT_TEMPLATE_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认模板仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 @@ -111,15 +110,15 @@ aliases: ### 仓库 - 编辑器 (`repository.editor`) - `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中应该换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件进行换行，只需放置一个逗号。 -- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览API的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 +- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 ### 仓库 - 合并请求 (`repository.pull-request`) - `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取请求标题中用于标记工作正在进行中的前缀列表。 -这些前缀在不区分大小写的情况下进行匹配。 + 这些前缀在不区分大小写的情况下进行匹配。 - `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取请求评论中用于自动关闭相关问题的关键词列表。 - `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取请求评论中用于自动重新打开相关问题的 -关键词列表。 + 关键词列表。 - `DEFAULT_MERGE_STYLE`: **merge**: 设置创建仓库的默认合并方式，可选: `merge`, `rebase`, `rebase-merge`, `squash`, `fast-forward-only` - `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在默认合并消息中，对于`squash`提交，最多包括此数量的提交。设置为 -1 以包括所有提交。 - `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在默认的合并消息中，对于`squash`提交，限制提交消息的大小。设置为 `-1`以取消限制。仅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`为`true`时使用。 @@ -128,18 +127,18 @@ aliases: - `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在默认合并消息中，仅包括官方允许审查的审批者。 - `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在默认的 squash 合并消息中，包括构成拉取请求的所有提交的提交消息。 - `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者与作者不匹配，在合并提交消息中添加`co-authored-by`和`co-committed-by`标记。 -- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 +- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是 1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 ### 仓库 - 工单 (`repository.issue`) - `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合并请求或工单被锁定的原因列表。 -- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为0禁用固定工单。 +- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为 0 禁用固定工单。 ### 仓库 - 文件上传 (`repository.upload`) - `ENABLED`: **true**: 是否启用仓库文件上传。 -- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在Gitea重启的时候该目录会被清空)。 -- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 +- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在 Gitea 重启的时候该目录会被清空)。 +- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime 类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 - `FILE_MAX_SIZE`: **50**: 每个文件的最大大小(MB)。 - `MAX_FILES`: **5**: 每次上传的最大文件数。 @@ -161,10 +160,10 @@ aliases: - 除了 never 和 always 之外的选项可以组合为逗号分隔的列表。 - `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用于验证提交的默认信任模型。 - `collaborator`: 信任协作者密钥签名的签名。 - - `committer`: 信任与提交者匹配的签名（这与GitHub匹配，并会强制Gitea签名的提交具有Gitea作为提交者）。 + - `committer`: 信任与提交者匹配的签名（这与 GitHub 匹配，并会强制 Gitea 签名的提交具有 Gitea 作为提交者）。 - `collaboratorcommitter`: 信任与提交者匹配的协作者密钥签名的签名。 -- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对wiki提交进行签名。 -- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对CRUD操作进行签名。 +- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对 wiki 提交进行签名。 +- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对 CRUD 操作进行签名。 - 与上面相同的选项，增加了： - `parentsigned`: 仅在父提交进行了签名时才进行签名。 - `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 对合并操作进行签名。 @@ -177,7 +176,7 @@ aliases: - `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地仓库副本的路径。默认为 tmp/local-repo（内容在 Gitea 重新启动时被删除） -### 仓库 - MIME type mapping (`repository.mimetype_mapping`) +### 仓库 - MIME type mapping (`repository.mimetype_mapping`) 配置用于根据可下载文件的文件扩展名设置预期的 MIME 类型。配置以键值对的形式呈现，文件扩展名以`.`开头。 @@ -195,7 +194,7 @@ aliases: - `MAX_AGE`: **10m**: 缓存响应的最大时间 - `ALLOW_CREDENTIALS`: **false**: 允许带有凭据的请求 - `HEADERS`: **Content-Type,User-Agent**: 允许请求携带的头部 -- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP头部. +- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP 头部. ## 界面 (`ui`) @@ -204,23 +203,23 @@ aliases: - `MEMBERS_PAGING_NUM`: **20**: 组织成员页面每页显示的成员数量。 - `FEED_MAX_COMMIT_NUM`: **5**: 活动流页面显示的最大提交数量。 - `FEED_PAGING_NUM`: **20**: 活动流页面显示的最大活动数量。 -- `SITEMAP_PAGING_NUM`: **20**: 在单个子SiteMap中显示的项数。 -- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大commit数量。 +- `SITEMAP_PAGING_NUM`: **20**: 在单个子 SiteMap 中显示的项数。 +- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大 commit 数量。 - `CODE_COMMENT_LINES`: **4**: 在代码评论中能够显示的最大代码行数。 -- `DEFAULT_THEME`: **gitea-auto**: 在Gitea安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 +- `DEFAULT_THEME`: **gitea-auto**: 在 Gitea 安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 - `SHOW_USER_EMAIL`: **true**: 用户的电子邮件是否应该显示在`Explore Users`页面中。 -- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， -- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为8MiB）。 +- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， +- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为 8MiB）。 - `REACTIONS`: 用户可以在问题（Issue）、Pull Request（PR）以及评论中选择的所有可选的反应。 - 这些值可以是表情符号别名（例如：:smile:）或Unicode表情符号。 - 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 -- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在utf8标准中定义的额外表情符号。 - 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， - 并将其添加到此配置中。 + 这些值可以是表情符号别名（例如：:smile:）或 Unicode 表情符号。 + 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 +- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。 + 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， + 并将其添加到此配置中。 - `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示用户的全名。如果没有设置全名，则将使用用户名。 - `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的仓库搜索中搜索描述。 - `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字并使用默认排序时，是否仅在探索页面上显示相关的仓库。 - 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 + 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 ### 界面 - 管理员 (`ui.admin`) @@ -248,11 +247,11 @@ aliases: ### 界面 - SVG Images (`ui.svg`) -- `ENABLE_RENDER`: **true**: 是否将SVG文件呈现为图像。如果禁用了SVG渲染，SVG文件将显示为文本，无法作为图像嵌入到Markdown文件中。 +- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈现为图像。如果禁用了 SVG 渲染，SVG 文件将显示为文本，无法作为图像嵌入到 Markdown 文件中。 ### 界面 - CSV Files (`ui.csv`) -- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将CSV文件呈现为表格的最大文件大小（将其设置为0表示没有限制）。 +- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将 CSV 文件呈现为表格的最大文件大小（将其设置为 0 表示没有限制）。 - `MAX_ROWS`: **2500** : 最大允许的 CSV 文件行数。 (设置为 0 不限制) ## Markdown (`markdown`) @@ -263,10 +262,10 @@ aliases: - `ENABLE_HARD_LINE_BREAK_IN_DOCUMENTS`: **false**: 在文档中将软换行符呈现为硬换行符， 这意味着段落之间的单个换行符将导致换行， 并且不需要在段落后添加尾随空格来强制换行。 -- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在Markdown中呈现的附加URL超链接。 - 以http和https开头的URL始终显示。 - 如果此条目为空，则允许所有URL方案。 -- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为Markdown的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为Markdown，请只需放置一个逗号。 +- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在 Markdown 中呈现的附加 URL 超链接。 + 以 http 和 https 开头的 URL 始终显示。 + 如果此条目为空，则允许所有 URL 方案。 +- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为 Markdown，请只需放置一个逗号。 - `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作为数学块的检测。 ## 服务器 (`server`) @@ -278,27 +277,27 @@ aliases: - `PROXY_PROTOCOL_HEADER_TIMEOUT`: **5s**: 等待`PROXY`协议头的超时时间（设置为`0`表示没有超时）。 - `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受带有未知类型的`PROXY`协议头。 - `DOMAIN`: **localhost**: 此服务器的域名。 -- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP\_PORT)s/**: - 覆盖自动生成的公共URL。 - 如果内部URL和外部URL不匹配（例如在Docker中），这很有用。 +- `ROOT_URL`: **%(PROTOCOL)s://%(DOMAIN)s:%(HTTP_PORT)s/**: + 覆盖自动生成的公共 URL。 + 如果内部 URL 和外部 URL 不匹配（例如在 Docker 中），这很有用。 - `STATIC_URL_PREFIX`: **_empty_**: - 覆盖此选项以从不同的URL请求静态资源。 - 这包括CSS文件、图片、JS文件和Web字体。 - 头像图片是动态资源，仍由Gitea提供。 - 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. - 请求会变成 `%(ROOT_URL)s/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` - 静态文件位于Gitea源代码仓库的`public/`目录中。 - 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 + 覆盖此选项以从不同的 URL 请求静态资源。 + 这包括 CSS 文件、图片、JS 文件和 Web 字体。 + 头像图片是动态资源，仍由 Gitea 提供。 + 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. + 请求会变成 `%(ROOT_URL)s/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` + 静态文件位于 Gitea 源代码仓库的`public/`目录中。 + 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 - `HTTP_ADDR`: **0.0.0.0**: HTTP 监听地址。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 - `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - 如果 `PROTOCOL` 设置为 `http+unix` 或 `fcgi+unix`，则应该是要使用的 Unix 套接字文件的名称。相对路径将相对于 _`AppWorkPath`_ 被转换为绝对路径。 - `HTTP_PORT`: **3000**: HTTP 监听端口。 - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 `HTTP_ADDR` 和 `HTTP_PORT` - 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 - `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的权限。 -- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: +- `LOCAL_ROOT_URL`: **%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/**: 用于访问网络服务的 Gitea 工作器（例如 SSH 更新）的本地（DMZ）URL。 在大多数情况下，您不需要更改默认值。 仅在您的 SSH 服务器节点与 HTTP 节点不同的情况下才修改它。对于不同的协议，默认值不同。如果 `PROTOCOL` @@ -307,15 +306,15 @@ aliases: `%(PROTOCOL)s://localhost:%(HTTP_PORT)s/`， 否则默认值为 `%(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/`。 - `LOCAL_USE_PROXY_PROTOCOL`: **%(USE_PROXY_PROTOCOL)s**: 在进行本地连接时传递 PROXY 协议头。 - 如果本地连接将经过代理，请将其设置为 false。 + 如果本地连接将经过代理，请将其设置为 false。 - `PER_WRITE_TIMEOUT`: **30s**: 连接的任何写操作的超时时间。（将其设置为 -1 以禁用所有超时。） - `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 连接每写入 1 KB 的超时时间。 -- `DISABLE_SSH`: **false**: 当SSH不可用时禁用SSH功能。 -- `START_SSH_SERVER`: **false**: 启用时，使用内置的SSH服务器。 -- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置SSH服务器建立连接时，期望PROXY协议头。 -- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: 用于内置SSH服务器的用户名。 -- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)s**: 在克隆URL中显示的SSH用户名。这仅适用于自行配置SSH服务器的人；在大多数情况下，您希望将其留空并修改`BUILTIN_SSH_SERVER_USER`。 +- `DISABLE_SSH`: **false**: 当 SSH 不可用时禁用 SSH 功能。 +- `START_SSH_SERVER`: **false**: 启用时，使用内置的 SSH 服务器。 +- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置 SSH 服务器建立连接时，期望 PROXY 协议头。 +- `BUILTIN_SSH_SERVER_USER`: **%(RUN_USER)s**: 用于内置 SSH 服务器的用户名。 +- `SSH_USER`: **%(BUILTIN_SSH_SERVER_USER)s**: 在克隆 URL 中显示的 SSH 用户名。这仅适用于自行配置 SSH 服务器的人；在大多数情况下，您希望将其留空并修改`BUILTIN_SSH_SERVER_USER`。 - `SSH_DOMAIN`: **%(DOMAIN)s**: 此服务器的域名，用于显示的克隆 URL。 - `SSH_PORT`: **22**: 显示在克隆 URL 中的 SSH 端口。 - `SSH_LISTEN_HOST`: **0.0.0.0**: 内置 SSH 服务器的监听地址。 @@ -408,7 +407,7 @@ aliases: ## 数据库 (`database`) - `DB_TYPE`: **mysql**: 数据库类型 \[mysql, postgres, mssql, sqlite3\]。 -- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或unix套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 +- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或 unix 套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 - `NAME`: **gitea**: 数据库名称。 - `USER`: **root**: 数据库用户名。 - `PASSWD`: **_empty_**: 数据库密码。如果密码包含特殊字符，请使用 \`your password\` 或 """your password"""。 @@ -442,15 +441,15 @@ aliases: ## 索引 (`indexer`) - `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型，当前支持：`bleve`、`db`、`elasticsearch` 或 `meilisearch`。 -- `ISSUE_INDEXER_CONN_STR`：****: 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 +- `ISSUE_INDEXER_CONN_STR`：\*\*\*\*: 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 - `ISSUE_INDEXER_NAME`：**gitea_issues**: 工单索引器名称，在 ISSUE_INDEXER_TYPE 为 elasticsearch 或 meilisearch 时可用。 -- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE_INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 _`AppWorkPath`_ 进行绝对路径化。 +- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE*INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 *`AppWorkPath`\_ 进行绝对路径化。 - `REPO_INDEXER_ENABLED`：**false**: 启用代码搜索（占用大量磁盘空间，约为存储库大小的 6 倍）。 - `REPO_INDEXER_REPO_TYPES`：**sources,forks,mirrors,templates**: 存储库索引器单元。要索引的项目可以是 `sources`、`forks`、`mirrors`、`templates` 或它们的任何组合，用逗号分隔。如果为空，则默认为仅 `sources`，如果要完全禁用，请参见 `REPO_INDEXER_ENABLED`。 - `REPO_INDEXER_TYPE`：**bleve**: 代码搜索引擎类型，可以为 `bleve` 或者 `elasticsearch`。 - `REPO_INDEXER_PATH`：**indexers/repos.bleve**: 用于代码搜索的索引文件。 -- `REPO_INDEXER_CONN_STR`：****: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` +- `REPO_INDEXER_CONN_STR`：\*\*\*\*: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` - `REPO_INDEXER_NAME`：**gitea_codes**: 代码索引器名称，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。 - `REPO_INDEXER_INCLUDE`：**empty**: 逗号分隔的 glob 模式列表（参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob)）以用于**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 扩展名的文件。空列表表示包括所有文件。 @@ -468,8 +467,8 @@ aliases: - `LENGTH`：**100000**: 通道队列阻塞之前的最大队列大小 - `BATCH_LENGTH`：**20**: 在传递给处理程序之前批处理数据 - `CONN_STR`：**redis://127.0.0.1:6379/0**: redis 队列类型的连接字符串。对于 `redis-cluster`，使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查询参数来设置选项。类似地，LevelDB 选项也可以使用：**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 进行设置，并将覆盖 `DATADIR`。 -- `QUEUE_NAME`：**_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 -- `SET_NAME`：**_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `QUEUE_NAME`：**\_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `SET_NAME`：**\_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 - `MAX_WORKERS`：**(dynamic)**: 队列的最大工作协程数。默认值为 "CpuNum/2"，限制在 1 到 10 之间。 Gitea 创建以下非唯一队列： @@ -493,8 +492,8 @@ Gitea 创建以下非唯一队列： - `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: 用户电子邮件通知的默认配置（用户可配置）。选项：enabled、onmention、disabled - `DISABLE_REGULAR_ORG_CREATION`: **false**: 禁止普通（非管理员）用户创建组织。 - `USER_DISABLED_FEATURES`:**_empty_** 禁用的用户特性，当前允许为空或者 `deletion`，`manage_ssh_keys`， `manage_gpg_keys` 未来可以增加更多设置。 - - `deletion`: 用户不能通过界面或者API删除他自己。 - - `manage_ssh_keys`: 用户不能通过界面或者API配置SSH Keys。 + - `deletion`: 用户不能通过界面或者 API 删除他自己。 + - `manage_ssh_keys`: 用户不能通过界面或者 API 配置 SSH Keys。 - `manage_gpg_keys`: 用户不能配置 GPG 密钥。 ## 安全性 (`security`) @@ -503,19 +502,19 @@ Gitea 创建以下非唯一队列： - `SECRET_KEY`: **\<每次安装时随机生成\>**: 全局服务器安全密钥。这个密钥非常重要，如果丢失将无法解密加密的数据（例如 2FA）。 - `SECRET_KEY_URI`: **_empty_**: 与定义 `SECRET_KEY` 不同，此选项可用于使用存储在文件中的密钥（示例值：`file:/etc/gitea/secret_key`）。它不应该像 `SECRET_KEY` 一样容易丢失。 - `LOGIN_REMEMBER_DAYS`: **31**: 在要求重新登录之前，记住用户的登录状态多长时间（以天为单位）。 -- `COOKIE_REMEMBER_NAME`: **gitea\_incredible**: 保存自动登录信息的 Cookie 名称。 +- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自动登录信息的 Cookie 名称。 - `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理认证的 HTTP 头部名称，用于提供用户信息。 - `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理认证的 HTTP 头部名称，用于提供邮箱信息。 - `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理认证的 HTTP 头部名称，用于提供全名信息。 - `REVERSE_PROXY_LIMIT`: **1**: 解释 X-Forwarded-For 标头或 X-Real-IP 标头，并将其设置为请求的远程 IP。 - 可信代理计数。设置为零以不使用这些标头。 + 可信代理计数。设置为零以不使用这些标头。 - `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗号分隔的受信任代理服务器的 IP 地址和网络列表。使用 `*` 来信任全部。 - `DISABLE_GIT_HOOKS`: **true**: 设置为 `false` 以允许具有 Git 钩子权限的用户创建自定义 Git 钩子。 - 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 - 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 - 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 - 这可能对您的网站或操作系统造成危害。 - 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 + 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 + 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 + 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 + 这可能对您的网站或操作系统造成危害。 + 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 - `DISABLE_WEBHOOKS`: **false**: 设置为 `true` 以禁用 Webhooks 功能。 - `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 设置为 `false` 以允许本地用户在未设置 Gitea 环境的情况下推送到 Gitea 存储库。不建议这样做，如果您希望本地用户推送到 Gitea 存储库，应该适当地设置环境。 - `IMPORT_LOCAL_PATHS`: **false**: 设置为 `false` 以防止所有用户（包括管理员）从服务器上导入本地路径。 @@ -543,7 +542,7 @@ Gitea 创建以下非唯一队列： - lower - 使用一个或多个小写拉丁字符 - upper - 使用一个或多个大写拉丁字符 - digit - 使用一个或多个数字 - - spec - 使用一个或多个特殊字符，如 ``!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~`` + - spec - 使用一个或多个特殊字符，如 `` !"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ `` - off - 不检查密码复杂性 - `PASSWORD_CHECK_PWN`: **false**: 检查密码是否在 [HaveIBeenPwned](https://haveibeenpwned.com/Passwords) 中曝光。 - `SUCCESSFUL_TOKENS_CACHE_SIZE`: **20**: 缓存成功的令牌哈希。API 令牌在数据库中存储为 pbkdf2 哈希，但这意味着在存在多个 API 操作时可能会有显着的哈希负载。此缓存将在 LRU 缓存中存储成功的哈希令牌，以在性能和安全性之间保持平衡。 @@ -551,27 +550,27 @@ Gitea 创建以下非唯一队列： ## Camo (`camo`) - `ENABLED`: **false**: 启用媒体代理，目前仅支持图像。 -- `SERVER_URL`: **_empty_**: Camo服务器的URL，如果启用camo，则**必填**。 -- `HMAC_KEY`: **_empty_**: 为URL编码提供HMAC密钥，如果启用camo，则**必填**。 -- `ALWAYS`: **false**: 设置为true以在HTTP和HTTPS内容上使用camo，否则仅代理非HTTPS URL。`ALLWAYS` 已经过期，并且会在未来版本中删除。 +- `SERVER_URL`: **_empty_**: Camo 服务器的 URL，如果启用 camo，则**必填**。 +- `HMAC_KEY`: **_empty_**: 为 URL 编码提供 HMAC 密钥，如果启用 camo，则**必填**。 +- `ALWAYS`: **false**: 设置为 true 以在 HTTP 和 HTTPS 内容上使用 camo，否则仅代理非 HTTPS URL。`ALLWAYS` 已经过期，并且会在未来版本中删除。 ## OpenID (`openid`) -- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过OpenID进行身份验证。 -- `ENABLE_OPENID_SIGNUP`: **! DISABLE\_REGISTRATION**: 允许通过OpenID进行注册。 -- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于允许访问。 -- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配OpenID URI的POSIX正则表达式模式，用于阻止访问。 +- `ENABLE_OPENID_SIGNIN`: **true**: 允许通过 OpenID 进行身份验证。 +- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: 允许通过 OpenID 进行注册。 +- `WHITELISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于允许访问。 +- `BLACKLISTED_URIS`: **_empty_**: 如果非空，是一组匹配 OpenID URI 的 POSIX 正则表达式模式，用于阻止访问。 ## OAuth2 Client (`oauth2_client`) -- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER\_EMAIL\_CONFIRM**: 设置此项以启用或禁用OAuth2自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） -- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的OpenID连接范围的列表。（`openid`已隐式添加） -- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的OAuth2用户自动创建用户帐户。 -- `USERNAME`: **nickname**: 新OAuth2帐户的用户名来源： - - userid - 使用userid / sub属性 - - nickname - 使用nickname属性 - - email - 使用email属性的用户名部分 -- `UPDATE_AVATAR`: **false**: 如果OAuth2提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 +- `REGISTER_EMAIL_CONFIRM`: _[service]_ **REGISTER_EMAIL_CONFIRM**: 设置此项以启用或禁用 OAuth2 自动注册的电子邮件确认。（覆盖`[service]`部分的`REGISTER\_EMAIL\_CONFIRM`设置） +- `OPENID_CONNECT_SCOPES`: **_empty_**: 附加的 OpenID 连接范围的列表。（`openid`已隐式添加） +- `ENABLE_AUTO_REGISTRATION`: **false**: 为新的 OAuth2 用户自动创建用户帐户。 +- `USERNAME`: **nickname**: 新 OAuth2 帐户的用户名来源： + - userid - 使用 userid / sub 属性 + - nickname - 使用 nickname 属性 + - email - 使用 email 属性的用户名部分 +- `UPDATE_AVATAR`: **false**: 如果 OAuth2 提供程序中有可用的头像，则进行头像更新。更新将在每次登录时执行。 - `ACCOUNT_LINKING`: **login**: 如果帐户/电子邮件已存在，如何处理： - disabled - 显示错误 - login - 显示帐户链接登录 @@ -584,54 +583,54 @@ Gitea 创建以下非唯一队列： - `REGISTER_EMAIL_CONFIRM`: **false**: 启用此项以要求通过邮件确认注册。需要启用`Mailer`。 - `REGISTER_MANUAL_CONFIRM`: **false**: 启用此项以手动确认新的注册。需要禁用`REGISTER_EMAIL_CONFIRM`。 - `DISABLE_REGISTRATION`: **false**: 禁用注册，之后只有管理员可以为用户创建帐户。 -- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过GitHub、OpenID Connect等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 -- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用API。 +- `REQUIRE_EXTERNAL_REGISTRATION_PASSWORD`: **false**: 启用此项以强制通过外部方式创建的帐户（通过 GitHub、OpenID Connect 等）创建密码。警告：启用此项将降低安全性，因此只有在您知道自己在做什么时才应启用它。 +- `REQUIRE_SIGNIN_VIEW`: **false**: 启用此项以强制用户登录以查看任何页面或使用 API。 - `ENABLE_NOTIFY_MAIL`: **false**: 启用此项以在发生某些情况（如创建问题）时向存储库的观察者发送电子邮件。需要启用`Mailer`。 -- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用HTTP BASIC和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌API端点。此外，这仅会禁用使用密码的BASIC身份验证，而不会禁用令牌或OAuth Basic。 +- `ENABLE_BASIC_AUTHENTICATION`: **true**: 禁用此项以禁止使用 HTTP BASIC 和用户的密码进行身份验证。请注意，如果禁用此项，您将无法使用密码访问令牌 API 端点。此外，这仅会禁用使用密码的 BASIC 身份验证，而不会禁用令牌或 OAuth Basic。 - `ENABLE_REVERSE_PROXY_AUTHENTICATION`: **false**: 启用此项以允许反向代理身份验证。 - `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION`: **false**: 启用此项以允许反向身份验证的自动注册。 - `ENABLE_REVERSE_PROXY_EMAIL`: **false**: 启用此项以允许使用提供的电子邮件而不是生成的电子邮件进行自动注册。 - `ENABLE_REVERSE_PROXY_FULL_NAME`: **false**: 启用此项以允许使用提供的全名进行自动注册。 - `ENABLE_CAPTCHA`: **false**: 启用此项以对注册使用验证码验证。 - `REQUIRE_CAPTCHA_FOR_LOGIN`: **false**: 启用此项以要求登录使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 -- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即GitHub、OpenID Connect等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 +- `REQUIRE_EXTERNAL_REGISTRATION_CAPTCHA`: **false**: 启用此项以强制对外部帐户（即 GitHub、OpenID Connect 等）使用验证码验证。您还必须启用`ENABLE_CAPTCHA`。 - `CAPTCHA_TYPE`: **image**: \[image、recaptcha、hcaptcha、mcaptcha、cfturnstile\] -- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的密钥。 -- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取recaptcha的站点密钥。 -- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/**: 设置recaptcha网址，允许使用recaptcha net。 -- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的密钥。 -- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取hcaptcha的站点密钥。 -- `MCAPTCHA_SECRET`: **""**: 访问您的mCaptcha实例以获取mCaptcha的密钥。 -- `MCAPTCHA_SITEKEY`: **""**: 访问您的mCaptcha实例以获取mCaptcha的站点密钥。 -- `MCAPTCHA_URL` **https://demo.mcaptcha.org/**: 设置mCaptcha的URL。 -- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的密钥。 -- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取cloudflare turnstile的站点密钥。 +- `RECAPTCHA_SECRET`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的密钥。 +- `RECAPTCHA_SITEKEY`: **""**: 访问 https://www.google.com/recaptcha/admin 以获取 recaptcha 的站点密钥。 +- `RECAPTCHA_URL`: **https://www.google.com/recaptcha/**: 设置 recaptcha 网址，允许使用 recaptcha net。 +- `HCAPTCHA_SECRET`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的密钥。 +- `HCAPTCHA_SITEKEY`: **""**: 注册 https://www.hcaptcha.com/ 以获取 hcaptcha 的站点密钥。 +- `MCAPTCHA_SECRET`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的密钥。 +- `MCAPTCHA_SITEKEY`: **""**: 访问您的 mCaptcha 实例以获取 mCaptcha 的站点密钥。 +- `MCAPTCHA_URL` **https://demo.mcaptcha.org/**: 设置 mCaptcha 的 URL。 +- `CF_TURNSTILE_SECRET` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的密钥。 +- `CF_TURNSTILE_SITEKEY` **""**: 访问 https://dash.cloudflare.com/?to=/:account/turnstile 以获取 cloudflare turnstile 的站点密钥。 - `DEFAULT_KEEP_EMAIL_PRIVATE`: **false**: 默认情况下，将用户设置为保持其电子邮件地址私有。 - `DEFAULT_ALLOW_CREATE_ORGANIZATION`: **true**: 默认情况下，允许新用户创建组织。 - `DEFAULT_USER_IS_RESTRICTED`: **false**: 默认情况下，为新用户分配受限权限。 - `DEFAULT_ENABLE_DEPENDENCIES`: **true**: 启用此项以默认启用依赖项。 - `ALLOW_CROSS_REPOSITORY_DEPENDENCIES` : **true** 启用此项以允许从用户被授予访问权限的任何存储库上进行依赖项操作。 -- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务URL。位置将作为转义的查询参数附加到URL中。 +- `USER_LOCATION_MAP_URL`: **""**: 一个显示用户在地图上位置的地图服务 URL。位置将作为转义的查询参数附加到 URL 中。 - `ENABLE_USER_HEATMAP`: **true**: 启用此项以在用户个人资料上显示热图。 - `ENABLE_TIMETRACKING`: **true**: 启用时间跟踪功能。 - `DEFAULT_ENABLE_TIMETRACKING`: **true**: 默认情况下，允许存储库默认使用时间跟踪。 - `DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME`: **true**: 仅允许具有写权限的用户跟踪时间。 - `EMAIL_DOMAIN_ALLOWLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，只能用于在此实例上注册，支持通配符。 - `EMAIL_DOMAIN_BLOCKLIST`: **_empty_**: 如果非空，逗号分隔的域名列表，不能用于在此实例上注册，支持通配符。 -- `SHOW_REGISTRATION_BUTTON`: **! DISABLE\_REGISTRATION**: 显示注册按钮 +- `SHOW_REGISTRATION_BUTTON`: **! DISABLE_REGISTRATION**: 显示注册按钮 - `SHOW_MILESTONES_DASHBOARD_PAGE`: **true** 启用此项以显示里程碑仪表板页面 - 查看所有用户的里程碑 - `AUTO_WATCH_NEW_REPOS`: **true** 启用此项以在创建新存储库时让所有组织用户观看新存储库 - `AUTO_WATCH_ON_CHANGES`: **false** 启用此项以在首次提交后使用户观看存储库 - `DEFAULT_USER_VISIBILITY`: **public**: 为用户设置默认的可见性模式，可以是"public"、"limited"或"private"。 - `ALLOWED_USER_VISIBILITY_MODES`: **public,limited,private**: 设置用户可以具有的可见性模式 - `DEFAULT_ORG_VISIBILITY`: **public**: 为组织设置默认的可见性模式，可以是"public"、"limited"或"private"。 -- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为True。 -- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为True以强制仅通过Gitea进行注册。 -- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为True以强制仅使用第三方服务进行注册。 -- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将KeepEmailPrivate设置为True，则在Git日志中的用户电子邮件地址的域部分的值。DOMAIN解析为server.DOMAIN中的值。 - 用户的电子邮件将被替换为小写的用户名、"@"和NO_REPLY_ADDRESS的连接。 +- `DEFAULT_ORG_MEMBER_VISIBLE`: **false**: 如果添加到组织时将用户的成员身份可见，设置为 True。 +- `ALLOW_ONLY_INTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅通过 Gitea 进行注册。 +- `ALLOW_ONLY_EXTERNAL_REGISTRATION`: **false**: 设置为 True 以强制仅使用第三方服务进行注册。 +- `NO_REPLY_ADDRESS`: **noreply.DOMAIN**: 如果用户将 KeepEmailPrivate 设置为 True，则在 Git 日志中的用户电子邮件地址的域部分的值。DOMAIN 解析为 server.DOMAIN 中的值。 + 用户的电子邮件将被替换为小写的用户名、"@"和 NO_REPLY_ADDRESS 的连接。 - `USER_DELETE_WITH_COMMENTS_MAX_TIME`: **0**: 用户删除后，评论将保留的最短时间。 -- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点URL方案 +- `VALID_SITE_URL_SCHEMES`: **http, https**: 用户个人资料的有效站点 URL 方案 ### Service - Explore (`service.explore`) @@ -642,12 +641,12 @@ Gitea 创建以下非唯一队列： ## SSH Minimum Key Sizes (`ssh.minimum_key_sizes`) -定义允许的算法及其最小密钥长度（使用-1来禁用某个类型）： +定义允许的算法及其最小密钥长度（使用-1 来禁用某个类型）： - `ED25519`：**256** - `ECDSA`：**256** -- `RSA`：**3071**: 我们在这里设置为2047，因为一个其他方面有效的3072 RSA密钥可能被报告为3071长度。 -- `DSA`：**-1**: 默认情况下禁用DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的SSHD提供者 +- `RSA`：**3071**: 我们在这里设置为 2047，因为一个其他方面有效的 3072 RSA 密钥可能被报告为 3071 长度。 +- `DSA`：**-1**: 默认情况下禁用 DSA。设置为**1024**以重新启用，但请注意可能需要重新配置您的 SSHD 提供者 ## Webhook (`webhook`) @@ -664,7 +663,7 @@ Gitea 创建以下非唯一队列： - `SKIP_TLS_VERIFY`: **false**: 允许不安全的证书。 - `PAGING_NUM`: **10**: 一页中显示的 Webhook 历史事件数量。 - `PROXY_URL`: **_empty_**: 代理服务器 URL，支持 http://、https://、socks://，留空将遵循环境的 http_proxy/https_proxy 设置。如果未提供，将使用全局代理设置。 -- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (*)；使用 ** 来匹配所有主机。如果未提供，将使用全局代理设置。 +- `PROXY_HOSTS`: **_empty_**: 需要代理的主机名的逗号分隔列表。支持通配符模式 (\*)；使用 \*\* 来匹配所有主机。如果未提供，将使用全局代理设置。 ## 邮件 (`mailer`) @@ -720,7 +719,7 @@ Gitea 创建以下非唯一队列： ## 缓存 (`cache`) -- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的LRU缓存) +- `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis`, `redis-cluster`, `twoqueue` 和 `memcache`. (`twoqueue` 代表缓冲区固定的 LRU 缓存) - `INTERVAL`: **60**: 垃圾回收间隔(秒)，只对`memory`和`towqueue`有效。 - `HOST`: **_empty_**: 缓存配置。`redis`, `redis-cluster`，`memcache`配置连接字符串;`twoqueue` 设置队列参数 - Redis: `redis://:macaron@127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` @@ -739,7 +738,7 @@ Gitea 创建以下非唯一队列： - `PROVIDER`: **memory**: 会话存储引擎 \[memory, file, redis, redis-cluster, db, mysql, couchbase, memcache, postgres\]。设置为 `db` 将会重用 `[database]` 的配置信息。 - `PROVIDER_CONFIG`: **data/sessions**: 对于文件，为根路径；对于 db，为空（将使用数据库配置）；对于其他引擎，为连接字符串。相对路径将根据 _`AppWorkPath`_ 绝对化。 - `COOKIE_SECURE`: **_empty_**: `true` 或 `false`。启用此选项以强制在所有会话访问中使用 HTTPS。如果没有设置，当 ROOT_URL 是 https 链接的时候默认设置为 true。 -- `COOKIE_NAME`: **i\_like\_gitea**: 用于会话 ID 的 cookie 名称。 +- `COOKIE_NAME`: **i_like_gitea**: 用于会话 ID 的 cookie 名称。 - `GC_INTERVAL_TIME`: **86400**: GC 间隔时间，以秒为单位。 - `SESSION_LIFE_TIME`: **86400**: 会话生命周期，以秒为单位，默认为 86400（1 天）。 - `DOMAIN`: **_empty_**: 设置 cookie 的域。 @@ -748,10 +747,10 @@ Gitea 创建以下非唯一队列： ## 图像 (`picture`) - `GRAVATAR_SOURCE`: **gravatar**: 头像来源，可以是 gravatar、duoshuo 或类似 http://cn.gravatar.com/avatar/ 的来源。 - `http://cn.gravatar.com/avatar/`。 + `http://cn.gravatar.com/avatar/`。 - `DISABLE_GRAVATAR`: **false**: 启用后，只使用内部头像。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `ENABLE_FEDERATED_AVATAR`: **false**: 启用头像联盟支持（参见 - [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 + [http://www.libravatar.org](http://www.libravatar.org)）。**已弃用 [v1.18+]** 该配置已迁移到数据库中保存，通过管理员面板进行配置。 - `AVATAR_STORAGE_TYPE`: **default**: 在 `[storage.xxx]` 中定义的存储类型。默认为 `default`，如果没有 `[storage]` 部分，则将读取 `[storage]`，如果没有则将是 `local` 类型。 - `AVATAR_UPLOAD_PATH`: **data/avatars**: 存储用户头像图像文件的路径。 @@ -794,7 +793,7 @@ Gitea 创建以下非唯一队列： - `MINIO_USE_SSL`: **false**: Minio 启用 SSL，仅当 STORAGE_TYPE 为 `minio` 时可用。 - `MINIO_INSECURE_SKIP_VERIFY`: **false**: Minio 跳过 SSL 验证，仅当 STORAGE_TYPE 为 `minio` 时可用。 - `MINIO_CHECKSUM_ALGORITHM`: **default**: Minio 校验算法：`default`（适用于 MinIO 或 AWS S3）或 `md5`（适用于 Cloudflare 或 Backblaze） -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 ## 日志 (`log`) @@ -821,7 +820,7 @@ Gitea 创建以下非唯一队列： - 例如： - 在请求头中：X-Request-ID: **test-id-123** - 在 app.ini 中的配置：REQUEST_ID_HEADERS = X-Request-ID - - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... + - 在日志中打印：127.0.0.1:58384 - - [14/Feb/2023:16:33:51 +0800] "**test-id-123**" ... ### 日志子部分 (`log.`) @@ -857,13 +856,13 @@ Gitea 创建以下非唯一队列： ## 定时任务 (`cron`) -- `ENABLED`: **false**: 是否在后台运行定期任务。 +- `ENABLED`: **false**: 是否在后台运行定期任务。 - `RUN_AT_START`: **false**: 在应用程序启动时运行定时任务。 -- `NOTICE_ON_SUCCESS`: **false**: 设置为 true时，任务成功完成时将进行通知。 +- `NOTICE_ON_SUCCESS`: **false**: 设置为 true 时，任务成功完成时将进行通知。 - `SCHEDULE` 接受的格式: - - 完整的crontab语法规范, e.g. `* * * * * ?` - - 描述符e.g. `@midnight`, `@every 1h30m` ... + - 完整的 crontab 语法规范, e.g. `* * * * * ?` + - 描述符 e.g. `@midnight`, `@every 1h30m` ... - 更多详见: [cron documentation](https://pkg.go.dev/github.com/gogs/cron@v0.0.0-20171120032916-9f6c956d3e14) ### 基本定时任务 - 默认开启 @@ -872,31 +871,31 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 是否启用该定时任务。 - `RUN_AT_START`: **true**: 设置在服务启动时运行。 -- `SCHEDULE`: **@midnight**: 使用Cron语法的定时任务触发配置，例如 `@every 1h`。 +- `SCHEDULE`: **@midnight**: 使用 Cron 语法的定时任务触发配置，例如 `@every 1h`。 - `OLDER_THAN`: **24h**: 超过`OLDER_THAN`时间的存档将被删除，例如 `12h`。 #### 定时任务 - 更新镜像仓库 (`cron.update_mirrors`) -- `SCHEDULE`: **@every 10m**: 使用Cron语法的定时任务触发配置，例如 `@every 3h`。 -- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 -- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `SCHEDULE`: **@every 10m**: 使用 Cron 语法的定时任务触发配置，例如 `@every 3h`。 +- `PULL_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 +- `PUSH_LIMIT`: **50**: 将要添加到队列的镜像数量限制为此数字（负值表示无限制，0 将导致不会将镜像加入队列，从而有效地禁用镜像更新）。 #### 定时任务 - 健康检查所有仓库 (`cron.repo_health_check`) -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库健康检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库健康检查。 - `TIMEOUT`: **60s**: 用于健康检查执行超时的时间持续语法。 - `ARGS`: **_empty_**: `git fsck` 命令的参数，例如 `--unreachable --tags`。在 http://git-scm.com/docs/git-fsck 上了解更多。 #### 定时任务 - 检查所有仓库统计 (`cron.check_repo_stats`) - `RUN_AT_START`: **true**: 在启动时运行仓库统计检查。 -- `SCHEDULE`: **@midnight**: Cron语法，用于安排仓库统计检查。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于安排仓库统计检查。 #### 定时任务 - 清理 hook_task 表 (`cron.cleanup_hook_task_table`) - `ENABLED`: **true**: 启用清理 hook_task 任务。 - `RUN_AT_START`: **false**: 在启动时运行清理 hook_task（如果启用）。 -- `SCHEDULE`: **@midnight**: Cron语法，用于清理 hook_task 表。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于清理 hook_task 表。 - `CLEANUP_TYPE` **OlderThan** OlderThan 或 PerWebhook 方法来清理 hook_task，可以按年龄（即 hook_task 记录传递多久）或按每个 Webhook 保留的数量（即每个 Webhook 保留最新的 x 个传递）来清理。 - `OLDER_THAN`: **168h**: 如果 CLEANUP_TYPE 设置为 OlderThan，则早于此表达式的任何传递的 hook_task 记录将被删除。 - `NUMBER_TO_KEEP`: **10**: 如果 CLEANUP_TYPE 设置为 PerWebhook，则 Webhook 的此数量 hook_task 记录将被保留（即保留最新的 x 个传递）。 @@ -906,7 +905,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **true**: 启用清理过期包任务。 - `RUN_AT_START`: **true**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 每次运行此任务时都会通知。 -- `SCHEDULE`: **@midnight**: Cron语法，用于任务。 +- `SCHEDULE`: **@midnight**: Cron 语法，用于任务。 - `OLDER_THAN`: **24h**: 未引用的包数据创建超过 OLDER_THAN 时间的包将被删除。 #### Cron - 更新迁移海报 ID (`cron.update_migration_poster_id`) @@ -924,7 +923,7 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 - `TIMEOUT`: **60s**: 用于垃圾收集执行超时的时间持续语法。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 - `ARGS`: **_empty_**: `git gc` 命令的参数，例如 `--aggressive --auto`。默认值与 [git] -> GC_ARGS 相同。 @@ -934,95 +933,95 @@ Gitea 创建以下非唯一队列： - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新同步所有仓库的 pre-receive、update 和 post-receive 钩子 (`cron.resync_all_hooks`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 重新初始化所有缺失的 Git 仓库，但记录已存在 (`cron.reinit_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除所有缺少 Git 文件的仓库 (`cron.delete_missing_repos`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 删除生成的仓库头像 (`cron.delete_generated_repository_avatars`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 72h**: Cron语法，用于安排仓库存档清理，例如 `@every 1h`。 +- `SCHEDULE`: **@every 72h**: Cron 语法，用于安排仓库存档清理，例如 `@every 1h`。 #### Cron - 从数据库中删除所有旧的操作 (`cron.delete_old_actions`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NOTICE_ON_SUCCESS`: **false**: 设置为 true 以打开成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1年），因为这是热力图的最大长度。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **8760h**: 早于此表达式的任何操作都将从数据库中删除，建议使用 `8760h`（1 年），因为这是热力图的最大长度。 #### Cron - 从数据库中删除所有旧的系统通知 (`cron.delete_old_system_notices`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 - `NO_SUCCESS_NOTICE`: **false**: 设置为 true 以关闭成功通知。 -- `SCHEDULE`: **@every 168h**: Cron语法，用于设置多长时间进行检查。 +- `SCHEDULE`: **@every 168h**: Cron 语法，用于设置多长时间进行检查。 - `OLDER_THAN`: **8760h**: 早于此表达式的任何系统通知都将从数据库中删除。 #### Cron - 在仓库中回收 LFS 指针 (`cron.gc_lfs`) - `ENABLED`: **false**: 启用服务。 - `RUN_AT_START`: **false**: 在启动时运行任务（如果启用）。 -- `SCHEDULE`: **@every 24h**: Cron语法，用于设置多长时间进行检查。 -- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认7天）的 LFSMetaObject。 -- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认3天）没有尝试过回收的 LFSMetaObject。 +- `SCHEDULE`: **@every 24h**: Cron 语法，用于设置多长时间进行检查。 +- `OLDER_THAN`: **168h**: 只会尝试回收早于此时间（默认 7 天）的 LFSMetaObject。 +- `LAST_UPDATED_MORE_THAN_AGO`: **72h**: 只会尝试回收超过此时间（默认 3 天）没有尝试过回收的 LFSMetaObject。 - `NUMBER_TO_CHECK_PER_REPO`: **100**: 每个仓库要检查的过期 LFSMetaObject 的最小数量。设置为 `0` 以始终检查所有。 ## Git (`git`) -- `PATH`: **""**: Git可执行文件的路径。如果为空，Gitea将在PATH环境中搜索。 -- `HOME_PATH`: **%(APP_DATA_PATH)s/home**: Git的HOME目录。 - 此目录将用于包含Gitea的git调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认Gitea是在此环境中唯一运行的应用程序，您可以将其设置为Gitea用户的正常主目录。 +- `PATH`: **""**: Git 可执行文件的路径。如果为空，Gitea 将在 PATH 环境中搜索。 +- `HOME_PATH`: **%(APP_DATA_PATH)s/home**: Git 的 HOME 目录。 + 此目录将用于包含 Gitea 的 git 调用将使用的`.gitconfig`和可能的`.gnupg`目录。如果您可以确认 Gitea 是在此环境中唯一运行的应用程序，您可以将其设置为 Gitea 用户的正常主目录。 - `DISABLE_DIFF_HIGHLIGHT`: **false**: 禁用已添加和已删除更改的高亮显示。 -- `MAX_GIT_DIFF_LINES`: **1000**: 在diff视图中允许单个文件的最大行数。 -- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在diff视图中每行的最大字符数。 -- `MAX_GIT_DIFF_FILES`: **100**: 在diff视图中显示的最大文件数。 +- `MAX_GIT_DIFF_LINES`: **1000**: 在 diff 视图中允许单个文件的最大行数。 +- `MAX_GIT_DIFF_LINE_CHARACTERS`: **5000**: 在 diff 视图中每行的最大字符数。 +- `MAX_GIT_DIFF_FILES`: **100**: 在 diff 视图中显示的最大文件数。 - `COMMITS_RANGE_SIZE`: **50**: 设置默认的提交范围大小 - `BRANCHES_RANGE_SIZE`: **20**: 设置默认的分支范围大小 - `GC_ARGS`: **_empty_**: 命令`git gc`的参数，例如`--aggressive --auto`。更多信息请参见http://git-scm.com/docs/git-gc/ -- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用Git版本 >= 2.18时使用Git wire协议版本2，默认为true，当您始终希望使用Git wire协议版本1时设置为false。 - 要在使用OpenSSH服务器的情况下为通过SSH的Git启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的sshd_config文件中。 -- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用URL创建拉取请求（如果启用了该存储库的拉取请求） +- `ENABLE_AUTO_GIT_WIRE_PROTOCOL`: **true**: 如果使用 Git 版本 >= 2.18 时使用 Git wire 协议版本 2，默认为 true，当您始终希望使用 Git wire 协议版本 1 时设置为 false。 + 要在使用 OpenSSH 服务器的情况下为通过 SSH 的 Git 启用此功能，请将`AcceptEnv GIT_PROTOCOL`添加到您的 sshd_config 文件中。 +- `PULL_REQUEST_PUSH_MESSAGE`: **true**: 对于推送到非默认分支的响应，使用 URL 创建拉取请求（如果启用了该存储库的拉取请求） - `VERBOSE_PUSH`: **true**: 在处理推送时打印有关推送状态的信息。 - `VERBOSE_PUSH_DELAY`: **5s**: 仅在推送时间超过此延迟时才打印详细信息。 -- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于Go-Git），不要在内存中缓存大于此大小的对象。（设置为0以禁用。） -- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为false。 -- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行git。 +- `LARGE_OBJECT_THRESHOLD`: **1048576**: （仅限于 Go-Git），不要在内存中缓存大于此大小的对象。（设置为 0 以禁用。） +- `DISABLE_CORE_PROTECT_NTFS`: **false** 将`core.protectNTFS`强制设置为 false。 +- `DISABLE_PARTIAL_CLONE`: **false** 禁用使用部分克隆进行 git。 ### Git - 超时设置 (`git.timeout`) -- `DEFAULT`: **360**: Git操作的默认超时时间，单位秒 +- `DEFAULT`: **360**: Git 操作的默认超时时间，单位秒 - `MIGRATE`: **600**: 在迁移外部存储库时的超时时间，单位秒 - `MIRROR`: **300**: 在镜像外部存储库时的超时时间，单位秒 - `CLONE`: **300**: 在存储库之间进行内部克隆的超时时间，单位秒 - `PULL`: **300**: 在存储库之间进行内部拉取的超时时间，单位秒 -- `GC`: **60**: git存储库GC的超时时间，单位秒 +- `GC`: **60**: git 存储库 GC 的超时时间，单位秒 ### Git - 配置选项 (`git.config`) -此部分中的键/值对将用作git配置。 -此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从git配置中删除。格式为`some.configKey = value`。 +此部分中的键/值对将用作 git 配置。 +此部分仅执行“设置”配置，从此部分中删除的配置键不会自动从 git 配置中删除。格式为`some.configKey = value`。 - `diff.algorithm`: **histogram** - `core.logAllRefUpdates`: **true** @@ -1030,45 +1029,45 @@ Gitea 创建以下非唯一队列： ## 指标 (`metrics`) -- `ENABLED`: **false**: 启用/prometheus的metrics端点。 +- `ENABLED`: **false**: 启用/prometheus 的 metrics 端点。 - `ENABLED_ISSUE_BY_LABEL`: **false**: 启用按标签统计问题，格式为`gitea_issues_by_label{label="bug"} 2`。 - `ENABLED_ISSUE_BY_REPOSITORY`: **false**: 启用按存储库统计问题，格式为`gitea_issues_by_repository{repository="org/repo"} 5`。 -- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在prometheus参数`bearer_token`或`bearer_token_file`中使用。 +- `TOKEN`: **_empty_**: 如果要在授权中包含指标，则需要指定令牌。相同的令牌需要在 prometheus 参数`bearer_token`或`bearer_token_file`中使用。 ## API (`api`) -- `ENABLE_SWAGGER`: **true**: 启用API文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 -- `MAX_RESPONSE_ITEMS`: **50**: API分页的最大单页项目数。 -- `DEFAULT_PAGING_NUM`: **30**: API分页的默认分页数。 -- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API的默认单页项目数。 -- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API的默认最大文件大小。 +- `ENABLE_SWAGGER`: **true**: 启用 API 文档接口 (`/api/swagger`, `/api/v1/swagger`, …). True or false。 +- `MAX_RESPONSE_ITEMS`: **50**: API 分页的最大单页项目数。 +- `DEFAULT_PAGING_NUM`: **30**: API 分页的默认分页数。 +- `DEFAULT_GIT_TREES_PER_PAGE`: **1000**: Git trees API 的默认单页项目数。 +- `DEFAULT_MAX_BLOB_SIZE`: **10485760** (10MiB): blobs API 的默认最大文件大小。 ## OAuth2 (`oauth2`) -- `ENABLED`: **true**: 启用OAuth2提供者。 -- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2访问令牌的生命周期，以秒为单位。 -- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2刷新令牌的生命周期，以小时为单位。 +- `ENABLED`: **true**: 启用 OAuth2 提供者。 +- `ACCESS_TOKEN_EXPIRATION_TIME`：**3600**: OAuth2 访问令牌的生命周期，以秒为单位。 +- `REFRESH_TOKEN_EXPIRATION_TIME`：**730**: OAuth2 刷新令牌的生命周期，以小时为单位。 - `INVALIDATE_REFRESH_TOKENS`：**false**: 检查刷新令牌是否已被使用。 -- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署OAuth2令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 -- `JWT_SECRET`：**_empty_**: OAuth2访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 -- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向Gitea提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 -- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署OAuth2令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含PKCS8格式的RSA或ECDSA私钥。如果不存在密钥，则将为您创建一个4096位密钥。 -- `MAX_TOKEN_LENGTH`：**32767**: 从OAuth2提供者接受的令牌/cookie的最大长度。 -- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager, tea**: 在启动时预注册用于某些服务的OAuth应用程序。有关可用选项列表，请参阅[OAuth2文档](/development/oauth2-provider.md)。 +- `JWT_SIGNING_ALGORITHM`：**RS256**: 用于签署 OAuth2 令牌的算法。有效值：[`HS256`，`HS384`，`HS512`，`RS256`，`RS384`，`RS512`，`ES256`，`ES384`，`ES512`]。 +- `JWT_SECRET`：**_empty_**: OAuth2 访问和刷新令牌的身份验证密钥，请将其更改为唯一的字符串。仅当`JWT_SIGNING_ALGORITHM`设置为`HS256`，`HS384`或`HS512`时才需要此设置。 +- `JWT_SECRET_URI`：**_empty_**: 可以使用此配置选项，而不是在配置中定义`JWT_SECRET`，以向 Gitea 提供包含密钥的文件的路径（示例值：`file:/etc/gitea/oauth2_jwt_secret`）。 +- `JWT_SIGNING_PRIVATE_KEY_FILE`：**jwt/private.pem**: 用于签署 OAuth2 令牌的私钥文件路径。路径相对于`APP_DATA_PATH`。仅当`JWT_SIGNING_ALGORITHM`设置为`RS256`，`RS384`，`RS512`，`ES256`，`ES384`或`ES512`时才需要此设置。文件必须包含 PKCS8 格式的 RSA 或 ECDSA 私钥。如果不存在密钥，则将为您创建一个 4096 位密钥。 +- `MAX_TOKEN_LENGTH`：**32767**: 从 OAuth2 提供者接受的令牌/cookie 的最大长度。 +- `DEFAULT_APPLICATIONS`：**git-credential-oauth，git-credential-manager, tea**: 在启动时预注册用于某些服务的 OAuth 应用程序。有关可用选项列表，请参阅[OAuth2 文档](/development/oauth2-provider.md)。 ## i18n (`i18n`) -- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: - 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 +- `LANGS`: **en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pt-PT,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sv-SE,ko-KR,el-GR,fa-IR,hu-HU,id-ID,ml-IN**: + 在语言选择器中显示的区域设置列表。如果用户浏览器的语言与列表中的任何区域设置不匹配，则将使用第一个区域设置作为默认值。 -- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: - 对应于各区域设置的可见名称。 +- `NAMES`：**English,简体中文,繁體中文（香港）,繁體中文（台灣）,Deutsch,Français,Nederlands,Latviešu,Русский,Українська,日本語,Español,Português do Brasil,Português de Portugal,Polski,Български,Italiano,Suomi,Türkçe,Čeština,Српски,Svenska,한국어,Ελληνικά,فارسی,Magyar nyelv,Bahasa Indonesia,മലയാളം**: + 对应于各区域设置的可见名称。 ## Markup (`markup`) -- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置Mermaid源的最大大小。(设为-1代表禁止) +- `MERMAID_MAX_SOURCE_CHARACTERS`: **5000**: 设置 Mermaid 源的最大大小。(设为-1 代表禁止) -gitea支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 +gitea 支持外部渲染工具，你可以配置你熟悉的文档渲染工具. 比如一下将新增一个名字为 asciidoc 的渲染工具。 ```ini [markup.asciidoc] @@ -1080,21 +1079,21 @@ IS_INPUT_FILE = false ``` - ENABLED：**false** 设置是否启动渲染器 -- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1等。 -- FILE_EXTENSIONS：**_empty_** 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 +- NEED_POSTPROCESS：**true** 设置为**true**以替换链接/SHA1 等。 +- FILE*EXTENSIONS：\*\*\_empty*\*\* 要由外部命令渲染的文件扩展名列表。多个扩展名需要用逗号分隔。 - RENDER_COMMAND：用于渲染所有匹配的扩展名的外部命令。 - IS_INPUT_FILE：**false** 输入不是标准输入，而是一个在`RENDER_COMMAND`之后带有文件参数的文件。 - RENDER_CONTENT_MODE：**sanitized** 内容将如何呈现。 - - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些HTML标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 - - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致XSS攻击。 - - iframe：在单独的独立页面中呈现内容，并通过iframe嵌入到当前页面中。iframe处于禁用同源策略的沙箱模式，并且JS代码与父页面安全隔离。 + - sanitized：对内容进行清理，并在当前页面内呈现，默认仅允许一些 HTML 标签和属性。可以在`[markup.sanitizer.*]`中定义自定义的清理规则。 + - no-sanitizer：禁用清理程序，在当前页面内呈现内容。这是**不安全**的，如果内容包含恶意代码，可能会导致 XSS 攻击。 + - iframe：在单独的独立页面中呈现内容，并通过 iframe 嵌入到当前页面中。iframe 处于禁用同源策略的沙箱模式，并且 JS 代码与父页面安全隔离。 两个特殊的环境变量会传递给渲染命令： -- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前URL前缀。用作链接的前缀。 -- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前URL前缀。用作图像路径的前缀。 +- `GITEA_PREFIX_SRC`，其中包含`src`路径树中的当前 URL 前缀。用作链接的前缀。 +- `GITEA_PREFIX_RAW`，其中包含`raw`路径树中的当前 URL 前缀。用作图像路径的前缀。 -如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea支持自定义用于呈现的HTML的清理策略。下面的示例将支持来自pandoc的KaTeX输出。 +如果`RENDER_CONTENT_MODE`为`sanitized`，Gitea 支持自定义用于呈现的 HTML 的清理策略。下面的示例将支持来自 pandoc 的 KaTeX 输出。 ```ini [markup.sanitizer.TeX] @@ -1109,18 +1108,18 @@ ALLOW_DATA_URI_IMAGES = true - `ELEMENT`：此策略适用于的元素。必须非空。 - `ALLOW_ATTR`：此策略允许的属性。必须非空。 - `REGEXP`：用于匹配属性内容的正则表达式。必须存在，但可以为空，以无条件允许此属性的白名单。 -- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据URI图像（``）。 +- `ALLOW_DATA_URI_IMAGES`：**false** 允许数据 URI 图像（``）。 可以通过添加唯一的子节来定义多个清理规则，例如`[markup.sanitizer.TeX-2]`。 要仅为指定的外部渲染器应用清理规则，它们必须使用渲染器名称，例如`[markup.sanitizer.asciidoc.rule-1]`。 -如果规则在渲染器ini节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 +如果规则在渲染器 ini 节之上定义，或者名称与渲染器不匹配，则应用于每个渲染器。 ## 代码高亮映射 (`highlight.mapping`) - `file_extension 比如 .toml`: **language 比如 ini**。文件扩展名到语言的映射覆盖。 - Gitea 将使用 `.gitattributes` 文件中的 `linguist-language` 或 `gitlab-language` 属性来对文件进行高亮显示，如果可用。 -如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 + 如果未设置此属性或语言不可用，则将查找文件扩展名在此映射中或使用启发式方法来确定文件类型。 ## 时间 (`time`) @@ -1200,11 +1199,11 @@ ALLOW_DATA_URI_IMAGES = true - `MINIO_BASE_PATH`：**lfs/**: 桶上的 Minio 基本路径，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_USE_SSL`：**false**: Minio 启用 ssl，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_INSECURE_SKIP_VERIFY`：**false**: Minio 跳过 SSL 验证，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 ## 存储 (`storage`) -默认的附件、lfs、头像、仓库头像、仓库归档、软件包、操作日志、artifacts 的存储配置。推荐仅仅配置此 section 并让其它的section 从此配置项继承。 +默认的附件、lfs、头像、仓库头像、仓库归档、软件包、操作日志、artifacts 的存储配置。推荐仅仅配置此 section 并让其它的 section 从此配置项继承。 - `STORAGE_TYPE`：**local**: 存储类型，`local` 表示本地磁盘，`minio` 表示 S3，`azureblob` 表示 azure 对象存储。 - `SERVE_DIRECT`：**false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，仅支持通过签名的 URL 提供 Minio/S3，本地不执行任何操作。 @@ -1215,7 +1214,7 @@ ALLOW_DATA_URI_IMAGES = true - `MINIO_LOCATION`：**us-east-1**: 创建桶的 Minio 位置，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_USE_SSL`：**false**: Minio 启用 ssl，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 - `MINIO_INSECURE_SKIP_VERIFY`：**false**: Minio 跳过 SSL 验证，仅在 `STORAGE_TYPE` 为 `minio` 时可用。 -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 - `AZURE_BLOB_ENDPOINT`: **_empty_**: Azure Blob 终端点，仅在 `STORAGE_TYPE` 为 `azureblob` 时可用。例如：https://accountname.blob.core.windows.net 或 http://127.0.0.1:10000/devstoreaccount1 - `AZURE_BLOB_ACCOUNT_NAME`: **_empty_**: Azure Blob 账号名，仅在 `STORAGE_TYPE` 为 `azureblob` 时可用。 @@ -1298,29 +1297,29 @@ MINIO_BUCKET_LOOKUP_TYPE = auto 存储库归档存储的配置。当将`STORAGE_TYPE`设置为`xxx`时，它将继承默认的 `[storage]` 或 `[storage.xxx]` 配置。`PATH`的默认值是`data/repo-archive`，`MINIO_BASE_PATH`的默认值是`repo-archive/`。 -- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 -- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的URL以直接提供文件。目前，只有Minio/S3支持通过签名URL，本地不执行任何操作。 +- `STORAGE_TYPE`: **local**: 存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，或者使用定义为`[storage.xxx]`的其他名称。 +- `SERVE_DIRECT`: **false**: 允许存储驱动程序重定向到经过身份验证的 URL 以直接提供文件。目前，只有 Minio/S3 支持通过签名 URL，本地不执行任何操作。 - `PATH`: **./data/repo-archive**: 用于存储归档文件的位置，仅在`STORAGE_TYPE`为`local`时可用。 -- `MINIO_ENDPOINT`: **localhost:9000**: Minio端点，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_ACCESS_KEY_ID`: Minio的accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_SECRET_ACCESS_KEY`: Minio的secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BUCKET`: **gitea**: 用于存储归档的Minio存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的Minio位置，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的Minio基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_USE_SSL`: **false**: 启用Minio的SSL，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过Minio的SSL验证，仅在`STORAGE_TYPE`为`minio`时可用。 -- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio的bucket查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ENDPOINT`: **localhost:9000**: Minio 端点，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_ACCESS_KEY_ID`: Minio 的 accessKeyID，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_SECRET_ACCESS_KEY`: Minio 的 secretAccessKey，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET`: **gitea**: 用于存储归档的 Minio 存储桶，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_LOCATION`: **us-east-1**: 用于创建存储桶的 Minio 位置，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BASE_PATH`: **repo-archive/**: 存储桶上的 Minio 基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_USE_SSL`: **false**: 启用 Minio 的 SSL，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_INSECURE_SKIP_VERIFY`: **false**: 跳过 Minio 的 SSL 验证，仅在`STORAGE_TYPE`为`minio`时可用。 +- `MINIO_BUCKET_LOOKUP_TYPE`: **auto**: Minio 的 bucket 查找方式默认为`auto`模式，可将其设置为`dns`（虚拟托管样式）或`path`（路径样式），仅当`STORAGE_TYPE`为`minio`时可用。 ### 存储库归档 (`repo-archive`) -- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **repo-archive/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 存储类型，用于操作日志，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **repo-archive/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 ## 代理 (`proxy`) -- `PROXY_ENABLED`: **false**: 启用代理，如果为true，所有通过HTTP向外部的请求都将受到影响，如果为false，即使环境设置了http_proxy/https_proxy也不会使用 +- `PROXY_ENABLED`: **false**: 启用代理，如果为 true，所有通过 HTTP 向外部的请求都将受到影响，如果为 false，即使环境设置了 http_proxy/https_proxy 也不会使用 - `PROXY_URL`: **_empty_**: 代理服务器地址，支持 http://, https//, socks://，为空则不启用代理而使用环境变量中的 http_proxy/https_proxy -- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 * 号匹配符号， ** 表示匹配所有网站 +- `PROXY_HOSTS`: **_empty_**: 逗号分隔的多个需要代理的网址，支持 \* 号匹配符号， \*\* 表示匹配所有网站 i.e. @@ -1334,8 +1333,8 @@ PROXY_HOSTS = *.github.com - `ENABLED`: **true**: 启用/禁用操作功能 - `DEFAULT_ACTIONS_URL`: **github**: 获取操作插件的默认平台，`github`表示`https://github.com`，`self`表示当前的 Gitea 实例。 -- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与S3兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 -- `MINIO_BASE_PATH`: **actions_log/**: Minio存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 +- `STORAGE_TYPE`: **local**: 用于操作日志的存储类型，`local`表示本地磁盘，`minio`表示与 S3 兼容的对象存储服务，默认为`local`，或者使用定义为`[storage.xxx]`的其他名称。 +- `MINIO_BASE_PATH`: **actions_log/**: Minio 存储桶上的基本路径，仅在`STORAGE_TYPE`为`minio`时可用。 - `LOG_RETENTION_DAYS`: **365**: 日志保留时间（天）。此期限后将删除旧日志。 - `LOG_COMPRESSION`: **zstd**: 日志压缩方式，`none`表示不压缩，`zstd`表示 zstd 压缩。 其它的压缩方式如`gzip`是不支持的，因为查看日志需要可寻址流。 @@ -1363,8 +1362,8 @@ PROXY_HOSTS = *.github.com ## 其他 (`other`) -- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示Gitea的版本。 +- `SHOW_FOOTER_VERSION`: **true**: 在页面底部显示 Gitea 的版本。 - `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: 在页脚显示模板执行的时间。 - `SHOW_FOOTER_POWERED_BY`: **true**: 在页脚显示“由...提供动力”的文本。 -- `ENABLE_SITEMAP`: **true**: 生成sitemap. -- `ENABLE_FEED`: **true**: 是否启用RSS/Atom +- `ENABLE_SITEMAP`: **true**: 生成 sitemap. +- `ENABLE_FEED`: **true**: 是否启用 RSS/Atom diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/customizing-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/customizing-gitea.md index 05ecde8a..ed090043 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/customizing-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/customizing-gitea.md @@ -5,14 +5,13 @@ sidebar_position: 100 aliases: - /zh-cn/customizing-gitea - --- # 自定义 Gitea 配置 Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板等默认配置。 -如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为Linux文件系统标准。Gitea +如果从二进制部署 Gitea ，则所有默认路径都将相对于该 gitea 二进制文件；如果从发行版安装，则可能会将这些路径修改为 Linux 文件系统标准。Gitea 将会自动创建包括 `custom/` 在内的必要应用目录，应用本身的配置存放在 `custom/conf/app.ini` 当中。在发行版中可能会以 `/etc/gitea/` 的形式为 `custom` 设置一个符号链接，查看配置详情请移步： @@ -66,7 +65,7 @@ Gitea 引用 `custom` 目录中的自定义配置文件来覆盖配置、模板 除了 `extra_links.tmpl` 和 `extra_tabs.tmpl`，您可以在您的 `custom/templates/custom/` 目录中存放一些其他有用的模板，例如： -- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义CSS文件 +- `header.tmpl`，在 `` 标记结束之前的模板，例如添加自定义 CSS 文件 - `body_outer_pre.tmpl`，在 `` 标记开始处的模板 - `body_inner_pre.tmpl`，在顶部导航栏之前，但在主 container 内部的模板，例如添加一个 `
` - `body_inner_post.tmpl`，在主 container 结束处的模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/email-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/email-setup.md index 3735e537..cc3f09e6 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/email-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/email-setup.md @@ -5,7 +5,6 @@ sidebar_position: 12 aliases: - /zh-cn/email-setup - --- # Email 设置 @@ -16,9 +15,9 @@ Gitea 具有邮件功能，用于发送事务性邮件（例如注册确认邮 使用 `sendmail` 命令作为邮件传输代理（mailer）。 -注意：对于在官方Gitea Docker镜像中使用，请使用SMTP版本进行配置（请参考下一节）。 +注意：对于在官方 Gitea Docker 镜像中使用，请使用 SMTP 版本进行配置（请参考下一节）。 -注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过TLS发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 +注意：对于面向互联网的网站，请查阅您的 MTA 文档以了解通过 TLS 发送邮件的说明。同时设置 SPF、DMARC 和 DKIM DNS 记录，以使发送的邮件被各个电子邮件提供商接受为合法邮件。 ```ini title="app.ini" [mailer] @@ -55,9 +54,9 @@ PASSWD = `password` - 通过端口 587 的 STARTTLS（也称为 Opportunistic TLS）。初始连接是明文的，但如果服务器支持，则可以升级为 TLS。 - 通过默认端口 465 的 SMTPS 连接。连接到服务器从一开始就使用 TLS。 - 使用 `PROTOCOL=smtps` 进行强制的 SMTPS 连接。（这两种方式都被称为 Implicit TLS） -这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 + 这是由于 Go 内部库对 STRIPTLS 攻击的保护机制。 -请注意，自2018年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 +请注意，自 2018 年起，[RFC8314](https://tools.ietf.org/html/rfc8314#section-3) 推荐使用 Implicit TLS。 ### Gmail diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/environment-variables.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/environment-variables.md index a61c1842..2e25fc8f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/environment-variables.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/environment-variables.md @@ -5,7 +5,6 @@ sidebar_position: 10 aliases: - /zh-cn/environment-variables - --- # 环境变量清单 @@ -20,31 +19,31 @@ GITEA_CUSTOM=/home/gitea/custom ./gitea web 因为 Gitea 使用 Go 语言编写，因此它使用了一些相关的 Go 的配置参数： -* `GOOS` -* `GOARCH` -* [`GOPATH`](https://go.dev/cmd/go/#hdr-GOPATH_environment_variable) +- `GOOS` +- `GOARCH` +- [`GOPATH`](https://go.dev/cmd/go/#hdr-GOPATH_environment_variable) 您可以在[官方文档](https://go.dev/cmd/go/#hdr-Environment_variables)中查阅这些配置参数的详细信息。 ## Gitea 的文件目录 -* `GITEA_WORK_DIR`：工作目录的绝对路径 -* `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录 -* `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 -* `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 +- `GITEA_WORK_DIR`：工作目录的绝对路径 +- `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 _custom_ 目录 +- `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代 +- `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代 ## 操作系统配置 -* `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 -* `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` -* `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 +- `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分 +- `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME` +- `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量 ### 仅限于 Windows 的配置 -* `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` -* `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘） -* `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 +- `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH` +- `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C 盘） +- `HOMEPATH`：在指定主驱动器下的 home 目录相对路径 ## Miscellaneous -* `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 +- `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/external-renderers.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/external-renderers.md index c5990ebd..ae4e49e2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/external-renderers.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/external-renderers.md @@ -5,7 +5,6 @@ sidebar_position: 60 aliases: - /zh-cn/external-renderers - --- # 外部渲染器 @@ -171,7 +170,8 @@ ALLOW_DATA_URI_IMAGES = true .markup.XXXXX body { color: #444; - font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", + serif; font-size: 12px; line-height: 1.7; padding: 1em; diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/fail2ban-setup.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/fail2ban-setup.md index 656dea53..3cef94a9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/fail2ban-setup.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/fail2ban-setup.md @@ -5,7 +5,6 @@ sidebar_position: 16 aliases: - /zh-cn/fail2ban-setup - --- # 设置 Fail2ban diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/git-lfs-support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/git-lfs-support.md index 3154c38e..b1586476 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/git-lfs-support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/git-lfs-support.md @@ -5,7 +5,6 @@ sidebar_position: 12 aliases: - /zh-cn/git-lfs-setup - --- # Git LFS 设置 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/mail-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/mail-templates.md index d1766619..78606546 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/mail-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/mail-templates.md @@ -17,18 +17,18 @@ aliases: 目前，以下通知事件使用模板： -| 操作名称 | 用途 | -| ----------- | ------------------------------------------------------------------------------------------------------------ | -| `new` | 创建了新的工单或合并请求。 | -| `comment` | 在现有工单或合并请求中创建了新的评论。 | -| `close` | 关闭了工单或合并请求。 | -| `reopen` | 重新打开了工单或合并请求。 | -| `review` | 在合并请求中进行审查的首要评论。 | -| `approve` | 对合并请求进行批准的首要评论。 | -| `reject` | 对合并请求提出更改请求的审查的首要评论。 | -| `code` | 关于合并请求的代码的单个评论。 | -| `assigned` | 用户被分配到工单或合并请求。 | -| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | +| 操作名称 | 用途 | +| ---------- | ---------------------------------------------------------------------- | +| `new` | 创建了新的工单或合并请求。 | +| `comment` | 在现有工单或合并请求中创建了新的评论。 | +| `close` | 关闭了工单或合并请求。 | +| `reopen` | 重新打开了工单或合并请求。 | +| `review` | 在合并请求中进行审查的首要评论。 | +| `approve` | 对合并请求进行批准的首要评论。 | +| `reject` | 对合并请求提出更改请求的审查的首要评论。 | +| `code` | 关于合并请求的代码的单个评论。 | +| `assigned` | 用户被分配到工单或合并请求。 | +| `default` | 未包括在上述类别中的任何操作，或者当对应类别的模板不存在时使用的模板。 | 特定消息类型的模板路径为： @@ -72,25 +72,25 @@ custom/templates/mail/pull/comment.tmpl 指定 _主题_ 部分是可选的（因此也是虚线分隔符）。在使用时，_主题_ 和 _邮件正文_ 模板之间的分隔符需要至少三个虚线；分隔符行中不允许使用其他字符。 -_主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： +_主题_ 和 _邮件正文_ 由 [Golang 的模板引擎](https://go.dev/pkg/text/template/) 解析，并提供了为每个通知组装的 _元数据上下文_。上下文包含以下元素： -| 名称 | 类型 | 可用性 | 用途 | -| -------------------- | ------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | -| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | -| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | -| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | -| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | -| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | -| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | -| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | -| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | -| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | -| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | -| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | -| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | -| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | -| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | +| 名称 | 类型 | 可用性 | 用途 | +| ------------------ | ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `.FallbackSubject` | string | 始终可用 | 默认主题行。参见下文。 | +| `.Subject` | string | 仅在正文中可用 | 解析后的 _主题_。 | +| `.Body` | string | 始终可用 | 工单、合并请求或评论的消息，从 Markdown 解析为 HTML 并进行了清理。请勿与 _邮件正文_ 混淆。 | +| `.Link` | string | 始终可用 | 源工单、合并请求或评论的地址。 | +| `.Issue` | models.Issue | 始终可用 | 产生通知的工单（或合并请求）。要获取特定于合并请求的数据（例如 `HasMerged`），可以使用 `.Issue.PullRequest`，但需要注意，如果工单 _不是_ 合并请求，则该字段将为 `nil`。 | +| `.Comment` | models.Comment | 如果适用 | 如果通知是针对添加到工单或合并请求的评论，则其中包含有关评论的信息。 | +| `.IsPull` | bool | 始终可用 | 如果邮件通知与合并请求关联（即 `.Issue.PullRequest` 不为 `nil` ），则为 `true`。 | +| `.Repo` | string | 始终可用 | 仓库的名称，包括所有者名称（例如 `mike/stuff`） | +| `.User` | models.User | 始终可用 | 事件来源仓库的所有者。要获取用户名（例如 `mike`），可以使用 `.User.Name`。 | +| `.Doer` | models.User | 始终可用 | 执行触发通知事件的操作的用户。要获取用户名（例如 `rhonda`），可以使用 `.Doer.Name`。 | +| `.IsMention` | bool | 始终可用 | 如果此通知仅是因为在评论中提到了用户而生成的，并且收件人未订阅源，则为 `true`。如果收件人已订阅工单或仓库，则为 `false`。 | +| `.SubjectPrefix` | string | 始终可用 | 如果通知是关于除工单或合并请求创建之外的其他内容，则为 `Re：`；否则为空字符串。 | +| `.ActionType` | string | 始终可用 | `"issue"` 或 `"pull"`。它将与实际的 _操作类型_ 对应，与选择的模板无关。 | +| `.ActionName` | string | 始终可用 | 它将是上述操作类型之一（`new` ，`comment` 等），并与选择的模板对应。 | +| `.ReviewComments` | []models.Comment | 始终可用 | 审查中的代码评论列表。评论文本将在 `.RenderedContent` 中，引用的代码将在 `.Patch` 中。 | 所有名称区分大小写。 @@ -107,7 +107,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ - 删除所有前导、尾随和多余的空格。 - 将字符串截断为前 256 个字母（字符）。 -如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用Gitea的**内部默认值**。 +如果最终结果为空字符串，**或者**没有可用的主题模板（即所选模板不包含主题部分），将使用 Gitea 的**内部默认值**。 内部默认（回退）主题相当于： @@ -117,7 +117,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 例如：`Re: [mike/stuff] New color palette (#38)` -即使存在有效的主题模板，Gitea的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 +即使存在有效的主题模板，Gitea 的默认主题也可以在模板的元数据中作为 `.FallbackSubject` 找到。 ### 模板中的邮件正文部分 @@ -139,7 +139,7 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 如果模板无法呈现，则只有在发送邮件时才会注意到。 如果主题模板失败，将使用默认主题，如果从 _邮件正文_ 中成功呈现了任何内容，则将使用该内容，忽略其他内容。 -如果遇到问题，请检查 [Gitea的日志](../administration/logging-config.md) 以获取错误消息。 +如果遇到问题，请检查 [Gitea 的日志](../administration/logging-config.md) 以获取错误消息。 ## 示例 @@ -221,11 +221,11 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ > > #### 消息内容 > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > Mike, I think we should tone down the blues a little. > -> \_********************************\_******************************** +> \_******\*\*******\*\*\*\*******\*\*******\_******\*\*******\*\*\*\*******\*\******* > > [在 Gitea 上查看](#)。 @@ -233,20 +233,22 @@ _主题_ 和 _邮件正文_ 由 [Golang的模板引擎](https://go.dev/pkg/text/ 模板系统包含一些函数，可用于进一步处理和格式化消息。以下是其中一些函数的列表： -| 函数名 | 参数 | 可用于 | 用法 | -|------------------| ----------- | ------------ | ------------------------------ | -| `AppUrl` | - | 任何地方 | Gitea 的 URL | -| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | -| `AppDomain` | - | 任何地方 | Gitea 的主机名 | -| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | -| `SanitizeHTML` | string | 仅正文部分 | 通过删除其中的危险 HTML 标签对文本进行清理 | -| `SafeHTML` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于输出原始的 HTML 内容 | +| 函数名 | 参数 | 可用于 | 用法 | +| ---------------- | ----------- | ---------- | ------------------------------------------------ | +| `AppUrl` | - | 任何地方 | Gitea 的 URL | +| `AppName` | - | 任何地方 | 从 `app.ini` 中设置，通常为 "Gitea" | +| `AppDomain` | - | 任何地方 | Gitea 的主机名 | +| `EllipsisString` | string, int | 任何地方 | 将字符串截断为指定长度；根据需要添加省略号 | +| `SanitizeHTML` | string | 仅正文部分 | 通过删除其中的危险 HTML 标签对文本进行清理 | +| `SafeHTML` | string | 仅正文部分 | 将输入作为 HTML 处理；可用于输出原始的 HTML 内容 | 这些都是 _函数_，而不是元数据，因此必须按以下方式使用： ```html -像这样使用： {{SanitizeHTML "Escapetext"}} -或者这样使用： {{"Escapetext" | SanitizeHTML}} -或者这样使用： {{AppUrl}} -但不要像这样使用： {{.AppUrl}} +像这样使用： {{SanitizeHTML "Escapetext"}} 或者这样使用： {{"Escapetext" | SanitizeHTML}} 或者这样使用： {{AppUrl}} 但不要像这样使用： + {{.AppUrl}} ``` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/repo-indexer.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/repo-indexer.md index 676c60c7..4743e61b 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/repo-indexer.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/repo-indexer.md @@ -30,7 +30,7 @@ REPO_INDEXER_EXCLUDE = resources/bin/** ### 按路径选择要索引的文件 -Gitea使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 +Gitea 使用 [`gobwas/glob` 库](https://github.com/gobwas/glob) 中的 glob 模式匹配来选择要包含在索引中的文件。 限制文件列表可以防止索引被派生或无关的文件（例如 lss、sym、map 等）污染，从而使搜索结果更相关。这还有助于减小索引的大小。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/reverse-proxies.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/reverse-proxies.md index 6c833b31..138f7d58 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/reverse-proxies.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/reverse-proxies.md @@ -229,7 +229,7 @@ git.example.com { 1. 在 IIS 中设置一个空网页，比如命名为 `Gitea Proxy`。 2. 根据[微软社区中为 IIS 设置 URL 重写的指南](https://techcommunity.microsoft.com/t5/iis-support-blog/setup-iis-with-url-rewrite-as-a-reverse-proxy-for-real-world/ba-p/846222#M343)的前两步进行配置，也就是： -- 使用 Microsoft Web Platform Installer 5.1 (WebPI) 安装 Application Request Routing（简称ARR），或者在 [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing) 下载这个插件。 +- 使用 Microsoft Web Platform Installer 5.1 (WebPI) 安装 Application Request Routing（简称 ARR），或者在 [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing) 下载这个插件。 - 一但这个模块被安装到 IIS 上，你将会在 IIS 管理控制台看到一个叫做 URL Rewrite 的新图标。 - 打开 IIS 管理控制台，在左边的列表中点击 `Gitea Proxy` 网页。在中间选中并且双击 URL Rewrite 的图标来加载 URL 重写的面板。 - 在管理控制台的右边选择 `Add Rule` 操作，并且在 `Inbound and Outbound Rules` 分类中选择 `Reverse Proxy Rule`。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/search-engines-indexation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/search-engines-indexation.md index 2f91167e..0b48a1f5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/search-engines-indexation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/search-engines-indexation.md @@ -22,7 +22,7 @@ User-agent: * Disallow: / ``` -如果您将Gitea安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 +如果您将 Gitea 安装在子目录中，则需要在顶级目录中创建或编辑 `robots.txt`。 ```txt User-agent: * diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/signing.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/signing.md index e3dd8beb..e0ea3f9d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/signing.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/administration/signing.md @@ -69,7 +69,7 @@ MERGES = pubkey, twofa, basesigned, commitssigned 如果您有自己定制的 Gitea git 配置，您应该将这些配置设置在系统 git 配置文件中（例如 `/etc/gitconfig`）或者 Gitea 的内部 git 配置文件 `{[git].HOME_PATH}/.gitconfig` 中。 与 git 命令相关的主目录文件（如 `.gnupg`）也应该放在 Gitea 的 git 主目录 `[git].HOME_PATH` 中。 -如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置，否则Gitea将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 +如果您希望将 `.gnupg` 目录放在 `{[git].HOME_PATH}/` 之外的位置，请考虑设置 `$GNUPGHOME` 环境变量为您首选的位置，否则 Gitea 将会从 `{[git].HOME_PATH}/.gnupg` 查找私钥。 ::: ### `INITIAL_COMMIT` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-backend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-backend.md index 80b2b666..758e4173 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-backend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-backend.md @@ -10,40 +10,40 @@ aliases: ## 背景 -Gitea使用Golang作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 -例如，Gitea使用[Chi](https://github.com/go-chi/chi)作为基本的Web框架。[Xorm](https://xorm.io)是一个用于与数据库交互的ORM框架。 +Gitea 使用 Golang 作为后端编程语言。它使用了许多第三方包，并且自己也编写了一些包。 +例如，Gitea 使用[Chi](https://github.com/go-chi/chi)作为基本的 Web 框架。[Xorm](https://xorm.io)是一个用于与数据库交互的 ORM 框架。 因此，管理这些包非常重要。在开始编写后端代码之前，请参考以下准则。 ## 包设计准则 ### 包列表 -为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea后端分为以下几个部分： +为了保持易于理解的代码并避免循环依赖，拥有良好的代码结构是很重要的。Gitea 后端分为以下几个部分： -- `build`：帮助构建Gitea的脚本。 -- `cmd`：包含所有Gitea的实际子命令，包括web、doctor、serv、hooks、admin等。`web`将启动Web服务。`serv`和`hooks`将被Git或OpenSSH调用。其他子命令可以帮助维护Gitea。 +- `build`：帮助构建 Gitea 的脚本。 +- `cmd`：包含所有 Gitea 的实际子命令，包括 web、doctor、serv、hooks、admin 等。`web`将启动 Web 服务。`serv`和`hooks`将被 Git 或 OpenSSH 调用。其他子命令可以帮助维护 Gitea。 - `tests`：常用的测试函数 - `tests/integration`：集成测试，用于测试后端回归。 - `tests/e2e`：端到端测试，用于测试前端和后端的兼容性和视觉回归。 -- `models`：包含由xorm用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他Gitea代码的依赖关系。在某些情况下，比如日志记录时可以例外。 - - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从models/中调用。 +- `models`：包含由 xorm 用于构建数据库表的数据结构。它还包含查询和更新数据库的函数。应避免与其他 Gitea 代码的依赖关系。在某些情况下，比如日志记录时可以例外。 + - `models/db`：基本的数据库操作。所有其他`models/xxx`包都应依赖于此包。`GetEngine`函数只能从 models/中调用。 - `models/fixtures`：单元测试和集成测试中使用的示例数据。一个`yml`文件表示一个将在测试开始时加载到数据库中的表。 - - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的PR**必须**包含一个迁移步骤。 -- `modules`：在Gitea中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于models的模块，因为它们依赖于数据库。 - - `modules/setting`：存储从ini文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 - - `modules/git`：用于与`Git`命令行或Gogit包交互的包。 -- `public`：编译后的前端文件（JavaScript、图像、CSS等） -- `routers`：处理服务器请求。由于它使用其他Gitea包来处理请求，因此其他包（models、modules或services）不能依赖于routers。 - - `routers/api`：包含`/api/v1`相关路由，用于处理RESTful API请求。 + - `models/migrations`：存储不同版本之间的数据库迁移。修改数据库结构的 PR**必须**包含一个迁移步骤。 +- `modules`：在 Gitea 中处理特定功能的不同模块。工作正在进行中：其中一些模块应该移到`services`中，特别是那些依赖于 models 的模块，因为它们依赖于数据库。 + - `modules/setting`：存储从 ini 文件中读取的所有系统配置，并在各处引用。但是在可能的情况下，应将其作为函数参数使用。 + - `modules/git`：用于与`Git`命令行或 Gogit 包交互的包。 +- `public`：编译后的前端文件（JavaScript、图像、CSS 等） +- `routers`：处理服务器请求。由于它使用其他 Gitea 包来处理请求，因此其他包（models、modules 或 services）不能依赖于 routers。 + - `routers/api`：包含`/api/v1`相关路由，用于处理 RESTful API 请求。 - `routers/install`：只能在系统处于安装模式（INSTALL_LOCK=false）时响应。 - `routers/private`：仅由内部子命令调用，特别是`serv`和`hooks`。 - - `routers/web`：处理来自Web浏览器或Git SMART HTTP协议的HTTP请求。 + - `routers/web`：处理来自 Web 浏览器或 Git SMART HTTP 协议的 HTTP 请求。 - `services`：用于常见路由操作或命令执行的支持函数。使用`models`和`modules`来处理请求。 -- `templates`：用于生成HTML输出的Golang模板。 +- `templates`：用于生成 HTML 输出的 Golang 模板。 ### 包依赖关系 -由于Golang不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 +由于 Golang 不支持导入循环，我们必须仔细决定包之间的依赖关系。这些包之间有一些级别。以下是理想的包依赖关系方向。 `cmd` -> `routers` -> `services` -> `models` -> `modules` @@ -88,18 +88,18 @@ func UpdateIssue(ctx context.Context, repoID int64) error { ### 导入别名 -由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个Go文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 +由于有一些使用相同包名的包，例如`modules/user`、`models/user`和`services/user`，当这些包在一个 Go 文件中被导入时，很难知道我们使用的是哪个包以及它是变量名还是导入名。因此，我们始终建议使用导入别名。为了与常见的驼峰命名法的包变量区分开，建议使用**snake_case**作为导入别名的命名规则。 例如：`import user_service "code.gitea.io/gitea/services/user"` ### 重要注意事项 - 永远不要写成`x.Update(exemplar)`，而没有明确的`WHERE`子句： - - 这将导致表中的所有行都被使用exemplar的非零值进行更新，包括ID。 + - 这将导致表中的所有行都被使用 exemplar 的非零值进行更新，包括 ID。 - 通常应该写成`x.ID(id).Update(exemplar)`。 -- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而ID是预设的： - - 对于MSSQL变体，你将需要执行``SET IDENTITY_INSERT `table` ON``（否则迁移将失败） - - 对于PostgreSQL，你还需要更新ID序列，否则迁移将悄无声息地通过，但后续的插入将失败： - ``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)`` +- 如果在迁移过程中使用`x.Insert(exemplar)`向表中插入记录，而 ID 是预设的： + - 对于 MSSQL 变体，你将需要执行`` SET IDENTITY_INSERT `table` ON ``（否则迁移将失败） + - 对于 PostgreSQL，你还需要更新 ID 序列，否则迁移将悄无声息地通过，但后续的插入将失败： + `` SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false) `` ### 未来的任务 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-frontend.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-frontend.md index d6581343..4f347891 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-frontend.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-frontend.md @@ -16,10 +16,10 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 源文件可以在以下目录中找到： -* **CSS 样式**： `web_src/css/` -* **JavaScript 文件**： `web_src/js/` -* **Vue 组件**： `web_src/js/components/` -* **Go HTML 模板**： `templates/` +- **CSS 样式**： `web_src/css/` +- **JavaScript 文件**： `web_src/js/` +- **Vue 组件**： `web_src/js/components/` +- **Go HTML 模板**： `templates/` ## 通用准则 @@ -28,9 +28,9 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 ## Gitea 特定准则 1. 每个功能（Fomantic-UI/jQuery 模块）应放在单独的文件/目录中。 -2. HTML 的 id 和 class 应使用 kebab-case，最好包含2-3个与功能相关的关键词。 -3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含2-3个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 -4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有2-3个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 +2. HTML 的 id 和 class 应使用 kebab-case，最好包含 2-3 个与功能相关的关键词。 +3. 在 JavaScript 中使用的 HTML 的 id 和 class 应在整个项目中是唯一的，并且应包含 2-3 个与功能相关的关键词。建议在仅在 JavaScript 中使用的 class 中使用 `js-` 前缀。 +4. 不应覆盖框架提供的 class 的 CSS 样式。始终使用具有 2-3 个与功能相关的关键词的新 class 名称来覆盖框架样式。Gitea 中的帮助 CSS 类在 `helpers.less` 中。 5. 后端可以通过使用`ctx.PageData["myModuleData"] = map[]{}`将复杂数据传递给前端，但不要将整个模型暴露给前端，以避免泄露敏感数据。 6. 简单页面和与 SEO 相关的页面使用 Go HTML 模板渲染生成静态的 Fomantic-UI HTML 输出。复杂页面可以使用 Vue3。 7. 明确变量类型，优先使用`elem.disabled = true`而不是`elem.setAttribute('disabled', 'anything')`，优先使用`$el.prop('checked', var === 'yes')`而不是`$el.prop('checked', var)`。 @@ -39,11 +39,11 @@ HTML 页面由[Go HTML Template](https://pkg.go.dev/html/template)渲染。 10. 避免在一个事件监听器中混合不同的事件，优先为每个事件使用独立的事件监听器。 11. 推荐使用自定义事件名称前缀`ce-`。 12. 建议使用 Tailwind CSS，它可以通过 `tw-` 前缀获得，例如 `tw-relative`. Gitea 自身的助手类 CSS 使用 `gt-` 前缀（`gt-ellipsis`），Gitea 自身的私有框架级 CSS 类使用 `g-` 前缀（`g-modal-confirm`）。 -13. 尽量避免内联脚本和样式，建议将JS代码放入JS文件中并使用CSS类。如果内联脚本和样式不可避免，请解释无法避免的原因。 +13. 尽量避免内联脚本和样式，建议将 JS 代码放入 JS 文件中并使用 CSS 类。如果内联脚本和样式不可避免，请解释无法避免的原因。 ### 可访问性 / ARIA -在历史上，Gitea大量使用了可访问性不友好的框架 Fomantic UI。 +在历史上，Gitea 大量使用了可访问性不友好的框架 Fomantic UI。 Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`）， 但仍然存在许多问题需要大量的工作和时间来修复。 @@ -54,16 +54,16 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 推荐的实现方式： -* Vue + Vanilla JS -* Fomantic-UI（jQuery） -* htmx （部分页面重新加载其他静态组件） -* Vanilla JS +- Vue + Vanilla JS +- Fomantic-UI（jQuery） +- htmx （部分页面重新加载其他静态组件） +- Vanilla JS 不推荐的实现方式： -* Vue + Fomantic-UI（jQuery） -* jQuery + Vanilla JS -* htmx + 任何其他需要大量 JavaScript 代码或不必要的功能，如 htmx 脚本 (`hx-on`) +- Vue + Fomantic-UI（jQuery） +- jQuery + Vanilla JS +- htmx + 任何其他需要大量 JavaScript 代码或不必要的功能，如 htmx 脚本 (`hx-on`) 为了保持界面一致，Vue 组件可以使用 Fomantic-UI 的 CSS 类。 尽管不建议混合使用不同的框架， @@ -83,7 +83,7 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 如果我们想在非异步上下文中调用`async`函数， 建议使用`const _promise = asyncFoo()`来告诉读者 -这是有意为之的，我们想调用异步函数并忽略Promise。 +这是有意为之的，我们想调用异步函数并忽略 Promise。 一些 lint 规则和 IDE 也会在未处理返回的 Promise 时发出警告。 ### 获取数据 @@ -97,31 +97,41 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） 禁止使用`dataset`，它的驼峰命名行为使得搜索属性变得困难。 然而，仍然存在一些特殊情况，因此当前的准则是： -* 对于旧代码： - * 应将`$.data()`重构为`$.attr()`。 - * 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 +- 对于旧代码： -* 对于新代码： - * 不应使用`node.dataset`，而应使用`node.getAttribute`。 - * 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 + - 应将`$.data()`重构为`$.attr()`。 + - 在极少数情况下，可以使用`$.data()`将一些非字符串数据绑定到元素上，但强烈不推荐使用。 + +- 对于新代码： + - 不应使用`node.dataset`，而应使用`node.getAttribute`。 + - 不要将任何用户数据绑定到 DOM 节点上，使用合适的设计模式描述节点和数据之间的关系。 ### 显示/隐藏元素 -* 推荐在Vue组件中使用`v-if`和`v-show`来显示/隐藏元素。 -* Go 模板代码应使用 `.tw-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.tw-hidden`的注释以获取更多详细信息。 +- 推荐在 Vue 组件中使用`v-if`和`v-show`来显示/隐藏元素。 +- Go 模板代码应使用 `.tw-hidden` 和 `showElem()/hideElem()/toggleElem()` 来显示/隐藏元素，请参阅`.tw-hidden`的注释以获取更多详细信息。 ### Go HTML 模板中的样式和属性 建议使用以下方式： ```html -
+
``` 而不是： ```html -
+
``` 以使代码更易读。 @@ -134,6 +144,6 @@ Gitea 使用一些补丁使 Fomantic UI 更具可访问性（参见 `aria.md`） Gitea 现在正在使用 Vue3。我们决定不引入 JSX，以保持 HTML 代码和 JavaScript 代码分离。 -### UI示例 +### UI 示例 Gitea 使用一些自制的 UI 元素并自定义其他元素，以将它们更好地集成到通用 UI 方法中。当在开发模式（`RUN_MODE=dev`）下运行 Gitea 时，在 `http(s)://your-gitea-url:port/devtest` 下会提供一个包含一些标准化 UI 示例的页面。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-refactoring.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-refactoring.md index e0ab3e3b..6df29443 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-refactoring.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/guidelines-refactoring.md @@ -10,31 +10,31 @@ aliases: ## 背景 -自2014年2月12日编写了第一行代码以来，Gitea已经发展成为一个庞大的项目。 +自 2014 年 2 月 12 日编写了第一行代码以来，Gitea 已经发展成为一个庞大的项目。 因此，代码库变得越来越大。代码库越大，维护就越困难。 存在许多过时的机制，许多框架混合在一起，一些遗留代码可能会导致错误并阻碍新功能的开发。 -为了使代码库更易于维护，使Gitea变得更好，开发人员应牢记使用现代机制来重构旧代码。 +为了使代码库更易于维护，使 Gitea 变得更好，开发人员应牢记使用现代机制来重构旧代码。 本文档是关于重构代码库的指南集合。 ## 重构建议 -* 设计更多关于未来的内容，而不仅仅解决当前问题。 -* 减少模糊性，减少冲突，提高可维护性。 -* 描述重构，例如： - * 为什么需要重构。 - * 如何解决旧问题。 - * 重构的优点/缺点是什么。 -* 只做必要的更改，尽量保留旧逻辑。 -* 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个PR中完成。 -* 如果存在分歧，应该请TOC（技术监督委员会）参与决策。 -* 添加必要的测试以确保重构的正确性。 -* 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 +- 设计更多关于未来的内容，而不仅仅解决当前问题。 +- 减少模糊性，减少冲突，提高可维护性。 +- 描述重构，例如： + - 为什么需要重构。 + - 如何解决旧问题。 + - 重构的优点/缺点是什么。 +- 只做必要的更改，尽量保留旧逻辑。 +- 引入一些中间步骤，使重构更容易审查，完整的重构计划可以在几个 PR 中完成。 +- 如果存在分歧，应该请 TOC（技术监督委员会）参与决策。 +- 添加必要的测试以确保重构的正确性。 +- 非错误重构优先在里程碑的开始时进行，这样可以更容易地在发布之前发现问题。 ## 审查和合并建议 -* 重构的PR不应该长时间保持打开状态（通常为7天），应尽快进行审查。 -* 重构的PR应尽快合并，不应被其他PR阻塞。 -* 如果TOC没有异议，重构的PR可以在7天后由一名核心成员（非作者）批准后合并。 -* 如果最终结果良好，容忍一些不完美/临时的步骤。 -* 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 +- 重构的 PR 不应该长时间保持打开状态（通常为 7 天），应尽快进行审查。 +- 重构的 PR 应尽快合并，不应被其他 PR 阻塞。 +- 如果 TOC 没有异议，重构的 PR 可以在 7 天后由一名核心成员（非作者）批准后合并。 +- 如果最终结果良好，容忍一些不完美/临时的步骤。 +- 如果重构是必要的，容忍一些回归错误，并尽快修复错误。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/localization.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/localization.md index 29596205..e0b81a3a 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/localization.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/contributing/localization.md @@ -8,9 +8,9 @@ aliases: # 本地化 -Gitea的本地化是通过我们的[Crowdin项目](https://crowdin.com/project/gitea)进行的。 +Gitea 的本地化是通过我们的[Crowdin 项目](https://crowdin.com/project/gitea)进行的。 -对于对**英语翻译**的更改，可以发出pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 +对于对**英语翻译**的更改，可以发出 pull-request，来更改[英语语言环境](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini)中合适的关键字。 有关对**非英语**翻译的更改，请参阅上面的 Crowdin 项目。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/hacking-on-gitea.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/hacking-on-gitea.md index 0d5657a8..de93ee2d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/hacking-on-gitea.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/hacking-on-gitea.md @@ -16,7 +16,7 @@ aliases: ## 安装 Golang -您需要 [安装 go]( https://go.dev/doc/install ) 并设置您的 go 环境。 +您需要 [安装 go](https://go.dev/doc/install) 并设置您的 go 环境。 接下来，[使用 npm 安装 Node.js](https://nodejs.org/en/download/) ，这是构建 JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @minNodeVersion@ @@ -24,12 +24,12 @@ JavaScript 和 CSS 文件的必要工具。最低支持的 Node.js 版本是 @mi **注意** ：当执行需要外部工具的 make 任务时，比如 `make watch-backend`，Gitea 会自动下载并构建这些必要的组件。为了能够使用这些，你必须 -将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把go bin目录添加到可执行路径你必须手动 +将 `"$GOPATH"/bin` 目录加入到可执行路径上。如果你不把 go bin 目录添加到可执行路径你必须手动 指定可执行程序路径。 -**注意2** ：Go版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 +**注意 2** ：Go 版本 @minGoVersion@ 或更高版本是必须的。Gitea 使用 `gofmt` 来 格式化源代码。然而，`gofmt` 的结果可能因 `go` 的版本而有差异。因此推荐安装我们持续集成使用 -的 Go版本。截至上次更新，Go 版本应该是 @goVersion@。 +的 Go 版本。截至上次更新，Go 版本应该是 @goVersion@。 ## 安装 Make @@ -55,15 +55,15 @@ sudo yum install make Make 的这三个发行版都可以在 Windows 上运行： -- [单个二进制构建]( http://www.equation.com/servlet/equation.cmd?fa=make )。复制到某处并添加到 `PATH`。 +- [单个二进制构建](http://www.equation.com/servlet/equation.cmd?fa=make)。复制到某处并添加到 `PATH`。 - [32 位版本](http://www.equation.com/ftpdir/make/32/make.exe) - [64 位版本](http://www.equation.com/ftpdir/make/64/make.exe) - [MinGW-w64](https://www.mingw-w64.org) / [MSYS2](https://www.msys2.org/)。 - MSYS2 是一个工具和库的集合，为您提供一个易于使用的环境来构建、安装和运行本机 Windows 软件，它包括 MinGW-w64。 - 在 MingGW-w64 中，二进制文件称为 `mingw32-make.exe` 而不是 `make.exe`。将 `bin` 文件夹添加到 `PATH`。 - 在 MSYS2 中，您可以直接使用 `make`。请参阅 [MSYS2 移植](https://www.msys2.org/wiki/Porting/)。 - - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 _beginthread 一样。 -- [Chocolatey包管理器]( https://chocolatey.org/packages/make )。运行`choco install make` + - 要使用 CGO_ENABLED（例如：SQLite3）编译 Gitea，您可能需要使用 [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) 而不是 MSYS2 gcc，因为 MSYS2 gcc 标头缺少一些 Windows -只有 CRT 函数像 \_beginthread 一样。 +- [Chocolatey 包管理器](https://chocolatey.org/packages/make)。运行`choco install make` **注意** ：如果您尝试在 Windows 命令提示符下使用 make 进行构建，您可能会遇到问题。建议使用上述提示（Git bash 或 MinGW），但是如果您只有命令提示符（或可能是 PowerShell），则可以使用 [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) 命令，例如 `set TAGS=bindata`。 @@ -75,7 +75,7 @@ Make 的这三个发行版都可以在 Windows 上运行： git clone https://github.com/go-gitea/gitea ``` -（自从go modules出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） +（自从 go modules 出现后，不再需要构建 go 项目从 `$GOPATH` 中获取，因此不再推荐使用 `go get` 方法。） ## 派生 Gitea @@ -196,7 +196,7 @@ SVG 图标是使用 `make svg` 命令构建的，该命令将图标资源编译 ### 构建 Logo -Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 +Gitea Logo 的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 目标从单个 SVG 源文件 assets/logo.svg 构建的。要运行它，Node.js 和 npm 必须可用。 通过更新 `assets/logo.svg` 并运行 `make generate-images`，同样的过程也可用于从 SVG 源文件生成自定义 Logo PNG。忽略 gitea 编译选项将仅更新用户指定的 LOGO 文件。 @@ -205,7 +205,7 @@ Gitea Logo的 PNG 和 SVG 版本是使用 `TAGS="gitea" make generate-images` 创建新的 API 路由或修改现有的 API 路由时，您**必须** 更新和/或创建 [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/) 这些使用 [go-swagger](https://goswagger.io/) 评论的文档。 -[规范]( https://goswagger.io/use/spec.html#annotation-syntax )中描述了这些注释的结构。 +[规范](https://goswagger.io/use/spec.html#annotation-syntax)中描述了这些注释的结构。 如果您想了解更多有关 Swagger 结构的信息，可以查看 [Swagger 2.0 文档](https://swagger.io/docs/specification/2-0/basic-structure/) 或与添加新 API 端点的先前 PR 进行比较，例如 [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20) @@ -239,7 +239,7 @@ make swagger-check 并到[配置备忘单](../administration/config-cheat-sheet.md) 在 `docs/content/doc/advanced/config-cheat-sheet.zh-cn.md` 中找到 -### 更改Logo +### 更改 Logo 更改 Gitea Logo SVG 时，您将需要运行并提交结果的： @@ -291,7 +291,7 @@ TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite 我们的持续集成将测试代码是否通过了单元测试，并且所有支持的数据库都将在 Docker 环境中通过集成测试。 还将测试从几个最新版本的 Gitea 迁移。 -请在PR中附带提交适当的单元测试和集成测试。 +请在 PR 中附带提交适当的单元测试和集成测试。 ## 网站文档 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/integrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/integrations.md index 052a8734..049d0bba 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/integrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/integrations.md @@ -8,7 +8,7 @@ aliases: # 集成 -Gitea拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 +Gitea 拥有一个出色的第三方集成社区，以及在其他各种项目中的一流支持。 我们正在[awesome-gitea](https://gitea.com/gitea/awesome-gitea)上整理一个列表来跟踪这些集成！ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/migrations.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/migrations.md index b92449e6..60cad1ab 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/migrations.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/migrations.md @@ -8,24 +8,24 @@ aliases: # 迁移接口 -完整迁移功能在Gitea 1.9.0版本中引入。它定义了两个接口，用于支持从其他Git托管平台迁移存储库数据到Gitea，或者在将来将Gitea数据迁移到其他Git托管平台。 +完整迁移功能在 Gitea 1.9.0 版本中引入。它定义了两个接口，用于支持从其他 Git 托管平台迁移存储库数据到 Gitea，或者在将来将 Gitea 数据迁移到其他 Git 托管平台。 -目前已实现了从GitHub、GitLab和其他Gitea实例的迁移。 +目前已实现了从 GitHub、GitLab 和其他 Gitea 实例的迁移。 -首先，Gitea在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 +首先，Gitea 在包[modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration)中定义了一些标准对象。它们是`Repository`、`Milestone`、`Release`、`ReleaseAsset`、`Label`、`Issue`、`Comment`、`PullRequest`、`Reaction`、`Review`、`ReviewComment`。 ## 下载器接口 -要从新的Git托管平台迁移，需要进行两个步骤的更新。 +要从新的 Git 托管平台迁移，需要进行两个步骤的更新。 - 您应该实现一个`Downloader`，用于获取存储库信息。 -- 您应该实现一个`DownloaderFactory`，用于检测URL是否匹配，并创建上述的`Downloader`。 +- 您应该实现一个`DownloaderFactory`，用于检测 URL 是否匹配，并创建上述的`Downloader`。 - 您需要在`init()`中通过`RegisterDownloaderFactory`注册`DownloaderFactory`。 您可以在[downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go)中找到这些接口。 ## 上传器接口 -目前，只实现了`GiteaLocalUploader`，因此我们只能通过此Uploader将下载的数据保存到本地的Gitea实例。目前不支持其他上传器。 +目前，只实现了`GiteaLocalUploader`，因此我们只能通过此 Uploader 将下载的数据保存到本地的 Gitea 实例。目前不支持其他上传器。 您可以在[uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go)中找到这些接口。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/oauth2-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/oauth2-provider.md index da39853f..66dd333d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/oauth2-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/development/oauth2-provider.md @@ -33,40 +33,40 @@ Gitea 支持作为 OAuth2 提供者，允许第三方应用程序在用户同意 Gitea 支持以下令牌范围: -| 名称 | 介绍 | -| ---- | ----------- | -| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | -| **repo** | 完全控制所有存储库 | -|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | -|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | -| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | -|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | -|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | -| **admin:org** | 授予对组织设置的完全访问权限 | -|     **write:org** | 授予对组织设置的读/写访问权限 | -|     **read:org** | 授予对组织设置的只读访问权限 | -| **admin:public_key** | 授予公钥管理的完全访问权限 | -|     **write:public_key** | 授予对公钥的读/写访问权限 | -|     **read:public_key** | 授予对公钥的只读访问权限 | -| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | -| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | -| **notification** | 授予对通知的完全访问权限 | -| **user** | 授予对用户个人资料信息的完全访问权限 | -|     **read:user** | 授予对用户个人资料的读取权限 | -|     **user:email** | 授予对用户电子邮件地址的读取权限 | -|     **user:follow** | 授予访问权限以关注/取消关注用户 | -| **delete_repo** | 授予删除存储库的权限 | -| **package** | 授予对托管包的完全访问权限 | -|     **write:package** | 授予对包的读/写访问权限 | -|     **read:package** | 授予对包的读取权限 | -|     **delete:package** | 授予对包的删除权限 | -| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | -|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | -|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | -| **admin:application** | 授予应用程序管理的完全访问权限 | -|     **write:application** | 授予应用程序管理的读/写访问权限 | -|     **read:application** | 授予应用程序管理的读取权限 | -| **sudo** | 允许以站点管理员身份执行操作 | +| 名称 | 介绍 | +| ---------------------------------------- | --------------------------------------------------------------- | +| **(no scope)** | 授予对公共用户配置文件和公共存储库的只读访问权限 | +| **repo** | 完全控制所有存储库 | +|     **repo:status** | 授予对所有存储库中提交状态的读/写访问权限 | +|     **public_repo** | 仅授予对公共存储库的读/写访问权限 | +| **admin:repo_hook** | 授予对所有存储库的 Hooks 访问权限，该权限已包含在 `repo` 范围中 | +|     **write:repo_hook** | 授予对存储库 Hooks 的读/写访问权限 | +|     **read:repo_hook** | 授予对存储库 Hooks 的只读访问权限 | +| **admin:org** | 授予对组织设置的完全访问权限 | +|     **write:org** | 授予对组织设置的读/写访问权限 | +|     **read:org** | 授予对组织设置的只读访问权限 | +| **admin:public_key** | 授予公钥管理的完全访问权限 | +|     **write:public_key** | 授予对公钥的读/写访问权限 | +|     **read:public_key** | 授予对公钥的只读访问权限 | +| **admin:org_hook** | 授予对组织级别 Hooks 的完全访问权限 | +| **admin:user_hook** | 授予对用户级别 Hooks 的完全访问权限 | +| **notification** | 授予对通知的完全访问权限 | +| **user** | 授予对用户个人资料信息的完全访问权限 | +|     **read:user** | 授予对用户个人资料的读取权限 | +|     **user:email** | 授予对用户电子邮件地址的读取权限 | +|     **user:follow** | 授予访问权限以关注/取消关注用户 | +| **delete_repo** | 授予删除存储库的权限 | +| **package** | 授予对托管包的完全访问权限 | +|     **write:package** | 授予对包的读/写访问权限 | +|     **read:package** | 授予对包的读取权限 | +|     **delete:package** | 授予对包的删除权限 | +| **admin:gpg_key** | 授予 GPG 密钥管理的完全访问权限 | +|     **write:gpg_key** | 授予对 GPG 密钥的读/写访问权限 | +|     **read:gpg_key** | 授予对 GPG 密钥的只读访问权限 | +| **admin:application** | 授予应用程序管理的完全访问权限 | +|     **write:application** | 授予应用程序管理的读/写访问权限 | +|     **read:application** | 授予应用程序管理的读取权限 | +| **sudo** | 允许以站点管理员身份执行操作 | ## 客户端类型 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/faq.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/faq.md index 81a2d172..e99bb62f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/faq.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/faq.md @@ -12,127 +12,127 @@ aliases: 有关更多帮助资源，请查看所有[支持选项](help/support.md)。 -## 1.x和1.x.x下载之间的区别 +## 1.x 和 1.x.x 下载之间的区别 -以1.7.x版本为例。 +以 1.7.x 版本为例。 -**注意：**此示例也适用于Docker镜像！ +**注意：**此示例也适用于 Docker 镜像！ -在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个1.7目录，以及1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5和1.7.6的目录。 +在我们的[下载页面](https://dl.gitea.com/gitea/)上，您会看到一个 1.7 目录，以及 1.7.0、1.7.1、1.7.2、1.7.3、1.7.4、1.7.5 和 1.7.6 的目录。 -1.7目录和1.7.0目录是**不同**的。1.7目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 +1.7 目录和 1.7.0 目录是**不同**的。1.7 目录是在每个合并到[`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7)分支的提交上构建的。 -然而，1.7.0目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 +然而，1.7.0 目录是在创建[`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0)标签时创建的构建。 -这意味着1.x的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 +这意味着 1.x 的下载会随着提交合并到各自的分支而改变（将其视为每个版本的单独的“main”分支）。 -另一方面，1.x.x的下载应该永远不会改变。 +另一方面，1.x.x 的下载应该永远不会改变。 -## 如何从Gogs/GitHub等迁移到Gitea +## 如何从 Gogs/GitHub 等迁移到 Gitea -要从Gogs迁移到Gitea： +要从 Gogs 迁移到 Gitea： -- [Gogs版本0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) +- [Gogs 版本 0.11.46.0418](https://github.com/go-gitea/gitea/issues/4286) -要从GitHub迁移到Gitea，您可以使用Gitea内置的迁移表单。 +要从 GitHub 迁移到 Gitea，您可以使用 Gitea 内置的迁移表单。 为了迁移诸如问题、拉取请求等项目，您需要至少输入您的用户名。 [Example (requires login)](https://demo.gitea.com/repo/migrate) -要从GitLab迁移到Gitea，您可以使用这个非关联的工具： +要从 GitLab 迁移到 Gitea，您可以使用这个非关联的工具： https://github.com/loganinak/MigrateGitlabToGogs -## Gitea存储文件的位置 +## Gitea 存储文件的位置 - _`AppWorkPath`_ - `--work-path`标志 - 或者环境变量`GITEA_WORK_DIR` - 或者在构建时设置的内置值 - - 或者包含Gitea二进制文件的目录 + - 或者包含 Gitea 二进制文件的目录 - `%(APP_DATA_PATH)`（数据库、索引器等的默认路径） - `app.ini`中的`APP_DATA_PATH` - - 或者_`AppWorkPath`_`/data` + - 或者*`AppWorkPath`*`/data` - _`CustomPath`_（自定义模板） - `--custom-path`标志 - 或者环境变量`GITEA_CUSTOM` - 或者在构建时设置的内置值 - - 或者_`AppWorkPath`_`/custom` + - 或者*`AppWorkPath`*`/custom` - HomeDir - Unix：环境变量`HOME` - Windows：环境变量`USERPROFILE`，或者环境变量`HOMEDRIVE`+`HOMEPATH` - RepoRootPath - `app.ini`中\[repository]部分的`ROOT`（如果是绝对路径） - - 否则_`AppWorkPath`_`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） + - 否则*`AppWorkPath`*`/ROOT`(如果`app.ini`中\[repository]部分的`ROOT`是相对路径） - 默认值为`%(APP_DATA_PATH)/gitea-repositories` - INI（配置文件） - `--config`标志 - 或者在构建时设置的可能内置值 - 或者 _`CustomPath`_`/conf/app.ini` -- SQLite数据库 - - app.ini中database部分的PATH +- SQLite 数据库 + - app.ini 中 database 部分的 PATH - 或者`%(APP_DATA_PATH)/gitea.db` -## 看不到克隆URL或克隆URL不正确 +## 看不到克隆 URL 或克隆 URL 不正确 有几个地方可能会导致显示不正确。 1. 如果使用反向代理，请确保按照[反向代理指南](../administration/reverse-proxies.md)中的正确说明进行设置。 2. 确保在`app.ini`的`server`部分中正确设置了`ROOT_URL`。 -如果某些克隆选项未显示（HTTP/S或SSH），可以在`app.ini中` +如果某些克隆选项未显示（HTTP/S 或 SSH），可以在`app.ini中` -- `DISABLE_HTTP_GIT`: 如果设为true, 将会没有HTTP/HTTPS链接 -- `DISABLE_SSH`: 如果设为true, 将会没有SSH链接 -- `SSH_EXPOSE_ANONYMOUS`: 如果设为false, SSH链接将会对匿名用户隐藏 +- `DISABLE_HTTP_GIT`: 如果设为 true, 将会没有 HTTP/HTTPS 链接 +- `DISABLE_SSH`: 如果设为 true, 将会没有 SSH 链接 +- `SSH_EXPOSE_ANONYMOUS`: 如果设为 false, SSH 链接将会对匿名用户隐藏 ## 文件上传失败：413 Request Entity Too Large 当反向代理限制文件上传大小时，会出现此错误。 -有关使用nginx解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 +有关使用 nginx 解决此问题，请参阅[反向代理指南](../administration/reverse-proxies.md)。 ## 自定义模板无法加载或运行错误 -Gitea的自定义模板必须将其添加到正确的位置，否则Gitea将无法找到并使用自定义模板。 +Gitea 的自定义模板必须将其添加到正确的位置，否则 Gitea 将无法找到并使用自定义模板。 模板的正确路径应该相对于`CustomPath`。 1. 要找到`CustomPath`，请在站点管理 -> 配置 中查找自定义文件根路径。 - 如果找不到，请尝试`echo $GITEA_CUSTOM`。 + 如果找不到，请尝试`echo $GITEA_CUSTOM`。 2. 如果仍然找不到，默认值可以被[计算](faq.md#Gitea存储文件的位置) -3. 如果仍然找不到路径，则可以参考[自定义Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 +3. 如果仍然找不到路径，则可以参考[自定义 Gitea](../administration/customizing-gitea.md)页面，将模板添加到正确的位置。 -## Gitea是否有"GitHub/GitLab Pages"功能？ +## Gitea 是否有"GitHub/GitLab Pages"功能？ -Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供静态页面，以避免CSRF安全风险。 +Gitea 不提供内置的 Pages 服务器。您需要一个专用的域名来提供静态页面，以避免 CSRF 安全风险。 -对于简单的用法，您可以使用反向代理来重写和提供Gitea的原始文件URL中的静态内容。 +对于简单的用法，您可以使用反向代理来重写和提供 Gitea 的原始文件 URL 中的静态内容。 还有一些已经可用的第三方服务，比如独立[pages server](https://codeberg.org/Codeberg/pages-server)的或[caddy plugin](https://github.com/42wim/caddy-gitea)，可以提供所需的功能。 ## 活跃用户与禁止登录用户 -在Gitea中，"活跃用户"是指通过电子邮件激活其帐户的用户。 +在 Gitea 中，"活跃用户"是指通过电子邮件激活其帐户的用户。 -"禁止登录用户"是指不允许再登录到Gitea的用户。 +"禁止登录用户"是指不允许再登录到 Gitea 的用户。 ## 设置日志记录 - [官方文档](../administration/logging-config.md) -## 什么是Swagger？ +## 什么是 Swagger？ -[Swagger](https://swagger.io/) 是Gitea用于其API文档的工具。 +[Swagger](https://swagger.io/) 是 Gitea 用于其 API 文档的工具。 -所有Gitea实例都有内置的API，无法完全禁用它。 -但是，您可以在app.ini的api部分将ENABLE_SWAGGER设置为false，以禁用其文档显示。 -有关更多信息，请参阅Gitea的[API文档](development/api-usage.md)。 +所有 Gitea 实例都有内置的 API，无法完全禁用它。 +但是，您可以在 app.ini 的 api 部分将 ENABLE_SWAGGER 设置为 false，以禁用其文档显示。 +有关更多信息，请参阅 Gitea 的[API 文档](development/api-usage.md)。 -您可以在上查看最新的API（例如）https://gitea.com/api/swagger +您可以在上查看最新的 API（例如）https://gitea.com/api/swagger 您还可以在上查看`swagger.json`文件的示例 https://gitea.com/swagger.v1.json @@ -143,7 +143,7 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 有多种方法可以组合使用来防止垃圾邮件发送者： 1. 通过设置电子邮件域名的白名单或黑名单。 -2. 通过设置一些域名或者OpenID白名单（见下文）。 +2. 通过设置一些域名或者 OpenID 白名单（见下文）。 3. 在您的`app.ini`中将`ENABLE_CAPTCHA`设置为`true`，并正确配置`RECAPTCHA_SECRET`和 `RECAPTCHA_SITEKEY`。 4. 将`DISABLE_REGISTRATION`设置为`true`，并通过 [CLI](../administration/command-line.md)、[API](development/api-usage.md) 或 Gitea 的管理界面创建新用户。 @@ -173,13 +173,13 @@ Gitea不提供内置的Pages服务器。您需要一个专用的域名来提供 使用 [Fail2Ban](../administration/fail2ban-setup.md) 监视并阻止基于日志模式的自动登录尝试或其他恶意行为。 -## SSHD vs 内建SSH +## SSHD vs 内建 SSH -SSHD是大多数Unix系统上内建的SSH服务器。 +SSHD 是大多数 Unix 系统上内建的 SSH 服务器。 -Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 +Gitea 还提供了自己的 SSH 服务器，用于在 SSHD 不可用时使用。 -## Gitea运行缓慢 +## Gitea 运行缓慢 导致此问题的最常见原因是加载联合头像。 @@ -189,21 +189,21 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 ## 无法创建仓库/文件 -请确保Gitea具有足够的权限来写入其主目录和数据目录。 +请确保 Gitea 具有足够的权限来写入其主目录和数据目录。 参见[AppDataPath 和 RepoRootPath](faq.md#Gitea存储文件的位置) -**适用于Arch用户的注意事项：**在撰写本文时，Arch软件包的systemd文件包含了以下行： +**适用于 Arch 用户的注意事项：**在撰写本文时，Arch 软件包的 systemd 文件包含了以下行： `ReadWritePaths=/etc/gitea/app.ini` -这将使得Gitea无法写入其他路径。 +这将使得 Gitea 无法写入其他路径。 ## 翻译不正确/如何添加更多翻译 -我们当前的翻译是在我们的[Crowdin项目](https://crowdin.com/project/gitea)上众包进行的 +我们当前的翻译是在我们的[Crowdin 项目](https://crowdin.com/project/gitea)上众包进行的 -无论您想要更改翻译还是添加新的翻译，都需要在Crowdin集成中进行，因为所有翻译都会被CI覆盖。 +无论您想要更改翻译还是添加新的翻译，都需要在 Crowdin 集成中进行，因为所有翻译都会被 CI 覆盖。 ## 推送钩子/ Webhook / Actions 未运行 @@ -211,15 +211,15 @@ Gitea还提供了自己的SSH服务器，用于在SSHD不可用时使用。 这可能是由于以下原因： -1. Git钩子不同步：在站点管理面板上运行“重新同步所有仓库的pre-receive、update和post-receive钩子” -2. Git仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由NAS挂载），请确保文件系统支持`chmod a+x any-script` -3. 如果您使用的是Docker，请确保Docker Server（而不是客户端）的版本 >= 20.10.6 +1. Git 钩子不同步：在站点管理面板上运行“重新同步所有仓库的 pre-receive、update 和 post-receive 钩子” +2. Git 仓库（和钩子）存储在一些不支持脚本执行的文件系统上（例如由 NAS 挂载），请确保文件系统支持`chmod a+x any-script` +3. 如果您使用的是 Docker，请确保 Docker Server（而不是客户端）的版本 >= 20.10.6 -## SSH问题 +## SSH 问题 如果无法通过`ssh`访问仓库，但`https`正常工作，请考虑以下情况。 -首先，请确保您可以通过SSH访问Gitea。 +首先，请确保您可以通过 SSH 访问 Gitea。 `ssh git@myremote.example` @@ -247,16 +247,18 @@ fatal: Could not read from remote repository. - 在客户端： - 确保公钥和私钥已添加到正确的 Gitea 用户。 - - 确保远程 URL 中没有任何问题。特别是，请确保∂ - Git 用户（@ 之前的部分）的名称拼写正确。 + - 确保远程 URL 中没有任何问题。特别是，请确保 ∂ + Git 用户（@ 之前的部分）的名称拼写正确。 - 确保客户端机器上的公钥和私钥正确无误。 - 在服务器上： + - 确保存储库存在并且命名正确。 - 检查系统用户主目录中的 `.ssh` 目录的权限。 - 验证正确的公钥是否已添加到 `.ssh/authorized_keys` 中。 尝试在 Gitea 管理面板上运行 `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)`。 + - 查看 Gitea 日志。 - 查看 /var/log/auth（或类似的文件）。 - 检查存储库的权限。 @@ -328,7 +330,9 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 - 使用[管理 CLI 命令](../administration/command-line.md#admin)。 请注意，大多数命令还需要一个[全局标志](../administration/command-line.md#全局选项)来指向正确的配置。 + - 作为**用户**，您可以更改密码... + - 在您的账户的`设置 -> 账户`页面（此方法**需要**您知道当前密码）。 - 使用`忘记密码`链接。 @@ -338,7 +342,7 @@ Gitea 提供了一个子命令`gitea migrate`来初始化数据库，然后您 在 Gitea 版本 `1.11` 中，我们转换为使用[goldmark](https://github.com/yuin/goldmark)进行 Markdown 渲染，它符合[CommonMark](https://commonmark.org/)标准。 -如果您在版本`1.11`之前的Markdown正常工作，但在升级后无法正常工作，请仔细阅读CommonMark规范，看看问题是由错误还是非兼容的语法引起的。 +如果您在版本`1.11`之前的 Markdown 正常工作，但在升级后无法正常工作，请仔细阅读 CommonMark 规范，看看问题是由错误还是非兼容的语法引起的。 如果是后者，通常规范中会列出一种符合标准的替代方法。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/support.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/support.md index 1e291061..b191f7c6 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/support.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/help/support.md @@ -58,12 +58,12 @@ Gitea 可以使用 Golang 的 pprof 处理程序和工具链来收集堆栈跟 1. 设置 app.ini： - ``` - [server] - ENABLE_PPROF = true - ``` + ``` + [server] + ENABLE_PPROF = true + ``` 2. 重新启动 Gitea -3. 尝试触发bug，当请求卡住一段时间，使用或浏览器访问：获取堆栈跟踪。 -`curl http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` +3. 尝试触发 bug，当请求卡住一段时间，使用或浏览器访问：获取堆栈跟踪。 + `curl http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/comparison.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/comparison.md index ae9ca785..68d6c795 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/comparison.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/comparison.md @@ -14,68 +14,68 @@ aliases: _表格中的符号含义:_ -* _✓ - 支持_ +- _✓ - 支持_ -* _⁄ - 部分支持_ +- _⁄ - 部分支持_ -* _✘ - 不支持_ +- _✘ - 不支持_ -* _⚙️ - 由第三方服务或插件支持_ +- _⚙️ - 由第三方服务或插件支持_ #### 主要特性 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------- | -------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | -| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | -| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | -| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | -| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | -| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | -| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | -| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | -| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | -| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | -| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | -| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | -| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | -| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | -| Markdown绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| Markdown数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | -------------- | ------------ | +| 开源免费 | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | +| 低资源开销 (RAM/CPU) | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | +| 支持多种数据库 | ✓ | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | +| 支持多种操作系统 | ✓ | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | +| 升级简便 | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 可观测性 | **✘** | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | +| WebAuthn (2FA) | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ? | +| 扩展 API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 内置软件包/容器注册中心 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 同步提交到外部仓库 (push mirror) | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 同步外部仓库的提交 (pull mirror) | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ? | +| 浅色和深色主题 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ? | +| 自定义主题支持 | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | +| 支持 Markdown | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | +| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | +| 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| RSS Feeds | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ✘ | +| 内置 CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 子组织：组织内的组织 | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✘ | ✓ | ✓ | ✘ | ✓ | +| 多实例交互 | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | +| Markdown 绘图 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Markdown 数学公式 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | #### 代码管理 -| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | -| ------------------------------------ | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | -| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | -| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | -| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | -| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | -| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | -| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | -| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | -| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | +| 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | +| -------------------- | --------------------------------------------------- | ---- | --------- | --------- | --------- | --------- | ------------ | +| 仓库主题描述 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 仓库内代码搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 全局代码搜索 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✓ | +| Git LFS 2.0 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 组织里程碑 | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 细粒度用户角色 | ✓ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | +| 提交人的身份验证 | ⁄ | ✘ | ? | ✓ | ✓ | ✓ | ✘ | +| GPG 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| SSH 签名的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ? | ? | +| 拒绝未通过验证的提交 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 外部仓库迁移 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 仓库活跃度页面 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 分支管理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 建立新分支 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 在线代码编辑 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 提交的统计图表 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | +| 模板仓库 | ✓ | ✘ | ✓ | ✘ | ✓ | ✓ | ✘ | +| Git Blame | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | +| 可视化镜像变化 | ✓ | ✘ | ✓ | ? | ? | ? | ? | #### 工单管理 @@ -93,7 +93,7 @@ _表格中的符号含义:_ | 工单批处理 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单看板 | [✓](https://github.com/go-gitea/gitea/pull/8346) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 从工单创建分支 | ✘ | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | -| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 从评论创建工单 | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | 工单搜索 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单全局搜索 | [✘](https://github.com/go-gitea/gitea/issues/2434) | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 工单依赖关系 | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | @@ -115,7 +115,7 @@ _表格中的符号含义:_ | Pull/Merge requests 模板 | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | | 查看 Cherry-picking 的更改 | [✓](https://github.com/go-gitea/gitea/issues/5158) | ✘ | ✘ | ✓ | ✓ | ✘ | ✘ | | 下载 Patch | ✓ | ✘ | ✓ | ✓ | ✓ | [/](https://jira.atlassian.com/plugins/servlet/mobile#issue/BCLOUD-8323) | ✘ | -| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | +| Merge queues | ✘ | ✘ | ✓ | ✘ | ✓ | ✘ | ✘ | #### 第三方集成 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/database-preparation.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/database-preparation.md index 2cee91be..4c76c21f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/database-preparation.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/database-preparation.md @@ -20,153 +20,153 @@ aliases: 1. 对于远程数据库设置，您需要让 MySQL 监听您的 IP 地址。编辑数据库实例上的 `/etc/mysql/my.cnf` 文件中的 `bind-address` 选项为： - ```ini - bind-address = 203.0.113.3 - ``` + ```ini + bind-address = 203.0.113.3 + ``` 2. 在数据库实例上，使用 `root` 用户登录到数据库控制台： - ``` - mysql -u root -p - ``` + ``` + mysql -u root -p + ``` - 按提示输入密码。 + 按提示输入密码。 3. 创建一个将被 Gitea 使用的数据库用户，并使用密码进行身份验证。以下示例中使用了 `'gitea'` 作为密码。请为您的实例使用一个安全密码。 - 对于本地数据库： + 对于本地数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea' IDENTIFIED BY 'gitea'; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - SET old_passwords=0; - CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; - ``` + ```sql + SET old_passwords=0; + CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea'; + ``` - 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 + 其中 `192.0.2.10` 是您的 Gitea 实例的 IP 地址。 - 根据需要替换上述用户名和密码。 + 根据需要替换上述用户名和密码。 4. 使用 UTF-8 字符集和大小写敏感的排序规则创建数据库。 - `utf8mb4_bin` 是 MySQL/MariaDB 的通用排序规则。 - Gitea 启动后会尝试把数据库修改为更合适的字符集 (`utf8mb4_0900_as_cs` 或者 `uca1400_as_cs`) 并在可能的情况下更改数据库。 - 如果你想指定自己的字符集规则，可以在 `app.ini` 中设置 `[database].CHARSET_COLLATION`。 + `utf8mb4_bin` 是 MySQL/MariaDB 的通用排序规则。 + Gitea 启动后会尝试把数据库修改为更合适的字符集 (`utf8mb4_0900_as_cs` 或者 `uca1400_as_cs`) 并在可能的情况下更改数据库。 + 如果你想指定自己的字符集规则，可以在 `app.ini` 中设置 `[database].CHARSET_COLLATION`。 - ```sql - CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin'; - ``` + ```sql + CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 5. 将数据库上的所有权限授予上述创建的数据库用户。 - 对于本地数据库： + 对于本地数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'; + FLUSH PRIVILEGES; + ``` - 对于远程数据库： + 对于远程数据库： - ```sql - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; - FLUSH PRIVILEGES; - ``` + ```sql + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10'; + FLUSH PRIVILEGES; + ``` 6. 通过 `exit` 退出数据库控制台。 7. 在您的 Gitea 服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h 203.0.113.3 -p giteadb - ``` + ``` + mysql -u gitea -h 203.0.113.3 -p giteadb + ``` - 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 `-h` 选项。 + 其中 `gitea` 是数据库用户名，`giteadb` 是数据库名称，`203.0.113.3` 是数据库实例的 IP 地址。对于本地数据库，省略 `-h` 选项。 - 到此您应该能够连接到数据库了。 + 到此您应该能够连接到数据库了。 ## PostgreSQL 1. 对于远程数据库设置，通过编辑数据库实例上的 postgresql.conf 文件中的 `listen_addresses` 将 `PostgreSQL` 配置为监听您的 IP 地址： - ```ini - listen_addresses = 'localhost, 203.0.113.3' - ``` + ```ini + listen_addresses = 'localhost, 203.0.113.3' + ``` 2. PostgreSQL 默认使用 `md5` 质询-响应加密方案进行密码身份验证。现在这个方案不再被认为是安全的。改用 SCRAM-SHA-256 方案，通过编辑数据库服务器上的` postgresql.conf` 配置文件： - ```ini - password_encryption = scram-sha-256 - ``` + ```ini + password_encryption = scram-sha-256 + ``` - 重启 PostgreSQL 以应用该设置。 + 重启 PostgreSQL 以应用该设置。 3. 在数据库服务器上，以超级用户身份登录到数据库控制台： - ``` - su -c "psql" - postgres - ``` + ``` + su -c "psql" - postgres + ``` 4. 创建具有登录权限和密码的数据库用户（在 PostgreSQL 术语中称为角色）。请使用安全的、强密码，而不是下面的 `'gitea'`： - ```sql - CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; - ``` + ```sql + CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea'; + ``` - 根据需要替换用户名和密码。 + 根据需要替换用户名和密码。 5. 使用 UTF-8 字符集创建数据库，并由之前创建的数据库用户拥有。可以根据预期内容使用任何 `libc` 排序规则，使用 `LC_COLLATE` 和 `LC_CTYPE` 参数指定： - ```sql - CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; - ``` + ```sql + CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8'; + ``` - 根据需要替换数据库名称。 + 根据需要替换数据库名称。 6. 通过将以下身份验证规则添加到 `pg_hba.conf`，允许数据库用户访问上面创建的数据库。 - 对于本地数据库： + 对于本地数据库： - ```ini - local giteadb gitea scram-sha-256 - ``` + ```ini + local giteadb gitea scram-sha-256 + ``` - 对于远程数据库： + 对于远程数据库： - ```ini - host giteadb gitea 192.0.2.10/32 scram-sha-256 - ``` + ```ini + host giteadb gitea 192.0.2.10/32 scram-sha-256 + ``` - 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 + 根据您自己的数据库名称、用户和 Gitea 实例的 IP 地址进行替换。 - 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 + 注意：`pg_hba.conf` 上的规则按顺序评估，也就是第一个匹配的规则将用于身份验证。您的 PostgreSQL 安装可能附带了适用于所有用户和数据库的通用身份验证规则。如果是这种情况，您可能需要将此处提供的规则放置在此类通用规则之上。 - 重启 PostgreSQL 以应用新的身份验证规则。 + 重启 PostgreSQL 以应用新的身份验证规则。 7. 在您的 Gitea 服务器上，测试与数据库的连接。 - 对于本地数据库： + 对于本地数据库： - ``` - psql -U gitea -d giteadb - ``` + ``` + psql -U gitea -d giteadb + ``` - 对于远程数据库： + 对于远程数据库： - ``` - psql "postgres://gitea@203.0.113.3/giteadb" - ``` + ``` + psql "postgres://gitea@203.0.113.3/giteadb" + ``` - 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 + 其中 `gitea` 是数据库用户，`giteadb` 是数据库名称，`203.0.113.3` 是您的数据库实例的 IP 地址。 - 您应该会被提示输入数据库用户的密码，并连接到数据库。 + 您应该会被提示输入数据库用户的密码，并连接到数据库。 ## 使用 TLS 进行数据库连接 @@ -185,116 +185,116 @@ Gitea 使用的 PostgreSQL 驱动程序支持双向 TLS。在双向 TLS 中， 1. 在数据库实例所在的服务器上，放置以下凭据： - - `/path/to/postgresql.crt`: 数据库实例证书 - - `/path/to/postgresql.key`: 数据库实例私钥 - - `/path/to/root.crt`: 用于验证客户端证书的CA证书链 + - `/path/to/postgresql.crt`: 数据库实例证书 + - `/path/to/postgresql.key`: 数据库实例私钥 + - `/path/to/root.crt`: 用于验证客户端证书的 CA 证书链 2. 在 `postgresql.conf` 中添加以下选项： - ```ini - ssl = on - ssl_ca_file = '/path/to/root.crt' - ssl_cert_file = '/path/to/postgresql.crt' - ssl_key_file = '/path/to/postgresql.key' - ssl_min_protocol_version = 'TLSv1.2' - ``` + ```ini + ssl = on + ssl_ca_file = '/path/to/root.crt' + ssl_cert_file = '/path/to/postgresql.crt' + ssl_key_file = '/path/to/postgresql.key' + ssl_min_protocol_version = 'TLSv1.2' + ``` 3. 根据 PostgreSQL 的要求，调整凭据的所有权和权限： - ``` - chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key - ``` + ``` + chown postgres:postgres /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + chmod 0600 /path/to/root.crt /path/to/postgresql.crt /path/to/postgresql.key + ``` -4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过SSL连接，并要求客户端证书验证。 +4. 编辑 `pg_hba.conf` 规则，仅允许 Gitea 数据库用户通过 SSL 连接，并要求客户端证书验证。 - 对于PostgreSQL 12： + 对于 PostgreSQL 12： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full + ``` - 对于PostgreSQL 11及更早版本： + 对于 PostgreSQL 11 及更早版本： - ```ini - hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 - ``` + ```ini + hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1 + ``` - 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 + 根据需要替换数据库名称、用户和 Gitea 实例的 IP 地址。 5. 重新启动 PostgreSQL 以应用上述配置。 6. 在运行 Gitea 实例的服务器上，将以下凭据放置在运行 Gitea 的用户的主目录下（例如 `git`）： - - `~/.postgresql/postgresql.crt`: 数据库客户端证书 - - `~/.postgresql/postgresql.key`: 数据库客户端私钥 - - `~/.postgresql/root.crt`: 用于验证服务器证书的CA证书链 + - `~/.postgresql/postgresql.crt`: 数据库客户端证书 + - `~/.postgresql/postgresql.key`: 数据库客户端私钥 + - `~/.postgresql/root.crt`: 用于验证服务器证书的 CA 证书链 - 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 + 注意：上述文件名在 PostgreSQL 中是硬编码的，无法更改。 7. 根据需要调整凭据、所有权和权限： - ``` - chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt - ``` + ``` + chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt + ``` 8. 测试与数据库的连接： - ``` - psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" - ``` + ``` + psql "postgres://gitea@example.db/giteadb?sslmode=verify-full" + ``` - 您将被提示输入数据库用户的密码，然后连接到数据库。 + 您将被提示输入数据库用户的密码，然后连接到数据库。 ### MySQL/MariaDB TLS -虽然 Gitea 使用的MySQL驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 +虽然 Gitea 使用的 MySQL 驱动程序也支持双向 TLS，但目前 Gitea 仅支持单向 TLS。有关详细信息，请参见工单＃10828。 -在单向TLS中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 +在单向 TLS 中，数据库客户端在连接握手期间验证服务器发送的证书，而服务器则假定连接的客户端是合法的，因为不进行客户端证书验证。 1. 在数据库实例上放置以下凭据： - - `/path/to/mysql.crt`: 数据库实例证书 - - `/path/to/mysql.key`: 数据库实例密钥 - - `/path/to/ca.crt`: CA证书链。在单向TLS中不使用此文件，但用于验证双向TLS中的客户端证书。 + - `/path/to/mysql.crt`: 数据库实例证书 + - `/path/to/mysql.key`: 数据库实例密钥 + - `/path/to/ca.crt`: CA 证书链。在单向 TLS 中不使用此文件，但用于验证双向 TLS 中的客户端证书。 2. 将以下选项添加到 `my.cnf`： - ```ini - [mysqld] - ssl-ca = /path/to/ca.crt - ssl-cert = /path/to/mysql.crt - ssl-key = /path/to/mysql.key - tls-version = TLSv1.2,TLSv1.3 - ``` + ```ini + [mysqld] + ssl-ca = /path/to/ca.crt + ssl-cert = /path/to/mysql.crt + ssl-key = /path/to/mysql.key + tls-version = TLSv1.2,TLSv1.3 + ``` 3. 调整凭据的所有权和权限： - ``` - chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key - ``` + ``` + chown mysql:mysql /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + chmod 0600 /path/to/ca.crt /path/to/mysql.crt /path/to/mysql.key + ``` -4. 重新启动MySQL以应用设置。 +4. 重新启动 MySQL 以应用设置。 5. Gitea 的数据库用户可能已经创建过，但只会对运行 Gitea 的服务器的 IP 地址进行身份验证。要对其域名进行身份验证，请重新创建用户，并设置其需要通过 TLS 连接到数据库： - ```sql - DROP USER 'gitea'@'192.0.2.10'; - CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; - GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; - FLUSH PRIVILEGES; - ``` + ```sql + DROP USER 'gitea'@'192.0.2.10'; + CREATE USER 'gitea'@'example.gitea' IDENTIFIED BY 'gitea' REQUIRE SSL; + GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'example.gitea'; + FLUSH PRIVILEGES; + ``` - 根据需要替换数据库用户名、密码和 Gitea 实例域名。 + 根据需要替换数据库用户名、密码和 Gitea 实例域名。 -6. 确保用于验证数据库服务器证书的CA证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 +6. 确保用于验证数据库服务器证书的 CA 证书链位于数据库和 Gitea 服务器的系统证书存储中。请参考系统文档中有关将 CA 证书添加到证书存储的说明。 -7. 在运行Gitea的服务器上，测试与数据库的连接： +7. 在运行 Gitea 的服务器上，测试与数据库的连接： - ``` - mysql -u gitea -h example.db -p --ssl - ``` + ``` + mysql -u gitea -h example.db -p --ssl + ``` - 至此应该成功连接到数据库了。 + 至此应该成功连接到数据库了。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-binary.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-binary.md index f16d687d..f940b094 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-binary.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-binary.md @@ -35,7 +35,7 @@ chmod +x gitea ## 验证 GPG 签名 -Gitea 对打包的二进制文件使用 [GPG密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 +Gitea 对打包的二进制文件使用 [GPG 密钥](https://keys.openpgp.org/search?q=teabot%40gitea.io) 签名以防止篡改。 请根据对应文件名 `.asc` 中包含的校验码检验文件的一致性。 ```sh @@ -166,7 +166,7 @@ GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini **提示：** 我们不建议使用 SIGKILL 信号（`-9`），这会强制停止 Gitea 程序，但不会正确关闭队列、索引器等任务。 -请参阅下面的疑难解答说明，以在Gitea版本更新后修复损坏的仓库。 +请参阅下面的疑难解答说明，以在 Gitea 版本更新后修复损坏的仓库。 ## 排查故障 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-source.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-source.md index 8e51c540..a05edd39 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-source.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/from-source.md @@ -8,7 +8,7 @@ aliases: # 使用源代码安装 -你需要 [安装Go](https://golang.google.cn/doc/install) 并正确设置Go环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 +你需要 [安装 Go](https://golang.google.cn/doc/install) 并正确设置 Go 环境。特别的，建议设置`$GOPATH`环境变量，并将 Go 的二进制目录或目录`${GOPATH//://bin:}/bin`添加到`$PATH`中。请参阅 Go 百科上关于 [GOPATH](https://github.com/golang/go/wiki/GOPATH) 的词条。 接下来，[安装 Node.js 和 npm](https://nodejs.org/zh-cn/download/)， 这是构建 JavaScript 和 CSS 文件所需的。最低支持的 Node.js 版本是 @minNodeVersion@，建议使用最新的 LTS 版本。 @@ -33,7 +33,7 @@ git branch -a git checkout @sourceBranch@ ``` -要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID是 `2663 `）： +要验证一个拉取请求（Pull Request, PR），要先启用新的分支（其中 `xyz` 是 PR 的 ID；例如，对于 [#2663](https://github.com/go-gitea/gitea/pull/2663)，ID 是 `2663 `）： ```bash git fetch origin pull/xyz/head:pr-xyz @@ -55,7 +55,7 @@ git checkout @sourceVersion@ # or git checkout pr-xyz - `node` @minNodeVersion@ 或更高版本，并且安装 `npm`, 请参阅 [这里](https://nodejs.org/zh-cn/download/) - `make`, 请参阅 [这里](development/hacking-on-gitea.md) -为了尽可能简化编译过程，提供了各种 [make任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 +为了尽可能简化编译过程，提供了各种 [make 任务](https://github.com/go-gitea/gitea/blob/main/Makefile)。 根据你的构建需求，以下 tags 可以使用： @@ -103,7 +103,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite 尽管在开发时这些值很有用，但可能与下游用户的偏好冲突。 -一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行Gitea之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： +一种选择是使用脚本文件来隐藏`gitea`二进制文件，并在运行 Gitea 之前创建适当的环境。然而，在构建时，可以使用`make`的`LDFLAGS`环境变量来更改这些默认值。适当的设置如下： - 要设置`CustomPath`，请使用`LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.CustomPath=custom-path\""` - 对于`CustomConf`，应该使用`-X \"code.gitea.io/gitea/modules/setting.CustomConf=conf.ini\"` @@ -119,7 +119,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite `go`编译器工具链支持将代码交叉编译到不同的目标架构上。请参考[`GOOS`和`GOARCH`环境变量](https://go.dev/doc/install/source#environment) 以获取支持的目标列表。如果您想为性能较弱的系统（如树莓派）构建 Gitea，交叉编译非常有用。 -要使用构建标签（`TAGS`）进行交叉编译Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 +要使用构建标签（`TAGS`）进行交叉编译 Gitea，您还需要一个 C 交叉编译器，该编译器的目标架构与`GOOS`和`GOARCH`变量选择的架构相同。例如，要为 Linux ARM64（`GOOS=linux`和`GOARCH=arm64`）进行交叉编译，您需要`aarch64-unknown-linux-gnu-gcc`交叉编译器。这是因为 Gitea 构建标签使用了`cgo`的外部函数接口（FFI）。 在没有任何标签的情况下，交叉编译的 Gitea 为 Linux ARM64 版本： @@ -127,7 +127,7 @@ Gitea 将从`CustomPath`中查找许多信息。默认的，这会在运行 Gite GOOS=linux GOARCH=arm64 make build ``` -要交叉编译 Linux ARM64 下的Gitea，这是推荐的构建标签： +要交叉编译 Linux ARM64 下的 Gitea，这是推荐的构建标签： ``` CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sqlite_unlock_notify" make build @@ -213,6 +213,6 @@ make build 默认情况下，gitea 会为前端文件生成精简的 Source Map 以节省空间。 这可以通过“ENABLE_SOURCEMAP”环境变量进行控制： -- `ENABLE_SOURCEMAP=true` 生成所有Source Map，这是开发版本的默认设置 -- `ENABLE_SOURCEMAP=reduced` 生成有限的Source Map，这是生产版本的默认设置 -- `ENABLE_SOURCEMAP=false` 不生成Source Map +- `ENABLE_SOURCEMAP=true` 生成所有 Source Map，这是开发版本的默认设置 +- `ENABLE_SOURCEMAP=reduced` 生成有限的 Source Map，这是生产版本的默认设置 +- `ENABLE_SOURCEMAP=false` 不生成 Source Map diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-cloud-provider.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-cloud-provider.md index 35499877..2cd15123 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-cloud-provider.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-cloud-provider.md @@ -15,9 +15,9 @@ Cloudron 使得在您的服务器上运行 Gitea，并保持其更新和安全 [![Install](/cloudron.svg)](https://cloudron.io/button.html?app=io.gitea.cloudronapp) -Gitea软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). +Gitea 软件包的维护地址在[这里](https://git.cloudron.io/cloudron/gitea-app). -这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行Gitea。 +这里有一个[demo 实例](https://my.demo.cloudron.io) (用户名: cloudron 密码: cloudron) 您可以在其中尝试运行 Gitea。 ## Linode diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-kubernetes.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-kubernetes.md index ddc3d68a..b127e830 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-kubernetes.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/on-kubernetes.md @@ -35,15 +35,15 @@ helm install gitea -f values.yaml gitea/gitea Gitea 附带了一个运行状况检查接口 `/api/healthz`，你可以像这样在 Kubernetes 中配置它： ```yaml - livenessProbe: - httpGet: - path: /api/healthz - port: http - initialDelaySeconds: 200 - timeoutSeconds: 5 - periodSeconds: 10 - successThreshold: 1 - failureThreshold: 10 +livenessProbe: + httpGet: + path: /api/healthz + port: http + initialDelaySeconds: 200 + timeoutSeconds: 5 + periodSeconds: 10 + successThreshold: 1 + failureThreshold: 10 ``` 成功的运行状况检查响应代码为 HTTP `200`，下面是示例： diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/windows-service.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/windows-service.md index c066d40c..d991cb77 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/windows-service.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/windows-service.md @@ -6,7 +6,7 @@ aliases: - /zh-cn/windows-service --- -# 注册为Windows服务 +# 注册为 Windows 服务 ## 准备工作 @@ -29,9 +29,9 @@ COMPUTERNAME 是从命令行中运行 `echo %COMPUTERNAME%` 后得到的响应 PATH = c:/gitea/data/gitea.db ``` -## 注册为Windows服务 +## 注册为 Windows 服务 -要注册为Windows服务，首先以Administrator身份运行 `cmd`，然后执行以下命令： +要注册为 Windows 服务，首先以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \"C:\gitea\custom\conf\app.ini\"" @@ -39,7 +39,7 @@ sc.exe create gitea start= auto binPath= "\"C:\gitea\gitea.exe\" web --config \" 别忘了将 `C:\gitea` 替换成你的 Gitea 安装目录。 -之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000是默认端口）。 +之后在控制面板打开 "Windows Services"，搜索 "gitea"，右键选择 "Run"。在浏览器打开 `http://localhost:3000` 就可以访问了。（如果你修改了端口，请访问对应的端口，3000 是默认端口）。 ### 服务启动类型 @@ -60,9 +60,9 @@ sc.exe config gitea depend= mariadb 这将确保在 Windows 计算机重新启动时，将延迟自动启动 Gitea，直到数据库准备就绪，从而减少启动失败的情况。 -## 从Windows服务中删除 +## 从 Windows 服务中删除 -以Administrator身份运行 `cmd`，然后执行以下命令： +以 Administrator 身份运行 `cmd`，然后执行以下命令： ``` sc.exe delete gitea diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker-rootless.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker-rootless.md index 1dcd2d6b..be04d7e4 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker-rootless.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker-rootless.md @@ -45,7 +45,7 @@ services: - "2222:2222" ``` -请注意，卷应由在配置文件中指定的UID/GID的用户/组所有。默认情况下，Docker中的Gitea将使用uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： +请注意，卷应由在配置文件中指定的 UID/GID 的用户/组所有。默认情况下，Docker 中的 Gitea 将使用 uid:1000 gid:1000。如果需要，您可以使用以下命令设置这些文件夹的所有权： ```sh sudo chown 1000:1000 config/ data/ @@ -53,11 +53,11 @@ sudo chown 1000:1000 config/ data/ > 如果未为卷设置正确的权限，容器可能无法启动。 -对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 +对于稳定版本，您可以使用 `:latest-rootless`、`:1-rootless`，或指定特定的版本，如: `@dockerVersion@-rootless`。如果您想使用最新的开发版本，则可以使用 `:dev-rootless` 标签。如果您想运行发布分支的最新提交，可以使用 `:1.x-dev-rootless` 标签，其中 x 是 Gitea 的次要版本号（例如:`1.16-dev-rootless`）。 ## 自定义端口 -要将集成的SSH和Web服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 +要将集成的 SSH 和 Web 服务器绑定到不同的端口，请调整端口部分。通常只需更改主机端口并保持容器内的端口不变。 ```diff version: "2" @@ -258,7 +258,7 @@ docker-compose up -d 除了上述的环境变量外，`app.ini` 中的任何设置都可以通过形式为 `GITEA__SECTION_NAME__KEY_NAME` 的环境变量进行设置或覆盖。这些设置在每次 Docker 容器启动时都会生效。完整信息请参考[这里](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini). -这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA__mailer__FROM、GITEA__mailer__HOST、GITEA__mailer__PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： +这些环境变量可以在 `docker-compose.yml` 中传递给 Docker 容器。以下示例将启用 SMTP 邮件服务器，如果主机上设置了所需的环境变量 GITEA**mailer**FROM、GITEA**mailer**HOST、GITEA**mailer**PASSWD，或者在与 `docker-compose.yml` 相同目录中的 `.env` 文件中设置了这些环境变量： ```bash ... diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker.md index 7a409489..0cceeca8 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/installation/with-docker.md @@ -296,7 +296,7 @@ docker run -it --rm docker.gitea.com/gitea:1 gitea generate secret INTERNAL_TOKE ``` ```yaml -... +--- services: server: environment: diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/clone-filter.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/clone-filter.md index f14b0375..90b6709c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/clone-filter.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/clone-filter.md @@ -5,7 +5,6 @@ slug: "clone-filters" sidebar_position: 25 aliases: - /zh-cn/clone-filters - --- # 克隆过滤器 (部分克隆) diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/incoming-email.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/incoming-email.md index 4ae55422..c91d1ae9 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/incoming-email.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/incoming-email.md @@ -5,7 +5,6 @@ slug: "incoming-email" sidebar_position: 13 aliases: - /zh-cn/incoming-email - --- # 邮件接收 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/issue-pull-request-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/issue-pull-request-templates.md index 7302368b..07dde742 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/issue-pull-request-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/issue-pull-request-templates.md @@ -100,16 +100,13 @@ Gitea 支持两种格式的模板：Markdown 和 YAML。 ```md --- - name: "Template Name" about: "This template is for testing!" title: "[TEST] " ref: "main" labels: - -- bug -- "help needed" - + - bug + - "help needed" --- This is the template! diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/linked-references.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/linked-references.md index fe760eb7..2d151d4c 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/linked-references.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/linked-references.md @@ -90,11 +90,11 @@ aliases: - `m` - 分钟 - `h` - 小时 -- `d` - 天（相当于8小时） -- `w` - 周（相当于5天） -- `mo` - 月（相当于4周） +- `d` - 天（相当于 8 小时） +- `w` - 周（相当于 5 天） +- `mo` - 月（相当于 4 周） -用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示1小时10分钟。 +用于指定时间的数字（``）也可以是小数，例如 `@1.5h` 表示一小时半。多个时间单位可以结合使用，例如 `@1h10m` 表示 1 小时 10 分钟。 提交消息示例： @@ -115,26 +115,26 @@ Gitea 支持使用外部工单跟踪器，并可以在合并请求中创建对 下表说明了工单和合并请求的不同类型的交叉引用。在示例中，`User1/Repo1` 指的是使用引用的仓库，而 `UserZ/RepoZ` 表示另一个仓库。 -| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | -| ----------------------- | :-------------------: | :-------------------: | ------------------------------------------------ | -| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | -| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | -| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | -| **字母数字工单编号:** | - | - | - | -| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | -| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | -| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | -| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | +| 在 User1/Repo1 中的引用 | Repo1 的工单是外部的 | RepoZ 的工单是外部的 | 渲染效果 | +| ----------------------- | :------------------: | :------------------: | --------------------------------------------- | +| `#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1#1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1!1234` | 否 | - | 链接到 `User1/Repo1` 中的工单/合并请求 1234 | +| `User1/Repo1#1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `UserZ/RepoZ#1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ!1234` | - | 否 | 链接到 `UserZ/RepoZ` 中的工单/合并请求 1234 | +| `UserZ/RepoZ#1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ 1234 | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 的 _PR_ 1234 | +| **字母数字工单编号:** | - | - | - | +| `AAA-1234` | 是 | - | 链接到 `User1/Repo1` 的 _外部工单_ `AAA-1234` | +| `!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| `User1/Repo1!1234` | 是 | - | 链接到 `User1/Repo1` 的 _PR_ 1234 | +| _不支持_ | - | 是 | 链接到 `UserZ/RepoZ` 的 _外部工单_ `AAA-1234` | +| `UserZ/RepoZ!1234` | - | 是 | 链接到 `UserZ/RepoZ` 中的 _PR_ 1234 | _最后一部分适用于使用字母数字格式的外部工单跟踪器的仓库。_ diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/merge-message-templates.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/merge-message-templates.md index 4c0c79e3..ebfeab7f 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/merge-message-templates.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/merge-message-templates.md @@ -5,7 +5,6 @@ sidebar_position: 15 aliases: - /zh-cn/merge-message-templates - --- # 合并消息模板 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/permissions.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/permissions.md index fae08cd6..bbe0088d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/permissions.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/permissions.md @@ -14,35 +14,35 @@ Gitea 支持对仓库进行权限管理，这样您就可以为不同的人员 在 Gitea 中，我们将仓库的子模块称为 `单元（Unit）`。现在我们有以下几个单元。 -| 名称 | 描述 | 权限 | -| ----------------- | --------------------------------------------------- | ------------ | -| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | -| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | -| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | -| 发布 | 跟踪项目版本和下载。 | 读取 写入 | -| 百科 | 与协作者编写和共享文档。 | 读取 写入 | -| 外部百科 | 链接到外部维基。 | 读取 | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | -| 项目 | 模板仓库的 URL。 | 读取 写入 | -| 包 | 链接到仓库 | 读取 写入 | -| Actions | 审查Actions日志或重启/取消工作流 | 读取 写入 | -| 设置 | 管理仓库。 | 管理员 | +| 名称 | 描述 | 权限 | +| -------------- | ---------------------------------- | --------- | +| 代码 | 访问源代码、文件、提交和分支。 | 读取 写入 | +| 工单 | 组织缺陷报告、任务和里程碑。 | 读取 写入 | +| 合并请求 | 启用合并请求和代码审核。 | 读取 写入 | +| 发布 | 跟踪项目版本和下载。 | 读取 写入 | +| 百科 | 与协作者编写和共享文档。 | 读取 写入 | +| 外部百科 | 链接到外部维基。 | 读取 | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | 读取 | +| 项目 | 模板仓库的 URL。 | 读取 写入 | +| 包 | 链接到仓库 | 读取 写入 | +| Actions | 审查 Actions 日志或重启/取消工作流 | 读取 写入 | +| 设置 | 管理仓库。 | 管理员 | 通过不同的权限，用户可以在这些单元上执行不同的操作。 -| 名称 | 读取 | 写入 | 管理员 | -| ----------------- | -------------------------------------------------- | ------------------------------ | ------------------------- | -| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | -| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | -| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | -| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | -| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | -| 外部百科 | 链接到外部百科。 | - | - | -| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | -| 项目 | 查看面板。 | 在面板之间移动工单。 | - | -| 包 | 查看包 | 上传/删除包 | - | -| Actions | 查看 Actions日志 | 同意 / 取消 / 重启 | - | -| 设置 | - | - | 管理仓库 | +| 名称 | 读取 | 写入 | 管理员 | +| -------------- | -------------------------------- | ------------------------------ | -------- | +| 代码 | 查看代码树、文件、提交、分支等。 | 推送代码。 | - | +| 工单 | 查看工单并创建新工单。 | 添加标签、分配、关闭工单。 | - | +| 合并请求 | 查看合并请求并创建新合并请求。 | 添加标签、分配、关闭合并请求。 | - | +| 发布 | 查看发布和下载文件。 | 创建/编辑发布。 | - | +| 百科 | 查看百科页面。克隆百科仓库。 | 创建/编辑百科页面，推送更改。 | - | +| 外部百科 | 链接到外部百科。 | - | - | +| 外部工单跟踪器 | 链接到外部工单跟踪器。 | - | - | +| 项目 | 查看面板。 | 在面板之间移动工单。 | - | +| 包 | 查看包 | 上传/删除包 | - | +| Actions | 查看 Actions 日志 | 同意 / 取消 / 重启 | - | +| 设置 | - | - | 管理仓库 | 个人仓库和组织仓库之间的权限存在一些差异。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/protected-tags.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/protected-tags.md index 307b048f..1bc4b8a2 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/protected-tags.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/protected-tags.md @@ -25,17 +25,17 @@ aliases: 示例： -| 类型 | 模式受保护的标签 | 可能匹配的标签 | +| 类型 | 模式受保护的标签 | 可能匹配的标签 | | ----- | ------------------------ | --------------------------------------- | | Glob | `v*` | `v`，`v-1`，`version2` | -| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | +| Glob | `v[0-9]` | `v0`，`v1` 到 `v9` | | Glob | `*-release` | `2.1-release`，`final-release` | | Glob | `gitea` | 仅限 `gitea` | | Glob | `*gitea*` | `gitea`，`2.1-gitea`，`1_gitea-release` | | Glob | `{v,rel}-*` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Glob | `*` | 匹配所有可能的标签名称 | +| Glob | `*` | 匹配所有可能的标签名称 | | Regex | `/\Av/` | `v`，`v-1`，`version2` | -| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | +| Regex | `/\Av[0-9]\z/` | `v0`，`v1` 到 `v9` | | Regex | `/\Av\d+\.\d+\.\d+\z/` | `v1.0.17`，`v2.1.0` | | Regex | `/\Av\d+(\.\d+){0,2}\z/` | `v1`，`v2.1`，`v1.2.34` | | Regex | `/-release\z/` | `2.1-release`，`final-release` | @@ -43,4 +43,4 @@ aliases: | Regex | `/\Agitea\z/` | 仅限 `gitea` | | Regex | `/^gitea$/` | 仅限 `gitea` | | Regex | `/\A(v\|rel)-/` | `v-`，`v-1`，`v-final`，`rel-`，`rel-x` | -| Regex | `/.+/` | 匹配所有可能的标签名称 | +| Regex | `/.+/` | 匹配所有可能的标签名称 | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/pull-request.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/pull-request.md index 389ce66e..01b7a7df 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/pull-request.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/pull-request.md @@ -17,15 +17,15 @@ aliases: 要创建合并请求，您需要遵循以下步骤： 1. **Fork 仓库** - 如果您没有直接对仓库进行更改的权限，您需要将仓库 fork 到您自己的账户中。 -这将创建一个您可以对其进行更改的仓库副本。 + 这将创建一个您可以对其进行更改的仓库副本。 2. **创建分支（可选）** - 在 fork 的仓库中创建一个新分支，该分支包含您要提出的更改。 -给分支取一个描述性的名称，以指示更改的内容。 + 给分支取一个描述性的名称，以指示更改的内容。 3. **进行更改** - 进行您想要的更改，提交并将其推送到 fork 的仓库中。 4. **创建合并请求** - 转到原始仓库并转到“合并请求”选项卡。单击“新建合并请求”按钮，并将您的新分支选择为源分支。 -为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 + 为您的合并请求输入描述性标题和描述，然后单击“创建合并请求”。 ## 评审合并请求 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/repo-mirror.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/repo-mirror.md index b4c7b54a..b89df30d 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/repo-mirror.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/repo-mirror.md @@ -53,7 +53,7 @@ aliases: 要从 Gitea 设置镜像到 GitHub，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *public_repo* 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 +1. 创建一个具有选中 _public_repo_ 选项的 [GitHub 个人访问令牌](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)。 2. 在 GitHub 上创建一个同名的仓库。与 Gitea 不同，GitHub 不支持通过推送到远程来创建仓库。如果您的现有远程仓库与您的 Gitea 仓库具有相同的提交历史，您也可以使用现有的远程仓库。 3. 在您的 Gitea 仓库设置中，填写**Git 远程仓库 URL**：`https://github.com//.git`。 4. 使用您的 GitHub 用户名填写**授权**字段，并将个人访问令牌作为**密码**。 @@ -66,7 +66,7 @@ aliases: 要从 Gitea 设置镜像到 GitLab，您需要按照以下步骤进行操作： -1. 创建具有 *write_repository* 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 +1. 创建具有 _write_repository_ 作用域的 [GitLab 个人访问令牌](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)。 2. 填写**Git 远程仓库 URL**：`https:////.git`。 3. 在**授权**字段中填写 `oauth2` 作为**用户名**，并将您的 GitLab 个人访问令牌作为**密码**。 4. 选择**添加推送镜像**以保存配置。 @@ -77,7 +77,7 @@ aliases: 要从 Gitea 设置镜像到 Bitbucket，您需要按照以下步骤进行操作： -1. 创建一个具有选中 *Repository Write* 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 +1. 创建一个具有选中 _Repository Write_ 选项的 [Bitbucket 应用密码](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/)。 2. 填写**Git 远程仓库 URL**：`https://bitbucket.org//.git`。 3. 使用您的 Bitbucket 用户名填写**授权**字段，并将应用密码作为**密码**。 4. 选择**添加推送镜像**以保存配置。 diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/template-repositories.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/template-repositories.md index a051d7ba..f9bc1744 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/template-repositories.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/template-repositories.md @@ -42,20 +42,20 @@ a/b/c/d.json 所有变量都必须采用`$VAR`或`${VAR}`的形式。要转义扩展，使用双重`$$`，例如`$$VAR`或`$${VAR}`。 -| 变量 | 扩展为 | 可转换 | -| -------------------- | --------------------------------------------------- | ------------- | -| REPO_NAME | 生成的仓库名称 | ✓ | -| TEMPLATE_NAME | 模板仓库名称 | ✓ | -| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | -| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | -| REPO_OWNER | 生成的仓库所有者 | ✓ | -| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | -| REPO_LINK | 生成的仓库链接 | ✘ | -| TEMPLATE_LINK | 模板仓库链接 | ✘ | -| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | -| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | -| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | -| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | +| 变量 | 扩展为 | 可转换 | +| -------------------- | ----------------------------- | ------ | +| REPO_NAME | 生成的仓库名称 | ✓ | +| TEMPLATE_NAME | 模板仓库名称 | ✓ | +| REPO_DESCRIPTION | 生成的仓库描述 | ✘ | +| TEMPLATE_DESCRIPTION | 模板仓库描述 | ✘ | +| REPO_OWNER | 生成的仓库所有者 | ✓ | +| TEMPLATE_OWNER | 模板仓库所有者 | ✓ | +| REPO_LINK | 生成的仓库链接 | ✘ | +| TEMPLATE_LINK | 模板仓库链接 | ✘ | +| REPO_HTTPS_URL | 生成的仓库的 HTTP(S) 克隆链接 | ✘ | +| TEMPLATE_HTTPS_URL | 模板仓库的 HTTP(S) 克隆链接 | ✘ | +| REPO_SSH_URL | 生成的仓库的 SSH 克隆链接 | ✘ | +| TEMPLATE_SSH_URL | 模板仓库的 SSH 克隆链接 | ✘ | ## 转换器 :robot: @@ -65,12 +65,12 @@ Gitea `1.12.0` 添加了一些转换器以应用于上述适用的变量。 将 `go-sdk` 传递给可用的转换器的效果如下... -| 转换器 | 效果 | -| ----------- | ------------ | -| SNAKE | go_sdk | -| KEBAB | go-sdk | -| CAMEL | goSdk | -| PASCAL | GoSdk | -| LOWER | go-sdk | -| UPPER | GO-SDK | -| TITLE | Go-Sdk | +| 转换器 | 效果 | +| ------ | ------ | +| SNAKE | go_sdk | +| KEBAB | go-sdk | +| CAMEL | goSdk | +| PASCAL | GoSdk | +| LOWER | go-sdk | +| UPPER | GO-SDK | +| TITLE | Go-Sdk | diff --git a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/webhooks.md b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/webhooks.md index fcb12da2..9210f0b5 100644 --- a/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/webhooks.md +++ b/i18n/zh-cn/docusaurus-plugin-content-docs/version-1.23/usage/webhooks.md @@ -8,7 +8,7 @@ aliases: # Webhooks -Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks还可以基于组织和整个系统进行配置。 +Gitea 支持用于仓库事件的 Webhooks。这可以在仓库管理员在设置页面 `/:username/:reponame/settings/hooks` 中进行配置。Webhooks 还可以基于组织和整个系统进行配置。 所有事件推送都是 POST 请求。目前支持： - Gitea (也可以是 GET 请求) @@ -26,7 +26,7 @@ Gitea支持用于仓库事件的Webhooks。这可以在仓库管理员在设置 **警告**：自 Gitea 1.13.0 版起，payload 中的 `secret` 字段已被弃用，并将在 1.14.0 版中移除：https://github.com/go-gitea/gitea/issues/11755 -以下是 Gitea 将发送给 payload URL的事件信息示例： +以下是 Gitea 将发送给 payload URL 的事件信息示例： ```http X-GitHub-Delivery: f6266f16-1bf3-46a5-9ea4-602e06ead473 @@ -182,4 +182,4 @@ if (json_last_error() !== JSON_ERROR_NONE) { ### 授权头（Authorization header） -**从1.19版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 +**从 1.19 版本开始**，Gitea 的 Webhook 可以配置为向 Webhook 目标发送一个 [授权头（authorization header）](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization)。 diff --git a/i18n/zh-tw/code.json b/i18n/zh-tw/code.json new file mode 100644 index 00000000..f17091c8 --- /dev/null +++ b/i18n/zh-tw/code.json @@ -0,0 +1,8 @@ +{ + "outdated.message": { + "message": "當前中文文檔翻譯不是最新版，請訪問英文版本查看最新內容，或" + }, + "outdated.help": { + "message": "幫助我們翻譯" + } +} \ No newline at end of file diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current.json b/i18n/zh-tw/docusaurus-plugin-content-docs/current.json new file mode 100644 index 00000000..bfe59f8a --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current.json @@ -0,0 +1,29 @@ +{ + "sidebar.docs.category.Installation": { + "message": "安裝" + }, + "sidebar.docs.category.Administration": { + "message": "管理" + }, + "sidebar.docs.category.Usage": { + "message": "使用" + }, + "sidebar.docs.category.actions": { + "message": "Actions" + }, + "sidebar.docs.category.packages": { + "message": "軟體包" + }, + "sidebar.docs.category.Development": { + "message": "開發" + }, + "sidebar.docs.category.Contributing": { + "message": "貢獻" + }, + "sidebar.docs.category.Help": { + "message": "幫助" + }, + "sidebar.docs.doc.What is Gitea?": { + "message": "Gitea是什麼?" + } +} \ No newline at end of file diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration.md new file mode 100644 index 00000000..4990aa60 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration.md @@ -0,0 +1,12 @@ +--- +date: "2016-12-01T16:00:00+02:00" +title: "運維" +slug: "administration" +sidebar_position: 30 + +menu: + sidebar: + name: "運維" + sidebar_position: 20 + identifier: "administration" +--- diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md new file mode 100644 index 00000000..e4c81127 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/adding-legal-pages.md @@ -0,0 +1,34 @@ +--- +date: "2023-05-23T09:00:00+08:00" +slug: adding-legal-pages +sidebar_position: 110 + +aliases: + - /zh-tw/adding-legal-pages +--- + +# 添加法律頁面 + +一些法域（例如歐盟）要求在網站上添加特定的法律頁面（例如隱私政策）。按照以下步驟將它們添加到你的 Gitea 實例中。 + +## 獲取頁面 + +Gitea 源代碼附帶了示例頁面，位於 `contrib/legal` 目錄中。將它們複製到 `custom/public/assets/` 目錄下。例如，如果要添加隱私政策： + +``` +wget -O /path/to/custom/public/assets/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/legal/privacy.html.sample +``` + +現在，你需要編輯該頁面以滿足你的需求。特別是，你必須更改電子郵件地址、網址以及與 "Your Gitea Instance" 相關的引用，以匹配你的情況。 + +請務必不要放置會暗示 Gitea 項目對你的服務器負責的一般服務條款或隱私聲明。 + +## 使其可見 + +創建或追加到 `/path/to/custom/templates/custom/extra_links_footer.tmpl` 文件中： + +```go +隱私政策 +``` + +重啟 Gitea 以查看更改。 diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md new file mode 100644 index 00000000..b82066d3 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/authentication.md @@ -0,0 +1,301 @@ +--- +date: "2016-12-01T16:00:00+02:00" +slug: "authentication" +sidebar_position: 10 +aliases: + - /zh-tw/authentication +--- + +# 认证 + +## 轻量级目录访问协议（Lightweight Directory Access Protocol，LDAP） + +通过 BindDN 的 LDAP 和简单认证方式 LDAP 共享以下字段: + +- 认证名称 **(必选)** + + - 分配给新授权方法的名称。 + +- 主机名 **(必选)** + + - LDAP 服务的主机地址. + - 例如:`mydomain.com` + +- 端口号 **(必选)** + + - LDAP 服务的端口号. + - 例如: LDAP `389`/ LDAPs `636` + +- 安全协议 (可选) + + - 连接 LDAP 服务器时是否使用 TLS 协议。 + +- 管理员过滤规则 (可选) + + - 一个 LDAP 过滤器，用于指定哪些用户应该被赋予管理员特权。如果用户帐户符合过滤器条件，则该用户将被授予管理员权限。 + - 示例:`(objectClass=adminAccount)` + - 适用于 Microsoft Active Directory（AD）的示例:`memberOf=CN=admin-group,OU=example,DC=example,DC=org` + +- 用户名属性（可选） + + - 用户 LDAP 记录中包含用户名称的属性。在第一次成功登录后，将使用指定的属性值作为新的 Gitea 账户用户名。若留空，则使用登录表单上提供的用户名。 + - 当提供的登录名与多个属性匹配时，这一选项非常有用，但是只有一个特定属性应该用于 Gitea 账户名称，请参阅"用户过滤器"。 + - 示例:uid + - 适用于 Microsoft Active Directory（AD）的示例:`sAMAccountName` + +- 名字属性（可选） + + - 用户 LDAP 记录中包含用户名字的属性。将用于填充他们的账户信息。 + - 示例:givenName + +- 姓氏属性（可选） + + - 用户 LDAP 记录中包含用户姓氏的属性。将用于填充他们的账户信息。 + - 示例:`sn` + +- 电子邮件属性 **(必选)** + - 用户 LDAP 记录中包含用户电子邮件地址的属性。将用于填充他们的账户信息。 + - 示例:`mail` + +### LDAP(via BindDN) + +需要额外设置以下字段: + +- 绑定 DN (可选) + + - 搜索用户时绑定到 LDAP 服务器的 DN。这可以留空以执行匿名搜索。 + - 示例: `cn=Search,dc=mydomain,dc=com` + +- 绑定密码 (可选) + + - 上述指定的 Bind DN（绑定区别名）的密码，如果有的话。注意：该密码在服务器上使用 SECRET_KEY 进行加密存储。仍然建议确保 Bind DN 具有尽可能少的权限。 + +- 用户搜索基准 **(必选)** + + - 这是用于搜索用户帐户的 LDAP 基础路径. + - 示例: `ou=Users,dc=mydomain,dc=com` + +- 用户过滤规则 **(必选)** + - LDAP 过滤器声明如何查找试图进行身份验证的用户记录 + `%[1]s`匹配参数将替换为登录表单中给出的登录名 + - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` + - 示例 for Microsoft Active Directory (AD): `(&(objectCategory=Person)(memberOf=CN=user-group,OU=example,DC=example,DC=org)(sAMAccountName=%s)(!(UserAccountControl:1.2.840.113556.1.4.803:=2)))` + - 如需多次替换，应使用 `%[1]s`，例如在将提供的登录名与多个属性（如用户标识符、电子邮件甚至电话号码）进行匹配时。 + - 示例: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))` +- 启用用户同步 + - 这个选项启用了一个周期性任务，用于将 Gitea 用户与 LDAP 服务器进行同步。默认的同步周期是每 24 小时， + 但您可以在 app.ini 文件中进行更改。 + 有关此部分的详细说明，请参阅[sample + app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) + 的*cron.sync_external_users* 部分的注释。前面提到的*User Search Base*和*User Filter* + 设置将限制哪些用户可以使用 Gitea 以及哪些用户将被同步。 + 在初始运行任务时，将根据给定的设置创建所有与 LDAP 匹配的用户，因此在使用大型企业 LDAP 目录时需要小心。 + +### LDAP(simple auth) + +需要额外设置以下字段: + +- 用户 DN **(必选)** + + - 用作用户 DN 的模板。匹配参数 `%s` 将替换为登录表单中的登录名。 + - 示例: `cn=%s,ou=Users,dc=mydomain,dc=com` + - 示例: `uid=%s,ou=Users,dc=mydomain,dc=com` + +- 用户搜索基准 (可选) + + - 用户搜索基准声明哪些用户帐户将被搜索. + - 示例: `ou=Users,dc=mydomain,dc=com` + +- 用户过滤规则 **(必选)** + - LDAP 过滤器声明何时允许用户登录 + `%[1]s`匹配参数将替换为登录表单中给出的登录名。 + - 示例: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))` + - 示例: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))` + +### 使用 LDAP 验证分组成员 + +使用以下字段: + +- 群组搜索基础 DN(可选) + + - 组使用的 LDAP DN。 + - 示例: `ou=group,dc=mydomain,dc=com` + +- 组名过滤器 (可选) + + - LDAP 过滤器，声明如何在上述 DN 中查找有效组。 + - 示例: `(|(cn=gitea_users)(cn=admins))` + +- 组中的用户属性 (可选) + + - 组中列出了哪个用户的 LDAP 属性。 + - 示例: `uid` + +- 用户组属性 (可选) + - 哪个组的 LDAP 属性包含一个高于用户属性名称的数组。 + - 示例: `memberUid` + +## 可插拔式认证模块(Pluggable Authentication Module,PAM) + +这个过程启用了 PAM（Pluggable Authentication Modules）认证。用户仍然可以通过用户管理手动添加到系统中。 +PAM 提供了一种机制，通过对用户进行 PAM 认证来自动将其添加到当前数据库中。为了与普通的 Linux 密码一起使用， +运行 Gitea 的用户还必须具有对`/etc/shadow`的读取权限，以便在使用公钥登录时检查账户的有效性。 + +**注意**:如果用户已将 SSH 公钥添加到 Gitea 中，使用这些密钥可能会绕过登录检查系统。因此， +如果您希望禁用使用 PAM 进行身份验证的用户，应该在 Gitea 中手动禁用该账户，使用内置的用户管理功能。 + +1. 配置和安装准备. + - 建议您创建一个管理用户. + - 建议取消自动注册. +1. 一旦数据库已初始化完成，使用新创建的管理员账户登录. +1. 导航至用户设置（右上角的图标），然后选择 + `Site Administration` -> `Authentication Sources`, 并选择 + `Add Authentication Source`. +1. 填写字段如下: + - 认证类型:`PAM`。 + - 名称:任何有效的值都可以，如果您愿意，可以使用"System Authentication"。 + - PAM 服务名称:从/etc/pam.d/目录下选择适用于所需认证的正确文件[^1]。 + - PAM 电子邮件域:用户认证时要附加的电子邮件后缀。例如，如果登录系统期望一个名为 gituse 的用户， + 并且将此字段设置为 mail.com，那么 Gitea 在验证一个 GIT 实例的用户时将期望 user emai 字段为gituser@mail.com[^2]。 + +**Note**: PAM 支持通过[build-time flags](installation/from-source.md#build)添加, +而官方提供的二进制文件通常不会默认启用此功能。PAM 需要确保系统上有必要的 libpam 动态库，并且编译器可以访问必要的 PAM 开发头文件。 + +[^1]: + 例如，在 Debian "Bullseye"上使用标准 Linux 登录，可以使用`common-session-noninteractive`。这个值对于其他版本的 Debian， + 包括 Ubuntu 和 Mint，可能也是有效的，请查阅您所使用发行版的文档以确认。 + +[^2]: **PAM 的必选项** 请注意:在上面的示例中，用户将作为`gituser`而不是`gituser@mail.com`登录到 Gitea 的 Web 界面。 + +## 简单邮件传输协议(Simple Mail Transfer Protocol,SMTP) + +此选项允许 Gitea 以 Gitea 用户身份登录 SMTP 主机。请设置以下字段: + +- 身份验证名称 **(必选)** + + - 分配给新授权方法的名称 + +- SMTP 验证类型 **(必选)** + + - 用于连接 SMTP 主机的验证类型，plain 或 login + +- 主机名 **(必选)** + + - SMTP 服务的主机地址 + - 例如:`smtp.mydomain.com` + +- 端口号 **(必选)** + + - SMTP 服务的端口号 + - 例如: `587` + +- 允许的域名 + + - 如果使用公共 SMTP 主机或有多个域的 SMTP 主机，限制哪些域可以登录 + 限制哪些域可以登录。 + - 示例: `gitea.com,mydomain.com,mydomain2.com` + +- 强制使用 SMTPS + - 默认情况下将使用 SMTPS 连接到端口 465.如果您希望将 smtp 用于其他端口，自行设置 + - 否则，如果服务器提供' STARTTLS '扩展名，则将使用此扩展名 +- 跳过 TLS 验证 + - 禁用 TLS 验证身份. +- 该认证源处于激活状态 + - 启用或禁用此身份验证源 + +## FreeIPA + +- 要使用 FreeIPA 凭据登录 Gitea，需要为 Gitea 创建一个绑定帐户。 + 创建一个绑定帐户: +- 在 FreeIPA 服务器上创建一个 gitea.ldif 文件，并将`dc=example,dc=com`替换为您的`dn`，然后提供一个适当安全的密码。 + + ```sh + dn: uid=gitea,cn=sysaccounts,cn=etc,dc=example,dc=com + changetype: add + objectclass: account + objectclass: simplesecurityobject + uid: gitea + userPassword: secure password + passwordExpirationTime: 20380119031407Z + nsIdleTimeout: 0 + ``` + +- 导入 LDIF 文件（如果需要，请将 localhost 更改为 IPA 服务器）。系统会提示您输入 Directory Manager 的密码。: + + ```sh + ldapmodify -h localhost -p 389 -x -D \ + "cn=Directory Manager" -W -f gitea.ldif + ``` + +- 为`gitea_users`添加 IPA 组: + + ```sh + ipa group-add --desc="Gitea Users" gitea_users + ``` + +- **提示**:对于 IPA 凭证错误，运行' kinit admin '并提供域管理帐户密码. +- 以管理员身份登录 Gitea，点击 Admin Panel 下的`Authentication`。然后单击`Add New Source`并填写详细信息，更改所有适当的地方。 + +## SPNEGO with SSPI (Kerberos/NTLM, for Windows only) + +Gitea 支持通过 Windows 内置的安全支持提供程序接口（Security Support Provider Interface，SSPI）实现 SPNEGO 单点登录认证（由 RFC4559 定义的方案），用于服务器的 Web 部分。SSPI 仅在 Windows 环境中工作，即当服务器和客户端都在 Windows 操作系统上运行时。 + +在激活 SSPI 单点登录认证（SSO）之前，您需要准备您的环境: + +- 在 Active Directory 中创建一个单独的用户账户，gitea.exe 进程将在该账户下运行（例如，在 domain.local 域下创建一个名为 user 的账户: +- 为运行 gitea.exe 的主机创建一个服务主体名称（Service Principal Name，SPN），其类别为 HTTP: + + - 以特权域用户（例如域管理员）的身份启动“命令提示符”或“PowerShell”。 + - 运行下面的命令，将 host.domain.local 替换为 Web 应用程序将运行的服务器的完全限定域名（FQDN），将 domain\user 替换为在前一步中创建的账户名称: + + ```sh + setspn -A HTTP/host.domain.local domain\user + ``` + +在遵循上述步骤之前，请确保您按照以下流程进行操作: + +1. 用之前创建的用户登录（如果已经登录，请先注销）。 +2. 确保在`custom/conf/app.ini`文件的`[server]`部分中，`ROOT_URL`设置为 Web 应用程序将运行的服务器的完全限定域名（FQDN），与之前创建服务主体名称时使用的一致（例如，`host.domain.local`）。 +3. 启动 Web 服务器（运行 `gitea.exe web`）。 +4. 在 `Site Administration -> Authentication Sources` 中添加一个 `SPNEGO with SSPI` 认证源，以启用 SSPI 认证。 +5. 在域中的客户端计算机上，使用任何域用户登录（与运行`gitea.exe`的服务器不同）。 +6. 如果您使用 Chrome 或 Edge 浏览器，请将 Web 应用程序的 URL 添加到“本地站点”（`Internet选项 -> 安全 -> 本地站点 -> 站点`）。 +7. 启动 Chrome 或 Edge 浏览器，导航到 Gitea 的 FQDN URL（例如，`http://host.domain.local:3000`）。 +8. 在控制面板中点击“Sign In”按钮，然后选择 SSPI，将会自动使用当前登录到计算机的用户进行登录。 +9. 如果无法正常工作，请确保: + - 您不是在运行`gitea.exe`的同一台服务器上运行 Web 浏览器。应该在与服务器不同的域加入计算机（客户端）上运行 Web 浏览器。如果客户端和服务器都在同一台计算机上运行，则 NTLM 将优先于 Kerberos。 + - 主机上只有一个`HTTP/...`的 SPN。 + - SPN 中只包含主机名，不包含端口号。 + - 将 Web 应用程序的 URL 添加到"本地站点"。 + - 服务器和客户端的时钟差异不超过 5 分钟（取决于组策略）。 + - 在 Internet Explorer 中启用了"集成 Windows 身份验证"（在"高级设置"下）。 + +遵循这些步骤，您应该能够成功启用和使用 SSPI 单点登录认证（SSO）。 + +## 反向代理认证 + +Gitea 支持通过读取反向代理传递的 HTTP 头中的登录名或者 email 地址来支持反向代理来认证。默认是不启用的，你可以用以下配置启用。 + +```ini +[service] +ENABLE_REVERSE_PROXY_AUTHENTICATION = true +``` + +默认的登录用户名的 HTTP 头是 `X-WEBAUTH-USER`，你可以通过修改 `REVERSE_PROXY_AUTHENTICATION_USER` 来变更它。如果用户不存在，可以自动创建用户，当然你需要修改 `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true` 来启用它。 + +默认的登录用户 Email 的 HTTP 头是 `X-WEBAUTH-EMAIL`，你可以通过修改 `REVERSE_PROXY_AUTHENTICATION_EMAIL` 来变更它。如果用户不存在，可以自动创建用户，当然你需要修改 `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true` 来启用它。你也可以通过修改 `ENABLE_REVERSE_PROXY_EMAIL` 来启用或停用这个 HTTP 头。 + +如果设置了 `ENABLE_REVERSE_PROXY_FULL_NAME=true`，则用户的全名会从 `X-WEBAUTH-FULLNAME` 读取，这样在自动创建用户时将使用这个字段作为用户全名，你也可以通过修改 `REVERSE_PROXY_AUTHENTICATION_FULL_NAME` 来变更 HTTP 头。 + +你也可以通过修改 `REVERSE_PROXY_TRUSTED_PROXIES` 来设置反向代理的 IP 地址范围，加强安全性，默认值是 `127.0.0.0/8,::1/128`。 通过 `REVERSE_PROXY_LIMIT`， 可以设置最多信任几级反向代理。 + +你可以通过以下配置为 API 启用此认证方法： + +```ini +[service] +ENABLE_REVERSE_PROXY_AUTHENTICATION_API = true +``` + +:::note +当此方法用于 API 时，反向代理负责处理 CSRF 保护。 +::: diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md new file mode 100644 index 00000000..10a6c540 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/backup-and-restore.md @@ -0,0 +1,146 @@ +--- +date: "2018-06-06T09:33:00+08:00" +slug: "backup-and-restore" +sidebar_position: 11 + +aliases: + - /zh-tw/backup-and-restore +--- + +# 备份与恢复 + +Gitea 已经实现了 `dump` 命令可以用来备份所有需要的文件到一个 zip 压缩文件。该压缩文件可以被用来进行数据恢复。 + +## 备份一致性 + +为了确保 Gitea 实例的一致性，在备份期间必须关闭它。 + +Gitea 包括数据库、文件和 Git 仓库，当它被使用时所有这些都会发生变化。例如，当迁移正在进行时，在数据库中创建一个事务，而 Git 仓库正在被复制。如果备份发生在迁移的中间，Git 仓库可能是不完整的，尽管数据库声称它是完整的，因为它是在之后被转储的。避免这种竞争条件的唯一方法是在备份期间停止 Gitea 实例。 + +## 备份命令 (`dump`) + +先转到 git 用户的权限: `su git`. 再 Gitea 目录运行 `./gitea dump`。一般会显示类似如下的输出： + +``` +2016/12/27 22:32:09 Creating tmp work dir: /tmp/gitea-dump-417443001 +2016/12/27 22:32:09 Dumping local repositories.../home/git/gitea-repositories +2016/12/27 22:32:22 Dumping database... +2016/12/27 22:32:22 Packing dump files... +2016/12/27 22:32:34 Removing tmp work dir: /tmp/gitea-dump-417443001 +2016/12/27 22:32:34 Finish dumping in file gitea-dump-1482906742.zip +``` + +最后生成的 `gitea-dump-1482906742.zip` 文件将会包含如下内容： + +- `app.ini` - 如果原先存储在默认的 custom/ 目录之外，则是配置文件的可选副本 +- `custom/` - 所有保存在 `custom/` 目录下的配置和自定义的文件。 +- `data/` - 数据目录（APP_DATA_PATH），如果使用文件会话，则不包括会话。该目录包括 `attachments`、`avatars`、`lfs`、`indexers`、如果使用 SQLite 则包括 SQLite 文件。 +- `repos/` - 仓库目录的完整副本。 +- `gitea-db.sql` - 数据库 dump 出来的 SQL。 +- `log/` - Logs 文件，如果用作迁移不是必须的。 + +中间备份文件将会在临时目录进行创建，如果您要重新指定临时目录，可以用 `--tempdir` 参数，或者用 `TMPDIR` 环境变量。 + +## 备份数据库 + +`gitea dump` 创建的 SQL 转储使用 XORM，Gitea 管理员可能更喜欢使用本地的 MySQL 和 PostgreSQL 转储工具。使用 XORM 转储数据库时仍然存在一些问题，可能会导致在尝试恢复时出现问题。 + +```sh +# mysql +mysqldump -u$USER -p$PASS --database $DATABASE > gitea-db.sql +# postgres +pg_dump -U $USER $DATABASE > gitea-db.sql +``` + +### 使用 Docker （`dump`） + +在使用 Docker 时，使用 `dump` 命令有一些注意事项。 + +必须以 `gitea/conf/app.ini` 中指定的 `RUN_USER = ` 执行该命令；并且，为了让备份文件夹的压缩过程能够顺利执行，`docker exec` 命令必须在 `--tempdir` 内部执行。 + +示例： + +```none +docker exec -u -it -w <--tempdir> $(docker ps -qf 'name=^$') bash -c '/usr/local/bin/gitea dump -c ' +``` + +\*注意：`--tempdir` 指的是 Gitea 使用的 Docker 环境的临时目录；如果您没有指定自定义的 `--tempdir`，那么 Gitea 将使用 `/tmp` 或 Docker 容器的 `TMPDIR` 环境变量。对于 `--tempdir`，请相应调整您的 `docker exec` 命令选项。 + +结果应该是一个文件，存储在指定的 `--tempdir` 中，类似于：`gitea-dump-1482906742.zip` + +## 恢复命令 (`restore`) + +当前还没有恢复命令，恢复需要人工进行。主要是把文件和数据库进行恢复。 + +例如： + +```sh +unzip gitea-dump-1610949662.zip +cd gitea-dump-1610949662 +mv app.ini /etc/gitea/conf/app.ini +mv data/* /var/lib/gitea/data/ +mv log/* /var/lib/gitea/log/ +mv repos/* /var/lib/gitea/gitea-repositories/ +chown -R gitea:gitea /etc/gitea/conf/app.ini /var/lib/gitea + +# mysql +mysql --default-character-set=utf8mb4 -u$USER -p$PASS $DATABASE Docker），或者 Gitea 安装到了与之前安装不同的目录，则需要重新生成仓库 Git 钩子。 + +在 Gitea 运行时，并从 Gitea 二进制文件所在的目录执行：`./gitea admin regenerate hooks` + +这样可以确保仓库 Git 钩子中的应用程序和配置文件路径与当前安装一致。如果这些路径没有更新，仓库的 `push` 操作将失败。 + +### 使用 Docker (`restore`) + +在基于 Docker 的 Gitea 实例中，也没有恢复命令的支持。恢复过程与前面描述的步骤相同，但路径不同。 + +示例： + +```sh +# 在容器中打开 bash 会话 +docker exec --user git -it 2a83b293548e bash +# 在容器内解压您的备份文件 +unzip gitea-dump-1610949662.zip +cd gitea-dump-1610949662 +# 恢复 Gitea 数据 +mv data/* /data/gitea +# 恢复仓库本身 +mv repos/* /data/git/gitea-repositories/ +# 调整文件权限 +chown -R git:git /data +# 重新生成 Git 钩子 +/usr/local/bin/gitea -c '/data/gitea/conf/app.ini' admin regenerate hooks +``` + +Gitea 容器中的默认用户是 `git`（1000:1000）。请用您的 Gitea 容器 ID 或名称替换 `2a83b293548e`。 + +### 使用 Docker-rootless (`restore`) + +在 Docker-rootless 容器中的恢复工作流程只是要使用的目录不同： + +```sh +# 在容器中打开 bash 会话 +docker exec --user git -it 2a83b293548e bash +# 在容器内解压您的备份文件 +unzip gitea-dump-1610949662.zip +cd gitea-dump-1610949662 +# 恢复 app.ini +mv data/conf/app.ini /etc/gitea/app.ini +# 恢复 Gitea 数据 +mv data/* /var/lib/gitea +# 恢复仓库本身 +mv repos/* /var/lib/gitea/git/gitea-repositories +# 调整文件权限 +chown -R git:git /etc/gitea/app.ini /var/lib/gitea +# 重新生成 Git 钩子 +/usr/local/bin/gitea -c '/etc/gitea/app.ini' admin regenerate hooks +``` diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md new file mode 100644 index 00000000..ba2adb21 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/cmd-embedded.md @@ -0,0 +1,93 @@ +--- +date: "2023-05-23T09:00:00+08:00" +slug: "cmd-embedded" +sidebar_position: 20 + +aliases: + - /zh-tw/cmd-embedded +--- + +# 嵌入资源提取工具 + +Gitea 的可执行文件包含了运行所需的所有资源：模板、图片、样式表和翻译文件。你可以通过在 `custom` 目录下的相应路径中放置替换文件来覆盖其中的任何资源（详见 [自定义 Gitea 配置](../administration/customizing-gitea.md)）。 + +要获取嵌入资源的副本以进行编辑，可以使用 CLI 中的 `embedded` 命令，通过操作系统的 shell 执行。 + +**注意：** 嵌入资源提取工具包含在 Gitea 1.12 及以上版本中。 + +## 资源列表 + +要列出嵌入在 Gitea 可执行文件中的资源，请使用以下语法： + +```sh +gitea embedded list [--include-vendored] [patterns...] +``` + +`--include-vendored` 标志使命令包括被供应的文件，这些文件通常被排除在外；即来自外部库的文件，这些文件是 Gitea 所需的（例如 [octicons](https://octicons.github.com/) 等）。 + +可以提供一系列文件搜索模式。Gitea 使用 [gobwas/glob](https://github.com/gobwas/glob) 作为其 glob 语法。以下是一些示例： + +- 列出所有模板文件，无论在哪个虚拟目录下：`**.tmpl` +- 列出所有邮件模板文件：`templates/mail/**.tmpl` + 列出 `public/assets/img` 目录下的所有文件：`public/assets/img/**` + +不要忘记为模式使用引号，因为空格、`*` 和其他字符可能对命令行解释器有特殊含义。 + +如果未提供模式，则列出所有文件。 + +### 示例：列出所有嵌入文件 + +列出所有路径中包含 `openid` 的嵌入文件： + +```sh +$ gitea embedded list '**openid**' +public/assets/img/auth/openid_connect.svg +public/assets/img/openid-16x16.png +templates/user/auth/finalize_openid.tmpl +templates/user/auth/signin_openid.tmpl +templates/user/auth/signup_openid_connect.tmpl +templates/user/auth/signup_openid_navbar.tmpl +templates/user/auth/signup_openid_register.tmpl +templates/user/settings/security_openid.tmpl +``` + +## 提取资源 + +要提取嵌入在 Gitea 可执行文件中的资源，请使用以下语法： + +```sh +gitea [--config {file}] embedded extract [--destination {dir}|--custom] [--overwrite|--rename] [--include-vendored] {patterns...} +``` + +`--config` 选项用于告知 Gitea `app.ini` 配置文件的位置（如果不在默认位置）。此选项仅在使用 `--custom` 标志时使用。 + +`--destination` 选项用于指定提取文件的目标目录。默认为当前目录。 + +`--custom` 标志告知 Gitea 直接将文件提取到 `custom` 目录中。为使其正常工作，该命令需要知道 `app.ini` 配置文件的位置（通过 `--config` 指定），并且根据配置的不同，需要从 Gitea 通常启动的目录运行。有关详细信息，请参阅 [自定义 Gitea 配置](../administration/customizing-gitea.md)。 + +`--overwrite` 标志允许覆盖目标目录中的任何现有文件。 + +`--rename` 标志告知 Gitea 将目标目录中的任何现有文件重命名为 `filename.bak`。之前的 `.bak` 文件将被覆盖。 + +至少需要提供一个文件搜索模式；有关模式的语法和示例，请参阅上述 `list` 子命令。 + +### 重要提示 + +请确保**只提取需要自定义的文件**。位于 `custom` 目录中的文件不会受到 Gitea 的升级过程的影响。当 Gitea 升级到新版本（通过替换可执行文件）时，许多嵌入文件将发生变化。Gitea 将尊重并使用在 `custom` 目录中找到的任何文件，即使这些文件是旧的和不兼容的。 + +### 示例：提取邮件模板 + +将邮件模板提取到临时目录： + +```sh +$ mkdir tempdir +$ gitea embedded extract --destination tempdir 'templates/mail/**.tmpl' +Extracting to tempdir: +tempdir/templates/mail/auth/activate.tmpl +tempdir/templates/mail/auth/activate_email.tmpl +tempdir/templates/mail/auth/register_notify.tmpl +tempdir/templates/mail/auth/reset_passwd.tmpl +tempdir/templates/mail/issue/assigned.tmpl +tempdir/templates/mail/issue/default.tmpl +tempdir/templates/mail/notify/collaborator.tmpl +``` diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md new file mode 100644 index 00000000..e3dbddd4 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/command-line.md @@ -0,0 +1,534 @@ +--- +date: "2023-05-23T09:00:00+08:00" +slug: "command-line" +sidebar_position: 1 + +aliases: + - /zh-tw/command-line +--- + +# 命令行 + +## 用法 + +`gitea [全局选项] 命令 [命令或全局选项] [参数...]` + +## 全局选项 + +所有全局选项均可被放置在命令级别。 + +- `--help`，`-h`：显示帮助文本并退出。可选。 +- `--version`，`-v`：显示版本信息并退出。可选。 (示例：`Gitea version 1.1.0+218-g7b907ed built with: bindata, sqlite`)。 +- `--custom-path path`，`-C path`：Gitea 自定义文件夹的路径。可选。 (默认值：`AppWorkPath`/custom 或 `$GITEA_CUSTOM`)。 +- `--config path`，`-c path`：Gitea 配置文件的路径。可选。 (默认值：`custom`/conf/app.ini)。 +- `--work-path path`，`-w path`：Gitea 的 `AppWorkPath`。可选。 (默认值：LOCATION_OF_GITEA_BINARY 或 `$GITEA_WORK_DIR`) + +注意：默认的 custom-path、config 和 work-path 也可以在构建时更改（如果需要）。 + +## 命令 + +### web + +启动服务器： + +- 选项： + - `--port number`，`-p number`：端口号。可选。 (默认值：3000)。覆盖配置文件中的设置。 + - `--install-port number`：运行安装页面的端口号。可选。 (默认值：3000)。覆盖配置文件中的设置。 + - `--pid path`，`-P path`：Pid 文件的路径。可选。 + - `--quiet`，`-q`：只在控制台上输出 Fatal 日志，用于在设置日志之前发出的日志。 + - `--verbose`：在控制台上输出跟踪日志，用于在设置日志之前发出的日志。 +- 示例： + - `gitea web` + - `gitea web --port 80` + - `gitea web --config /etc/gitea.ini --pid /some/custom/gitea.pid` +- 注意： + - Gitea 不应以 root 用户身份运行。要绑定到低于 1024 的端口，您可以在 Linux 上使用 setcap 命令：`sudo setcap 'cap_net_bind_service=+ep' /path/to/gitea`。每次更新 Gitea 都需要重新执行此操作。 + +### admin + +管理员操作： + +- 命令： + - `user`： + - `list`： + - 选项： + - `--admin`：仅列出管理员用户。可选。 + - 描述：列出所有现有用户。 + - 示例： + - `gitea admin user list` + - `delete`： + - 选项： + - `--email`：要删除的用户的电子邮件。 + - `--username`：要删除的用户的用户名。 + - `--id`：要删除的用户的 ID。 + - 必须提供 `--id`、`--username` 或 `--email` 中的一个。如果提供多个，则所有条件必须匹配。 + - 示例： + - `gitea admin user delete --id 1` + - `create`： + - 选项： + - `--name value`：用户名。必填。自 Gitea 1.9.0 版本起，请改用 `--username` 标志。 + - `--username value`：用户名。必填。Gitea 1.9.0 新增。 + - `--password value`：密码。必填。 + - `--email value`：邮箱。必填。 + - `--admin`：如果提供此选项，将创建一个管理员用户。可选。 + - `--access-token`：如果提供，将为用户创建访问令牌。可选。（默认值：false）。 + - `--must-change-password`：如果提供，创建的用户将在初始登录后需要选择一个新密码。可选。（默认值：true）。 + - `--random-password`：如果提供，将使用随机生成的密码作为创建用户的密码。`--password` 的值将被忽略。可选。 + - `--random-password-length`：如果提供，将用于配置随机生成密码的长度。可选。（默认值：12） + - 示例： + - `gitea admin user create --username myname --password asecurepassword --email me@example.com` + - `change-password`： + - 选项： + - `--username value`，`-u value`：用户名。必填。 + - `--password value`，`-p value`：新密码。必填。 + - 示例： + - `gitea admin user change-password --username myname --password asecurepassword` + - `must-change-password`： + - 参数： + - `[username...]`：需要更改密码的用户 + - 选项： + - `--all`，`-A`：强制所有用户更改密码 + - `--exclude username`，`-e username`：排除给定的用户。可以多次设置。 + - `--unset`：撤销对给定用户的强制密码更改 + - `regenerate`： + - 选项： + - `hooks`：重新生成所有仓库的 Git Hooks。 + - `keys`：重新生成 authorized_keys 文件。 + - 示例： + - `gitea admin regenerate hooks` + - `gitea admin regenerate keys` + - `auth`： + - `list`： + - 描述：列出所有存在的外部认证源。 + - 示例： + - `gitea admin auth list` + - `delete`： + - 选项： + - `--id`：要删除的源的 ID。必填。 + - 示例： + - `gitea admin auth delete --id 1` + - `add-oauth`： + - 选项： + - `--name`：应用程序名称。 + - `--provider`：OAuth2 提供者。 + - `--key`：客户端 ID（Key）。 + - `--secret`：客户端密钥。 + - `--auto-discover-url`：OpenID Connect 自动发现 URL（仅在使用 OpenID Connect 作为提供程序时需要）。 + - `--use-custom-urls`：在 GitLab/GitHub OAuth 端点上使用自定义 URL。 + - `--custom-tenant-id`：在 OAuth 端点上使用自定义租户 ID。 + - `--custom-auth-url`：使用自定义授权 URL（GitLab/GitHub 的选项）。 + - `--custom-token-url`：使用自定义令牌 URL（GitLab/GitHub 的选项）。 + - `--custom-profile-url`：使用自定义配置文件 URL（GitLab/GitHub 的选项）。 + - `--custom-email-url`：使用自定义电子邮件 URL（GitHub 的选项）。 + - `--icon-url`：OAuth2 登录源的自定义图标 URL。 + - `--skip-local-2fa`：允许源覆盖本地 2FA。（可选） + - `--scopes`：请求此 OAuth2 源的附加范围。（可选） + - `--required-claim-name`：必须设置的声明名称，以允许用户使用此源登录。（可选） + - `--required-claim-value`：必须设置的声明值，以允许用户使用此源登录。（可选） + - `--group-claim-name`：提供此源的组名的声明名称。（可选） + - `--admin-group`：管理员用户的组声明值。（可选） + - `--restricted-group`：受限用户的组声明值。（可选） + - `--group-team-map`：组与组织团队之间的 JSON 映射。（可选） + - `--group-team-map-removal`：根据组自动激活团队成员资格的删除。（可选） + - 示例： + - `gitea admin auth add-oauth --name external-github --provider github --key OBTAIN_FROM_SOURCE --secret OBTAIN_FROM_SOURCE` + - `update-oauth`： + - 选项： + - `--id`：要更新的源的 ID。必填。 + - `--name`：应用程序名称。 + - `--provider`：OAuth2 提供者。 + - `--key`：客户端 ID（Key）。 + - `--secret`：客户端密钥。 + - `--auto-discover-url`：OpenID Connect 自动发现 URL（仅在使用 OpenID Connect 作为提供程序时需要）。 + - `--use-custom-urls`：在 GitLab/GitHub OAuth 端点上使用自定义 URL。 + - `--custom-tenant-id`：在 OAuth 端点上使用自定义租户 ID。 + - `--custom-auth-url`：使用自定义授权 URL（GitLab/GitHub 的选项）。 + - `--custom-token-url`：使用自定义令牌 URL（GitLab/GitHub 的选项）。 + - `--custom-profile-url`：使用自定义配置文件 URL（GitLab/GitHub 的选项）。 + - `--custom-email-url`：使用自定义电子邮件 URL（GitHub 的选项）。 + - `--icon-url`：OAuth2 登录源的自定义图标 URL。 + - `--skip-local-2fa`：允许源覆盖本地 2FA。（可选） + - `--scopes`：请求此 OAuth2 源的附加范围。 + - `--required-claim-name`：必须设置的声明名称，以允许用户使用此源登录。（可选） + - `--required-claim-value`：必须设置的声明值，以允许用户使用此源登录。（可选） + - `--group-claim-name`：提供此源的组名的声明名称。（可选） + - `--admin-group`：管理员用户的组声明值。（可选） + - `--restricted-group`：受限用户的组声明值。（可选） + - 示例： + - `gitea admin auth update-oauth --id 1 --name external-github-updated` + - `add-smtp`： + - 选项： + - `--name`：应用程序名称。必填。 + - `--auth-type`：SMTP 认证类型（PLAIN/LOGIN/CRAM-MD5）。默认为 PLAIN。 + - `--host`：SMTP 主机。必填。 + - `--port`：SMTP 端口。必填。 + - `--force-smtps`：SMTPS 始终在端口 465 上使用。设置此选项以强制在其他端口上使用 SMTPS。 + - `--skip-verify`：跳过 TLS 验证。 + - `--helo-hostname`：发送 HELO 时使用的主机名。留空以发送当前主机名。 + - `--disable-helo`：禁用 SMTP helo。 + - `--allowed-domains`：留空以允许所有域。使用逗号（','）分隔多个域。 + - `--skip-local-2fa`：跳过 2FA 登录。 + - `--active`：启用此认证源。 + 备注： + `--force-smtps`、`--skip-verify`、`--disable-helo`、`--skip-local-2fs` 和 `--active` 选项可以采用以下形式使用： + - `--option`、`--option=true` 以启用选项 + - `--option=false` 以禁用选项 + 如果未指定这些选项，则在 `update-smtp` 中不会更改值，或者在 `add-smtp` 中将使用默认的 `false` 值。 + - 示例： + - `gitea admin auth add-smtp --name ldap --host smtp.mydomain.org --port 587 --skip-verify --active` + - `update-smtp`： + - 选项： + - `--id`：要更新的源的 ID。必填。 + - 其他选项与 `add-smtp` 共享 + - 示例： + - `gitea admin auth update-smtp --id 1 --host smtp.mydomain.org --port 587 --skip-verify=false` + - `gitea admin auth update-smtp --id 1 --active=false` + - `add-ldap`：添加新的 LDAP（通过 Bind DN）认证源 + - 选项： + - `--name value`：认证名称。必填。 + - `--not-active`：停用认证源。 + - `--security-protocol value`：安全协议名称。必填。 + - `--skip-tls-verify`：禁用 TLS 验证。 + - `--host value`：LDAP 服务器的地址。必填。 + - `--port value`：连接到 LDAP 服务器时使用的端口。必填。 + - `--user-search-base value`：用户帐户将在其中搜索的 LDAP 基础路径。必填。 + - `--user-filter value`：声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。必填。 + - `--admin-filter value`：指定是否应授予用户管理员特权的 LDAP 过滤器。 + - `--restricted-filter value`：指定是否应将用户设置为受限状态的 LDAP 过滤器。 + - `--username-attribute value`：用户 LDAP 记录中包含用户名的属性。 + - `--firstname-attribute value`：用户 LDAP 记录中包含用户名字的属性。 + - `--surname-attribute value`：用户 LDAP 记录中包含用户姓氏的属性。 + - `--email-attribute value`：用户 LDAP 记录中包含用户电子邮件地址的属性。必填。 + - `--public-ssh-key-attribute value`：用户 LDAP 记录中包含用户公共 SSH 密钥的属性。 + - `--avatar-attribute value`：用户 LDAP 记录中包含用户头像的属性。 + - `--bind-dn value`：在搜索用户时绑定到 LDAP 服务器的 DN。 + - `--bind-password value`：绑定 DN 的密码（如果有）。 + - `--attributes-in-bind`：在绑定 DN 上下文中获取属性。 + - `--synchronize-users`：启用用户同步。 + - `--page-size value`：搜索页面大小。 + - 示例： + - `gitea admin auth add-ldap --name ldap --security-protocol unencrypted --host mydomain.org --port 389 --user-search-base "ou=Users,dc=mydomain,dc=org" --user-filter "(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))" --email-attribute mail` + - `update-ldap`：更新现有的 LDAP（通过 Bind DN）认证源 + - 选项： + - `--id value`：认证源的 ID。必填。 + - `--name value`：认证名称。 + - `--not-active`：停用认证源。 + - `--security-protocol value`：安全协议名称。 + - `--skip-tls-verify`：禁用 TLS 验证。 + - `--host value`：LDAP 服务器的地址。 + - `--port value`：连接到 LDAP 服务器时使用的端口。 + - `--user-search-base value`：用户帐户将在其中搜索的 LDAP 基础路径。 + - `--user-filter value`：声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。 + - `--admin-filter value`：指定是否应授予用户管理员特权的 LDAP 过滤器。 + - `--restricted-filter value`：指定是否应将用户设置为受限状态的 LDAP 过滤器。 + - `--username-attribute value`：用户 LDAP 记录中包含用户名的属性。 + - `--firstname-attribute value`：用户 LDAP 记录中包含用户名字的属性。 + - `--surname-attribute value`：用户 LDAP 记录中包含用户姓氏的属性。 + - `--email-attribute value`：用户 LDAP 记录中包含用户电子邮件地址的属性。 + - `--public-ssh-key-attribute value`：用户 LDAP 记录中包含用户公共 SSH 密钥的属性。 + - `--avatar-attribute value`：用户 LDAP 记录中包含用户头像的属性。 + - `--bind-dn value`：在搜索用户时绑定到 LDAP 服务器的 DN。 + - `--bind-password value`：绑定 DN 的密码（如果有）。 + - `--attributes-in-bind`：在绑定 DN 上下文中获取属性。 + - `--synchronize-users`：启用用户同步。 + - `--page-size value`：搜索页面大小。 + - 示例： + - `gitea admin auth update-ldap --id 1 --name "my ldap auth source"` + - `gitea admin auth update-ldap --id 1 --username-attribute uid --firstname-attribute givenName --surname-attribute sn` + - `add-ldap-simple`：添加新的 LDAP（简单身份验证）认证源 + - 选项： + - `--name value`：认证名称。必填。 + - `--not-active`：停用认证源。 + - `--security-protocol value`：安全协议名称。必填。 + - `--skip-tls-verify`：禁用 TLS 验证。 + - `--host value`：LDAP 服务器的地址。必填。 + - `--port value`：连接到 LDAP 服务器时使用的端口。必填。 + - `--user-search-base value`：用户帐户将在其中搜索的 LDAP 基础路径。 + - `--user-filter value`：声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。必填。 + - `--admin-filter value`：指定是否应授予用户管理员特权的 LDAP 过滤器。 + - `--restricted-filter value`：指定是否应将用户设置为受限状态的 LDAP 过滤器。 + - `--username-attribute value`：用户 LDAP 记录中包含用户名的属性。 + - `--firstname-attribute value`：用户 LDAP 记录中包含用户名字的属性。 + - `--surname-attribute value`：用户 LDAP 记录中包含用户姓氏的属性。 + - `--email-attribute value`：用户 LDAP 记录中包含用户电子邮件地址的属性。必填。 + - `--public-ssh-key-attribute value`：用户 LDAP 记录中包含用户公共 SSH 密钥的属性。 + - `--avatar-attribute value`：用户 LDAP 记录中包含用户头像的属性。 + - `--user-dn value`：用户的 DN。必填。 + - 示例： + - `gitea admin auth add-ldap-simple --name ldap --security-protocol unencrypted --host mydomain.org --port 389 --user-dn "cn=%s,ou=Users,dc=mydomain,dc=org" --user-filter "(&(objectClass=posixAccount)(cn=%s))" --email-attribute mail` + - `update-ldap-simple`：更新现有的 LDAP（简单身份验证）认证源 + - 选项： + - `--id value`：认证源的 ID。必填。 + - `--name value`：认证名称。 + - `--not-active`：停用认证源。 + - `--security-protocol value`：安全协议名称。 + - `--skip-tls-verify`：禁用 TLS 验证。 + - `--host value`：LDAP 服务器的地址。 + - `--port value`：连接到 LDAP 服务器时使用的端口。 + - `--user-search-base value`：用户帐户将在其中搜索的 LDAP 基础路径。 + - `--user-filter value`：声明如何查找试图进行身份验证的用户记录的 LDAP 过滤器。 + - `--admin-filter value`：指定是否应授予用户管理员特权的 LDAP 过滤器。 + - `--restricted-filter value`：指定是否应将用户设置为受限状态的 LDAP 过滤器。 + - `--username-attribute value`：用户 LDAP 记录中包含用户名的属性。 + - `--firstname-attribute value`：用户 LDAP 记录中包含用户名字的属性。 + - `--surname-attribute value`：用户 LDAP 记录中包含用户姓氏的属性。 + - `--email-attribute value`：用户 LDAP 记录中包含用户电子邮件地址的属性。 + - `--public-ssh-key-attribute value`：用户 LDAP 记录中包含用户公共 SSH 密钥的属性。 + - `--avatar-attribute value`：用户 LDAP 记录中包含用户头像的属性。 + - `--user-dn value`：用户的 DN。 + - 示例： + - `gitea admin auth update-ldap-simple --id 1 --name "my ldap auth source"` + - `gitea admin auth update-ldap-simple --id 1 --username-attribute uid --firstname-attribute givenName --surname-attribute sn` + +### cert + +生成自签名的 SSL 证书。将输出到当前目录下的`cert.pem`和`key.pem`文件中，并且会覆盖任何现有文件。 + +- 选项： + - `--host value`：逗号分隔的主机名和 IP 地址列表，此证书适用于这些主机。支持使用通配符。必填。 + - `--ecdsa-curve value`：用于生成密钥的 ECDSA 曲线。可选。有效选项为 P224、P256、P384、P521。 + - `--rsa-bits value`：要生成的 RSA 密钥的大小。可选。如果设置了--ecdsa-curve，则忽略此选项。（默认值：3072）。 + - `--start-date value`：证书的创建日期。可选。（格式：`Jan 1 15:04:05 2011`）。 + - `--duration value`：证书有效期。可选。（默认值：8760h0m0s） + - `--ca`：如果提供此选项，则证书将生成自己的证书颁发机构。可选。 +- 示例： + - `gitea cert --host git.example.com,example.com,www.example.com --ca` + +### dump + +将所有文件和数据库导出到一个 zip 文件中。输出文件将保存在当前目录下，类似于`gitea-dump-1482906742.zip`。 + +- 选项： + - `--file name`，`-f name`：指定要创建的导出文件的名称。可选。（默认值：gitea-dump-[timestamp].zip）。 + - `--tempdir path`，`-t path`：指定临时目录的路径。可选。（默认值：/tmp）。 + - `--skip-repository`，`-R`：跳过仓库的导出。可选。 + - `--skip-custom-dir`：跳过自定义目录的导出。可选。 + - `--skip-lfs-data`：跳过 LFS 数据的导出。可选。 + - `--skip-attachment-data`：跳过附件数据的导出。可选。 + - `--skip-package-data`：跳过包数据的导出。可选。 + - `--skip-log`：跳过日志数据的导出。可选。 + - `--database`，`-d`：指定数据库的 SQL 语法。可选。 + - `--verbose`，`-V`：如果提供此选项，显示附加详细信息。可选。 + - `--type`：设置导出的格式。可选。（默认值：zip） +- 示例： + - `gitea dump` + - `gitea dump --verbose` + +### generate + +用于在配置文件中生成随机值和令牌。对于自动部署时生成值非常有用。 + +- 命令: + - `secret`: + - 选项: + - `INTERNAL_TOKEN`: 用于内部 API 调用身份验证的令牌。 + - `JWT_SECRET`: 用于 LFS 和 OAUTH2 JWT 身份验证的密钥（LFS_JWT_SECRET 是此选项的别名，用于向后兼容）。 + - `SECRET_KEY`: 全局密钥。 + - 示例: + - `gitea generate secret INTERNAL_TOKEN` + - `gitea generate secret JWT_SECRET` + - `gitea generate secret SECRET_KEY` + +### keys + +提供一个 SSHD AuthorizedKeysCommand。需要在 sshd 配置文件中进行配置: + +```ini +... +# -e 的值和 AuthorizedKeysCommandUser 应与运行 Gitea 的用户名匹配 +AuthorizedKeysCommandUser git +AuthorizedKeysCommand /path/to/gitea keys -e git -u %u -t %t -k %k +``` + +该命令将返回适用于提供的密钥的合适 authorized_keys 行。您还应在 `app.ini` 的 `[server]` 部分设置值 `SSH_CREATE_AUTHORIZED_KEYS_FILE=false`。 + +注意: opensshd 要求 Gitea 程序由 root 拥有，并且不可由组或其他人写入。程序必须使用绝对路径指定。 +注意: Gitea 必须在运行此命令时处于运行状态才能成功。 + +### migrate + +迁移数据库。该命令可用于在首次启动服务器之前运行其他命令。此命令是幂等的。 + +### doctor check + +对 Gitea 实例进行诊断，可以修复一些可修复的问题。 +默认只运行部分检查，额外的检查可以参考： + +- `gitea doctor check --list` - 列出所有可用的检查 +- `gitea doctor check --all` - 运行所有可用的检查 +- `gitea doctor check --default` - 运行默认的检查 +- `gitea doctor check --run [check(s),]...` - 运行指定的名字的检查 + +有些问题可以通过设置 `--fix` 选项进行自动修复。 +额外的日志可以通过 `--log-file=...` 进行设置。 + +#### doctor recreate-table + +有时，在迁移时，旧的列和默认值可能会在数据库模式中保持不变。这可能会导致警告，如下所示: + +``` +2020/08/02 11:32:29 ...rm/session_schema.go:360:Sync() [W] Table user Column keep_activity_private db default is , struct default is 0 +``` + +您可以通过以下方式让 Gitea 重新创建这些表，并将旧数据复制到新表中，并适当设置默认值： + +``` +gitea doctor recreate-table user +``` + +您可以使用以下方式让 Gitea 重新创建多个表： + +``` +gitea doctor recreate-table table1 table2 ... +``` + +如果您希望 Gitea 重新创建所有表，请直接调用： + +``` +gitea doctor recreate-table +``` + +强烈建议在运行这些命令之前备份您的数据库。 + +### doctor convert + +将现有的 MySQL 数据库从 utf8 转换为 utf8mb4，或者把 MSSQL 数据库从 varchar 转换为 nvarchar。 + +### manager + +管理运行中的服务器操作： + +- 命令: + - `shutdown`: 优雅地关闭运行中的进程 + - `restart`: 优雅地重新启动运行中的进程（对于 Windows 服务器尚未实现） + - `flush-queues`: 刷新运行中的进程中的队列 + - 选项: + - `--timeout value`: 刷新过程的超时时间（默认值: 1m0s） + - `--non-blocking`: 设置为 true，以在返回之前不等待刷新完成 + - `logging`: 调整日志命令 + - 命令: + - `pause`: 暂停日志记录 + - 注意: + - 如果日志级别低于此级别，日志级别将被临时提升为 INFO。 + - Gitea 将在一定程度上缓冲日志，并在超过该点后丢弃日志。 + - `resume`: 恢复日志记录 + - `release-and-reopen`: 使 Gitea 释放和重新打开用于日志记录的文件和连接（相当于向 Gitea 发送 SIGUSR1 信号）。 + - `remove name`: 删除指定的日志记录器 + - 选项: + - `--group group`, `-g group`: 从中删除子记录器的组（默认为`default`） + - `add`: 添加日志记录器 + - 命令: + - `console`: 添加控制台日志记录器 + - 选项: + - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" + - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 + - `--level value`, `-l value`: 新日志记录器的日志级别 + - `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别 + - `--flags value`, `-F value`: 日志记录器的标志 + - `--expression value`, `-e value`: 日志记录器的匹配表达式 + - `--prefix value`, `-p value`: 日志记录器的前缀 + - `--color`: 在日志中使用颜色 + - `--stderr`: 将控制台日志输出到 stderr - 仅适用于控制台 + - `file`: 添加文件日志记录器 + - 选项: + - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" + - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 + - `--level value`, `-l value`: 新日志记录器的日志级别 + - `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别 + - `--flags value`, `-F value`: 日志记录器的标志 + - `--expression value`, `-e value`: 日志记录器的匹配表达式 + - `--prefix value`, `-p value`: 日志记录器的前缀 + - `--color`: 在日志中使用颜色 + - `--filename value`, `-f value`: 日志记录器的文件名 + - `--rotate`, `-r`: 轮转日志 + - `--max-size value`, `-s value`: 在轮转之前的最大大小（以字节为单位） + - `--daily`, `-d`: 每天轮转日志 + - `--max-days value`, `-D value`: 保留的每日日志的最大数量 + - `--compress`, `-z`: 压缩轮转的日志 + - `--compression-level value`, `-Z value`: 使用的压缩级别 + - `conn`: 添加网络连接日志记录器 + - 选项: + - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" + - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 + - `--level value`, `-l value`: 新日志记录器的日志级别 + - `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别 + - `--flags value`, `-F value`: 日志记录器的标志 + - `--expression value`, `-e value`: 日志记录器的匹配表达式 + - `--prefix value`, `-p value`: 日志记录器的前缀 + - `--color`: 在日志中使用颜色 + - `--reconnect-on-message`, `-R`: 对于每个消息重新连接主机 + - `--reconnect`, `-r`: 连接中断时重新连接主机 + - `--protocol value`, `-P value`: 设置要使用的协议：tcp、unix 或 udp（默认为 tcp） + - `--address value`, `-a value`: 要连接到的主机地址和端口（默认为:7020） + - `smtp`: 添加 SMTP 日志记录器 + - 选项: + - `--group value`, `-g value`: 要添加日志记录器的组 - 默认为"default" + - `--name value`, `-n value`: 新日志记录器的名称 - 默认为模式 + - `--level value`, `-l value`: 新日志记录器的日志级别 + - `--stacktrace-level value`, `-L value`: 堆栈跟踪日志级别 + - `--flags value`, `-F value`: 日志记录器的标志 + - `--expression value`, `-e value`: 日志记录器的匹配表达式 + - `--prefix value`, `-p value`: 日志记录器的前缀 + - `--color`: 在日志中使用颜色 + - `--username value`, `-u value`: 邮件服务器用户名 + - `--password value`, `-P value`: 邮件服务器密码 + - `--host value`, `-H value`: 邮件服务器主机（默认为: 127.0.0.1:25） + - `--send-to value`, `-s value`: 要发送到的电子邮件地址 + - `--subject value`, `-S value`: 发送电子邮件的主题标题 + - `processes`: 显示 Gitea 进程和 Goroutine 信息 + - 选项: + - `--flat`: 以平面表格形式显示进程，而不是树形结构 + - `--no-system`: 不显示系统进程 + - `--stacktraces`: 显示与进程关联的 Goroutine 的堆栈跟踪 + - `--json`: 输出为 JSON 格式 + - `--cancel PID`: 向具有 PID 的进程发送取消命令（仅适用于非系统进程） + +### dump-repo + +`dump-repo` 从 Git/GitHub/Gitea/GitLab 中转储存储库数据： + +- 选项： + - `--git_service service`：Git 服务，可以是 `git`、`github`、`gitea`、`gitlab`。如果 `clone_addr` 可以被识别，则可以忽略此选项。 + - `--repo_dir dir`，`-r dir`：存储数据的存储库目录路径。 + - `--clone_addr addr`：将被克隆的 URL，目前可以是 git/github/gitea/gitlab 的 http/https URL。例如：https://github.com/lunny/tango.git + - `--auth_username lunny`：访问 `clone_addr` 的用户名。 + - `--auth_password `：访问 `clone_addr` 的密码。 + - `--auth_token `：访问 `clone_addr` 的个人令牌。 + - `--owner_name lunny`：如果非空，数据将存储在具有所有者名称的目录中。 + - `--repo_name tango`：如果非空，数据将存储在具有存储库名称的目录中。 + - `--units `：要迁移的项目，一个或多个项目应以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果为空，则表示所有项目。 + +### restore-repo + +`restore-repo` 从磁盘目录中还原存储库数据： + +- 选项： + - `--repo_dir dir`，`-r dir`：还原数据的存储库目录路径。 + - `--owner_name lunny`：还原目标所有者名称。 + - `--repo_name tango`：还原目标存储库名称。 + - `--units `：要还原的项目，一个或多个项目应以逗号分隔。允许的项目有 wiki, issues, labels, releases, release_assets, milestones, pull_requests, comments。如果为空，则表示所有项目。 + +### actions generate-runner-token + +生成一个供 Runner 使用的新令牌，用于向服务器注册。 + +- 选项： + - `--scope {owner}[/{repo}]`，`-s {owner}[/{repo}]`：限制 Runner 的范围，没有范围表示该 Runner 可用于所有仓库，但你也可以将其限制为特定的仓库或所有者。 + +要注册全局 Runner： + +``` +gitea actions generate-runner-token +``` + +要注册特定组织的 Runner，例如 `org`： + +``` +gitea actions generate-runner-token -s org +``` + +要注册特定仓库的 Runner，例如 `username/test-repo`： + +``` +gitea actions generate-runner-token -s username/test-repo +``` diff --git a/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md new file mode 100644 index 00000000..c7239dc0 --- /dev/null +++ b/i18n/zh-tw/docusaurus-plugin-content-docs/current/administration/config-cheat-sheet.md @@ -0,0 +1,1380 @@ +--- +date: "2016-12-26T16:00:00+02:00" +slug: "config-cheat-sheet" +sidebar_position: 30 + +aliases: + - /zh-tw/config-cheat-sheet +--- + +# 配置说明 + +这是针对 Gitea 配置文件的说明， +你可以了解 Gitea 的强大配置。 + +需要说明的是，你的所有改变请修改 `custom/conf/app.ini` 文件而不是源文件。 +如果是从发行版本完成的安装， +配置文件的路径为`/etc/gitea/conf/app.ini`。 + +所有默认值可以通过 [app.example.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini) 查看到。 +标注了 :exclamation: 的配置项表明除非你真的理解这个配置项的意义，否则最好使用默认值。 + +包含`#`或者`;`的变量必须使用引号( `` ` `` 或者 `"` )包裹，否则会被解析为注释。 + +本文档使用以下约定： + +- `[section].FOO_BAR` 或 `[section]FOO_BAR`: 一个位于 INI 文件 `[section]` 段中的配置项。 +- `FooBar`: 这是一个 Gitea 内部变量，不是一个配置项，仅用于描述相关逻辑。 +- `$FOO_BAR`: 这是一个环境变量，Gitea 可能会使用它的值，但是它不能直接用于配置文件中。 +- `{FOO_BAR}/something` 或 `{FooBar}/something`: 这个值会默认使用配置项 `FOO_BAR` 或者内部变量 `FooBar`。 + +**注意:** 修改完配置文件后，需要重启 Gitea 服务才能生效。 + +## 使用环境变量配置 Gitea + +我们提供了 [environment-to-ini](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini) 工具 +来帮助通过环境变量生成 Gitea 的 `app.ini` 配置文件。 + +## 默认配置 (非`app.ini`配置文件) + +这些值取决于环境，但构成了许多值的基础。当运行 `gitea help`或启动时，它们将 +作为默认配置的一部分进行报告。它们在那里发出的顺序略有不同，但我们将按照设置的顺序在这里列出。 + +- _`AppPath`_: Gitea 二进制可执行文件的绝对路径 +- _`AppWorkPath`_: Gitea 可执行文件的工作目录。 该配置可以通过以下几种方式设置，优先级依次递减: + - `app.ini`中的`WORK_PATH`配置项 + - 启动 Gitea 时的`--work-path`命令行参数 + - `$GITEA_WORK_DIR`环境变量 + - 在编译时设置的内置值（参见从源代码编译） + - 默认为 _`AppPath`_ 的目录 + - 如果上述任何路径为相对路径，将自动解析为相对于 _`AppPath`_ 目录的绝对路径 +- _`CustomPath`_: 这是用于自定义模板和其他选项的基础目录。 + 它是通过使用以下层次结构中的第一个设置的内容来确定的： + - 通过传递给二进制文件的`--custom-path`标志 + - 环境变量 `$GITEA_CUSTOM` + - 在构建时设置的内置值（参见从源代码构建） + - 否则，默认为 _`AppWorkPath`_`/custom` + - 如果上述任何路径是相对路径，则会相对于 _`AppWorkPath`_ 目录进行处理， + 使其变为绝对路径。 +- _`CustomConf`_: 这是指向`app.ini`文件的路径。 + - 这是指向`app.ini`文件的路径。 + - 在构建时设置的内置值（参见从源代码构建） + - 否则，默认为 _`CustomPath`_`/conf/app.ini` + - 如果上述任何路径是相对路径，则会相对于*`CustomPath`*目录进行处理。 + +此外，还有*`StaticRootPath`*，可以在构建时设置为内置值，否则将默认为 _`AppWorkPath`_。 + +## Overall (`DEFAULT`) + +- `APP_NAME`: **Gitea: Git with a cup of tea** 应用名称，在网页的标题中显示。 +- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: 运行 Gitea 的用户， + 应当是一个专用的系统账户(非用户使用，推荐创建一个专用的`git`用户). 如果在你自己的个人电脑使用改成你自己的用户名。 + 该配置如果设置不正确，Gitea 可能崩溃。 +- `RUN_MODE`: **prod**: 应用的运行模式，对运行性能和问题排除有影响: `dev` 或者 `prod`,默认为 `prod`。 `dev`模式有助于开发和问题排查, 除设置为`dev` 外，均被视为 `prod`. +- `WORK_PATH`: **_the-work-path_**: 工作目录, 前文有提及. + +## 仓库 (`repository`) + +- `ROOT`: **`{APP_DATA_PATH}/gitea-repositories`**: 存放 git 工程的根目录，建议填绝对路径。 + 相对路径将被解析为**`{AppWorkPath}/{ROOT}`**. +- `SCRIPT_TYPE`: **bash**: 服务器支持的 Shell 类型，通常是`bash`， + 但有些服务器也有可能是`sh`。 +- `DETECTED_CHARSETS_ORDER`: **UTF-8, UTF-16BE, UTF-16LE, UTF-32BE, UTF-32LE, ISO-8859, windows-1252, ISO-8859, windows-1250, ISO-8859, ISO-8859, ISO-8859, windows-1253, ISO-8859, windows-1255, ISO-8859, windows-1251, windows-1256, KOI8-R, ISO-8859, windows-1254, Shift_JIS, GB18030, EUC-JP, EUC-KR, Big5, ISO-2022, ISO-2022, ISO-2022, IBM424_rtl, IBM424_ltr, IBM420_rtl, IBM420_ltr**: 检测到的字符集的决定性顺序 - 如果检测到的字符集具有相等的置信度，则优先选择列表中较早出现的字符集，而不是较晚出现的字符集。添加“defaults”将会将未命名的字符集放置在该点。 +- `ANSI_CHARSET`: **_empty_**: 默认的 ANSI 字符集，用于覆盖非 UTF-8 字符集。 +- `FORCE_PRIVATE`: **false**: 强制使每个新仓库变为私有。 +- `DEFAULT_PRIVATE`: **last**: 创建新仓库时默认为私有：`last`, `private`, `public`。 +- `DEFAULT_PUSH_CREATE_PRIVATE`: **true**: 使用推送创建新仓库时默认为私有。 +- `MAX_CREATION_LIMIT`: **-1**: 每个用户的全局仓库创建上限, + `-1` 代表无限制. +- `PREFERRED_LICENSES`: **Apache License 2.0,MIT License**: 要放置在列表顶部的指定许可证。 + 名称必须与 options/license 或 custom/options/license 中的文件名匹配。 +- `DISABLE_HTTP_GIT`: **false**: 禁用 HTTP 协议与仓库进行 + 交互的能力。 +- `USE_COMPAT_SSH_URI`: **false**: 当使用默认的 SSH 端口时，强制使用 ssh://克隆 URL， + 而不是 scp-style uri。 +- `GO_GET_CLONE_URL_PROTOCOL`: **https**: 用于 "go get" 请求的值，返回仓库的 URL 作为 https 或 ssh， + 默认为 https。 +- `ACCESS_CONTROL_ALLOW_ORIGIN`: **_empty_**:用于 Access-Control-Allow-Origin 标头的值， + 默认不提供。 + 警告：如果您不提供正确的值，这可能对您的网站造成危害。 +- `DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH`: **false**: 如果非默认分支上的提交将问题标记为已关闭，则关闭该问题。 +- `ENABLE_PUSH_CREATE_USER`: **false**: 允许用户将本地存储库推送到 Gitea，并为用户自动创建它们。 +- `ENABLE_PUSH_CREATE_ORG`: **false**: 允许用户将本地存储库推送到 Gitea，并为组织自动创建它们。 +- `DISABLED_REPO_UNITS`: **_empty_**: 逗号分隔的全局禁用的仓库单元列表。允许的值是：: \[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,repo.actions**: 逗号分隔的默认新仓库单元列表。允许的值是：: \[repo.code, repo.releases, repo.issues, repo.pulls, repo.wiki, repo.projects, repo.packages, repo.actions\]. 注意：目前无法停用代码和发布。如果您指定了默认的仓库单元，您仍应将它们列出以保持未来的兼容性。外部 wiki 和问题跟踪器不能默认启用，因为它需要额外的设置。禁用的仓库单元将不会添加到新的仓库中，无论它是否在默认列表中。 +- `DEFAULT_FORK_REPO_UNITS`: **repo.code,repo.pulls**: 逗号分隔的默认分叉仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 +- `DEFAULT_MIRROR_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认镜像仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 +- `DEFAULT_TEMPLATE_REPO_UNITS`: **repo.code,repo.releases,repo.issues,repo.pulls,repo.wiki,repo.projects,repo.packages**: 逗号分隔的默认模板仓库单元列表。允许的值和规则与`DEFAULT_REPO_UNITS`相同。 +- `PREFIX_ARCHIVE_FILES`: **true**: 通过将存档文件放置在以仓库命名的目录中来添加前缀。 +- `DISABLE_MIGRATIONS`: **false**: 禁用迁移功能。 +- `DISABLE_STARS`: **false**: 禁用点赞功能。 +- `DEFAULT_BRANCH`: **main**: 所有仓库的默认分支名称。 +- `ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`: **false**: 允许非管理员用户认领未被认领的仓库。 +- `ALLOW_DELETION_OF_UNADOPTED_REPOSITORIES`: **false**: 允许非管理员用户删除未被认领的仓库。 +- `DISABLE_DOWNLOAD_SOURCE_ARCHIVES`: **false**: 不允许从用户界面下载源代码存档文件。 +- `ALLOW_FORK_WITHOUT_MAXIMUM_LIMIT`: **true**: 允许无限制得派生仓库。 + +### 仓库 - 编辑器 (`repository.editor`) + +- `LINE_WRAP_EXTENSIONS`: **.txt,.md,.markdown,.mdown,.mkd,.livemd,**: 在 Monaco 编辑器中应该换行的文件扩展名列表。用逗号分隔扩展名。要对没有扩展名的文件进行换行，只需放置一个逗号。 +- `PREVIEWABLE_FILE_MODES`: **markdown**: 具有预览 API 的有效文件模式，例如 `api/v1/markdown`。用逗号分隔各个值。如果文件扩展名不匹配，编辑模式下的预览选项卡将不会显示。 + +### 仓库 - 合并请求 (`repository.pull-request`) + +- `WORK_IN_PROGRESS_PREFIXES`: **WIP:,\[WIP\]**: 在拉取请求标题中用于标记工作正在进行中的前缀列表。 + 这些前缀在不区分大小写的情况下进行匹配。 +- `CLOSE_KEYWORDS`: **close**, **closes**, **closed**, **fix**, **fixes**, **fixed**, **resolve**, **resolves**, **resolved**: 在拉取请求评论中用于自动关闭相关问题的关键词列表。 +- `REOPEN_KEYWORDS`: **reopen**, **reopens**, **reopened**: 在拉取请求评论中用于自动重新打开相关问题的 + 关键词列表。 +- `DEFAULT_MERGE_STYLE`: **merge**: 设置创建仓库的默认合并方式，可选: `merge`, `rebase`, `rebase-merge`, `squash`, `fast-forward-only` +- `DEFAULT_MERGE_MESSAGE_COMMITS_LIMIT`: **50**: 在默认合并消息中，对于`squash`提交，最多包括此数量的提交。设置为 -1 以包括所有提交。 +- `DEFAULT_MERGE_MESSAGE_SIZE`: **5120**: 在默认的合并消息中，对于`squash`提交，限制提交消息的大小。设置为 `-1`以取消限制。仅在`POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`为`true`时使用。 +- `DEFAULT_MERGE_MESSAGE_ALL_AUTHORS`: **false**: 在默认合并消息中，对于`squash`提交，遍历所有提交以包括所有作者的`Co-authored-by`，否则仅使用限定列表中的作者。 +- `DEFAULT_MERGE_MESSAGE_MAX_APPROVERS`: **10**:在默认合并消息中，限制列出的审批者数量为`Reviewed-by`:。设置为 `-1` 以包括所有审批者。 +- `DEFAULT_MERGE_MESSAGE_OFFICIAL_APPROVERS_ONLY`: **true**: 在默认合并消息中，仅包括官方允许审查的审批者。 +- `POPULATE_SQUASH_COMMENT_WITH_COMMIT_MESSAGES`: **false**: 在默认的 squash 合并消息中，包括构成拉取请求的所有提交的提交消息。 +- `ADD_CO_COMMITTER_TRAILERS`: **true**: 如果提交者与作者不匹配，在合并提交消息中添加`co-authored-by`和`co-committed-by`标记。 +- `TEST_CONFLICTING_PATCHES_WITH_GIT_APPLY`:使用三方合并方法测试`PR Patch`以发现是否存在冲突。如果此设置`true`，将使用`git apply`重新测试冲突的`PR Pathch` - 这是 1.18（和之前版本）中的先前行为，但效率相对较低。如果发现需要此设置，请报告。 + +### 仓库 - 工单 (`repository.issue`) + +- `LOCK_REASONS`: **Too heated,Off-topic,Resolved,Spam**: 合并请求或工单被锁定的原因列表。 +- `MAX_PINNED`: **3**: 每个仓库的最大可固定工单数量。设置为 0 禁用固定工单。 + +### 仓库 - 文件上传 (`repository.upload`) + +- `ENABLED`: **true**: 是否启用仓库文件上传。 +- `TEMP_PATH`: **data/tmp/uploads**: 文件上传的临时保存路径(在 Gitea 重启的时候该目录会被清空)。 +- `ALLOWED_TYPES`: **_empty_**: 以逗号分割的列表，代表支持上传的文件类型。(`.zip`), mime 类型 (`text/plain`) or 通配符类型 (`image/*`, `audio/*`, `video/*`). 为空或者 `*/*`代表允许所有类型文件。 +- `FILE_MAX_SIZE`: **50**: 每个文件的最大大小(MB)。 +- `MAX_FILES`: **5**: 每次上传的最大文件数。 + +### 仓库 - 版本发布 (`repository.release`) + +- `ALLOWED_TYPES`: **_empty_**: 允许发布的文件类型列表，用逗号分隔 。如压缩包类型(`.zip`), mime 类型 (`text/plain`) ，也支持通配符 (`image/*`, `audio/*`, `video/*`)。 空值或者 `*/*` 代表允许所有类型。 +- `DEFAULT_PAGING_NUM`: **10**: 默认的发布版本页面分页大小 +- 关于版本发布相关的附件设置，详见`附件`部分。 + +### 仓库 - Signing (`repository.signing`) + +- `SIGNING_KEY`: **default**: \[none, KEYID, default \]: 用于签名的密钥 +- `SIGNING_NAME` & `SIGNING_EMAIL`: 如果`SIGNING_KEY`提供了一个 KEYID，将使用这些作为签名者的姓名和电子邮件地址。这些应与密钥的公开姓名和电子邮件地址相匹配。 +- `INITIAL_COMMIT`: **always**: \[never, pubkey, twofa, always\]: 签名初始提交。 + - `never`: 永不签名 + - `pubkey`: 仅在用户具有公钥时签名 + - `twofa`: 仅在用户使用双因素身份验证登录时签名 + - `always`: 始终签名 + - 除了 never 和 always 之外的选项可以组合为逗号分隔的列表。 +- `DEFAULT_TRUST_MODEL`: **collaborator**: \[collaborator, committer, collaboratorcommitter\]: 用于验证提交的默认信任模型。 + - `collaborator`: 信任协作者密钥签名的签名。 + - `committer`: 信任与提交者匹配的签名（这与 GitHub 匹配，并会强制 Gitea 签名的提交具有 Gitea 作为提交者）。 + - `collaboratorcommitter`: 信任与提交者匹配的协作者密钥签名的签名。 +- `WIKI`: **never**: \[never, pubkey, twofa, always, parentsigned\]: 对 wiki 提交进行签名。 +- `CRUD_ACTIONS`: **pubkey, twofa, parentsigned**: \[never, pubkey, twofa, parentsigned, always\]: 对 CRUD 操作进行签名。 + - 与上面相同的选项，增加了： + - `parentsigned`: 仅在父提交进行了签名时才进行签名。 +- `MERGES`: **pubkey, twofa, basesigned, commitssigned**: \[never, pubkey, twofa, approved, basesigned, commitssigned, always\]: 对合并操作进行签名。 + - `approved`: 仅对已批准的合并操作进行签名，适用于受保护的分支。 + - `basesigned`: 仅在基础仓库的父提交进行了签名时才进行签名。 + - `headsigned`: 仅在头分支的头提交进行了签名时才进行签名。 + - `commitssigned`: 仅在头分支中的所有提交到合并点都进行了签名时才进行签名。 + +### 仓库 - Local (`repository.local`) + +- `LOCAL_COPY_PATH`: **tmp/local-repo**:临时本地仓库副本的路径。默认为 tmp/local-repo（内容在 Gitea 重新启动时被删除） + +### 仓库 - MIME type mapping (`repository.mimetype_mapping`) + +配置用于根据可下载文件的文件扩展名设置预期的 MIME 类型。配置以键值对的形式呈现，文件扩展名以`.`开头。 + +以下配置在下载具有`.apk`文件扩展名的文件时设置`Content-Type: application/vnd.android.package-archive`头部。 + +```ini +.apk=application/vnd.android.package-archive +``` + +## 跨域 (`cors`) + +- `ENABLED`: **false**: 启用 CORS 头部（默认禁用） +- `ALLOW_DOMAIN`: **\***: 允许请求的域名列表 +- `METHODS`: **GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS**: 允许发起的请求方式列表 +- `MAX_AGE`: **10m**: 缓存响应的最大时间 +- `ALLOW_CREDENTIALS`: **false**: 允许带有凭据的请求 +- `HEADERS`: **Content-Type,User-Agent**: 允许请求携带的头部 +- `X_FRAME_OPTIONS`: **SAMEORIGIN**: 详见 `X-Frame-Options`HTTP 头部. + +## 界面 (`ui`) + +- `EXPLORE_PAGING_NUM`: **20**: 探索页面每页显示的仓库数量。 +- `ISSUE_PAGING_NUM`: **20**: 工单页面每页显示的工单数量。 +- `MEMBERS_PAGING_NUM`: **20**: 组织成员页面每页显示的成员数量。 +- `FEED_MAX_COMMIT_NUM`: **5**: 活动流页面显示的最大提交数量。 +- `FEED_PAGING_NUM`: **20**: 活动流页面显示的最大活动数量。 +- `SITEMAP_PAGING_NUM`: **20**: 在单个子 SiteMap 中显示的项数。 +- `GRAPH_MAX_COMMIT_NUM`: **100**: 提交图中显示的最大 commit 数量。 +- `CODE_COMMENT_LINES`: **4**: 在代码评论中能够显示的最大代码行数。 +- `DEFAULT_THEME`: **gitea-auto**: 在 Gitea 安装时候设置的默认主题，自定义的主题可以通过 `{CustomPath}/public/assets/css/theme-*.css` 提供。 +- `SHOW_USER_EMAIL`: **true**: 用户的电子邮件是否应该显示在`Explore Users`页面中。 +- `THEMES`: **_empty_**: 所有可用的主题（由 `{CustomPath}/public/assets/css/theme-*.css` 提供）。允许用户选择个性化的主题， +- `MAX_DISPLAY_FILE_SIZE`: **8388608**: 能够显示文件的最大大小（默认为 8MiB）。 +- `REACTIONS`: 用户可以在问题（Issue）、Pull Request（PR）以及评论中选择的所有可选的反应。 + 这些值可以是表情符号别名（例如：:smile:）或 Unicode 表情符号。 + 对于自定义的反应，在 public/assets/img/emoji/ 目录下添加一个紧密裁剪的正方形图像，文件名为 reaction_name.png。 +- `CUSTOM_EMOJIS`: **gitea, codeberg, gitlab, git, github, gogs**: 不在 utf8 标准中定义的额外表情符号。 + 默认情况下，我们支持 Gitea 表情符号（:gitea:）。要添加更多表情符号，请将它们复制到 public/assets/img/emoji/ 目录下， + 并将其添加到此配置中。 +- `DEFAULT_SHOW_FULL_NAME`: **false**: 是否在可能的情况下显示用户的全名。如果没有设置全名，则将使用用户名。 +- `SEARCH_REPO_DESCRIPTION`: **true**: 是否在探索页面上的仓库搜索中搜索描述。 +- `ONLY_SHOW_RELEVANT_REPOS`: **false** 在没有指定关键字并使用默认排序时，是否仅在探索页面上显示相关的仓库。 + 如果一个仓库是分叉或者没有元数据（没有描述、图标、主题），则被视为不相关的仓库。 + +### 界面 - 管理员 (`ui.admin`) + +- `USER_PAGING_NUM`: **50**: 单页显示的用户数量。 +- `REPO_PAGING_NUM`: **50**: 单页显示的仓库数量。 +- `NOTICE_PAGING_NUM`: **25**: 单页显示的通知数量。 +- `ORG_PAGING_NUM`: **50**: 单页显示的组织数量。 + +### 界面 - 用户 (`ui.user`) + +- `REPO_PAGING_NUM`: **15**: 单页显示的仓库数量。 +- `ORG_PAGING_NUM`: **15**: 个人信息页展示的组织数量。 + +### 界面 - 元信息 (`ui.meta`) + +- `AUTHOR`: **Gitea - Git with a cup of tea**: 主页的作者元标签。 +- `DESCRIPTION`: **Gitea (Git with a cup of tea) is a painless self-hosted Git service written in Go**: 主页的描述元标签。 +- `KEYWORDS`: **go,git,self-hosted,gitea**: 首页关键词元标签。 + +### 界面 - 通知 (`ui.notification`) + +- `MIN_TIMEOUT`: **10s**: 这些选项控制通知端点定期轮询以更新通知计数。在页面加载后，通知计数将在` MIN_TIMEOUT`之后进行检查。如果通知计数未更改，超时时间将按照`TIMEOUT_STEP`增加到`MAX_TIMEOUT`。将 `MIN_TIMEOUT`设置为 -1 以关闭该功能。 +- `MAX_TIMEOUT`: **60s**. +- `TIMEOUT_STEP`: **10s**. +- `EVENT_SOURCE_UPDATE_TIME`: **10s**: 该设置确定了查询数据库以更新通知计数的频率。如果浏览器客户端支持`EventSource`和`SharedWorker`，则优先使用`SharedWorker`而不是轮询通知端点。将其设置为 -1 可以禁用 `EventSource`。 + +### 界面 - SVG Images (`ui.svg`) + +- `ENABLE_RENDER`: **true**: 是否将 SVG 文件呈现为图像。如果禁用了 SVG 渲染，SVG 文件将显示为文本，无法作为图像嵌入到 Markdown 文件中。 + +### 界面 - CSV Files (`ui.csv`) + +- `MAX_FILE_SIZE`: **524288** (512kb): 以字节为单位允许将 CSV 文件呈现为表格的最大文件大小（将其设置为 0 表示没有限制）。 +- `MAX_ROWS`: **2500** : 最大允许的 CSV 文件行数。 (设置为 0 不限制) + +## Markdown (`markdown`) + +- `ENABLE_HARD_LINE_BREAK_IN_COMMENTS`: **true**: 在评论中将软换行符呈现为硬换行符， + 这意味着段落之间的单个换行符将导致换行， + 并且不需要在段落后添加尾随空格来强制换行。 +- `ENABLE_HARD_LINE_BREAK_IN_DOCUMENTS`: **false**: 在文档中将软换行符呈现为硬换行符， + 这意味着段落之间的单个换行符将导致换行， + 并且不需要在段落后添加尾随空格来强制换行。 +- `CUSTOM_URL_SCHEMES`: 使用逗号分隔的列表（ftp、git、svn）来指示要在 Markdown 中呈现的附加 URL 超链接。 + 以 http 和 https 开头的 URL 始终显示。 + 如果此条目为空，则允许所有 URL 方案。 +- `FILE_EXTENSIONS`: **.md,.markdown,.mdown,.mkd,.livemd**: 应呈现/编辑为 Markdown 的文件扩展名列表。使用逗号分隔扩展名。要将没有任何扩展名的文件呈现为 Markdown，请只需放置一个逗号。 +- `ENABLE_MATH`: **true**: 启用对`\(...\)`, `\[...\]`, `$...$`和`$$...$$` 作为数学块的检测。 + +## 服务器 (`server`) + +- `APP_DATA_PATH`: **_`AppWorkPath`_/data**: 这是存储数据的默认根路径。 +- `PROTOCOL`: **http**: \[http, https, fcgi, http+unix, fcgi+unix\] +- `USE_PROXY_PROTOCOL`: **false**: 在连接中预期`PROXY`协议头。 +- `PROXY_PROTOCOL_TLS_BRIDGING`: **false**: 协议为 https 时，在`TLS`协商后预期`PROXY`协议头。 +- `PROXY_PROTOCOL_HEADER_TIMEOUT`: **5s**: 等待`PROXY`协议头的超时时间（设置为`0`表示没有超时）。 +- `PROXY_PROTOCOL_ACCEPT_UNKNOWN`: **false**:接受带有未知类型的`PROXY`协议头。 +- `DOMAIN`: **localhost**: 此服务器的域名。 +- `ROOT_URL`: **`{PROTOCOL}://{DOMAIN}:{HTTP_PORT}/`**: + 覆盖自动生成的公共 URL。 + 如果内部 URL 和外部 URL 不匹配（例如在 Docker 中），这很有用。 +- `STATIC_URL_PREFIX`: **_empty_**: + 覆盖此选项以从不同的 URL 请求静态资源。 + 这包括 CSS 文件、图片、JS 文件和 Web 字体。 + 头像图片是动态资源，仍由 Gitea 提供。 + 选项可以是不同的路径，例如`/static`, 也可以是另一个域，例如`https://cdn.example.com`. + 请求会变成 `{ROOT_URL}/static/assets/css/index.css` 或 `https://cdn.example.com/assets/css/index.css` + 静态文件位于 Gitea 源代码仓库的`public/`目录中。 + 您可以将`STATIC_URL_PREFIX`请求代理到 Gitea 服务器以提供静态资源，或者将手动构建的 Gitea 资源从 `$GITEA_BUILD/public`复制到静态位置，例如`/var/www/assets`。确保`$STATIC_URL_PREFIX/assets/css/index.css`指向`/var/www/assets/css/index.css`。 + +- `HTTP_ADDR`: **0.0.0.0**: HTTP 监听地址。 + - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 + `HTTP_ADDR` 和 `HTTP_PORT` 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 + - 如果 `PROTOCOL` 设置为 `http+unix` 或 `fcgi+unix`，则应该是要使用的 Unix 套接字文件的名称。相对路径将相对于 _`AppWorkPath`_ 被转换为绝对路径。 +- `HTTP_PORT`: **3000**: HTTP 监听端口。 + - 如果 `PROTOCOL` 设置为 `fcgi`，Gitea 将在由 `HTTP_ADDR` 和 `HTTP_PORT` + 配置设置定义的 TCP 套接字上监听 FastCGI 请求。 +- `UNIX_SOCKET_PERMISSION`: **666**: Unix 套接字的权限。 +- `LOCAL_ROOT_URL`: **`{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`**: + 用于访问网络服务的 Gitea 工作器（例如 SSH 更新）的本地（DMZ）URL。 + 在大多数情况下，您不需要更改默认值。 + 仅在您的 SSH 服务器节点与 HTTP 节点不同的情况下才修改它。对于不同的协议，默认值不同。如果 `PROTOCOL` + 是 `http+unix`，则默认值为 `http://unix/`。如果 `PROTOCOL` 是 `fcgi` 或 `fcgi+unix`，则默认值为 + `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。如果监听在 `0.0.0.0`，则默认值为 + `{PROTOCOL}://localhost:{HTTP_PORT}/`， + 否则默认值为 `{PROTOCOL}://{HTTP_ADDR}:{HTTP_PORT}/`。 +- `LOCAL_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在进行本地连接时传递 PROXY 协议头。 + 如果本地连接将经过代理，请将其设置为 false。 +- `PER_WRITE_TIMEOUT`: **30s**: 连接的任何写操作的超时时间。（将其设置为 -1 + 以禁用所有超时。） +- `PER_WRITE_PER_KB_TIMEOUT`: **10s**: 连接每写入 1 KB 的超时时间。 +- `DISABLE_SSH`: **false**: 当 SSH 不可用时禁用 SSH 功能。 +- `START_SSH_SERVER`: **false**: 启用时，使用内置的 SSH 服务器。 +- `SSH_SERVER_USE_PROXY_PROTOCOL`: **false**: 在与内置 SSH 服务器建立连接时，期望 PROXY 协议头。 +- `BUILTIN_SSH_SERVER_USER`: **`{RUN_USER}`**: 用于内置 SSH 服务器的用户名。 +- `SSH_USER`: **BUILTIN_SSH_SERVER_USER**: 在克隆 URL 中显示的 SSH 用户名。 + 如果设置为 `(DOER_USERNAME)`，将使用当前登录用户名作为克隆用的 SSH 用户名。 + 此配置项仅为自己配置 SSH 反向代理的高级用户准备， + 大多数用户应当把它留空，或者按需修改 `BUILTIN_SSH_SERVER_USER`。 +- `SSH_DOMAIN`: **`{DOMAIN}`**: 此服务器的域名，用于显示的克隆 URL。 +- `SSH_PORT`: **22**: 显示在克隆 URL 中的 SSH 端口。 +- `SSH_LISTEN_HOST`: **0.0.0.0**: 内置 SSH 服务器的监听地址。 +- `SSH_LISTEN_PORT`: **`{SSH_PORT}`**: 内置 SSH 服务器的端口。 +- `SSH_ROOT_PATH`: **~/.ssh**: SSH 目录的根路径。 +- `SSH_CREATE_AUTHORIZED_KEYS_FILE`: **true**: 当 Gitea 不使用内置 SSH 服务器时，默认情况下 Gitea 会创建一个 authorized_keys 文件。如果您打算使用 AuthorizedKeysCommand 功能，您应该关闭此选项。 +- `SSH_AUTHORIZED_KEYS_BACKUP`: **false**: 在重写所有密钥时启用 SSH 授权密钥备份，默认值为 false。 +- `SSH_TRUSTED_USER_CA_KEYS`: **_empty_**: 指定信任的证书颁发机构的公钥，用于对用户证书进行身份验证。多个密钥应以逗号分隔。例如 `ssh- ` 或 `ssh- , ssh- `。有关详细信息，请参阅 `sshd` 配置手册中的 `TrustedUserCAKeys` 部分。当为空时，不会创建文件，并且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 默认为 `off`。 +- `SSH_TRUSTED_USER_CA_KEYS_FILENAME`: **`RUN_USER`/.ssh/gitea-trusted-user-ca-keys.pem**: Gitea 将管理的 `TrustedUserCaKeys` 文件的绝对路径。如果您正在运行自己的 SSH 服务器，并且想要使用 Gitea 管理的文件，您还需要修改您的 `sshd_config` 来指向此文件。官方的 Docker 映像将自动工作，无需进一步配置。 +- `SSH_AUTHORIZED_PRINCIPALS_ALLOW`: **off** 或 **username, email**: \[off, username, email, anything\]：指定允许用户用作 principal 的值。当设置为 `anything` 时，对 principal 字符串不执行任何检查。当设置为 `off` 时，不允许设置授权的 principal。 +- `SSH_CREATE_AUTHORIZED_PRINCIPALS_FILE`: **false/true**: 当 Gitea 不使用内置 SSH 服务器且 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不为 `off` 时，默认情况下 Gitea 会创建一个 authorized_principals 文件。 +- `SSH_AUTHORIZED_PRINCIPALS_BACKUP`: **false/true**: 在重写所有密钥时启用 SSH 授权 principal 备份，默认值为 true（如果 `SSH_AUTHORIZED_PRINCIPALS_ALLOW` 不为 `off`）。 +- `SSH_AUTHORIZED_KEYS_COMMAND_TEMPLATE`: **`{{.AppPath}} --config={{.CustomConf}} serv key-{{.Key.ID}}`**: 设置用于传递授权密钥的命令模板。可能的密钥是：AppPath、AppWorkPath、CustomConf、CustomPath、Key，其中 Key 是 `models/asymkey.PublicKey`，其他是 shellquoted 字符串。 +- `SSH_SERVER_CIPHERS`: **chacha20-poly1305@openssh.com, aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, aes256-gcm@openssh.com**: 对于内置的 SSH 服务器，选择支持的 SSH 连接的加密方法，对于系统 SSH，此设置无效。 +- `SSH_SERVER_KEY_EXCHANGES`: **curve25519-sha256, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group14-sha256, diffie-hellman-group14-sha1**: 对于内置 SSH 服务器，选择支持的 SSH 连接的密钥交换算法，对于系统 SSH，此设置无效。 +- `SSH_SERVER_MACS`: **hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1**: 对于内置 SSH 服务器，选择支持的 SSH 连接的 MAC 算法，对于系统 SSH，此设置无效。 +- `SSH_SERVER_HOST_KEYS`: **ssh/gitea.rsa, ssh/gogs.rsa**: 对于内置 SSH 服务器，选择要提供为主机密钥的密钥对。私钥应在 `SSH_SERVER_HOST_KEY` 中，公钥在 `SSH_SERVER_HOST_KEY.pub` 中。相对路径会相对于 `APP_DATA_PATH` 转为绝对路径。如果不存在密钥，将为您创建一个 4096 位的 RSA 密钥。 +- `SSH_KEY_TEST_PATH`: **/tmp**: 在使用 `ssh-keygen` 测试公共 SSH 密钥时要在其中创建临时文件的目录，默认为系统临时目录。 +- `SSH_KEYGEN_PATH`: **_empty_**: 使用 `ssh-keygen` 解析公共 SSH 密钥。该值将传递给 shell。默认情况下，Gitea 会自行进行解析。 +- `SSH_EXPOSE_ANONYMOUS`: **false**: 启用将 SSH 克隆 URL 暴露给匿名访问者，默认为 false。 +- `SSH_PER_WRITE_TIMEOUT`: **30s**: 对 SSH 连接的任何写入设置超时。（将其设置为 -1 可以禁用所有超时。） +- `SSH_PER_WRITE_PER_KB_TIMEOUT`: **10s**: 对写入 SSH 连接的每 KB 设置超时。 +- `MINIMUM_KEY_SIZE_CHECK`: **true**: 指示是否检查最小密钥大小与相应类型。 +- `OFFLINE_MODE`: **true**: 禁用 CDN 用于静态文件和 Gravatar 用于个人资料图片。 +- `CERT_FILE`: **https/cert.pem**: 用于 HTTPS 的证书文件路径。在链接时，服务器证书必须首先出现，然后是中间 CA 证书（如果有）。如果 `ENABLE_ACME=true`，则此设置会被忽略。路径相对于 `CUSTOM_PATH`。 +- `KEY_FILE`: **https/key.pem**: 用于 HTTPS 的密钥文件路径。如果 `ENABLE_ACME=true`，则此设置会被忽略。路径相对于 `CUSTOM_PATH`。 +- `STATIC_ROOT_PATH`: **_`StaticRootPath`_**: 模板和静态文件路径的上一级。 +- `APP_DATA_PATH`: **data**（在 Docker 上为 **/data/gitea**）：应用程序数据的默认路径。相对路径会相对于 _`AppWorkPath`_ 转为绝对路径。 +- `STATIC_CACHE_TIME`: **6h**: 对 `custom/`、`public/` 和所有上传的头像的静态资源的 Web 浏览器缓存时间。请注意，在 `RUN_MODE` 为 "dev" 时，此缓存会被禁用。 +- `ENABLE_GZIP`: **false**: 为运行时生成的内容启用 gzip 压缩，静态资源除外。 +- `ENABLE_PPROF`: **false**: 应用程序分析（内存和 CPU）。对于 "web" 命令，它会在 `localhost:6060` 上监听。对于 "serv" 命令，它会将数据转储到磁盘上的 `PPROF_DATA_PATH` 中，文件名为 `(cpuprofile|memprofile)__`。 +- `PPROF_DATA_PATH`: **_`AppWorkPath`_/data/tmp/pprof**: `PPROF_DATA_PATH`，当您将 Gitea 作为服务启动时，请使用绝对路径。 +- `LANDING_PAGE`: **home**: 未经身份验证用户的登录页面 \[home, explore, organizations, login, **custom**]。其中 custom 可以是任何 URL，例如 "/org/repo" 或甚至是 `https://anotherwebsite.com`。 +- `LFS_START_SERVER`: **false**: 启用 Git LFS 支持。 +- `LFS_CONTENT_PATH`: **`{APP_DATA_PATH}/lfs`**: 默认的 LFS 内容路径（如果它在本地存储中）。**已弃用**，请使用 `[lfs]` 中的设置。 +- `LFS_JWT_SECRET`: **_empty_**: LFS 身份验证密钥，将其更改为唯一的字符串。你可以通过 Gitea 子命令来生成此字符串。转到 [Command Line](administration/command-line.md#generate)。 +- `LFS_JWT_SECRET_URI`: **_empty_**: 代替在配置中定义 LFS_JWT_SECRET，可以使用此配置选项为 Gitea 提供包含密钥的文件的路径（示例值：`file:/etc/gitea/lfs_jwt_secret`）。 +- `LFS_HTTP_AUTH_EXPIRY`: **24h**: LFS 身份验证的有效期，以 time.Duration 表示，超过此期限的推送可能会失败。 +- `LFS_MAX_FILE_SIZE`: **0**: 允许的最大 LFS 文件大小（以字节为单位，设置为 0 为无限制）。 +- `LFS_LOCKS_PAGING_NUM`: **50**: 每页返回的最大 LFS 锁定数。 +- `REDIRECT_OTHER_PORT`: **false**: 如果为 true 并且 `PROTOCOL` 为 https，则允许将 http 请求重定向到 Gitea 监听的 https 端口的 `PORT_TO_REDIRECT`。 +- `REDIRECTOR_USE_PROXY_PROTOCOL`: **`{USE_PROXY_PROTOCOL}`**: 在连接到 https 重定向器时，需要 PROXY 协议头。 +- `PORT_TO_REDIRECT`: **80**: http 重定向服务监听的端口。当 `REDIRECT_OTHER_PORT` 为 true 时使用。 +- `SSL_MIN_VERSION`: **TLSv1.2**: 设置最低支持的 SSL 版本。 +- `SSL_MAX_VERSION`: **_empty_**: 设置最大支持的 SSL 版本。 +- `SSL_CURVE_PREFERENCES`: **X25519,P256**: 设置首选的曲线。 +- `SSL_CIPHER_SUITES`: **ecdhe_ecdsa_with_aes_256_gcm_sha384,ecdhe_rsa_with_aes_256_gcm_sha384,ecdhe_ecdsa_with_aes_128_gcm_sha256,ecdhe_rsa_with_aes_128_gcm_sha256,ecdhe_ecdsa_with_chacha20_poly1305,ecdhe_rsa_with_chacha20_poly1305**: 设置首选的密码套件。 + - 如果没有对 AES 套件的硬件支持，默认情况下，ChaCha 套件将优先于 AES 套件。 + - 根据 Go 1.18 的支持的套件有： + - TLS 1.0 - 1.2 套件 + - "rsa_with_rc4_128_sha" + - "rsa_with_3des_ede_cbc_sha" + - "rsa_with_aes_128_cbc_sha" + - "rsa_with_aes_256_cbc_sha" + - "rsa_with_aes_128_cbc_sha256" + - "rsa_with_aes_128_gcm_sha256" + - "rsa_with_aes_256_gcm_sha384" + - "ecdhe_ecdsa_with_rc4_128_sha" + - "ecdhe_ecdsa_with_aes_128_cbc_sha" + - "ecdhe_ecdsa_with_aes_256_cbc_sha" + - "ecdhe_rsa_with_rc4_128_sha" + - "ecdhe_rsa_with_3des_ede_cbc_sha" + - "ecdhe_rsa_with_aes_128_cbc_sha" + - "ecdhe_rsa_with_aes_256_cbc_sha" + - "ecdhe_ecdsa_with_aes_128_cbc_sha256" + - "ecdhe_rsa_with_aes_128_cbc_sha256" + - "ecdhe_rsa_with_aes_128_gcm_sha256" + - "ecdhe_ecdsa_with_aes_128_gcm_sha256" + - "ecdhe_rsa_with_aes_256_gcm_sha384" + - "ecdhe_ecdsa_with_aes_256_gcm_sha384" + - "ecdhe_rsa_with_chacha20_poly1305_sha256" + - "ecdhe_ecdsa_with_chacha20_poly1305_sha256" + - TLS 1.3 套件 + - "aes_128_gcm_sha256" + - "aes_256_gcm_sha384" + - "chacha20_poly1305_sha256" + - 别名 + - "ecdhe_rsa_with_chacha20_poly1305" 是 "ecdhe_rsa_with_chacha20_poly1305_sha256" 的别名 + - "ecdhe_ecdsa_with_chacha20_poly1305" 是 "ecdhe_ecdsa_with_chacha20_poly1305_sha256" 的别名 +- `ENABLE_ACME`: **false**: 通过 ACME 能力的证书颁发机构（CA）服务器（默认为 Let's Encrypt）启用自动证书管理的标志。如果启用，将忽略 `CERT_FILE` 和 `KEY_FILE`，并且 CA 必须将 `DOMAIN` 解析为此 Gitea 服务器。确保设置了 DNS 记录，并且端口 `80` 或端口 `443` 可以被 CA 服务器访问（默认情况下是公共互联网），并重定向到相应的端口 `PORT_TO_REDIRECT` 或 `HTTP_PORT`。 +- `ACME_URL`: **_empty_**: CA 的 ACME 目录 URL，例如自托管的 [smallstep CA 服务器](https://github.com/smallstep/certificates)，它可以是 `https://ca.example.com/acme/acme/directory`。如果留空，默认使用 Let's Encrypt 的生产 CA（还要检查 `LETSENCRYPT_ACCEPTTOS`）。 +- `ACME_ACCEPTTOS`: **false**: 这是一个明确的检查，您是否接受 ACME 提供者的服务条款。默认为 Let's Encrypt 的 [服务条款](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf)。 +- `ACME_DIRECTORY`: **https**: 证书管理器用于缓存证书和私钥等信息的目录。 +- `ACME_EMAIL`: **_empty_**: 用于 ACME 注册的电子邮件。通常用于通知有关已颁发的证书的问题。 +- `ACME_CA_ROOT`: **_empty_**: CA 的根证书。如果留空，默认使用系统的信任链。 +- `ALLOW_GRACEFUL_RESTARTS`: **true**: 在 SIGHUP 时执行优雅重启。 +- `GRACEFUL_HAMMER_TIME`: **60s**: 在重新启动后，父进程将停止接受新连接，并允许请求在停止之前完成。如果耗时超过此时间，则会强制关闭关闭。 +- `STARTUP_TIMEOUT`: **0**: 如果启动超过提供的时间，将关闭服务器。在 Windows 上设置这将向 SVC 主机发送一个等待提示，告诉 SVC 主机启动可能需要一些时间。请注意，启动由监听器（HTTP/HTTPS/SSH）的打开来确定。索引程序可能需要更长时间启动，可能具有自己的超时时间。 + +## 数据库 (`database`) + +- `DB_TYPE`: **mysql**: 数据库类型 \[mysql, postgres, mssql, sqlite3\]。 +- `HOST`: **127.0.0.1:3306**: 数据库主机地址和端口或 unix 套接字的绝对路径 \[mysql, postgres\]（例如：/var/run/mysqld/mysqld.sock）。 +- `NAME`: **gitea**: 数据库名称。 +- `USER`: **root**: 数据库用户名。 +- `PASSWD`: **_empty_**: 数据库密码。如果密码包含特殊字符，请使用 \`your password\` 或 """your password"""。 +- `SCHEMA`: **_empty_**: 对于 PostgreSQL，如果与 "public" 不同的模式。模式必须事先存在，用户必须对其具有创建特权，并且用户搜索路径必须设置为首先查找模式（例如 `ALTER USER user SET SEARCH_PATH = schema_name,"$user",public;`）。 +- `SSL_MODE`: **disable**: MySQL 或 PostgreSQL 数据库是否启用 SSL 模式，仅适用于 MySQL 和 PostgreSQL。 + - MySQL 的有效值： + - `true`：启用 TLS，并针对数据库服务器证书根证书进行验证。选择此选项时，请确保用于验证数据库服务器证书的根证书（例如 CA 证书）位于数据库服务器和 Gitea 服务器的系统证书存储中。有关如何将 CA 证书添加到证书存储的说明，请参阅系统文档。 + - `false`：禁用 TLS。 + - `disable`：`false` 的别名，与 PostgreSQL 兼容。 + - `skip-verify`：启用 TLS，但不进行数据库服务器证书验证。如果数据库服务器上有自签名或无效证书，请使用此选项。 + - `prefer`：启用 TLS，并回退到非 TLS 连接。 + - PostgreSQL 的有效值： + - `disable`：禁用 TLS。 + - `require`：启用 TLS，但不进行任何验证。 + - `verify-ca`：启用 TLS，并对数据库服务器证书进行根证书验证。 + - `verify-full`：启用 TLS，并验证数据库服务器名称是否与给定的证书的 "Common Name" 或 "Subject Alternative Name" 字段匹配。 +- `SQLITE_TIMEOUT`：**500**: 仅适用于 SQLite3 的查询超时。 +- `SQLITE_JOURNAL_MODE`：**""**: 更改 SQlite3 的日志模式。可以用于在高负载导致写入拥塞时启用 [WAL 模式](https://www.sqlite.org/wal.html)。有关可能的值，请参阅 [SQlite3 文档](https://www.sqlite.org/pragma.html#pragma_journal_mode)。默认为数据库文件的默认值，通常为 DELETE。 +- `ITERATE_BUFFER_SIZE`：**50**: 用于迭代的内部缓冲区大小。 +- `PATH`：**data/gitea.db**: 仅适用于 SQLite3 的数据库文件路径。 +- `LOG_SQL`：**false**: 记录已执行的 SQL。 +- `DB_RETRIES`：**10**: 允许多少次 ORM 初始化 / DB 连接尝试。 +- `DB_RETRY_BACKOFF`：**3s**: 如果发生故障，等待另一个 ORM 初始化 / DB 连接尝试的 time.Duration。 +- `MAX_OPEN_CONNS`：**0**: 数据库最大打开连接数 - 默认为 0，表示没有限制。 +- `MAX_IDLE_CONNS`：**2**: 连接池上的最大空闲数据库连接数，默认为 2 - 这将限制为 `MAX_OPEN_CONNS`。 +- `CONN_MAX_LIFETIME`：**0 或 3s**: 设置 DB 连接可以重用的最长时间 - 默认为 0，表示没有限制（除了 MySQL，其中为 3s - 请参见 #6804 和 #7071）。 +- `AUTO_MIGRATION`：**true**: 是否自动执行数据库模型迁移。 + +请参见 #8540 和 #8273 以获取有关 `MAX_OPEN_CONNS`、`MAX_IDLE_CONNS` 和 `CONN_MAX_LIFETIME` 的适当值及其与端口耗尽的关系的进一步讨论。 + +## 索引 (`indexer`) + +- `ISSUE_INDEXER_TYPE`: **bleve**: 工单索引类型，当前支持：`bleve`、`db`、`elasticsearch` 或 `meilisearch`。 +- `ISSUE_INDEXER_CONN_STR`：\*\*\*\* : 工单索引连接字符串，仅适用于 elasticsearch 和 meilisearch（例如：`http://elastic:password@localhost:9200`）或者（例如：`http://:apikey@localhost:7700`）。 +- `ISSUE_INDEXER_NAME`：**gitea_issues**: 工单索引器名称，在 ISSUE_INDEXER_TYPE 为 elasticsearch 或 meilisearch 时可用。 +- `ISSUE_INDEXER_PATH`：**indexers/issues.bleve**: 用于工单搜索的索引文件；在 ISSUE*INDEXER_TYPE 为 bleve 和 elasticsearch 时可用。相对路径将相对于 *`AppWorkPath`\_ 进行绝对路径化。 + +- `REPO_INDEXER_ENABLED`：**false**: 启用代码搜索（占用大量磁盘空间，约为存储库大小的 6 倍）。 +- `REPO_INDEXER_REPO_TYPES`：**sources,forks,mirrors,templates**: 存储库索引器单元。要索引的项目可以是 `sources`、`forks`、`mirrors`、`templates` 或它们的任何组合，用逗号分隔。如果为空，则默认为仅 `sources`，如果要完全禁用，请参见 `REPO_INDEXER_ENABLED`。 +- `REPO_INDEXER_TYPE`：**bleve**: 代码搜索引擎类型，可以为 `bleve` 或者 `elasticsearch`。 +- `REPO_INDEXER_PATH`：**indexers/repos.bleve**: 用于代码搜索的索引文件。 +- `REPO_INDEXER_CONN_STR`：\*\*\*\*: 代码索引器连接字符串，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。例如：`http://elastic:password@localhost:9200` +- `REPO_INDEXER_NAME`：**gitea_codes**: 代码索引器名称，在 `REPO_INDEXER_TYPE` 为 elasticsearch 时可用。 + +- `REPO_INDEXER_INCLUDE`：**empty**: 逗号分隔的 glob 模式列表（参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob)）以用于**包括**在索引中。使用 `**.txt` 匹配任何具有 .txt 扩展名的文件。空列表表示包括所有文件。 +- `REPO_INDEXER_EXCLUDE`：**empty**: 逗号分隔的 glob 模式列表（参见 [https://github.com/gobwas/glob](https://github.com/gobwas/glob)）以用于**排除**在索引中。即使在 `REPO_INDEXER_INCLUDE` 中匹配，也不会索引与此列表匹配的文件。 +- `REPO_INDEXER_EXCLUDE_VENDORED`：**true**: 从索引中排除 vendored 文件。 +- `MAX_FILE_SIZE`：**1048576**: 要索引的文件的最大字节数。 +- `STARTUP_TIMEOUT`：**30s**: 如果索引器启动时间超过此超时时间 - 则失败。（此超时时间将添加到上面的锤子时间中，用于子进程 - 因为 bleve 不会在上一个父进程关闭之前启动）。设置为 -1 表示永不超时。 + +## 队列 (`queue` and `queue.*`) + +[queue] 配置在 `[queue.*]` 下为各个队列设置默认值，并允许为各个队列设置单独的配置覆盖。（不过请参见下文。） + +- `TYPE`：**level**: 通用队列类型，当前支持：`level`（在内部使用 LevelDB）、`channel`、`redis`、`dummy`。无效的类型将视为 `level`。 +- `DATADIR`：**queues/common**: 用于存储 level 队列的基本 DataDir。单独的队列的 `DATADIR` 可以在 `queue.name` 部分进行设置。相对路径将根据 `{APP_DATA_PATH}` 变为绝对路径。 +- `LENGTH`：**100000**: 通道队列阻塞之前的最大队列大小 +- `BATCH_LENGTH`：**20**: 在传递给处理程序之前批处理数据 +- `CONN_STR`：**redis://127.0.0.1:6379/0**: redis 队列类型的连接字符串。对于 `redis-cluster`，使用 `redis+cluster://127.0.0.1:6379/0`。可以使用查询参数来设置选项。类似地，LevelDB 选项也可以使用：**leveldb://relative/path?option=value** 或 **leveldb:///absolute/path?option=value** 进行设置，并将覆盖 `DATADIR`。 +- `QUEUE_NAME`：**\_queue**: 默认的 redis 和磁盘队列名称的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `SET_NAME`：**\_unique**: 将添加到默认的 redis 和磁盘队列 `set` 名称中以用于唯一队列的后缀。单独的队列将默认为 **`name`**`QUEUE_NAME`_`SET_NAME`_，但可以在特定的 `queue.name` 部分中进行覆盖。 +- `MAX_WORKERS`：**(dynamic)**: 队列的最大工作协程数。默认值为 "CpuNum/2"，限制在 1 到 10 之间。 + +Gitea 创建以下非唯一队列： + +- `code_indexer` +- `issue_indexer` +- `notification-service` +- `task` +- `mail` +- `push_update` + +以及以下唯一队列： + +- `repo_stats_update` +- `repo-archive` +- `mirror` +- `pr_patch_checker` + +## Admin (`admin`) + +- `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: 用户电子邮件通知的默认配置（用户可配置）。选项：enabled、onmention、disabled +- `DISABLE_REGULAR_ORG_CREATION`: **false**: 禁止普通（非管理员）用户创建组织。 +- `USER_DISABLED_FEATURES`:**_empty_** 禁用的用户特性，当前允许为空或者 `deletion`，`manage_ssh_keys`， `manage_gpg_keys` 未来可以增加更多设置。 + - `deletion`: 用户不能通过界面或者 API 删除他自己。 + - `manage_ssh_keys`: 用户不能通过界面或者 API 配置 SSH Keys。 + - `manage_gpg_keys`: 用户不能配置 GPG 密钥。 + +## 安全性 (`security`) + +- `INSTALL_LOCK`: **false**: 控制是否能够访问安装向导页面，设置为 `true` 则禁止访问安装向导页面。 +- `SECRET_KEY`: **\<每次安装时随机生成\>**: 全局服务器安全密钥。这个密钥非常重要，如果丢失将无法解密加密的数据（例如 2FA）。 +- `SECRET_KEY_URI`: **_empty_**: 与定义 `SECRET_KEY` 不同，此选项可用于使用存储在文件中的密钥（示例值：`file:/etc/gitea/secret_key`）。它不应该像 `SECRET_KEY` 一样容易丢失。 +- `LOGIN_REMEMBER_DAYS`: **31**: 在要求重新登录之前，记住用户的登录状态多长时间（以天为单位）。 +- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: 保存自动登录信息的 Cookie 名称。 +- `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: 反向代理认证的 HTTP 头部名称，用于提供用户信息。 +- `REVERSE_PROXY_AUTHENTICATION_EMAIL`: **X-WEBAUTH-EMAIL**: 反向代理认证的 HTTP 头部名称，用于提供邮箱信息。 +- `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`: **X-WEBAUTH-FULLNAME**: 反向代理认证的 HTTP 头部名称，用于提供全名信息。 +- `REVERSE_PROXY_LIMIT`: **1**: 解释 X-Forwarded-For 标头或 X-Real-IP 标头，并将其设置为请求的远程 IP。 + 可信代理计数。设置为零以不使用这些标头。 +- `REVERSE_PROXY_TRUSTED_PROXIES`: **127.0.0.0/8,::1/128**: 逗号分隔的受信任代理服务器的 IP 地址和网络列表。使用 `*` 来信任全部。 +- `DISABLE_GIT_HOOKS`: **true**: 设置为 `false` 以允许具有 Git 钩子权限的用户创建自定义 Git 钩子。 + 警告：自定义 Git 钩子可用于在主机操作系统上执行任意代码。这允许用户访问和修改此配置文件和 Gitea 数据库，并中断 Gitea 服务。 + 通过修改 Gitea 数据库，用户可以获得 Gitea 管理员权限。 + 它还使他们可以访问正在运行 Gitea 实例的操作系统上用户可用的其他资源，并以 Gitea 操作系统用户的名义执行任意操作。 + 这可能对您的网站或操作系统造成危害。 + 在必要之前，请在更改现有 git 存储库中的钩子之前进行调整。 +- `DISABLE_WEBHOOKS`: **false**: 设置为 `true` 以禁用 Webhooks 功能。 +- `ONLY_ALLOW_PUSH_IF_GITEA_ENVIRONMENT_SET`: **true**: 设置为 `false` 以允许本地用户在未设置 Gitea 环境的情况下推送到 Gitea 存储库。不建议这样做，如果您希望本地用户推送到 Gitea 存储库，应该适当地设置环境。 +- `IMPORT_LOCAL_PATHS`: **false**: 设置为 `false` 以防止所有用户（包括管理员）从服务器上导入本地路径。 +- `INTERNAL_TOKEN`: **\<每次安装时随机生成，如果未设置 URI\>**: 用于验证 Gitea 二进制文件内部通信的密钥。 +- `INTERNAL_TOKEN_URI`: **_empty_**: 与在配置中定义 `INTERNAL_TOKEN` 不同，此配置选项可用于将包含内部令牌的文件的路径提供给 Gitea（示例值：`file:/etc/gitea/internal_token`）。 +- `PASSWORD_HASH_ALGO`: **pbkdf2**: 要使用的哈希算法 \[argon2、pbkdf2、pbkdf2_v1、pbkdf2_hi、scrypt、bcrypt\]，argon2 和 scrypt 将消耗大量内存。 + - 注意：`pbkdf2` 哈希的默认参数已更改 - 先前的设置可作为 `pbkdf2_v1` 使用，但不建议使用。 + - 可以通过在算法后使用 `$` 进行调整： + - `argon2$