mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-16 14:53:46 +00:00
Add 1.25.0 documentation (#289)
Reviewed-on: https://gitea.com/gitea/docs/pulls/289
This commit is contained in:
1 parent
d5eac4f23d
commit
7d50e32ba8
112 files changed
+49037
-217
No files matched your search
+36
-19
@@ -29,7 +29,11 @@ const apiConfig = [
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
route: "/api/",
|
route: "/api/",
|
||||||
spec: "static/swagger-24.json",
|
spec: "static/swagger-25.json",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
route: "/api/1.25/",
|
||||||
|
spec: "static/swagger-25.json",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
route: "/api/1.24/",
|
route: "/api/1.24/",
|
||||||
@@ -72,17 +76,27 @@ const pageConfig = renderApiSSR
|
|||||||
: {};
|
: {};
|
||||||
|
|
||||||
const globalVariables = {
|
const globalVariables = {
|
||||||
current: {
|
"current": {
|
||||||
goVersion: "1.24",
|
goVersion: "1.25",
|
||||||
minGoVersion: "1.24",
|
minGoVersion: "1.25",
|
||||||
minNodeVersion: "22",
|
minNodeVersion: "22",
|
||||||
version: "main-nightly",
|
version: "main-nightly",
|
||||||
sourceVersion: "main",
|
sourceVersion: "main",
|
||||||
sourceBranch: "main",
|
sourceBranch: "main",
|
||||||
dockerVersion: "nightly",
|
dockerVersion: "nightly",
|
||||||
displayVersion: "1.25-dev",
|
displayVersion: "1.26-dev",
|
||||||
},
|
},
|
||||||
1.24: {
|
"1.25": {
|
||||||
|
goVersion: "1.25",
|
||||||
|
minGoVersion: "1.25",
|
||||||
|
minNodeVersion: "22",
|
||||||
|
version: "1.25.0",
|
||||||
|
sourceVersion: "v1.25.0",
|
||||||
|
sourceBranch: "release/v1.25",
|
||||||
|
dockerVersion: "1.25.0",
|
||||||
|
displayVersion: "1.25.0",
|
||||||
|
},
|
||||||
|
"1.24": {
|
||||||
goVersion: "1.24",
|
goVersion: "1.24",
|
||||||
minGoVersion: "1.24",
|
minGoVersion: "1.24",
|
||||||
minNodeVersion: "22",
|
minNodeVersion: "22",
|
||||||
@@ -92,7 +106,7 @@ const globalVariables = {
|
|||||||
dockerVersion: "1.24.7",
|
dockerVersion: "1.24.7",
|
||||||
displayVersion: "1.24.7",
|
displayVersion: "1.24.7",
|
||||||
},
|
},
|
||||||
1.23: {
|
"1.23": {
|
||||||
goVersion: "1.23",
|
goVersion: "1.23",
|
||||||
minGoVersion: "1.22",
|
minGoVersion: "1.22",
|
||||||
minNodeVersion: "18",
|
minNodeVersion: "18",
|
||||||
@@ -102,7 +116,7 @@ const globalVariables = {
|
|||||||
dockerVersion: "1.23.8",
|
dockerVersion: "1.23.8",
|
||||||
displayVersion: "1.23.8",
|
displayVersion: "1.23.8",
|
||||||
},
|
},
|
||||||
1.22: {
|
"1.22": {
|
||||||
goVersion: "1.22",
|
goVersion: "1.22",
|
||||||
minGoVersion: "1.22",
|
minGoVersion: "1.22",
|
||||||
minNodeVersion: "18",
|
minNodeVersion: "18",
|
||||||
@@ -112,7 +126,7 @@ const globalVariables = {
|
|||||||
dockerVersion: "1.22.6",
|
dockerVersion: "1.22.6",
|
||||||
displayVersion: "1.22.6",
|
displayVersion: "1.22.6",
|
||||||
},
|
},
|
||||||
1.21: {
|
"1.21": {
|
||||||
goVersion: "1.21",
|
goVersion: "1.21",
|
||||||
minGoVersion: "1.21",
|
minGoVersion: "1.21",
|
||||||
minNodeVersion: "18",
|
minNodeVersion: "18",
|
||||||
@@ -132,7 +146,7 @@ const globalVariables = {
|
|||||||
dockerVersion: "1.20.6",
|
dockerVersion: "1.20.6",
|
||||||
displayVersion: "1.20.6",
|
displayVersion: "1.20.6",
|
||||||
},
|
},
|
||||||
1.19: {
|
"1.19": {
|
||||||
goVersion: "1.20",
|
goVersion: "1.20",
|
||||||
minGoVersion: "1.19",
|
minGoVersion: "1.19",
|
||||||
minNodeVersion: "14",
|
minNodeVersion: "14",
|
||||||
@@ -145,26 +159,29 @@ const globalVariables = {
|
|||||||
};
|
};
|
||||||
|
|
||||||
const versions = {
|
const versions = {
|
||||||
current: {
|
"current": {
|
||||||
label: globalVariables["current"].displayVersion, // path is kept as next for dev (so users can always find "nightly" docs)
|
label: globalVariables["current"].displayVersion, // path is kept as next for dev (so users can always find "nightly" docs)
|
||||||
banner: "unreleased",
|
banner: "unreleased",
|
||||||
},
|
},
|
||||||
1.24: {
|
"1.25": {
|
||||||
|
label: globalVariables["1.25"].displayVersion,
|
||||||
|
},
|
||||||
|
"1.24": {
|
||||||
label: globalVariables["1.24"].displayVersion,
|
label: globalVariables["1.24"].displayVersion,
|
||||||
},
|
},
|
||||||
1.23: {
|
"1.23": {
|
||||||
label: globalVariables["1.23"].displayVersion,
|
label: globalVariables["1.23"].displayVersion,
|
||||||
},
|
},
|
||||||
1.22: {
|
"1.22": {
|
||||||
label: globalVariables["1.22"].displayVersion,
|
label: globalVariables["1.22"].displayVersion,
|
||||||
},
|
},
|
||||||
1.21: {
|
"1.21": {
|
||||||
label: globalVariables["1.21"].displayVersion,
|
label: globalVariables["1.21"].displayVersion,
|
||||||
},
|
},
|
||||||
"1.20": {
|
"1.20": {
|
||||||
label: globalVariables["1.20"].displayVersion,
|
label: globalVariables["1.20"].displayVersion,
|
||||||
},
|
},
|
||||||
1.19: {
|
"1.19": {
|
||||||
label: globalVariables["1.19"].displayVersion,
|
label: globalVariables["1.19"].displayVersion,
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
@@ -284,7 +301,7 @@ const config = {
|
|||||||
}/${docPath}`;
|
}/${docPath}`;
|
||||||
},
|
},
|
||||||
versions: versions,
|
versions: versions,
|
||||||
lastVersion: "1.24",
|
lastVersion: "1.25",
|
||||||
async sidebarItemsGenerator({
|
async sidebarItemsGenerator({
|
||||||
defaultSidebarItemsGenerator,
|
defaultSidebarItemsGenerator,
|
||||||
...args
|
...args
|
||||||
@@ -391,10 +408,10 @@ const config = {
|
|||||||
label: "Docs",
|
label: "Docs",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
to: "/api/1.24/",
|
to: "/api/1.25/",
|
||||||
label: "API",
|
label: "API",
|
||||||
position: "left",
|
position: "left",
|
||||||
activeBaseRegex: "api/(1.19|1.20|1.21|1.22|1.23|1.24|next)/",
|
activeBaseRegex: "api/(1.19|1.20|1.21|1.22|1.23|1.24|1.25|next)/",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
to: "/runner/0.2.11/",
|
to: "/runner/0.2.11/",
|
||||||
|
|||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"sidebar.docs.category.actions": {
|
||||||
|
"message": "Actions"
|
||||||
|
},
|
||||||
|
"sidebar.docs.category.packages": {
|
||||||
|
"message": "Packages"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"sidebar.docs.category.actions": {
|
||||||
|
"message": "Actions"
|
||||||
|
},
|
||||||
|
"sidebar.docs.category.packages": {
|
||||||
|
"message": "Packages"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"sidebar.docs.category.actions": {
|
||||||
|
"message": "Actions"
|
||||||
|
},
|
||||||
|
"sidebar.docs.category.packages": {
|
||||||
|
"message": "Packages"
|
||||||
|
}
|
||||||
|
}
|
||||||
Generated
-35
@@ -164,7 +164,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.19.0.tgz",
|
"resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.19.0.tgz",
|
||||||
"integrity": "sha512-Ctg3xXD/1VtcwmkulR5+cKGOMj4r0wC49Y/KZdGQcqpydKn+e86F6l3tb3utLJQVq4lpEJud6kdRykFgcNsp8Q==",
|
"integrity": "sha512-Ctg3xXD/1VtcwmkulR5+cKGOMj4r0wC49Y/KZdGQcqpydKn+e86F6l3tb3utLJQVq4lpEJud6kdRykFgcNsp8Q==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@algolia/client-common": "5.19.0",
|
"@algolia/client-common": "5.19.0",
|
||||||
"@algolia/requester-browser-xhr": "5.19.0",
|
"@algolia/requester-browser-xhr": "5.19.0",
|
||||||
@@ -302,7 +301,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.0.tgz",
|
"resolved": "https://registry.npmjs.org/@babel/core/-/core-7.26.0.tgz",
|
||||||
"integrity": "sha512-i1SLeK+DzNnQ3LL/CswPCa/E5u4lh1k6IAEphON8F+cXt0t9euTshDru0q7/IqMa1PMPz5RnHuHscF8/ZJsStg==",
|
"integrity": "sha512-i1SLeK+DzNnQ3LL/CswPCa/E5u4lh1k6IAEphON8F+cXt0t9euTshDru0q7/IqMa1PMPz5RnHuHscF8/ZJsStg==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@ampproject/remapping": "^2.2.0",
|
"@ampproject/remapping": "^2.2.0",
|
||||||
"@babel/code-frame": "^7.26.0",
|
"@babel/code-frame": "^7.26.0",
|
||||||
@@ -2055,7 +2053,6 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=18"
|
"node": ">=18"
|
||||||
},
|
},
|
||||||
@@ -2078,7 +2075,6 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=18"
|
"node": ">=18"
|
||||||
}
|
}
|
||||||
@@ -2188,7 +2184,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
||||||
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cssesc": "^3.0.0",
|
"cssesc": "^3.0.0",
|
||||||
"util-deprecate": "^1.0.2"
|
"util-deprecate": "^1.0.2"
|
||||||
@@ -2581,7 +2576,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
||||||
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cssesc": "^3.0.0",
|
"cssesc": "^3.0.0",
|
||||||
"util-deprecate": "^1.0.2"
|
"util-deprecate": "^1.0.2"
|
||||||
@@ -3406,7 +3400,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@docusaurus/faster/-/faster-3.8.1.tgz",
|
"resolved": "https://registry.npmjs.org/@docusaurus/faster/-/faster-3.8.1.tgz",
|
||||||
"integrity": "sha512-XYrj3qnTm+o2d5ih5drCq9s63GJoM8vZ26WbLG5FZhURsNxTSXgHJcx11Qo7nWPUStCQkuqk1HvItzscCUnd4A==",
|
"integrity": "sha512-XYrj3qnTm+o2d5ih5drCq9s63GJoM8vZ26WbLG5FZhURsNxTSXgHJcx11Qo7nWPUStCQkuqk1HvItzscCUnd4A==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/types": "3.8.1",
|
"@docusaurus/types": "3.8.1",
|
||||||
"@rspack/core": "^1.3.15",
|
"@rspack/core": "^1.3.15",
|
||||||
@@ -3575,7 +3568,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.1.tgz",
|
"resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.8.1.tgz",
|
||||||
"integrity": "sha512-oByRkSZzeGNQByCMaX+kif5Nl2vmtj2IHQI2fWjCfCootsdKZDPFLonhIp5s3IGJO7PLUfe0POyw0Xh/RrGXJA==",
|
"integrity": "sha512-oByRkSZzeGNQByCMaX+kif5Nl2vmtj2IHQI2fWjCfCootsdKZDPFLonhIp5s3IGJO7PLUfe0POyw0Xh/RrGXJA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/core": "3.8.1",
|
"@docusaurus/core": "3.8.1",
|
||||||
"@docusaurus/logger": "3.8.1",
|
"@docusaurus/logger": "3.8.1",
|
||||||
@@ -3873,7 +3865,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.8.1.tgz",
|
"resolved": "https://registry.npmjs.org/@docusaurus/theme-common/-/theme-common-3.8.1.tgz",
|
||||||
"integrity": "sha512-UswMOyTnPEVRvN5Qzbo+l8k4xrd5fTFu2VPPfD6FcW/6qUtVLmJTQCktbAL3KJ0BVXGm5aJXz/ZrzqFuZERGPw==",
|
"integrity": "sha512-UswMOyTnPEVRvN5Qzbo+l8k4xrd5fTFu2VPPfD6FcW/6qUtVLmJTQCktbAL3KJ0BVXGm5aJXz/ZrzqFuZERGPw==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/mdx-loader": "3.8.1",
|
"@docusaurus/mdx-loader": "3.8.1",
|
||||||
"@docusaurus/module-type-aliases": "3.8.1",
|
"@docusaurus/module-type-aliases": "3.8.1",
|
||||||
@@ -3967,7 +3958,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.8.1.tgz",
|
"resolved": "https://registry.npmjs.org/@docusaurus/utils/-/utils-3.8.1.tgz",
|
||||||
"integrity": "sha512-P1ml0nvOmEFdmu0smSXOqTS1sxU5tqvnc0dA4MTKV39kye+bhQnjkIKEE18fNOvxjyB86k8esoCIFM3x4RykOQ==",
|
"integrity": "sha512-P1ml0nvOmEFdmu0smSXOqTS1sxU5tqvnc0dA4MTKV39kye+bhQnjkIKEE18fNOvxjyB86k8esoCIFM3x4RykOQ==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/logger": "3.8.1",
|
"@docusaurus/logger": "3.8.1",
|
||||||
"@docusaurus/types": "3.8.1",
|
"@docusaurus/types": "3.8.1",
|
||||||
@@ -4186,7 +4176,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@emotion/react/-/react-11.14.0.tgz",
|
"resolved": "https://registry.npmjs.org/@emotion/react/-/react-11.14.0.tgz",
|
||||||
"integrity": "sha512-O000MLDBDdk/EohJPFUqvnp4qnHeYkVP5B0xEG0D/L7cOKP9kefu2DXn8dj74cQfsEzUqh+sr1RzFqiL1o+PpA==",
|
"integrity": "sha512-O000MLDBDdk/EohJPFUqvnp4qnHeYkVP5B0xEG0D/L7cOKP9kefu2DXn8dj74cQfsEzUqh+sr1RzFqiL1o+PpA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/runtime": "^7.18.3",
|
"@babel/runtime": "^7.18.3",
|
||||||
"@emotion/babel-plugin": "^11.13.5",
|
"@emotion/babel-plugin": "^11.13.5",
|
||||||
@@ -4456,7 +4445,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz",
|
"resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz",
|
||||||
"integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==",
|
"integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/mdx": "^2.0.0"
|
"@types/mdx": "^2.0.0"
|
||||||
},
|
},
|
||||||
@@ -5522,7 +5510,6 @@
|
|||||||
"version": "8.1.0",
|
"version": "8.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz",
|
||||||
"integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==",
|
"integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/core": "^7.21.3",
|
"@babel/core": "^7.21.3",
|
||||||
"@svgr/babel-preset": "8.1.0",
|
"@svgr/babel-preset": "8.1.0",
|
||||||
@@ -5673,7 +5660,6 @@
|
|||||||
"integrity": "sha512-py91kjI1jV5D5W/Q+PurBdGsdU5TFbrzamP7zSCqLdMcHkKi3rQEM5jkQcZr0MXXSJTaayLxS3MWYTBIkzPDrg==",
|
"integrity": "sha512-py91kjI1jV5D5W/Q+PurBdGsdU5TFbrzamP7zSCqLdMcHkKi3rQEM5jkQcZr0MXXSJTaayLxS3MWYTBIkzPDrg==",
|
||||||
"hasInstallScript": true,
|
"hasInstallScript": true,
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@swc/counter": "^0.1.3",
|
"@swc/counter": "^0.1.3",
|
||||||
"@swc/types": "^0.1.17"
|
"@swc/types": "^0.1.17"
|
||||||
@@ -6334,7 +6320,6 @@
|
|||||||
"version": "18.2.46",
|
"version": "18.2.46",
|
||||||
"resolved": "https://registry.npmjs.org/@types/react/-/react-18.2.46.tgz",
|
"resolved": "https://registry.npmjs.org/@types/react/-/react-18.2.46.tgz",
|
||||||
"integrity": "sha512-nNCvVBcZlvX4NU1nRRNV/mFl1nNRuTuslAJglQsq+8ldXe5Xv0Wd2f7WTE3jOxhLH2BFfiZGC6GCp+kHQbgG+w==",
|
"integrity": "sha512-nNCvVBcZlvX4NU1nRRNV/mFl1nNRuTuslAJglQsq+8ldXe5Xv0Wd2f7WTE3jOxhLH2BFfiZGC6GCp+kHQbgG+w==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/prop-types": "*",
|
"@types/prop-types": "*",
|
||||||
"@types/scheduler": "*",
|
"@types/scheduler": "*",
|
||||||
@@ -6670,7 +6655,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz",
|
"resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.0.tgz",
|
||||||
"integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==",
|
"integrity": "sha512-cl669nCJTZBsL97OF4kUQm5g5hC2uihk0NxY3WENAC0TYdILVkAyHymAntgxGkl7K+t0cXIrH5siy5S4XkFycA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"bin": {
|
"bin": {
|
||||||
"acorn": "bin/acorn"
|
"acorn": "bin/acorn"
|
||||||
},
|
},
|
||||||
@@ -6727,7 +6711,6 @@
|
|||||||
"version": "8.12.0",
|
"version": "8.12.0",
|
||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz",
|
||||||
"integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==",
|
"integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.1",
|
"fast-deep-equal": "^3.1.1",
|
||||||
"json-schema-traverse": "^1.0.0",
|
"json-schema-traverse": "^1.0.0",
|
||||||
@@ -6771,7 +6754,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.19.0.tgz",
|
"resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.19.0.tgz",
|
||||||
"integrity": "sha512-zrLtGhC63z3sVLDDKGW+SlCRN9eJHFTgdEmoAOpsVh6wgGL1GgTTDou7tpCBjevzgIvi3AIyDAQO3Xjbg5eqZg==",
|
"integrity": "sha512-zrLtGhC63z3sVLDDKGW+SlCRN9eJHFTgdEmoAOpsVh6wgGL1GgTTDou7tpCBjevzgIvi3AIyDAQO3Xjbg5eqZg==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@algolia/client-abtesting": "5.19.0",
|
"@algolia/client-abtesting": "5.19.0",
|
||||||
"@algolia/client-analytics": "5.19.0",
|
"@algolia/client-analytics": "5.19.0",
|
||||||
@@ -7211,7 +7193,6 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"caniuse-lite": "^1.0.30001735",
|
"caniuse-lite": "^1.0.30001735",
|
||||||
"electron-to-chromium": "^1.5.204",
|
"electron-to-chromium": "^1.5.204",
|
||||||
@@ -8000,7 +7981,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/core-js/-/core-js-3.35.0.tgz",
|
"resolved": "https://registry.npmjs.org/core-js/-/core-js-3.35.0.tgz",
|
||||||
"integrity": "sha512-ntakECeqg81KqMueeGJ79Q5ZgQNR+6eaE8sxGCx62zMbAIj65q+uYvatToew3m6eAGdU4gNZwpZ34NMe4GYswg==",
|
"integrity": "sha512-ntakECeqg81KqMueeGJ79Q5ZgQNR+6eaE8sxGCx62zMbAIj65q+uYvatToew3m6eAGdU4gNZwpZ34NMe4GYswg==",
|
||||||
"hasInstallScript": true,
|
"hasInstallScript": true,
|
||||||
"peer": true,
|
|
||||||
"funding": {
|
"funding": {
|
||||||
"type": "opencollective",
|
"type": "opencollective",
|
||||||
"url": "https://opencollective.com/core-js"
|
"url": "https://opencollective.com/core-js"
|
||||||
@@ -8218,7 +8198,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
||||||
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cssesc": "^3.0.0",
|
"cssesc": "^3.0.0",
|
||||||
"util-deprecate": "^1.0.2"
|
"util-deprecate": "^1.0.2"
|
||||||
@@ -9585,7 +9564,6 @@
|
|||||||
"version": "6.12.6",
|
"version": "6.12.6",
|
||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.1",
|
"fast-deep-equal": "^3.1.1",
|
||||||
"fast-json-stable-stringify": "^2.0.0",
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
@@ -13873,7 +13851,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/mobx/-/mobx-6.13.7.tgz",
|
"resolved": "https://registry.npmjs.org/mobx/-/mobx-6.13.7.tgz",
|
||||||
"integrity": "sha512-aChaVU/DO5aRPmk1GX8L+whocagUUpBQqoPtJk+cm7UOXUk87J4PeWCh6nNmTTIfEhiR9DI/+FnA8dln/hTK7g==",
|
"integrity": "sha512-aChaVU/DO5aRPmk1GX8L+whocagUUpBQqoPtJk+cm7UOXUk87J4PeWCh6nNmTTIfEhiR9DI/+FnA8dln/hTK7g==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"funding": {
|
"funding": {
|
||||||
"type": "opencollective",
|
"type": "opencollective",
|
||||||
"url": "https://opencollective.com/mobx"
|
"url": "https://opencollective.com/mobx"
|
||||||
@@ -14132,7 +14109,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.1",
|
"fast-deep-equal": "^3.1.1",
|
||||||
"fast-json-stable-stringify": "^2.0.0",
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
@@ -14753,7 +14729,6 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"nanoid": "^3.3.7",
|
"nanoid": "^3.3.7",
|
||||||
"picocolors": "^1.1.1",
|
"picocolors": "^1.1.1",
|
||||||
@@ -15668,7 +15643,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz",
|
||||||
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
"integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cssesc": "^3.0.0",
|
"cssesc": "^3.0.0",
|
||||||
"util-deprecate": "^1.0.2"
|
"util-deprecate": "^1.0.2"
|
||||||
@@ -16425,7 +16399,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/react/-/react-19.2.0.tgz",
|
"resolved": "https://registry.npmjs.org/react/-/react-19.2.0.tgz",
|
||||||
"integrity": "sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ==",
|
"integrity": "sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=0.10.0"
|
"node": ">=0.10.0"
|
||||||
}
|
}
|
||||||
@@ -16435,7 +16408,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.0.tgz",
|
"resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.0.tgz",
|
||||||
"integrity": "sha512-UlbRu4cAiGaIewkPyiRGJk0imDN2T3JjieT6spoL2UeSf5od4n5LB/mQ4ejmxhCFT1tYe8IvaFulzynWovsEFQ==",
|
"integrity": "sha512-UlbRu4cAiGaIewkPyiRGJk0imDN2T3JjieT6spoL2UeSf5od4n5LB/mQ4ejmxhCFT1tYe8IvaFulzynWovsEFQ==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"scheduler": "^0.27.0"
|
"scheduler": "^0.27.0"
|
||||||
},
|
},
|
||||||
@@ -16487,7 +16459,6 @@
|
|||||||
"version": "6.0.0",
|
"version": "6.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz",
|
||||||
"integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==",
|
"integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/react": "*"
|
"@types/react": "*"
|
||||||
},
|
},
|
||||||
@@ -16514,7 +16485,6 @@
|
|||||||
"version": "5.3.4",
|
"version": "5.3.4",
|
||||||
"resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz",
|
"resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz",
|
||||||
"integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==",
|
"integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/runtime": "^7.12.13",
|
"@babel/runtime": "^7.12.13",
|
||||||
"history": "^4.9.0",
|
"history": "^4.9.0",
|
||||||
@@ -18021,7 +17991,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/styled-components/-/styled-components-6.1.17.tgz",
|
"resolved": "https://registry.npmjs.org/styled-components/-/styled-components-6.1.17.tgz",
|
||||||
"integrity": "sha512-97D7DwWanI7nN24v0D4SvbfjLE9656umNSJZkBkDIWL37aZqG/wRQ+Y9pWtXyBIM/NSfcBzHLErEsqHmJNSVUg==",
|
"integrity": "sha512-97D7DwWanI7nN24v0D4SvbfjLE9656umNSJZkBkDIWL37aZqG/wRQ+Y9pWtXyBIM/NSfcBzHLErEsqHmJNSVUg==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@emotion/is-prop-valid": "1.2.2",
|
"@emotion/is-prop-valid": "1.2.2",
|
||||||
"@emotion/unitless": "0.8.1",
|
"@emotion/unitless": "0.8.1",
|
||||||
@@ -18238,7 +18207,6 @@
|
|||||||
"version": "6.12.6",
|
"version": "6.12.6",
|
||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.1",
|
"fast-deep-equal": "^3.1.1",
|
||||||
"fast-json-stable-stringify": "^2.0.0",
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
@@ -18792,7 +18760,6 @@
|
|||||||
"version": "6.12.6",
|
"version": "6.12.6",
|
||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.1",
|
"fast-deep-equal": "^3.1.1",
|
||||||
"fast-json-stable-stringify": "^2.0.0",
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
@@ -18996,7 +18963,6 @@
|
|||||||
"resolved": "https://registry.npmjs.org/webpack/-/webpack-5.97.1.tgz",
|
"resolved": "https://registry.npmjs.org/webpack/-/webpack-5.97.1.tgz",
|
||||||
"integrity": "sha512-EksG6gFY3L1eFMROS/7Wzgrii5mBAFe4rIr3r2BTfo7bcc+DWwFZ4OJ/miOuHJO/A85HwyI4eQ0F6IKXesO7Fg==",
|
"integrity": "sha512-EksG6gFY3L1eFMROS/7Wzgrii5mBAFe4rIr3r2BTfo7bcc+DWwFZ4OJ/miOuHJO/A85HwyI4eQ0F6IKXesO7Fg==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/eslint-scope": "^3.7.7",
|
"@types/eslint-scope": "^3.7.7",
|
||||||
"@types/estree": "^1.0.6",
|
"@types/estree": "^1.0.6",
|
||||||
@@ -19240,7 +19206,6 @@
|
|||||||
"version": "6.12.6",
|
"version": "6.12.6",
|
||||||
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
"resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz",
|
||||||
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
"integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==",
|
||||||
"peer": true,
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"fast-deep-equal": "^3.1.1",
|
"fast-deep-equal": "^3.1.1",
|
||||||
"fast-json-stable-stringify": "^2.0.0",
|
"fast-json-stable-stringify": "^2.0.0",
|
||||||
|
|||||||
+30383
File diff suppressed because it is too large.
Load diff
+3840
-163
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
title: "Administration"
|
||||||
|
slug: "administration"
|
||||||
|
sidebar_position: 30
|
||||||
|
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
name: "Administration"
|
||||||
|
sidebar_position: 20
|
||||||
|
collapse: true
|
||||||
|
identifier: "administration"
|
||||||
|
---
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
---
|
||||||
|
date: "2019-12-28"
|
||||||
|
slug: adding-legal-pages
|
||||||
|
sidebar_position: 110
|
||||||
|
aliases:
|
||||||
|
- /en-us/adding-legal-pages
|
||||||
|
---
|
||||||
|
|
||||||
|
# Adding Legal Pages
|
||||||
|
|
||||||
|
Some jurisdictions (such as EU), requires certain legal pages (e.g. Privacy Policy) to be added to website. Follow these steps to add them to your Gitea instance.
|
||||||
|
|
||||||
|
## Getting Pages
|
||||||
|
|
||||||
|
Gitea source code ships with sample pages, available in `contrib/legal` directory. Copy them to `custom/public/assets/`. For example, to add Privacy Policy:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget -O /path/to/custom/public/assets/privacy.html https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/legal/privacy.html.sample
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you need to edit the page to meet your requirements. In particular you must change the email addresses, web addresses and references to "Your Gitea Instance" to match your situation.
|
||||||
|
|
||||||
|
You absolutely must not place a general ToS or privacy statement that implies that the Gitea project is responsible for your server.
|
||||||
|
|
||||||
|
## Make it Visible
|
||||||
|
|
||||||
|
Create or append to `/path/to/custom/templates/custom/extra_links_footer.tmpl`:
|
||||||
|
|
||||||
|
```go
|
||||||
|
<a class="item" href="{{AppSubUrl}}/assets/privacy.html">Privacy Policy</a>
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart Gitea to see the changes.
|
||||||
@@ -0,0 +1,351 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
slug: "authentication"
|
||||||
|
sidebar_position: 10
|
||||||
|
aliases:
|
||||||
|
- /en-us/authentication
|
||||||
|
---
|
||||||
|
|
||||||
|
# Authentication
|
||||||
|
|
||||||
|
## LDAP (Lightweight Directory Access Protocol)
|
||||||
|
|
||||||
|
Both the LDAP via BindDN and the simple auth LDAP share the following fields:
|
||||||
|
|
||||||
|
- Authorization Name **(required)**
|
||||||
|
|
||||||
|
- A name to assign to the new method of authorization.
|
||||||
|
|
||||||
|
- Host **(required)**
|
||||||
|
|
||||||
|
- The address where the LDAP server can be reached.
|
||||||
|
- Example: `mydomain.com`
|
||||||
|
|
||||||
|
- Port **(required)**
|
||||||
|
|
||||||
|
- The port to use when connecting to the server.
|
||||||
|
- Example: `389` for LDAP or `636` for LDAP SSL
|
||||||
|
|
||||||
|
- Enable TLS Encryption (optional)
|
||||||
|
|
||||||
|
- Whether to use TLS when connecting to the LDAP server.
|
||||||
|
|
||||||
|
- Admin Filter (optional)
|
||||||
|
|
||||||
|
- An LDAP filter specifying if a user should be given administrator
|
||||||
|
privileges. If a user account passes the filter, the user will be
|
||||||
|
privileged as an administrator.
|
||||||
|
- Example: `(objectClass=adminAccount)`
|
||||||
|
- Example for Microsoft Active Directory (AD): `(memberOf=CN=admin-group,OU=example,DC=example,DC=org)`
|
||||||
|
|
||||||
|
- Username attribute (optional)
|
||||||
|
|
||||||
|
- The attribute of the user's LDAP record containing the user name. Given
|
||||||
|
attribute value will be used for new Gitea account user name after first
|
||||||
|
successful sign-in. Leave empty to use login name given on sign-in form.
|
||||||
|
- This is useful when supplied login name is matched against multiple
|
||||||
|
attributes, but only single specific attribute should be used for Gitea
|
||||||
|
account name, see "User Filter".
|
||||||
|
- Example: `uid`
|
||||||
|
- Example for Microsoft Active Directory (AD): `sAMAccountName`
|
||||||
|
|
||||||
|
- First name attribute (optional)
|
||||||
|
|
||||||
|
- The attribute of the user's LDAP record containing the user's first name.
|
||||||
|
This will be used to populate their account information.
|
||||||
|
- Example: `givenName`
|
||||||
|
|
||||||
|
- Surname attribute (optional)
|
||||||
|
|
||||||
|
- The attribute of the user's LDAP record containing the user's surname.
|
||||||
|
This will be used to populate their account information.
|
||||||
|
- Example: `sn`
|
||||||
|
|
||||||
|
- E-mail attribute **(required)**
|
||||||
|
- The attribute of the user's LDAP record containing the user's email
|
||||||
|
address. This will be used to populate their account information.
|
||||||
|
- Example: `mail`
|
||||||
|
|
||||||
|
### LDAP via BindDN
|
||||||
|
|
||||||
|
Adds the following fields:
|
||||||
|
|
||||||
|
- Bind DN (optional)
|
||||||
|
|
||||||
|
- The DN to bind to the LDAP server with when searching for the user. This
|
||||||
|
may be left blank to perform an anonymous search.
|
||||||
|
- Example: `cn=Search,dc=mydomain,dc=com`
|
||||||
|
|
||||||
|
- Bind Password (optional)
|
||||||
|
|
||||||
|
- The password for the Bind DN specified above, if any. _Note: The password
|
||||||
|
is stored encrypted with the SECRET_KEY on the server. It is still recommended
|
||||||
|
to ensure that the Bind DN has as few privileges as possible._
|
||||||
|
|
||||||
|
- User Search Base **(required)**
|
||||||
|
|
||||||
|
- The LDAP base at which user accounts will be searched for.
|
||||||
|
- Example: `ou=Users,dc=mydomain,dc=com`
|
||||||
|
|
||||||
|
- User Filter **(required)**
|
||||||
|
- An LDAP filter declaring how to find the user record that is attempting to
|
||||||
|
authenticate. The `%[1]s` matching parameter will be substituted with login
|
||||||
|
name given on sign-in form.
|
||||||
|
- Example: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))`
|
||||||
|
- Example 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)))`
|
||||||
|
- To substitute more than once, `%[1]s` should be used instead, e.g. when
|
||||||
|
matching supplied login name against multiple attributes such as user
|
||||||
|
identifier, email or even phone number.
|
||||||
|
- Example: `(&(objectClass=Person)(|(uid=%[1]s)(mail=%[1]s)(mobile=%[1]s)))`
|
||||||
|
- Enable user synchronization
|
||||||
|
- This option enables a periodic task that synchronizes the Gitea users with
|
||||||
|
the LDAP server. The default period is every 24 hours but that can be
|
||||||
|
changed in the app.ini file. See the _cron.sync_external_users_ section in
|
||||||
|
the [sample
|
||||||
|
app.ini](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini)
|
||||||
|
for detailed comments about that section. The _User Search Base_ and _User
|
||||||
|
Filter_ settings described above will limit which users can use Gitea and
|
||||||
|
which users will be synchronized. When initially run the task will create
|
||||||
|
all LDAP users that match the given settings so take care if working with
|
||||||
|
large Enterprise LDAP directories.
|
||||||
|
|
||||||
|
### LDAP using simple auth
|
||||||
|
|
||||||
|
Adds the following fields:
|
||||||
|
|
||||||
|
- User DN **(required)**
|
||||||
|
|
||||||
|
- A template to use as the user's DN. The `%s` matching parameter will be
|
||||||
|
substituted with login name given on sign-in form.
|
||||||
|
- Example: `cn=%s,ou=Users,dc=mydomain,dc=com`
|
||||||
|
- Example: `uid=%s,ou=Users,dc=mydomain,dc=com`
|
||||||
|
|
||||||
|
- User Search Base (optional)
|
||||||
|
|
||||||
|
- The LDAP base at which user accounts will be searched for.
|
||||||
|
- Example: `ou=Users,dc=mydomain,dc=com`
|
||||||
|
|
||||||
|
- User Filter **(required)**
|
||||||
|
- An LDAP filter declaring when a user should be allowed to log in. The `%[1]s`
|
||||||
|
matching parameter will be substituted with login name given on sign-in
|
||||||
|
form.
|
||||||
|
- Example: `(&(objectClass=posixAccount)(|(cn=%[1]s)(mail=%[1]s)))`
|
||||||
|
- Example: `(&(objectClass=posixAccount)(|(uid=%[1]s)(mail=%[1]s)))`
|
||||||
|
|
||||||
|
### Verify group membership in LDAP
|
||||||
|
|
||||||
|
Uses the following fields:
|
||||||
|
|
||||||
|
- Group Search Base DN (optional)
|
||||||
|
|
||||||
|
- The LDAP DN used for groups.
|
||||||
|
- Example: `ou=group,dc=mydomain,dc=com`
|
||||||
|
|
||||||
|
- Group Attribute Containing List Of Users (optional)
|
||||||
|
- The attribute of the group object that lists/contains the group members.
|
||||||
|
- Example: `memberUid` or `member`
|
||||||
|
|
||||||
|
- User Attribute Listed in Group (optional)
|
||||||
|
|
||||||
|
- The user attribute that is used to reference a user in the group object.
|
||||||
|
- Example: `uid` if the group objects contains a `member: bender` and the user object contains a `uid: bender`.
|
||||||
|
- Example: `dn` if the group object contains a `member: uid=bender,ou=users,dc=planetexpress,dc=com`.
|
||||||
|
|
||||||
|
- Verify group membership in LDAP (optional)
|
||||||
|
|
||||||
|
- An LDAP filter declaring how to find valid groups in the above DN.
|
||||||
|
- Example: `(|(cn=gitea_users)(cn=admins))`
|
||||||
|
|
||||||
|
## PAM (Pluggable Authentication Module)
|
||||||
|
|
||||||
|
This procedure enables PAM authentication. Users may still be added to the
|
||||||
|
system manually using the user administration. PAM provides a mechanism to
|
||||||
|
automatically add users to the current database by testing them against PAM
|
||||||
|
authentication. To work with normal Linux passwords, the user running Gitea
|
||||||
|
must also have read access to `/etc/shadow` in order to check the validity of
|
||||||
|
the account when logging in using a public key.
|
||||||
|
|
||||||
|
**Note**: If a user has added SSH public keys into Gitea, the use of these
|
||||||
|
keys _may_ bypass the login check system. Therefore, if you wish to disable a user who
|
||||||
|
authenticates with PAM, you _should_ also manually disable the account in Gitea using the
|
||||||
|
built-in user manager.
|
||||||
|
|
||||||
|
1. Configure and prepare the installation.
|
||||||
|
- It is recommended that you create an administrative user.
|
||||||
|
- Deselecting automatic sign-up may also be desired.
|
||||||
|
1. Once the database has been initialized, log in as the newly created
|
||||||
|
administrative user.
|
||||||
|
1. Navigate to the user setting (icon in top-right corner), and select
|
||||||
|
`Site Administration` -> `Authentication Sources`, and select
|
||||||
|
`Add Authentication Source`.
|
||||||
|
1. Fill out the field as follows:
|
||||||
|
- `Authentication Type` : `PAM`
|
||||||
|
- `Name` : Any value should be valid here, use "System Authentication" if
|
||||||
|
you'd like.
|
||||||
|
- `PAM Service Name` : Select the appropriate file listed under `/etc/pam.d/`
|
||||||
|
that performs the authentication desired.[^1]
|
||||||
|
- `PAM Email Domain` : The e-mail suffix to append to user authentication.
|
||||||
|
For example, if the login system expects a user called `gituser`, and this
|
||||||
|
field is set to `mail.com`, then Gitea will expect the `user email` field
|
||||||
|
for an authenticated GIT instance to be `[email protected]`.[^2]
|
||||||
|
|
||||||
|
**Note**: PAM support is added via [build-time flags](installation/from-source.md#build),
|
||||||
|
and the official binaries provided do not have this enabled. PAM requires that
|
||||||
|
the necessary libpam dynamic library be available and the necessary PAM
|
||||||
|
development headers be accessible to the compiler.
|
||||||
|
|
||||||
|
[^1]: For example, using standard Linux log-in on Debian "Bullseye" use
|
||||||
|
`common-session-noninteractive` - this value may be valid for other flavors of
|
||||||
|
Debian including Ubuntu and Mint, consult your distribution's documentation.
|
||||||
|
[^2]: **This is a required field for PAM**. Be aware: In the above example, the
|
||||||
|
user will log into the Gitea web interface as `gituser` and not `[email protected]`
|
||||||
|
|
||||||
|
## SMTP (Simple Mail Transfer Protocol)
|
||||||
|
|
||||||
|
This option allows Gitea to log in to an SMTP host as a Gitea user. To
|
||||||
|
configure this, set the fields below:
|
||||||
|
|
||||||
|
- Authentication Name **(required)**
|
||||||
|
|
||||||
|
- A name to assign to the new method of authorization.
|
||||||
|
|
||||||
|
- SMTP Authentication Type **(required)**
|
||||||
|
|
||||||
|
- Type of authentication to use to connect to SMTP host, PLAIN or LOGIN.
|
||||||
|
|
||||||
|
- Host **(required)**
|
||||||
|
|
||||||
|
- The address where the SMTP host can be reached.
|
||||||
|
- Example: `smtp.mydomain.com`
|
||||||
|
|
||||||
|
- Port **(required)**
|
||||||
|
|
||||||
|
- The port to use when connecting to the server.
|
||||||
|
- Example: `587`
|
||||||
|
|
||||||
|
- Allowed Domains
|
||||||
|
|
||||||
|
- Restrict what domains can log in if using a public SMTP host or SMTP host
|
||||||
|
with multiple domains.
|
||||||
|
- Example: `gitea.com,mydomain.com,mydomain2.com`
|
||||||
|
|
||||||
|
- Force SMTPS
|
||||||
|
|
||||||
|
- SMTPS will be used by default for connections to port 465, if you wish to use SMTPS
|
||||||
|
for other ports. Set this value.
|
||||||
|
- Otherwise if the server provides the `STARTTLS` extension this will be used.
|
||||||
|
|
||||||
|
- Skip TLS Verify
|
||||||
|
|
||||||
|
- Disable TLS verify on authentication.
|
||||||
|
|
||||||
|
- This Authentication Source is Activated
|
||||||
|
- Enable or disable this authentication source.
|
||||||
|
|
||||||
|
## FreeIPA
|
||||||
|
|
||||||
|
- In order to log in to Gitea using FreeIPA credentials, a bind account needs to
|
||||||
|
be created for Gitea:
|
||||||
|
|
||||||
|
- On the FreeIPA server, create a `gitea.ldif` file, replacing `dc=example,dc=com`
|
||||||
|
with your DN, and provide an appropriately secure password:
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
- Import the LDIF (change localhost to an IPA server if needed). A prompt for
|
||||||
|
Directory Manager password will be presented:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
ldapmodify -h localhost -p 389 -x -D \
|
||||||
|
"cn=Directory Manager" -W -f gitea.ldif
|
||||||
|
```
|
||||||
|
|
||||||
|
- Add an IPA group for gitea_users :
|
||||||
|
|
||||||
|
```sh
|
||||||
|
ipa group-add --desc="Gitea Users" gitea_users
|
||||||
|
```
|
||||||
|
|
||||||
|
- Note: For errors about IPA credentials, run `kinit admin` and provide the
|
||||||
|
domain admin account password.
|
||||||
|
|
||||||
|
- Log in to Gitea as an Administrator and click on "Authentication" under Admin Panel.
|
||||||
|
Then click `Add New Source` and fill in the details, changing all where appropriate.
|
||||||
|
|
||||||
|
## SPNEGO with SSPI (Kerberos/NTLM, for Windows only)
|
||||||
|
|
||||||
|
Gitea supports SPNEGO single sign-on authentication (the scheme defined by RFC4559) for the web part of the server via the Security Support Provider Interface (SSPI) built in Windows. SSPI works only in Windows environments - when both the server and the clients are running Windows.
|
||||||
|
|
||||||
|
Before activating SSPI single sign-on authentication (SSO) you have to prepare your environment:
|
||||||
|
|
||||||
|
- Create a separate user account in active directory, under which the `gitea.exe` process will be running (eg. `user` under domain `domain.local`):
|
||||||
|
|
||||||
|
- Create a service principal name for the host where `gitea.exe` is running with class `HTTP`:
|
||||||
|
|
||||||
|
- Start `Command Prompt` or `PowerShell` as a privileged domain user (eg. Domain Administrator)
|
||||||
|
- Run the command below, replacing `host.domain.local` with the fully qualified domain name (FQDN) of the server where the web application will be running, and `domain\user` with the name of the account created in the previous step:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
setspn -A HTTP/host.domain.local domain\user
|
||||||
|
```
|
||||||
|
|
||||||
|
- Sign in (_sign out if you were already signed in_) with the user created
|
||||||
|
|
||||||
|
- Make sure that `ROOT_URL` in the `[server]` section of `custom/conf/app.ini` is the fully qualified domain name of the server where the web application will be running - the same you used when creating the service principal name (eg. `host.domain.local`)
|
||||||
|
|
||||||
|
- Start the web server (`gitea.exe web`)
|
||||||
|
|
||||||
|
- Enable SSPI authentication by adding an `SPNEGO with SSPI` authentication source in `Site Administration -> Authentication Sources`
|
||||||
|
|
||||||
|
- Sign in to a client computer in the same domain with any domain user (client computer, different from the server running `gitea.exe`)
|
||||||
|
|
||||||
|
- If you are using Chrome or Edge, add the URL of the web app to the Local intranet sites (`Internet Options -> Security -> Local intranet -> Sites`)
|
||||||
|
|
||||||
|
- Start Chrome or Edge and navigate to the FQDN URL of Gitea (eg. `http://host.domain.local:3000`)
|
||||||
|
|
||||||
|
- Click the `Sign In` button on the dashboard and choose SSPI to be automatically logged in with the same user that is currently logged on to the computer
|
||||||
|
|
||||||
|
- If it does not work, make sure that:
|
||||||
|
- You are not running the web browser on the same server where Gitea is running. You should be running the web browser on a domain joined computer (client) that is different from the server. If both the client and server are running on the same computer NTLM will be preferred over Kerberos.
|
||||||
|
- There is only one `HTTP/...` SPN for the host
|
||||||
|
- The SPN contains only the hostname, without the port
|
||||||
|
- You have added the URL of the web app to the `Local intranet zone`
|
||||||
|
- The clocks of the server and client should not differ with more than 5 minutes (depends on group policy)
|
||||||
|
- `Integrated Windows Authentication` should be enabled in Internet Explorer (under `Advanced settings`)
|
||||||
|
|
||||||
|
## Reverse Proxy
|
||||||
|
|
||||||
|
Gitea supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[service]
|
||||||
|
ENABLE_REVERSE_PROXY_AUTHENTICATION = true
|
||||||
|
```
|
||||||
|
|
||||||
|
The default login user name is in the `X-WEBAUTH-USER` header, you can change it via changing `REVERSE_PROXY_AUTHENTICATION_USER` in app.ini. If the user doesn't exist, you can enable automatic registration with `ENABLE_REVERSE_PROXY_AUTO_REGISTRATION=true`.
|
||||||
|
|
||||||
|
The default login user email is `X-WEBAUTH-EMAIL`, you can change it via changing `REVERSE_PROXY_AUTHENTICATION_EMAIL` in app.ini, this could also be disabled with `ENABLE_REVERSE_PROXY_EMAIL`
|
||||||
|
|
||||||
|
If set `ENABLE_REVERSE_PROXY_FULL_NAME=true`, a user full name expected in `X-WEBAUTH-FULLNAME` will be assigned to the user when auto creating the user. You can also change the header name with `REVERSE_PROXY_AUTHENTICATION_FULL_NAME`.
|
||||||
|
|
||||||
|
You can also limit the reverse proxy's IP address range with `REVERSE_PROXY_TRUSTED_PROXIES` which default value is `127.0.0.0/8,::1/128`. By `REVERSE_PROXY_LIMIT`, you can limit trusted proxies level.
|
||||||
|
|
||||||
|
You can enable the this authentication method for the API with
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[service]
|
||||||
|
ENABLE_REVERSE_PROXY_AUTHENTICATION_API = true
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
When this method is enabled for the API, the reverse proxy is responsible for handling CSRF protection.
|
||||||
|
:::
|
||||||
@@ -0,0 +1,176 @@
|
|||||||
|
---
|
||||||
|
date: "2017-01-01T16:00:00+02:00"
|
||||||
|
slug: "backup-and-restore"
|
||||||
|
sidebar_position: 11
|
||||||
|
aliases:
|
||||||
|
- /en-us/backup-and-restore
|
||||||
|
---
|
||||||
|
|
||||||
|
# Backup and Restore
|
||||||
|
|
||||||
|
Gitea currently has a `dump` command that will save the installation to a ZIP file. This
|
||||||
|
file can be unpacked and used to restore an instance.
|
||||||
|
|
||||||
|
## Backup Consistency
|
||||||
|
|
||||||
|
To ensure the consistency of the Gitea instance, it must be shutdown during backup.
|
||||||
|
|
||||||
|
Gitea consists of a database, files and git repositories, all of which change when it is used. For instance, when a migration is in progress, a transaction is created in the database while the git repository is being copied over. If the backup happens in the middle of the migration, the git repository may be incomplete although the database claims otherwise because it was dumped afterwards. The only way to avoid such race conditions is by stopping the Gitea instance during the backups.
|
||||||
|
|
||||||
|
## Backup Command (`dump`)
|
||||||
|
|
||||||
|
Switch to the user running Gitea: `su git`. Run `./gitea dump -c /path/to/app.ini` in the Gitea installation
|
||||||
|
directory. There should be some output similar to the following:
|
||||||
|
|
||||||
|
```log
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
Inside the `gitea-dump-1482906742.zip` file, will be the following:
|
||||||
|
|
||||||
|
- `app.ini` - Optional copy of configuration file if originally stored outside the default `custom/` directory
|
||||||
|
- `custom/` - All config or customization files in `custom/`.
|
||||||
|
- `data/` - Data directory (APP_DATA_PATH), except sessions if you are using file session. This directory includes `attachments`, `avatars`, `lfs`, `indexers`, SQLite file if you are using SQLite.
|
||||||
|
- `repos/` - Complete copy of the repository directory.
|
||||||
|
- `gitea-db.sql` - SQL dump of database
|
||||||
|
- `log/` - Various logs. They are not needed for a recovery or migration.
|
||||||
|
|
||||||
|
Intermediate backup files are created in a temporary directory specified either with the
|
||||||
|
`--tempdir` command-line parameter or the `TMPDIR` environment variable.
|
||||||
|
|
||||||
|
## Backup the database
|
||||||
|
|
||||||
|
The SQL dump created by `gitea dump` uses XORM and Gitea admins may prefer to use the native the MySQL and PostgreSQL dump tools instead. There are still open issues when using XORM for dumping the database that may cause problems when attempting to restore it.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# mysql
|
||||||
|
mysqldump -u$USER -p$PASS --database $DATABASE > gitea-db.sql
|
||||||
|
# postgres
|
||||||
|
pg_dump -U $USER $DATABASE > gitea-db.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using Docker (`dump`)
|
||||||
|
|
||||||
|
There are a few caveats for using the `dump` command with Docker.
|
||||||
|
|
||||||
|
The command has to be executed with the `RUN_USER = <OS_USERNAME>` specified in `gitea/conf/app.ini`; and, for the zipping of the backup folder to occur without permission error the command `docker exec` must be executed inside of the `--tempdir`.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker exec -u <OS_USERNAME> -it -w <--tempdir> $(docker ps -qf 'name=^<NAME_OF_DOCKER_CONTAINER>$') bash -c '/usr/local/bin/gitea dump -c </path/to/app.ini>'
|
||||||
|
```
|
||||||
|
|
||||||
|
\*Note: `--tempdir` refers to the temporary directory of the docker environment used by Gitea; if you have not specified a custom `--tempdir`, then Gitea uses `/tmp` or the `TMPDIR` environment variable of the docker container. For `--tempdir` adjust your `docker exec` command options accordingly.
|
||||||
|
|
||||||
|
The result should be a file, stored in the `--tempdir` specified, along the lines of: `gitea-dump-1482906742.zip`
|
||||||
|
|
||||||
|
## Restore Command (`restore`)
|
||||||
|
|
||||||
|
There is currently no support for a recovery command. It is a manual process that mostly
|
||||||
|
involves moving files to their correct locations and restoring a database dump.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```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/data/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 <gitea-db.sql
|
||||||
|
# sqlite3
|
||||||
|
sqlite3 $DATABASE_PATH <gitea-db.sql
|
||||||
|
# postgres
|
||||||
|
psql -U $USER -d $DATABASE < gitea-db.sql
|
||||||
|
|
||||||
|
service gitea restart
|
||||||
|
```
|
||||||
|
|
||||||
|
Repository Git Hooks should be regenerated if installation method is changed (eg. binary -> Docker), or if Gitea is installed to a different directory than the previous installation.
|
||||||
|
|
||||||
|
With Gitea running, and from the directory Gitea's binary is located, execute: `./gitea admin regenerate hooks`
|
||||||
|
|
||||||
|
This ensures that application and configuration file paths in repository Git Hooks are consistent and applicable to the current installation. If these paths are not updated, repository `push` actions will fail.
|
||||||
|
|
||||||
|
If you still have issues, consider running `./gitea doctor check` to inspect possible errors (or run with `--fix`).
|
||||||
|
|
||||||
|
### Using Docker (`restore`)
|
||||||
|
|
||||||
|
There is also no support for a recovery command in a Docker-based gitea instance. The restore process contains the same steps as described in the previous section but with different paths.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# open bash session in container
|
||||||
|
docker exec --user git -it 2a83b293548e bash
|
||||||
|
# unzip your backup file within the container
|
||||||
|
unzip gitea-dump-1610949662.zip
|
||||||
|
cd gitea-dump-1610949662
|
||||||
|
# restore the gitea data
|
||||||
|
mv data/* /data/gitea
|
||||||
|
# restore the repositories itself
|
||||||
|
mv repos/* /data/git/gitea-repositories/
|
||||||
|
# adjust file permissions
|
||||||
|
chown -R git:git /data
|
||||||
|
# Regenerate Git Hooks
|
||||||
|
/usr/local/bin/gitea -c '/data/gitea/conf/app.ini' admin regenerate hooks
|
||||||
|
```
|
||||||
|
|
||||||
|
The default user in the gitea container is `git` (1000:1000). Please replace `2a83b293548e` with your gitea container id or name.
|
||||||
|
|
||||||
|
### Using Docker-rootless (`restore`)
|
||||||
|
|
||||||
|
The restore workflow in Docker-rootless containers differs only in the directories to be used:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# open bash session in container
|
||||||
|
docker exec --user git -it 2a83b293548e bash
|
||||||
|
# unzip your backup file within the container
|
||||||
|
unzip gitea-dump-1610949662.zip
|
||||||
|
cd gitea-dump-1610949662
|
||||||
|
# restore the app.ini
|
||||||
|
mv data/conf/app.ini /etc/gitea/app.ini
|
||||||
|
# restore the gitea data
|
||||||
|
mv data/* /var/lib/gitea
|
||||||
|
# restore the repositories itself
|
||||||
|
mv repos/* /var/lib/gitea/git/gitea-repositories
|
||||||
|
# adjust file permissions
|
||||||
|
chown -R git:git /etc/gitea/app.ini /var/lib/gitea
|
||||||
|
# Regenerate Git Hooks
|
||||||
|
/usr/local/bin/gitea -c '/etc/gitea/app.ini' admin regenerate hooks
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using `gitea dump` to convert database types
|
||||||
|
|
||||||
|
The `gitea dump` command can produce a SQL file that can be read by another database type, which is useful to convert the database to another in case you did not choose the correct one during the first installation.
|
||||||
|
|
||||||
|
Note that this conversion process is not well-tested, which is why it is recommended to choose the final database type during the first installation without attempting to change it afterwards.
|
||||||
|
|
||||||
|
Stop the Gitea server, then make sure you have a full backup of your original database.
|
||||||
|
|
||||||
|
Before attempting the conversion, ensure that the original database is clean. Run `gitea doctor check --all --fix` and `gitea doctor recreate-table` to address common issues.
|
||||||
|
|
||||||
|
Use the `--database` flag to get a Gitea dump with the SQL file in the target format, in this example PostgreSQL: `gitea dump --database postgres`, then extract the file `gitea-db.sql` from the generated ZIP file.
|
||||||
|
|
||||||
|
Create the PostgreSQL Gitea user and Gitea database. Then, import the SQL file as the Gitea user into the Gitea database, using commands such as:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo -u postgres psql -d gitea
|
||||||
|
gitea=# SET synchronous_commit TO off
|
||||||
|
gitea=# SET on_error_stop TO on
|
||||||
|
gitea=# \i gitea-db.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
Disabling `synchronous_commit` makes PostgreSQL less resilient to crashes, but makes the import a lot faster. Since we already have a backup of the original database and we can check that the import completes successfully, it should be a good trade-off.
|
||||||
|
|
||||||
|
After the import is completed, set up Gitea to use PostgreSQL and start the Gitea server again. Good luck!
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
---
|
||||||
|
date: "2020-01-25T21:00:00-03:00"
|
||||||
|
slug: "cmd-embedded"
|
||||||
|
sidebar_position: 20
|
||||||
|
aliases:
|
||||||
|
- /en-us/cmd-embedded
|
||||||
|
---
|
||||||
|
|
||||||
|
# Embedded data extraction tool
|
||||||
|
|
||||||
|
Gitea's executable contains all the resources required to run: templates, images, style-sheets
|
||||||
|
and translations. Any of them can be overridden by placing a replacement in a matching path
|
||||||
|
inside the `custom` directory (see [Customizing Gitea](../administration/customizing-gitea.md)).
|
||||||
|
|
||||||
|
To obtain a copy of the embedded resources ready for editing, the `embedded` command from the CLI
|
||||||
|
can be used from the OS shell interface.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
The embedded data extraction tool is included in Gitea versions 1.12 and above.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Listing resources
|
||||||
|
|
||||||
|
To list resources embedded in Gitea's executable, use the following syntax:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
gitea embedded list [--include-vendored] [patterns...]
|
||||||
|
```
|
||||||
|
|
||||||
|
The `--include-vendored` flag makes the command include vendored files, which are
|
||||||
|
normally excluded; that is, files from external libraries that are required for Gitea
|
||||||
|
(e.g. [octicons](https://octicons.github.com/), etc).
|
||||||
|
|
||||||
|
A list of file search patterns can be provided. Gitea uses [gobwas/glob](https://github.com/gobwas/glob)
|
||||||
|
for its glob syntax. Here are some examples:
|
||||||
|
|
||||||
|
- List all template files, in any virtual directory: `**.tmpl`
|
||||||
|
- List all mail template files: `templates/mail/**.tmpl`
|
||||||
|
- List all files inside `public/assets/img`: `public/assets/img/**`
|
||||||
|
|
||||||
|
Don't forget to use quotes for the patterns, as spaces, `*` and other characters might have
|
||||||
|
a special meaning for your command shell.
|
||||||
|
|
||||||
|
If no pattern is provided, all files are listed.
|
||||||
|
|
||||||
|
### Example: Listing all embedded files
|
||||||
|
|
||||||
|
Listing all embedded files with `openid` in their path:
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
|
## Extracting resources
|
||||||
|
|
||||||
|
To extract resources embedded in Gitea's executable, use the following syntax:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
gitea [--config {file}] embedded extract [--destination {dir}|--custom] [--overwrite|--rename] [--include-vendored] {patterns...}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `--config` option tells Gitea the location of the `app.ini` configuration file if
|
||||||
|
it's not in its default location. This option is only used with the `--custom` flag.
|
||||||
|
|
||||||
|
The `--destination` option tells Gitea the directory where the files must be extracted to.
|
||||||
|
The default is the current directory.
|
||||||
|
|
||||||
|
The `--custom` flag tells Gitea to extract the files directly into the `custom` directory.
|
||||||
|
For this to work, the command needs to know the location of the `app.ini` configuration
|
||||||
|
file (`--config`) and, depending of the configuration, be ran from the directory where
|
||||||
|
Gitea normally starts. See [Customizing Gitea](../administration/customizing-gitea.md) for details.
|
||||||
|
|
||||||
|
The `--overwrite` flag allows any existing files in the destination directory to be overwritten.
|
||||||
|
|
||||||
|
The `--rename` flag tells Gitea to rename any existing files in the destination directory
|
||||||
|
as `filename.bak`. Previous `.bak` files are overwritten.
|
||||||
|
|
||||||
|
At least one file search pattern must be provided; see `list` subcomand above for pattern
|
||||||
|
syntax and examples.
|
||||||
|
|
||||||
|
### Important notice
|
||||||
|
|
||||||
|
Make sure to **only extract those files that require customization**. Files that
|
||||||
|
are present in the `custom` directory are not upgraded by Gitea's upgrade process.
|
||||||
|
When Gitea is upgraded to a new version (by replacing the executable), many of the
|
||||||
|
embedded files will suffer changes. Gitea will honor and use any files found
|
||||||
|
in the `custom` directory, even if they are old and incompatible.
|
||||||
|
|
||||||
|
### Example: Extracting mail templates
|
||||||
|
|
||||||
|
Extracting mail templates to a temporary directory:
|
||||||
|
|
||||||
|
```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
|
||||||
|
```
|
||||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,120 @@
|
|||||||
|
---
|
||||||
|
date: "2019-10-15T10:10:00+05:00"
|
||||||
|
slug: "email-setup"
|
||||||
|
sidebar_position: 12
|
||||||
|
aliases:
|
||||||
|
- /en-us/email-setup
|
||||||
|
---
|
||||||
|
|
||||||
|
# Email setup
|
||||||
|
|
||||||
|
Gitea has mailer functionality for sending transactional emails (such as registration confirmation). It can be configured to either use Sendmail (or compatible MTAs like Postfix and msmtp) or directly use SMTP server.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Be sure to set ENABLE_NOTIFY_MAIL=true to allow Gitea to send email notifications. Check the [Config Cheat Sheet](../administration/config-cheat-sheet.md#service-service) for details.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Using Sendmail
|
||||||
|
|
||||||
|
Use `sendmail` command as mailer.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
For use in the official Gitea Docker image, please configure with the SMTP version (see the following section).
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::note
|
||||||
|
For Internet-facing sites consult documentation of your MTA for instructions to send emails over TLS. Also set up SPF, DMARC, and DKIM DNS records to make emails sent be accepted as legitimate by various email providers.
|
||||||
|
:::
|
||||||
|
|
||||||
|
```ini title="app.ini"
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
FROM = [email protected]
|
||||||
|
PROTOCOL = sendmail
|
||||||
|
SENDMAIL_PATH = /usr/sbin/sendmail
|
||||||
|
SENDMAIL_ARGS = "--" ; most "sendmail" programs take options, "--" will prevent an email address being interpreted as an option.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Using SMTP
|
||||||
|
|
||||||
|
Directly use SMTP server as relay. This option is useful if you don't want to set up MTA on your instance but you have an account at email provider.
|
||||||
|
|
||||||
|
```ini title="app.ini"
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
FROM = [email protected]
|
||||||
|
PROTOCOL = smtps
|
||||||
|
SMTP_ADDR = mail.mydomain.com
|
||||||
|
SMTP_PORT = 587
|
||||||
|
USER = [email protected]
|
||||||
|
PASSWD = `password`
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart Gitea for the configuration changes to take effect.
|
||||||
|
|
||||||
|
To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > Summary -> Mailer Configuration.
|
||||||
|
|
||||||
|
For the full list of options check the [Config Cheat Sheet](../administration/config-cheat-sheet.md)
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:
|
||||||
|
:::
|
||||||
|
|
||||||
|
- STARTTLS (also known as Opportunistic TLS) via port 587 with `PROTOCOL=smtp+starttls`. Initial connection is done over cleartext, but then be upgraded over TLS if the server supports it.
|
||||||
|
- SMTPS connection (SMTP over TLS) via the default port 465. Connection to the server use TLS from the beginning.
|
||||||
|
- Forced SMTPS connection with `PROTOCOL=smtps`. (These are both known as Implicit TLS.)
|
||||||
|
This is due to protections imposed by the Go internal libraries against STRIPTLS attacks.
|
||||||
|
|
||||||
|
Note that Implicit TLS is recommended by [RFC8314](https://tools.ietf.org/html/rfc8314#section-3) since 2018.
|
||||||
|
|
||||||
|
### Gmail
|
||||||
|
|
||||||
|
The following configuration should work with GMail's SMTP server:
|
||||||
|
|
||||||
|
```ini title="app.ini"
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
HOST = smtp.gmail.com:465 ; Remove this line for Gitea >= 1.18.0
|
||||||
|
SMTP_ADDR = smtp.gmail.com
|
||||||
|
SMTP_PORT = 465
|
||||||
|
FROM = [email protected]
|
||||||
|
USER = example.user
|
||||||
|
PASSWD = `***`
|
||||||
|
PROTOCOL = smtps
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that you'll need to create and use an [App password](https://support.google.com/accounts/answer/185833?hl=en) by enabling 2FA on your Google
|
||||||
|
account. You won't be able to use your Google account password directly.
|
||||||
|
|
||||||
|
### ProtonMail
|
||||||
|
|
||||||
|
This feature is currently only available for select Proton for Business customers and those with Visionary and Family plans with custom domain addresses. See [ProtonMail's SMTP documentation](https://proton.me/support/smtp-submission) for more information. This limitation can be circumvented by using the ProtonMail Bridge application.
|
||||||
|
|
||||||
|
Note that emails sent using SMTP are not [end-to-end encrypted](https://proton.me/support/proton-mail-encryption-explained). However, they’re still stored with zero-access encryption like any other emails in your Proton Mail inbox.
|
||||||
|
|
||||||
|
The following configuration should work with ProtonMail's SMTP server:
|
||||||
|
|
||||||
|
1. In your browser (or desktop application), sign in to your Proton Mail account and select **Settings → All settings → Proton Mail → IMAP/SMTP → SMTP tokens**.
|
||||||
|
2. Click **Generate token**.
|
||||||
|
3. Enter the following details to create a new SMTP token:
|
||||||
|
- **Token name**: Select a name for your token. This is for your reference only and does not affect the token's functionality.
|
||||||
|
- **Email address**: Select one of your active custom domain addresses to pair with your token. Copy this email address and use it for the `FROM` and `USER` configuration in `app.ini`.
|
||||||
|
4. Click **Generate**.
|
||||||
|
5. Enter your Proton Mail Account password.
|
||||||
|
|
||||||
|
Your SMTP username and SMTP token (password) will be generated. You can now enter them as the `USER` and `PASSWD` in your `app.ini` configuration.
|
||||||
|
|
||||||
|
```ini title="app.ini"
|
||||||
|
[mailer]
|
||||||
|
ENABLED = true
|
||||||
|
FROM = [email protected]
|
||||||
|
PROTOCOL = smtp+starttls
|
||||||
|
SMTP_ADDR = smtp.protonmail.ch
|
||||||
|
SMTP_PORT = 587
|
||||||
|
USER = [email protected]
|
||||||
|
PASSWD = `TOKEN`
|
||||||
|
```
|
||||||
|
|
||||||
|
After closing the popup, you will not be able to see this SMTP token (password) again for security reasons. You can always generate more tokens if you need to rotate passwords.
|
||||||
|
|
||||||
|
Note: Your Proton Mail login or mailbox passwords will not work with SMTP
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
date: "2017-04-08T11:34:00+02:00"
|
||||||
|
slug: "environment-variables"
|
||||||
|
sidebar_position: 10
|
||||||
|
aliases:
|
||||||
|
- /en-us/environment-variables
|
||||||
|
---
|
||||||
|
|
||||||
|
# Environment variables
|
||||||
|
|
||||||
|
This is an inventory of Gitea environment variables. They change Gitea behaviour.
|
||||||
|
|
||||||
|
Initialize them before Gitea command to be effective, for example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
GITEA_CUSTOM=/home/gitea/custom ./gitea web
|
||||||
|
```
|
||||||
|
|
||||||
|
## From Go language
|
||||||
|
|
||||||
|
As Gitea is written in Go, it uses some variables that influence the behaviour of Go's runtime, such as:
|
||||||
|
|
||||||
|
- `GOMEMLIMIT`
|
||||||
|
- `GOGC`
|
||||||
|
- `GOMAXPROCS`
|
||||||
|
- `GODEBUG`
|
||||||
|
|
||||||
|
For documentation about each of the variables available, refer to the
|
||||||
|
[official Go documentation on runtime environment variables](https://pkg.go.dev/runtime#hdr-Environment_Variables).
|
||||||
|
|
||||||
|
## Gitea files
|
||||||
|
|
||||||
|
- `GITEA_WORK_DIR`: Absolute path of working directory.
|
||||||
|
- `GITEA_CUSTOM`: Gitea uses `WorkPath`/custom folder by default. Use this variable to change _custom_ directory.
|
||||||
|
|
||||||
|
## Operating system specifics
|
||||||
|
|
||||||
|
- `USER`: System user that Gitea will run as. Used for some repository access strings.
|
||||||
|
- `USERNAME`: if no `USER` found, Gitea will use `USERNAME`
|
||||||
|
- `HOME`: User home directory path. The `USERPROFILE` environment variable is used in Windows.
|
||||||
|
|
||||||
|
### Only on Windows
|
||||||
|
|
||||||
|
- `USERPROFILE`: User home directory path. If empty, uses `HOMEDRIVE` + `HOMEPATH`
|
||||||
|
- `HOMEDRIVE`: Main drive path used to access the home directory (C:)
|
||||||
|
- `HOMEPATH`: Home relative path in the given home drive path
|
||||||
|
|
||||||
|
## Miscellaneous
|
||||||
|
|
||||||
|
- `SKIP_MINWINSVC`: If set to 1, do not run as a service on Windows.
|
||||||
@@ -0,0 +1,183 @@
|
|||||||
|
---
|
||||||
|
date: "2018-11-23:00:00+02:00"
|
||||||
|
slug: "external-renderers"
|
||||||
|
sidebar_position: 60
|
||||||
|
aliases:
|
||||||
|
- /en-us/external-renderers
|
||||||
|
---
|
||||||
|
|
||||||
|
# External renderers
|
||||||
|
|
||||||
|
Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries,
|
||||||
|
it is just a matter of:
|
||||||
|
|
||||||
|
- installing external binaries
|
||||||
|
- add some configuration to your `app.ini` file
|
||||||
|
- restart your Gitea instance
|
||||||
|
|
||||||
|
This supports rendering of whole files. If you want to render code blocks in markdown you would need to do something with javascript. See some examples on the [Customizing Gitea](../administration/customizing-gitea.md) page.
|
||||||
|
|
||||||
|
## Installing external binaries
|
||||||
|
|
||||||
|
In order to get file rendering through external binaries, their associated packages must be installed.
|
||||||
|
If you're using a Docker image, your `Dockerfile` should contain something along this lines:
|
||||||
|
|
||||||
|
```docker
|
||||||
|
FROM docker.gitea.com/gitea:@dockerVersion@
|
||||||
|
[...]
|
||||||
|
|
||||||
|
COPY custom/app.ini /data/gitea/conf/app.ini
|
||||||
|
[...]
|
||||||
|
|
||||||
|
RUN apk --no-cache add asciidoctor freetype freetype-dev gcc g++ libpng libffi-dev pandoc python3-dev py3-pyzmq pipx
|
||||||
|
# install any other package you need for your external renderers
|
||||||
|
|
||||||
|
RUN pipx install jupyter docutils --include-deps --global
|
||||||
|
# add above any other python package you may need to install
|
||||||
|
```
|
||||||
|
|
||||||
|
## `app.ini` file configuration
|
||||||
|
|
||||||
|
add one `[markup.XXXXX]` section per external renderer on your custom `app.ini`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.asciidoc]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .adoc,.asciidoc
|
||||||
|
RENDER_COMMAND = "asciidoctor -s -a showtitle --out-file=- -"
|
||||||
|
; Input is not a standard input but a file
|
||||||
|
IS_INPUT_FILE = false
|
||||||
|
|
||||||
|
[markup.jupyter]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .ipynb
|
||||||
|
RENDER_COMMAND = "jupyter nbconvert --stdin --stdout --to html --template basic"
|
||||||
|
IS_INPUT_FILE = false
|
||||||
|
|
||||||
|
[markup.restructuredtext]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .rst
|
||||||
|
RENDER_COMMAND = "timeout 30s pandoc +RTS -M512M -RTS -f rst"
|
||||||
|
IS_INPUT_FILE = false
|
||||||
|
```
|
||||||
|
|
||||||
|
If your external markup relies on additional classes and attributes on the generated HTML elements, you might need to enable custom sanitizer policies. Gitea uses the [`bluemonday`](https://godoc.org/github.com/microcosm-cc/bluemonday) package as our HTML sanitizer. The example below could be used to support server-side [KaTeX](https://katex.org/) rendering output from [`pandoc`](https://pandoc.org/).
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.sanitizer.TeX]
|
||||||
|
; Pandoc renders TeX segments as <span>s with the "math" class, optionally
|
||||||
|
; with "inline" or "display" classes depending on context.
|
||||||
|
; - note this is different from the built-in math support in our markdown parser which uses <code>
|
||||||
|
ELEMENT = span
|
||||||
|
ALLOW_ATTR = class
|
||||||
|
REGEXP = ^\s*((math(\s+|$)|inline(\s+|$)|display(\s+|$)))+
|
||||||
|
|
||||||
|
[markup.markdown]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .md,.markdown
|
||||||
|
RENDER_COMMAND = pandoc -f markdown -t html --katex
|
||||||
|
```
|
||||||
|
|
||||||
|
You must define `ELEMENT` and `ALLOW_ATTR` in each section.
|
||||||
|
|
||||||
|
To define multiple entries, add a unique alphanumeric suffix (e.g., `[markup.sanitizer.1]` and `[markup.sanitizer.something]`).
|
||||||
|
|
||||||
|
To apply a sanitisation rules only for a specify external renderer they must use the renderer name, e.g. `[markup.sanitizer.asciidoc.rule-1]`, `[markup.sanitizer.<renderer>.rule-1]`.
|
||||||
|
|
||||||
|
**Note**: If the rule is defined above the renderer ini section or the name does not match a renderer it is applied to every renderer.
|
||||||
|
|
||||||
|
Once your configuration changes have been made, restart Gitea to have changes take effect.
|
||||||
|
|
||||||
|
**Note**: Prior to Gitea 1.12 there was a single `markup.sanitiser` section with keys that were redefined for multiple rules, however,
|
||||||
|
there were significant problems with this method of configuration necessitating configuration through multiple sections.
|
||||||
|
|
||||||
|
### Example: HTML
|
||||||
|
|
||||||
|
Render HTML files directly:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.html]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .html,.htm
|
||||||
|
RENDER_COMMAND = cat
|
||||||
|
; Input is not a standard input but a file
|
||||||
|
IS_INPUT_FILE = true
|
||||||
|
|
||||||
|
[markup.sanitizer.html.1]
|
||||||
|
ELEMENT = div
|
||||||
|
ALLOW_ATTR = class
|
||||||
|
|
||||||
|
[markup.sanitizer.html.2]
|
||||||
|
ELEMENT = a
|
||||||
|
ALLOW_ATTR = class
|
||||||
|
```
|
||||||
|
|
||||||
|
### Example: Office DOCX
|
||||||
|
|
||||||
|
Display Office DOCX files with [`pandoc`](https://pandoc.org/):
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.docx]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .docx
|
||||||
|
RENDER_COMMAND = "pandoc --from docx --to html --self-contained --template /path/to/basic.html"
|
||||||
|
|
||||||
|
[markup.sanitizer.docx.img]
|
||||||
|
ALLOW_DATA_URI_IMAGES = true
|
||||||
|
```
|
||||||
|
|
||||||
|
The template file has the following content:
|
||||||
|
|
||||||
|
```
|
||||||
|
$body$
|
||||||
|
```
|
||||||
|
|
||||||
|
### Example: Jupyter Notebook
|
||||||
|
|
||||||
|
Display Jupyter Notebook files with [`nbconvert`](https://github.com/jupyter/nbconvert):
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[markup.jupyter]
|
||||||
|
ENABLED = true
|
||||||
|
FILE_EXTENSIONS = .ipynb
|
||||||
|
RENDER_COMMAND = "jupyter-nbconvert --stdin --stdout --to html --template basic"
|
||||||
|
|
||||||
|
[markup.sanitizer.jupyter.img]
|
||||||
|
ALLOW_DATA_URI_IMAGES = true
|
||||||
|
```
|
||||||
|
|
||||||
|
## Customizing CSS
|
||||||
|
|
||||||
|
The external renderer is specified in the .ini in the format `[markup.XXXXX]` and the HTML supplied by your external renderer will be wrapped in a `<div>` with classes `markup` and `XXXXX`. The `markup` class provides out of the box styling (as does `markdown` if `XXXXX` is `markdown`). Otherwise you can use these classes to specifically target the contents of your rendered HTML.
|
||||||
|
|
||||||
|
And so you could write some CSS:
|
||||||
|
|
||||||
|
```css
|
||||||
|
.markup.XXXXX html {
|
||||||
|
font-size: 100%;
|
||||||
|
overflow-y: scroll;
|
||||||
|
-webkit-text-size-adjust: 100%;
|
||||||
|
-ms-text-size-adjust: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.markup.XXXXX body {
|
||||||
|
color: #444;
|
||||||
|
font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif;
|
||||||
|
font-size: 12px;
|
||||||
|
line-height: 1.7;
|
||||||
|
padding: 1em;
|
||||||
|
margin: auto;
|
||||||
|
max-width: 42em;
|
||||||
|
background: #fefefe;
|
||||||
|
}
|
||||||
|
|
||||||
|
.markup.XXXXX p {
|
||||||
|
color: orangered;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Add your stylesheet to your custom directory e.g `custom/public/assets/css/my-style-XXXXX.css` and import it using a custom header file `custom/templates/custom/header.tmpl`:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<link rel="stylesheet" href="{{AppSubUrl}}/assets/css/my-style-XXXXX.css" />
|
||||||
|
```
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
---
|
||||||
|
date: "2018-05-11T11:00:00+02:00"
|
||||||
|
slug: "fail2ban-setup"
|
||||||
|
sidebar_position: 16
|
||||||
|
aliases:
|
||||||
|
- /en-us/fail2ban-setup
|
||||||
|
---
|
||||||
|
|
||||||
|
# Fail2ban Setup
|
||||||
|
|
||||||
|
**Remember that fail2ban is powerful and can cause lots of issues if you do it incorrectly, so make
|
||||||
|
sure to test this before relying on it so you don't lock yourself out.**
|
||||||
|
|
||||||
|
Gitea returns an HTTP 200 for bad logins in the web logs, but if you have logging options on in
|
||||||
|
`app.ini`, then you should be able to go off of `log/gitea.log`, which gives you something like this
|
||||||
|
on a bad authentication from the web or CLI using SSH or HTTP respectively:
|
||||||
|
|
||||||
|
```log
|
||||||
|
2018/04/26 18:15:54 [I] Failed authentication attempt for user from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:05:09 modules/ssh/ssh.go:143:publicKeyHandler() [W] Failed authentication attempt from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
(DEPRECATED: This may be a false positive as the user may still go on to correctly authenticate.)
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:05:09 modules/ssh/ssh.go:155:publicKeyHandler() [W] Failed authentication attempt from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
(DEPRECATED: This may be a false positive as the user may still go on to correctly authenticate.)
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:05:09 modules/ssh/ssh.go:198:publicKeyHandler() [W] Failed authentication attempt from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
(DEPRECATED: This may be a false positive as the user may still go on to correctly authenticate.)
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:05:09 modules/ssh/ssh.go:213:publicKeyHandler() [W] Failed authentication attempt from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
(DEPRECATED: This may be a false positive as the user may still go on to correctly authenticate.)
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:05:09 modules/ssh/ssh.go:227:publicKeyHandler() [W] Failed authentication attempt from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
(DEPRECATED: This may be a false positive as the user may still go on to correctly authenticate.)
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:05:09 modules/ssh/ssh.go:249:sshConnectionFailed() [W] Failed authentication attempt from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
(From 1.15 this new message will available and doesn't have any of the false positive results that above messages from publicKeyHandler do. This will only be logged if the user has completely failed authentication.)
|
||||||
|
|
||||||
|
```log
|
||||||
|
2020/10/15 16:08:44 ...s/context/context.go:204:HandleText() [E] invalid credentials from xxx.xxx.xxx.xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
Add our filter in `/etc/fail2ban/filter.d/gitea.local`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
# gitea.local
|
||||||
|
[Definition]
|
||||||
|
failregex = .*(Failed authentication attempt|invalid credentials|Attempted access of unknown user).* from <HOST>
|
||||||
|
ignoreregex =
|
||||||
|
```
|
||||||
|
|
||||||
|
Add our jail in `/etc/fail2ban/jail.d/gitea.local`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[gitea]
|
||||||
|
enabled = true
|
||||||
|
filter = gitea
|
||||||
|
logpath = /var/lib/gitea/log/gitea.log
|
||||||
|
maxretry = 10
|
||||||
|
findtime = 3600
|
||||||
|
bantime = 900
|
||||||
|
action = iptables-allports
|
||||||
|
```
|
||||||
|
|
||||||
|
If you're using Docker, you'll also need to add an additional jail to handle the **FORWARD**
|
||||||
|
chain in **iptables**. Configure it in `/etc/fail2ban/jail.d/gitea-docker.local`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[gitea-docker]
|
||||||
|
enabled = true
|
||||||
|
filter = gitea
|
||||||
|
logpath = /var/lib/gitea/log/gitea.log
|
||||||
|
maxretry = 10
|
||||||
|
findtime = 3600
|
||||||
|
bantime = 900
|
||||||
|
action = iptables-allports[chain="FORWARD"]
|
||||||
|
```
|
||||||
|
|
||||||
|
Then simply run `service fail2ban restart` to apply your changes. You can check to see if
|
||||||
|
fail2ban has accepted your configuration using `service fail2ban status`.
|
||||||
|
|
||||||
|
Make sure and read up on fail2ban and configure it to your needs, this bans someone
|
||||||
|
for **15 minutes** (from all ports) when they fail authentication 10 times in an hour.
|
||||||
|
|
||||||
|
If you run Gitea behind a reverse proxy with Nginx (for example with Docker), you need to add
|
||||||
|
this to your Nginx configuration so that IPs don't show up as 127.0.0.1:
|
||||||
|
|
||||||
|
```
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
```
|
||||||
|
|
||||||
|
The security options in `app.ini` need to be adjusted to allow the interpretation of the headers
|
||||||
|
as well as the list of IP addresses and networks that describe trusted proxy servers
|
||||||
|
(See the [configuration cheat sheet](../administration/config-cheat-sheet.md#security-security) for more information).
|
||||||
|
|
||||||
|
```
|
||||||
|
REVERSE_PROXY_LIMIT = 1
|
||||||
|
REVERSE_PROXY_TRUSTED_PROXIES = 127.0.0.1/8 ; 172.17.0.0/16 for the docker default network
|
||||||
|
```
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
date: "2019-10-06T08:00:00+05:00"
|
||||||
|
slug: "git-lfs-setup"
|
||||||
|
sidebar_position: 12
|
||||||
|
aliases:
|
||||||
|
- /en-us/git-lfs-setup
|
||||||
|
---
|
||||||
|
|
||||||
|
# Git LFS setup
|
||||||
|
|
||||||
|
To use Gitea's built-in LFS support, you must update the `app.ini` file:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
; Enables git-lfs support. true or false, default is false.
|
||||||
|
LFS_START_SERVER = true
|
||||||
|
|
||||||
|
[lfs]
|
||||||
|
; Where your lfs files reside, default is data/lfs.
|
||||||
|
PATH = /home/gitea/data/lfs
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
LFS server support needs at least Git v2.1.2 installed on the server
|
||||||
|
:::
|
||||||
|
|
||||||
|
# Git LFS Pure SSH protocol
|
||||||
|
|
||||||
|
The LFS Pure SSH protocol supports making LFS connections purely over SSH
|
||||||
|
(without having to expose an HTTP endpoint for the Gitea server).
|
||||||
|
Support for it can be enabled with the config option `server.LFS_ALLOW_PURE_SSH`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
LFS_ALLOW_PURE_SSH = true
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
The option is currently set to default false due to an open bug in the `git-lfs`
|
||||||
|
client that causes SSH transfers to hang: https://github.com/git-lfs/git-lfs/pull/5816
|
||||||
|
This can be worked around on all the client machines by setting the git config:
|
||||||
|
`git config --global lfs.ssh.automultiplex false`
|
||||||
|
:::
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
---
|
||||||
|
date: "2018-06-02T11:00:00+02:00"
|
||||||
|
slug: "https-setup"
|
||||||
|
sidebar_position: 12
|
||||||
|
aliases:
|
||||||
|
- /en-us/https-setup
|
||||||
|
---
|
||||||
|
|
||||||
|
# HTTPS Setup
|
||||||
|
|
||||||
|
## Using the built-in server
|
||||||
|
|
||||||
|
Before you enable HTTPS, make sure that you have valid SSL/TLS certificates.
|
||||||
|
You could use self-generated certificates for evaluation and testing. Please run `gitea cert --host [HOST]` to generate a self signed certificate.
|
||||||
|
|
||||||
|
If you are using Apache or nginx on the server, it's recommended to check the [reverse proxy guide](./reverse-proxies.md).
|
||||||
|
|
||||||
|
To use Gitea's built-in HTTPS support, you must change your `app.ini` file:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
PROTOCOL = https
|
||||||
|
ROOT_URL = https://git.example.com:3000/
|
||||||
|
HTTP_PORT = 3000
|
||||||
|
CERT_FILE = cert.pem
|
||||||
|
KEY_FILE = key.pem
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that if your certificate is signed by a third party certificate authority (i.e. not self-signed), then cert.pem should contain the certificate chain. The server certificate must be the first entry in cert.pem, followed by the intermediaries in order (if any). The root certificate does not have to be included because the connecting client must already have it in order to establish the trust relationship.
|
||||||
|
To learn more about the config values, please checkout the [Config Cheat Sheet](./config-cheat-sheet.md#server-server).
|
||||||
|
|
||||||
|
For the `CERT_FILE` or `KEY_FILE` field, the file path is relative to the `GITEA_CUSTOM` environment variable when it is a relative path. It can be an absolute path as well.
|
||||||
|
|
||||||
|
### Setting up HTTP redirection
|
||||||
|
|
||||||
|
The Gitea server is only able to listen to one port; to redirect HTTP requests to the HTTPS port, you will need to enable the HTTP redirection service:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
REDIRECT_OTHER_PORT = true
|
||||||
|
; Port the redirection service should listen on
|
||||||
|
PORT_TO_REDIRECT = 3080
|
||||||
|
```
|
||||||
|
|
||||||
|
If you are using Docker, make sure that this port is configured in your `docker-compose.yml` file.
|
||||||
|
|
||||||
|
## Using ACME (Default: Let's Encrypt)
|
||||||
|
|
||||||
|
[ACME](https://tools.ietf.org/html/rfc8555) is a Certificate Authority standard protocol that allows you to automatically request and renew SSL/TLS certificates. [Let's Encrypt](https://letsencrypt.org/) is a free publicly trusted Certificate Authority server using this standard. Only `HTTP-01` and `TLS-ALPN-01` challenges are implemented. In order for ACME challenges to pass and verify your domain ownership, external traffic to the gitea domain on port `80` (`HTTP-01`) or port `443` (`TLS-ALPN-01`) has to be served by the gitea instance. Setting up [HTTP redirection](#setting-up-http-redirection) and port-forwards might be needed for external traffic to route correctly. Normal traffic to port `80` will otherwise be automatically redirected to HTTPS. **You must consent** to the ACME provider's terms of service (default Let's Encrypt's [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf)).
|
||||||
|
|
||||||
|
Minimum setup using the default Let's Encrypt:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
PROTOCOL=https
|
||||||
|
DOMAIN=git.example.com
|
||||||
|
ENABLE_ACME=true
|
||||||
|
ACME_ACCEPTTOS=true
|
||||||
|
ACME_DIRECTORY=https
|
||||||
|
;; Email can be omitted here and provided manually at first run, after which it is cached
|
||||||
|
ACME_EMAIL=[email protected]
|
||||||
|
```
|
||||||
|
|
||||||
|
Minimum setup using a [smallstep CA](https://github.com/smallstep/certificates), refer to [their tutorial](https://smallstep.com/docs/tutorials/acme-challenge) for more information.
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[server]
|
||||||
|
PROTOCOL=https
|
||||||
|
DOMAIN=git.example.com
|
||||||
|
ENABLE_ACME=true
|
||||||
|
ACME_ACCEPTTOS=true
|
||||||
|
ACME_URL=https://ca.example.com/acme/acme/directory
|
||||||
|
;; Can be omitted if using the system's trust is preferred
|
||||||
|
;ACME_CA_ROOT=/path/to/root_ca.crt
|
||||||
|
ACME_DIRECTORY=https
|
||||||
|
ACME_EMAIL=[email protected]
|
||||||
|
```
|
||||||
|
|
||||||
|
To learn more about the config values, please checkout the [Config Cheat Sheet](./config-cheat-sheet.md#server-server).
|
||||||
|
|
||||||
|
## Using a reverse proxy
|
||||||
|
|
||||||
|
Setup up your reverse proxy as shown in the [reverse proxy guide](../administration/reverse-proxies.md).
|
||||||
|
|
||||||
|
After that, enable HTTPS by following one of these guides:
|
||||||
|
|
||||||
|
- [nginx](https://nginx.org/en/docs/http/configuring_https_servers.html)
|
||||||
|
- [apache2/httpd](https://httpd.apache.org/docs/2.4/ssl/ssl_howto.html)
|
||||||
|
- [caddy](https://caddyserver.com/docs/tls)
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Enabling HTTPS only at the proxy level is referred as [TLS Termination Proxy](https://en.wikipedia.org/wiki/TLS_termination_proxy). The proxy server accepts incoming TLS connections, decrypts the contents, and passes the now unencrypted contents to Gitea. This is normally fine as long as both the proxy and Gitea instances are either on the same machine, or on different machines within private network (with the proxy is exposed to outside network). If your Gitea instance is separated from your proxy over a public network, or if you want full end-to-end encryption, you can also [enable HTTPS support directly in Gitea using built-in server](#using-the-built-in-server) and forward the connections over HTTPS instead.
|
||||||
|
:::
|
||||||
@@ -0,0 +1,284 @@
|
|||||||
|
---
|
||||||
|
date: "2019-04-02T17:06:00+01:00"
|
||||||
|
slug: "logging-config"
|
||||||
|
sidebar_position: 40
|
||||||
|
aliases:
|
||||||
|
- /en-us/logging-configuration
|
||||||
|
---
|
||||||
|
|
||||||
|
# Logging Configuration
|
||||||
|
|
||||||
|
The logging configuration of Gitea mainly consists of 3 types of components:
|
||||||
|
|
||||||
|
- The `[log]` section for general configuration
|
||||||
|
- `[log.<mode-name>]` sections for the configuration of different log writers to output logs, aka: "writer mode", the mode name is also used as "writer name".
|
||||||
|
- The `[log]` section can also contain sub-logger configurations following the key schema `logger.<logger-name>.<CONFIG-KEY>`
|
||||||
|
|
||||||
|
There is a fully functional log output by default, so it is not necessary to define one.
|
||||||
|
|
||||||
|
## Collecting Logs for Help
|
||||||
|
|
||||||
|
To collect logs for help and issue report, see [Support Options](help/support.md).
|
||||||
|
|
||||||
|
## The `[log]` section
|
||||||
|
|
||||||
|
Configuration of logging facilities in Gitea happen in the `[log]` section and its subsections.
|
||||||
|
|
||||||
|
In the top level `[log]` section the following configurations can be placed:
|
||||||
|
|
||||||
|
- `ROOT_PATH`: (Default: **%(GITEA_WORK_DIR)/log**): Base path for log files
|
||||||
|
- `MODE`: (Default: **console**) List of log outputs to use for the Default logger.
|
||||||
|
- `LEVEL`: (Default: **Info**) Least severe log events to persist, case-insensitive. Possible values are: `Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`.
|
||||||
|
- `STACKTRACE_LEVEL`: (Default: **None**) For this and more severe events the stacktrace will be printed upon getting logged.
|
||||||
|
|
||||||
|
And it can contain the following sub-loggers:
|
||||||
|
|
||||||
|
- `logger.router.MODE`: (Default: **,**): List of log outputs to use for the Router logger.
|
||||||
|
- `logger.access.MODE`: (Default: **_empty_**) List of log outputs to use for the Access logger. By default, the access logger is disabled.
|
||||||
|
- `logger.xorm.MODE`: (Default: **,**) List of log outputs to use for the XORM logger.
|
||||||
|
|
||||||
|
Setting a comma (`,`) to sub-logger's mode means making it use the default global `MODE`.
|
||||||
|
|
||||||
|
## Quick samples
|
||||||
|
|
||||||
|
### Default (empty) Configuration
|
||||||
|
|
||||||
|
The empty configuration is equivalent to default:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[log]
|
||||||
|
ROOT_PATH = %(GITEA_WORK_DIR)/log
|
||||||
|
MODE = console
|
||||||
|
LEVEL = Info
|
||||||
|
STACKTRACE_LEVEL = None
|
||||||
|
logger.router.MODE = ,
|
||||||
|
logger.xorm.MODE = ,
|
||||||
|
logger.access.MODE =
|
||||||
|
|
||||||
|
; this is the config options of "console" mode (used by MODE=console above)
|
||||||
|
[log.console]
|
||||||
|
MODE = console
|
||||||
|
FLAGS = stdflags
|
||||||
|
PREFIX =
|
||||||
|
COLORIZE = true
|
||||||
|
```
|
||||||
|
|
||||||
|
This is equivalent to sending all logs to the console, with default Golang log being sent to the console log too.
|
||||||
|
|
||||||
|
This is only a sample, and it is the default, do not need to write it into your configuration file.
|
||||||
|
|
||||||
|
### Disable Router logs and record some access logs to file
|
||||||
|
|
||||||
|
The Router logger is disabled, the access logs (>=Warn) goes into `access.log`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[log]
|
||||||
|
logger.router.MODE =
|
||||||
|
logger.access.MODE = access-file
|
||||||
|
|
||||||
|
[log.access-file]
|
||||||
|
MODE = file
|
||||||
|
LEVEL = Warn
|
||||||
|
FILE_NAME = access.log
|
||||||
|
```
|
||||||
|
|
||||||
|
### Set different log levels for different modes
|
||||||
|
|
||||||
|
Default logs (>=Warn) goes into `gitea.log`, while Error logs goes into `file-error.log`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[log]
|
||||||
|
LEVEL = Warn
|
||||||
|
MODE = file, file-error
|
||||||
|
|
||||||
|
; by default, the "file" mode will record logs to %(log.ROOT_PATH)/gitea.log, so we don't need to set it
|
||||||
|
; [log.file]
|
||||||
|
; by default, the MODE (actually it's the output writer of this logger) is taken from the section name, so we don't need to set it either
|
||||||
|
; MODE = file
|
||||||
|
|
||||||
|
[log.file-error]
|
||||||
|
MODE = file
|
||||||
|
LEVEL = Error
|
||||||
|
FILE_NAME = file-error.log
|
||||||
|
```
|
||||||
|
|
||||||
|
## Log outputs (mode and writer)
|
||||||
|
|
||||||
|
Gitea provides the following log output writers:
|
||||||
|
|
||||||
|
- `console` - Log to `stdout` (or `stderr` if it is set in the config)
|
||||||
|
- `file` - Log to a file
|
||||||
|
- `conn` - Log to a socket (network or unix)
|
||||||
|
|
||||||
|
### Common configuration
|
||||||
|
|
||||||
|
Certain configuration is common to all modes of log output:
|
||||||
|
|
||||||
|
- `MODE` is the mode of the log output writer. It will default to the mode name in the ini section. Thus `[log.console]` will default to `MODE = console`.
|
||||||
|
- `LEVEL` is the lowest level that this output will log.
|
||||||
|
- `STACKTRACE_LEVEL` is the lowest level that this output will print a stacktrace.
|
||||||
|
- `COLORIZE` will default to `true` for `console` as described, otherwise it will default to `false`.
|
||||||
|
|
||||||
|
#### `EXPRESSION`
|
||||||
|
|
||||||
|
`EXPRESSION` represents a regular expression that log events must match to be logged by the output writer.
|
||||||
|
Either the log message, (with colors removed), must match or the `longfilename:linenumber:functionname` must match.
|
||||||
|
NB: the whole message or string doesn't need to completely match.
|
||||||
|
|
||||||
|
Please note this expression will be run in the writer's goroutine but not the logging event goroutine.
|
||||||
|
|
||||||
|
#### `FLAGS`
|
||||||
|
|
||||||
|
`FLAGS` represents the preceding logging context information that is
|
||||||
|
printed before each message. It is a comma-separated string set. The order of values does not matter.
|
||||||
|
|
||||||
|
It defaults to `stdflags` (= `date,time,medfile,shortfuncname,levelinitial`)
|
||||||
|
|
||||||
|
Possible values are:
|
||||||
|
|
||||||
|
- `none` or `,` - No flags.
|
||||||
|
- `date` - the date in the local time zone: `2009/01/23`.
|
||||||
|
- `time` - the time in the local time zone: `01:23:23`.
|
||||||
|
- `microseconds` - microsecond resolution: `01:23:23.123123`. Assumes time.
|
||||||
|
- `longfile` - full file name and line number: `/a/b/c/d.go:23`.
|
||||||
|
- `shortfile` - final file name element and line number: `d.go:23`.
|
||||||
|
- `funcname` - function name of the caller: `runtime.Caller()`.
|
||||||
|
- `shortfuncname` - last part of the function name. Overrides `funcname`.
|
||||||
|
- `utc` - if date or time is set, use UTC rather than the local time zone.
|
||||||
|
- `levelinitial` - initial character of the provided level in brackets eg. `[I]` for info.
|
||||||
|
- `level` - level in brackets `[INFO]`.
|
||||||
|
- `gopid` - the Goroutine-PID of the context.
|
||||||
|
- `medfile` - last 20 characters of the filename - equivalent to `shortfile,longfile`.
|
||||||
|
- `stdflags` - equivalent to `date,time,medfile,shortfuncname,levelinitial`.
|
||||||
|
|
||||||
|
### Console mode
|
||||||
|
|
||||||
|
In this mode the logger will forward log messages to the stdout and
|
||||||
|
stderr streams attached to the Gitea process.
|
||||||
|
|
||||||
|
For loggers in console mode, `COLORIZE` will default to `true` if not
|
||||||
|
on windows, or the Windows terminal can be set into ANSI mode or is a
|
||||||
|
cygwin or Msys pipe.
|
||||||
|
|
||||||
|
Settings:
|
||||||
|
|
||||||
|
- `STDERR`: **false**: Whether the logger should print to `stderr` instead of `stdout`.
|
||||||
|
|
||||||
|
### File mode
|
||||||
|
|
||||||
|
In this mode the logger will save log messages to a file.
|
||||||
|
|
||||||
|
Settings:
|
||||||
|
|
||||||
|
- `FILE_NAME`: The file to write the log events to, relative to `ROOT_PATH`, Default to `%(ROOT_PATH)/gitea.log`. Exception: access log will default to `%(ROOT_PATH)/access.log`.
|
||||||
|
- `MAX_SIZE_SHIFT`: **28**: Maximum size shift of a single file. 28 represents 256Mb. For details see below.
|
||||||
|
- `LOG_ROTATE` **true**: Whether to rotate the log files. TODO: if false, will it delete instead on daily rotate, or do nothing?.
|
||||||
|
- `DAILY_ROTATE`: **true**: Whether to rotate logs daily.
|
||||||
|
- `MAX_DAYS`: **7**: Delete rotated log files after this number of days.
|
||||||
|
- `COMPRESS`: **true**: Whether to compress old log files by default with gzip.
|
||||||
|
- `COMPRESSION_LEVEL`: **-1**: Compression level. For details see below.
|
||||||
|
|
||||||
|
`MAX_SIZE_SHIFT` defines the maximum size of a file by left shifting 1 the given number of times (`1 << x`).
|
||||||
|
The exact behavior at the time of v1.17.3 can be seen [here](https://github.com/go-gitea/gitea/blob/v1.17.3/modules/setting/log.go#L185).
|
||||||
|
|
||||||
|
The useful values of `COMPRESSION_LEVEL` are from 1 (best speed) to 9 (best compression). [DefaultCompression](https://pkg.go.dev/compress/gzip#pkg-constants) (-1) and [HuffmanOnly](https://pkg.go.dev/compress/flate#HuffmanOnly) (-2) can also be chosen.
|
||||||
|
Beware that better compression might come with higher resource usage.
|
||||||
|
|
||||||
|
### Conn mode
|
||||||
|
|
||||||
|
In this mode the logger will send log messages over a network socket.
|
||||||
|
|
||||||
|
Settings:
|
||||||
|
|
||||||
|
- `ADDR`: **:7020**: Sets the address to connect to.
|
||||||
|
- `PROTOCOL`: **tcp**: Set the protocol, either "tcp", "unix" or "udp".
|
||||||
|
- `RECONNECT`: **false**: Try to reconnect when connection is lost.
|
||||||
|
- `RECONNECT_ON_MSG`: **false**: Reconnect host for every single message.
|
||||||
|
|
||||||
|
### The "Router" logger
|
||||||
|
|
||||||
|
The Router logger logs the following message types when Gitea's route handlers work:
|
||||||
|
|
||||||
|
- `started` messages will be logged at TRACE level
|
||||||
|
- `polling`/`completed` routers will be logged at INFO. Exception: "/assets" static resource requests are also logged at TRACE.
|
||||||
|
- `slow` routers will be logged at WARN
|
||||||
|
- `failed` routers will be logged at WARN
|
||||||
|
|
||||||
|
### The "XORM" logger
|
||||||
|
|
||||||
|
To make XORM outputs SQL logs, the `LOG_SQL` in `[database]` section should also be set to `true`.
|
||||||
|
|
||||||
|
### The "Access" logger
|
||||||
|
|
||||||
|
The Access logger is a new logger since Gitea 1.9. It provides a NCSA
|
||||||
|
Common Log compliant log format. It's highly configurable but caution
|
||||||
|
should be taken when changing its template. The main benefit of this
|
||||||
|
logger is that Gitea can now log accesses in a standard log format so
|
||||||
|
standard tools may be used.
|
||||||
|
|
||||||
|
You can enable this logger using `logger.access.MODE = ...`.
|
||||||
|
|
||||||
|
If desired the format of the Access logger can be changed by changing
|
||||||
|
the value of the `ACCESS_LOG_TEMPLATE`.
|
||||||
|
|
||||||
|
Please note, the access logger will log at `INFO` level, setting the
|
||||||
|
`LEVEL` of this logger to `WARN` or above will result in no access logs.
|
||||||
|
|
||||||
|
#### The ACCESS_LOG_TEMPLATE
|
||||||
|
|
||||||
|
This value represents a go template. Its default value is
|
||||||
|
|
||||||
|
```tmpl
|
||||||
|
{{.Ctx.RemoteHost}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.URL.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}" "{{.Ctx.Req.UserAgent}}"`
|
||||||
|
```
|
||||||
|
|
||||||
|
The template is passed following options:
|
||||||
|
|
||||||
|
- `Ctx` is the `context.Context`
|
||||||
|
- `Identity` is the `SignedUserName` or `"-"` if the user is not logged in
|
||||||
|
- `Start` is the start time of the request
|
||||||
|
- `ResponseWriter` is the `http.ResponseWriter`
|
||||||
|
|
||||||
|
Caution must be taken when changing this template as it runs outside of
|
||||||
|
the standard panic recovery trap. The template should also be as simple
|
||||||
|
as it runs for every request.
|
||||||
|
|
||||||
|
## Releasing-and-Reopening, Pausing and Resuming logging
|
||||||
|
|
||||||
|
If you are running on Unix you may wish to release-and-reopen logs in order to use `logrotate` or other tools.
|
||||||
|
It is possible force Gitea to release and reopen it's logging files and connections by sending `SIGUSR1` to the
|
||||||
|
running process, or running `gitea manager logging release-and-reopen`.
|
||||||
|
|
||||||
|
Alternatively, you may wish to pause and resume logging - this can be accomplished through the use of the
|
||||||
|
`gitea manager logging pause` and `gitea manager logging resume` commands. Please note that whilst logging
|
||||||
|
is paused log events below INFO level will not be stored and only a limited number of events will be stored.
|
||||||
|
Logging may block, albeit temporarily, slowing Gitea considerably whilst paused - therefore it is
|
||||||
|
recommended that pausing only done for a very short period of time.
|
||||||
|
|
||||||
|
## Adding and removing logging whilst Gitea is running
|
||||||
|
|
||||||
|
It is possible to add and remove logging whilst Gitea is running using the `gitea manager logging add` and `remove` subcommands.
|
||||||
|
This functionality can only adjust running log systems and cannot be used to start the access or router loggers if they
|
||||||
|
were not already initialized. If you wish to start these systems you are advised to adjust the app.ini and (gracefully) restart
|
||||||
|
the Gitea service.
|
||||||
|
|
||||||
|
The main intention of these commands is to easily add a temporary logger to investigate problems on running systems where a restart
|
||||||
|
may cause the issue to disappear.
|
||||||
|
|
||||||
|
## Using `logrotate` instead of built-in log rotation
|
||||||
|
|
||||||
|
Gitea includes built-in log rotation, which should be enough for most deployments. However, if you instead want to use the `logrotate` utility:
|
||||||
|
|
||||||
|
- Disable built-in log rotation by setting `LOG_ROTATE` to `false` in your `app.ini`.
|
||||||
|
- Install `logrotate`.
|
||||||
|
- Configure `logrotate` to match your deployment requirements, see `man 8 logrotate` for configuration syntax details.
|
||||||
|
In the `postrotate/endscript` block send Gitea a `USR1` signal via `kill -USR1` or `kill -10` to the `gitea` process itself,
|
||||||
|
or run `gitea manager logging release-and-reopen` (with the appropriate environment).
|
||||||
|
Ensure that your configurations apply to all files emitted by Gitea loggers as described in the above sections.
|
||||||
|
- Always do `logrotate /etc/logrotate.conf --debug` to test your configurations.
|
||||||
|
- If you are using docker and are running from outside the container you can use
|
||||||
|
`docker exec -u $OS_USER $CONTAINER_NAME sh -c 'gitea manager logging release-and-reopen'`
|
||||||
|
or `docker exec $CONTAINER_NAME sh -c '/bin/s6-svc -1 /etc/s6/gitea/'` or send `USR1` directly to the Gitea process itself.
|
||||||
|
|
||||||
|
The next `logrotate` jobs will include your configurations, so no restart is needed.
|
||||||
|
You can also immediately reload `logrotate` with `logrotate /etc/logrotate.conf --force`.
|
||||||
@@ -0,0 +1,269 @@
|
|||||||
|
---
|
||||||
|
date: "2019-10-23T17:00:00-03:00"
|
||||||
|
slug: "mail-templates"
|
||||||
|
sidebar_position: 45
|
||||||
|
aliases:
|
||||||
|
- /en-us/mail-templates
|
||||||
|
---
|
||||||
|
|
||||||
|
# Mail templates
|
||||||
|
|
||||||
|
To craft the e-mail subject and contents for certain operations, Gitea can be customized by using templates. The templates
|
||||||
|
for these functions are located under the [`custom` directory](../administration/customizing-gitea.md).
|
||||||
|
Gitea has an internal template that serves as default in case there's no custom alternative.
|
||||||
|
|
||||||
|
Custom templates are loaded when Gitea starts. Changes made to them are not recognized until Gitea is restarted again.
|
||||||
|
|
||||||
|
## Mail notifications supporting templates
|
||||||
|
|
||||||
|
Currently, the following notification events make use of templates:
|
||||||
|
|
||||||
|
| Action name | Usage |
|
||||||
|
| ----------- | ------------------------------------------------------------------------------------------------------------ |
|
||||||
|
| `new` | A new issue or pull request was created. |
|
||||||
|
| `comment` | A new comment was created in an existing issue or pull request. |
|
||||||
|
| `close` | An issue or pull request was closed. |
|
||||||
|
| `reopen` | An issue or pull request was reopened. |
|
||||||
|
| `review` | The head comment of a review in a pull request. |
|
||||||
|
| `approve` | The head comment of a approving review for a pull request. |
|
||||||
|
| `reject` | The head comment of a review requesting changes for a pull request. |
|
||||||
|
| `code` | A single comment on the code of a pull request. |
|
||||||
|
| `assigned` | User was assigned to an issue or pull request. |
|
||||||
|
| `default` | Any action not included in the above categories, or when the corresponding category template is not present. |
|
||||||
|
|
||||||
|
The path for the template of a particular message type is:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
custom/templates/mail/{action type}/{action name}.tmpl
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `{action type}` is one of `issue` or `pull` (for pull requests), and `{action name}` is one of the names listed above.
|
||||||
|
|
||||||
|
For example, the specific template for a mail regarding a comment in a pull request is:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
custom/templates/mail/pull/comment.tmpl
|
||||||
|
```
|
||||||
|
|
||||||
|
However, creating templates for each and every action type/name combination is not required.
|
||||||
|
A fallback system is used to choose the appropriate template for an event. The _first existing_
|
||||||
|
template on this list is used:
|
||||||
|
|
||||||
|
- The specific template for the desired **action type** and **action name**.
|
||||||
|
- The template for action type `issue` and the desired **action name**.
|
||||||
|
- The template for the desired **action type**, action name `default`.
|
||||||
|
- The template for action type `issue`, action name `default`.
|
||||||
|
|
||||||
|
The only mandatory template is action type `issue`, action name `default`, which is already embedded in Gitea
|
||||||
|
unless it's overridden by the user in the `custom` directory.
|
||||||
|
|
||||||
|
## Template syntax
|
||||||
|
|
||||||
|
Mail templates are UTF-8 encoded text files that need to follow one of the following formats:
|
||||||
|
|
||||||
|
```
|
||||||
|
Text and macros for the subject line
|
||||||
|
------------
|
||||||
|
Text and macros for the mail body
|
||||||
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```
|
||||||
|
Text and macros for the mail body
|
||||||
|
```
|
||||||
|
|
||||||
|
Specifying a _subject_ section is optional (and therefore also the dash line separator). When used, the separator between
|
||||||
|
_subject_ and _mail body_ templates requires at least three dashes; no other characters are allowed in the separator line.
|
||||||
|
|
||||||
|
_Subject_ and _mail body_ are parsed by [Golang's template engine](https://go.dev/pkg/text/template/) and
|
||||||
|
are provided with a _metadata context_ assembled for each notification. The context contains the following elements:
|
||||||
|
|
||||||
|
| Name | Type | Available | Usage |
|
||||||
|
| ------------------ | ---------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `.FallbackSubject` | string | Always | A default subject line. See Below. |
|
||||||
|
| `.Subject` | string | Only in body | The _subject_, once resolved. |
|
||||||
|
| `.Body` | string | Always | The message of the issue, pull request or comment, parsed from Markdown into HTML and sanitized. Do not confuse with the _mail body_. |
|
||||||
|
| `.Link` | string | Always | The address of the originating issue, pull request or comment. |
|
||||||
|
| `.Issue` | models.Issue | Always | The issue (or pull request) originating the notification. To get data specific to a pull request (e.g. `HasMerged`), `.Issue.PullRequest` can be used, but care should be taken as this field will be `nil` if the issue is _not_ a pull request. |
|
||||||
|
| `.Comment` | models.Comment | If applicable | If the notification is from a comment added to an issue or pull request, this will contain the information about the comment. |
|
||||||
|
| `.IsPull` | bool | Always | `true` if the mail notification is associated with a pull request (i.e. `.Issue.PullRequest` is not `nil`). |
|
||||||
|
| `.Repo` | string | Always | Name of the repository, including owner name (e.g. `mike/stuff`) |
|
||||||
|
| `.User` | models.User | Always | Owner of the repository from which the event originated. To get the user name (e.g. `mike`),`.User.Name` can be used. |
|
||||||
|
| `.Doer` | models.User | Always | User that executed the action triggering the notification event. To get the user name (e.g. `rhonda`), `.Doer.Name` can be used. |
|
||||||
|
| `.IsMention` | bool | Always | `true` if this notification was only generated because the user was mentioned in the comment, while not being subscribed to the source. It will be `false` if the recipient was subscribed to the issue or repository. |
|
||||||
|
| `.SubjectPrefix` | string | Always | `Re: ` if the notification is about other than issue or pull request creation; otherwise an empty string. |
|
||||||
|
| `.ActionType` | string | Always | `"issue"` or `"pull"`. Will correspond to the actual _action type_ independently of which template was selected. |
|
||||||
|
| `.ActionName` | string | Always | It will be one of the action types described above (`new`, `comment`, etc.), and will correspond to the actual _action name_ independently of which template was selected. |
|
||||||
|
| `.ReviewComments` | []models.Comment | Always | List of code comments in a review. The comment text will be in `.RenderedContent` and the referenced code will be in `.Patch`. |
|
||||||
|
|
||||||
|
All names are case sensitive.
|
||||||
|
|
||||||
|
### The _subject_ part of the template
|
||||||
|
|
||||||
|
The template engine used for the mail _subject_ is golang's [`text/template`](https://go.dev/pkg/text/template/).
|
||||||
|
Please refer to the linked documentation for details about its syntax.
|
||||||
|
|
||||||
|
The _subject_ is built using the following steps:
|
||||||
|
|
||||||
|
- A template is selected according to the type of notification and to what templates are present.
|
||||||
|
- The template is parsed and resolved (e.g. `{{.Issue.Index}}` is converted to the number of the issue
|
||||||
|
or pull request).
|
||||||
|
- All space-like characters (e.g. `TAB`, `LF`, etc.) are converted to normal spaces.
|
||||||
|
- All leading, trailing and redundant spaces are removed.
|
||||||
|
- The string is truncated to its first 256 runes (characters).
|
||||||
|
|
||||||
|
If the end result is an empty string, **or** no subject template was available (i.e. the selected template
|
||||||
|
did not include a subject part), Gitea's **internal default** will be used.
|
||||||
|
|
||||||
|
The internal default (fallback) subject is the equivalent of:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
{{.SubjectPrefix}}[{{.Repo}}] {{.Issue.Title}} (#{{.Issue.Index}})
|
||||||
|
```
|
||||||
|
|
||||||
|
For example: `Re: [mike/stuff] New color palette (#38)`
|
||||||
|
|
||||||
|
Gitea's default subject can also be found in the template _metadata_ as `.FallbackSubject` from any of
|
||||||
|
the two templates, even if a valid subject template is present.
|
||||||
|
|
||||||
|
### The _mail body_ part of the template
|
||||||
|
|
||||||
|
The template engine used for the _mail body_ is golang's [`html/template`](https://go.dev/pkg/html/template/).
|
||||||
|
Please refer to the linked documentation for details about its syntax.
|
||||||
|
|
||||||
|
The _mail body_ is parsed after the mail subject, so there is an additional _metadata_ field which is
|
||||||
|
the actual rendered subject, after all considerations.
|
||||||
|
|
||||||
|
The expected result is HTML (including structural elements like`<html>`, `<body>`, etc.). Styling
|
||||||
|
through `<style>` blocks, `class` and `style` attributes is possible. However, `html/template`
|
||||||
|
does some [automatic escaping](https://go.dev/pkg/html/template/#hdr-Contexts) that should be considered.
|
||||||
|
|
||||||
|
Attachments (such as images or external style sheets) are not supported. However, other templates can
|
||||||
|
be referenced too, for example to provide the contents of a `<style>` element in a centralized fashion.
|
||||||
|
The external template must be placed under `custom/mail` and referenced relative to that directory.
|
||||||
|
For example, `custom/mail/styles/base.tmpl` can be included using `{{template styles/base}}`.
|
||||||
|
|
||||||
|
The mail is sent with `Content-Type: multipart/alternative`, so the body is sent in both HTML
|
||||||
|
and text formats. The latter is obtained by stripping the HTML markup.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
How a mail is rendered is directly dependent on the capabilities of the mail application. Many mail
|
||||||
|
clients don't even support HTML, so they show the text version included in the generated mail.
|
||||||
|
|
||||||
|
If the template fails to render, it will be noticed only at the moment the mail is sent.
|
||||||
|
A default subject is used if the subject template fails, and whatever was rendered successfully
|
||||||
|
from the _mail body_ is used, disregarding the rest.
|
||||||
|
|
||||||
|
Please check [Gitea's logs](../administration/logging-config.md) for error messages in case of trouble.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
`custom/templates/mail/issue/default.tmpl`:
|
||||||
|
|
||||||
|
```html
|
||||||
|
[{{.Repo}}] @{{.Doer.Name}}
|
||||||
|
{{if eq .ActionName "new"}}
|
||||||
|
created
|
||||||
|
{{else if eq .ActionName "comment"}}
|
||||||
|
commented on
|
||||||
|
{{else if eq .ActionName "close"}}
|
||||||
|
closed
|
||||||
|
{{else if eq .ActionName "reopen"}}
|
||||||
|
reopened
|
||||||
|
{{else}}
|
||||||
|
updated
|
||||||
|
{{end}}
|
||||||
|
{{if eq .ActionType "issue"}}
|
||||||
|
issue
|
||||||
|
{{else}}
|
||||||
|
pull request
|
||||||
|
{{end}}
|
||||||
|
#{{.Issue.Index}}: {{.Issue.Title}}
|
||||||
|
------------
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
<title>{{.Subject}}</title>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
{{if .IsMention}}
|
||||||
|
<p>
|
||||||
|
You are receiving this because @{{.Doer.Name}} mentioned you.
|
||||||
|
</p>
|
||||||
|
{{end}}
|
||||||
|
<p>
|
||||||
|
<p>
|
||||||
|
<a href="{{AppUrl}}/{{.Doer.LowerName}}">@{{.Doer.Name}}</a>
|
||||||
|
{{if not (eq .Doer.FullName "")}}
|
||||||
|
({{.Doer.FullName}})
|
||||||
|
{{end}}
|
||||||
|
{{if eq .ActionName "new"}}
|
||||||
|
created
|
||||||
|
{{else if eq .ActionName "close"}}
|
||||||
|
closed
|
||||||
|
{{else if eq .ActionName "reopen"}}
|
||||||
|
reopened
|
||||||
|
{{else}}
|
||||||
|
updated
|
||||||
|
{{end}}
|
||||||
|
<a href="{{.Link}}">{{.Repo}}#{{.Issue.Index}}</a>.
|
||||||
|
</p>
|
||||||
|
{{if not (eq .Body "")}}
|
||||||
|
<h3>Message content</h3>
|
||||||
|
<hr>
|
||||||
|
{{.Body}}
|
||||||
|
{{end}}
|
||||||
|
</p>
|
||||||
|
<hr>
|
||||||
|
<p>
|
||||||
|
<a href="{{.Link}}">View it on Gitea</a>.
|
||||||
|
</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
This template produces something along these lines:
|
||||||
|
|
||||||
|
### Subject
|
||||||
|
|
||||||
|
> [mike/stuff] @rhonda commented on pull request #38: New color palette
|
||||||
|
|
||||||
|
### Mail body
|
||||||
|
|
||||||
|
> [@rhonda](#) (Rhonda Myers) updated [mike/stuff#38](#).
|
||||||
|
>
|
||||||
|
> #### Message content
|
||||||
|
>
|
||||||
|
> \_********************************\_********************************
|
||||||
|
>
|
||||||
|
> Mike, I think we should tone down the blues a little.
|
||||||
|
> \_********************************\_********************************
|
||||||
|
>
|
||||||
|
> [View it on Gitea](#).
|
||||||
|
|
||||||
|
## Advanced
|
||||||
|
|
||||||
|
The template system contains several functions that can be used to further process and format
|
||||||
|
the messages. Here's a list of some of them:
|
||||||
|
|
||||||
|
| Name | Parameters | Available | Usage |
|
||||||
|
| ---------------- | ----------- | --------- | ------------------------------------------------------------------- |
|
||||||
|
| `AppUrl` | - | Any | Gitea's URL |
|
||||||
|
| `AppName` | - | Any | Set from `app.ini`, usually "Gitea" |
|
||||||
|
| `AppDomain` | - | Any | Gitea's host name |
|
||||||
|
| `EllipsisString` | string, int | Any | Truncates a string to the specified length; adds ellipsis as needed |
|
||||||
|
| `SanitizeHTML` | string | Body only | Sanitizes text by removing any dangerous HTML tags from it |
|
||||||
|
| `SafeHTML` | string | Body only | Takes the input as HTML, can be used for outputing raw HTML content |
|
||||||
|
|
||||||
|
These are _functions_, not metadata, so they have to be used:
|
||||||
|
|
||||||
|
```html
|
||||||
|
Like this: {{SanitizeHTML "Escape<my>text"}}
|
||||||
|
Or this: {{"Escape<my>text" | SanitizeHTML}}
|
||||||
|
Or this: {{AppUrl}}
|
||||||
|
But not like this: {{.AppUrl}}
|
||||||
|
```
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
---
|
||||||
|
date: "2019-09-06T01:35:00-03:00"
|
||||||
|
slug: "repo-indexer"
|
||||||
|
sidebar_position: 45
|
||||||
|
aliases:
|
||||||
|
- /en-us/repo-indexer
|
||||||
|
---
|
||||||
|
|
||||||
|
# Repository indexer
|
||||||
|
|
||||||
|
## Builtin repository code search without indexer
|
||||||
|
|
||||||
|
Users could do repository-level code search without setting up a repository indexer.
|
||||||
|
The builtin code search is based on the `git grep` command, which is fast and efficient for small repositories.
|
||||||
|
Better code search support could be achieved by setting up the repository indexer.
|
||||||
|
|
||||||
|
## Setting up the repository indexer
|
||||||
|
|
||||||
|
Gitea can search through the files of the repositories by enabling this function in your [`app.ini`](../administration/config-cheat-sheet.md):
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[indexer]
|
||||||
|
; ...
|
||||||
|
REPO_INDEXER_ENABLED = true
|
||||||
|
REPO_INDEXER_PATH = indexers/repos.bleve
|
||||||
|
MAX_FILE_SIZE = 1048576
|
||||||
|
REPO_INDEXER_INCLUDE =
|
||||||
|
REPO_INDEXER_EXCLUDE = resources/bin/**
|
||||||
|
```
|
||||||
|
|
||||||
|
Please bear in mind that indexing the contents can consume a lot of system resources, especially when the index is created for the first time or globally updated (e.g. after upgrading Gitea).
|
||||||
|
|
||||||
|
### Choosing the files for indexing by size
|
||||||
|
|
||||||
|
The `MAX_FILE_SIZE` option will make the indexer skip all files larger than the specified value.
|
||||||
|
|
||||||
|
### Choosing the files for indexing by path
|
||||||
|
|
||||||
|
Gitea applies glob pattern matching from the [`gobwas/glob` library](https://github.com/gobwas/glob) to choose which files will be included in the index.
|
||||||
|
|
||||||
|
Limiting the list of files prevents the indexes from becoming polluted with derived or irrelevant files (e.g. lss, sym, map, etc.), so the search results are more relevant. It can also help reduce the index size.
|
||||||
|
|
||||||
|
`REPO_INDEXER_EXCLUDE_VENDORED` (default: true) excludes vendored files from index.
|
||||||
|
|
||||||
|
`REPO_INDEXER_INCLUDE` (default: empty) is a comma separated list of glob patterns to **include** in the index. An empty list means "_include all files_".
|
||||||
|
`REPO_INDEXER_EXCLUDE` (default: empty) is a comma separated list of glob patterns to **exclude** from the index. Files that match this list will not be indexed. `REPO_INDEXER_EXCLUDE` takes precedence over `REPO_INDEXER_INCLUDE`.
|
||||||
|
|
||||||
|
Pattern matching works as follows:
|
||||||
|
|
||||||
|
- To match all files with a `.txt` extension no matter what directory, use `**.txt`.
|
||||||
|
- To match all files with a `.txt` extension _only at the root level of the repository_, use `*.txt`.
|
||||||
|
- To match all files inside `resources/bin` and below, use `resources/bin/**`.
|
||||||
|
- To match all files _immediately inside_ `resources/bin`, use `resources/bin/*`.
|
||||||
|
- To match all files named `Makefile`, use `**Makefile`.
|
||||||
|
- Matching a directory has no effect; the pattern `resources/bin` will not include/exclude files inside that directory; `resources/bin/**` will.
|
||||||
|
- All files and patterns are normalized to lower case, so `**Makefile`, `**makefile` and `**MAKEFILE` are equivalent.
|
||||||
@@ -0,0 +1,404 @@
|
|||||||
|
---
|
||||||
|
date: "2018-05-22T11:00:00+00:00"
|
||||||
|
slug: "reverse-proxies"
|
||||||
|
sidebar_position: 16
|
||||||
|
aliases:
|
||||||
|
- /en-us/reverse-proxies
|
||||||
|
---
|
||||||
|
|
||||||
|
# Reverse Proxies
|
||||||
|
|
||||||
|
## General configuration
|
||||||
|
|
||||||
|
1. Set `[server] ROOT_URL = https://git.example.com/` in your `app.ini` file.
|
||||||
|
2. Make the reverse-proxy pass `https://git.example.com/foo` to `http://gitea:3000/foo`.
|
||||||
|
3. Make sure the reverse-proxy does not decode the URI. The request `https://git.example.com/a%2Fb` should be passed as `http://gitea:3000/a%2Fb`.
|
||||||
|
4. Make sure `Host` and `X-Fowarded-Proto` headers are correctly passed to Gitea to make Gitea see the real URL being visited.
|
||||||
|
5. Make sure your webserver has a certificate, including all intermediate and RootCA certificates, for `git clone` and `git pull` to work.
|
||||||
|
|
||||||
|
### Use a sub-path
|
||||||
|
|
||||||
|
Usually it's **not recommended** to put Gitea in a sub-path, it's not widely used and may have some issues in rare cases.
|
||||||
|
|
||||||
|
To make Gitea work with a sub-path (eg: `https://common.example.com/gitea/`),
|
||||||
|
there are some extra requirements besides the general configuration above:
|
||||||
|
|
||||||
|
1. Use `[server] ROOT_URL = https://common.example.com/gitea/` in your `app.ini` file.
|
||||||
|
2. Make the reverse-proxy pass `https://common.example.com/gitea/foo` to `http://gitea:3000/foo`.
|
||||||
|
3. The container registry requires a fixed sub-path `/v2` at the root level which must be configured:
|
||||||
|
- Make the reverse-proxy pass `https://common.example.com/v2` to `http://gitea:3000/v2`.
|
||||||
|
- Make sure the URI and headers are also correctly passed (see the general configuration above).
|
||||||
|
|
||||||
|
## Nginx
|
||||||
|
|
||||||
|
If you want Nginx to serve your Gitea instance, add the following `server` section to the `http` section of `nginx.conf`.
|
||||||
|
|
||||||
|
Make sure `client_max_body_size` is large enough, otherwise there would be "413 Request Entity Too Large" error when uploading large files.
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
server {
|
||||||
|
...
|
||||||
|
location / {
|
||||||
|
client_max_body_size 512M;
|
||||||
|
proxy_pass http://localhost:3000;
|
||||||
|
proxy_set_header Connection $http_connection;
|
||||||
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Nginx with a sub-path
|
||||||
|
|
||||||
|
In case you already have a site, and you want Gitea to share the domain name,
|
||||||
|
you can setup Nginx to serve Gitea under a sub-path by adding the following `server` section
|
||||||
|
into the `http` section of `nginx.conf`:
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
server {
|
||||||
|
...
|
||||||
|
location ~ ^/(gitea|v2)($|/) {
|
||||||
|
client_max_body_size 512M;
|
||||||
|
|
||||||
|
# make nginx use unescaped URI, keep "%2F" as-is, remove the "/gitea" sub-path prefix, pass "/v2" as-is.
|
||||||
|
rewrite ^ $request_uri;
|
||||||
|
rewrite ^/(gitea($|/))?(.*) /$3 break;
|
||||||
|
proxy_pass http://127.0.0.1:3000$uri;
|
||||||
|
|
||||||
|
# other common HTTP headers, see the "Nginx" config section above
|
||||||
|
proxy_set_header Connection $http_connection;
|
||||||
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
proxy_set_header X-Forwarded-Proto $scheme;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you **MUST** set something like `[server] ROOT_URL = http://git.example.com/gitea/` correctly in your configuration.
|
||||||
|
|
||||||
|
## Nginx and serve static resources directly
|
||||||
|
|
||||||
|
We can tune the performance in splitting requests into categories static and dynamic.
|
||||||
|
|
||||||
|
CSS files, JavaScript files, images and web fonts are static content.
|
||||||
|
The front page, a repository view or issue list is dynamic content.
|
||||||
|
|
||||||
|
Nginx can serve static resources directly and proxy only the dynamic requests to Gitea.
|
||||||
|
Nginx is optimized for serving static content, while the proxying of large responses might be the opposite of that
|
||||||
|
(see [https://serverfault.com/q/587386](https://serverfault.com/q/587386)).
|
||||||
|
|
||||||
|
Download a snapshot of the Gitea source repository to `/path/to/gitea/`.
|
||||||
|
After this, run `make frontend` in the repository directory to generate the static resources. We are only interested in the `public/` directory for this task, so you can delete the rest.
|
||||||
|
(You will need to have [Node with npm](https://nodejs.org/en/download/) and `make` installed to generate the static resources)
|
||||||
|
|
||||||
|
Depending on the scale of your user base, you might want to split the traffic to two distinct servers,
|
||||||
|
or use a cdn for the static files.
|
||||||
|
|
||||||
|
### Single node and single domain
|
||||||
|
|
||||||
|
Set `[server] STATIC_URL_PREFIX = /_/static` in your configuration.
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name git.example.com;
|
||||||
|
|
||||||
|
location /_/static/assets/ {
|
||||||
|
alias /path/to/gitea/public/;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://localhost:3000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Two nodes and two domains
|
||||||
|
|
||||||
|
Set `[server] STATIC_URL_PREFIX = http://cdn.example.com/gitea` in your configuration.
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
# application server running Gitea
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name git.example.com;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://localhost:3000;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
# static content delivery server
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name cdn.example.com;
|
||||||
|
|
||||||
|
location /gitea/ {
|
||||||
|
alias /path/to/gitea/public/;
|
||||||
|
}
|
||||||
|
|
||||||
|
location / {
|
||||||
|
return 404;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Nginx Proxy Manager
|
||||||
|
|
||||||
|
If you are using Nginx Proxy Manager to serve your Gitea instance it differs slighly from the raw Nginx.
|
||||||
|
|
||||||
|
It is [adding some directives](https://github.com/NginxProxyManager/nginx-proxy-manager/blob/master/docker/rootfs/etc/nginx/conf.d/include/proxy.conf) for a custom location by default, so you have to skip these from the above mentioned Nginx config. Otherwise Nginx will produce `400 bad request` error due to duplicated directives (`proxy_set_header Host $host` is the particularly problematic one).
|
||||||
|
|
||||||
|
So while creating the `/` Custom location, just add the following lines to it's configuration:
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
client_max_body_size 512M;
|
||||||
|
proxy_set_header Connection $http_connection;
|
||||||
|
proxy_set_header Upgrade $http_upgrade;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Apache HTTPD
|
||||||
|
|
||||||
|
If you want Apache HTTPD to serve your Gitea instance, you can add the following to your Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
|
||||||
|
|
||||||
|
```apacheconf
|
||||||
|
<VirtualHost *:80>
|
||||||
|
...
|
||||||
|
ProxyPreserveHost On
|
||||||
|
ProxyRequests off
|
||||||
|
AllowEncodedSlashes NoDecode
|
||||||
|
ProxyPass / http://localhost:3000/ nocanon
|
||||||
|
RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
|
||||||
|
</VirtualHost>
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
The following Apache HTTPD mods must be enabled: `proxy`, `proxy_http`.
|
||||||
|
:::
|
||||||
|
|
||||||
|
If you wish to use Let's Encrypt with webroot validation, add the line `ProxyPass /.well-known !` before `ProxyPass` to disable proxying these requests to Gitea.
|
||||||
|
|
||||||
|
## Apache HTTPD with a sub-path
|
||||||
|
|
||||||
|
In case you already have a site, and you want Gitea to share the domain name, you can setup Apache HTTPD to serve Gitea under a sub-path by adding the following to you Apache HTTPD configuration (usually located at `/etc/apache2/httpd.conf` in Ubuntu):
|
||||||
|
|
||||||
|
```apacheconf
|
||||||
|
<VirtualHost *:80>
|
||||||
|
...
|
||||||
|
<Proxy *>
|
||||||
|
Order allow,deny
|
||||||
|
Allow from all
|
||||||
|
</Proxy>
|
||||||
|
AllowEncodedSlashes NoDecode
|
||||||
|
# Note: no trailing slash after either /git or port
|
||||||
|
ProxyPass /git http://localhost:3000 nocanon
|
||||||
|
ProxyPreserveHost On
|
||||||
|
RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
|
||||||
|
</VirtualHost>
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you **MUST** set something like `[server] ROOT_URL = http://git.example.com/git/` correctly in your configuration.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
The following Apache HTTPD mods must be enabled: `proxy`, `proxy_http`.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Caddy
|
||||||
|
|
||||||
|
If you want Caddy to serve your Gitea instance, you can add the following server block to your Caddyfile:
|
||||||
|
|
||||||
|
```
|
||||||
|
git.example.com {
|
||||||
|
reverse_proxy localhost:3000
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Caddy with a sub-path
|
||||||
|
|
||||||
|
In case you already have a site, and you want Gitea to share the domain name, you can setup Caddy to serve Gitea under a sub-path by adding the following to your server block in your Caddyfile:
|
||||||
|
|
||||||
|
```
|
||||||
|
git.example.com {
|
||||||
|
route /git/* {
|
||||||
|
uri strip_prefix /git
|
||||||
|
reverse_proxy localhost:3000
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then set `[server] ROOT_URL = http://git.example.com/git/` in your configuration.
|
||||||
|
|
||||||
|
## IIS
|
||||||
|
|
||||||
|
If you wish to run Gitea with IIS. You will need to setup IIS with URL Rewrite as reverse proxy.
|
||||||
|
|
||||||
|
1. Setup an empty website in IIS, named let's say, `Gitea Proxy`.
|
||||||
|
2. Follow the first two steps in [Microsoft's Technical Community Guide to Setup IIS with URL Rewrite](https://techcommunity.microsoft.com/t5/iis-support-blog/setup-iis-with-url-rewrite-as-a-reverse-proxy-for-real-world/ba-p/846222#M343). That is:
|
||||||
|
|
||||||
|
- Install Application Request Routing (ARR for short) either by using the Microsoft Web Platform Installer 5.1 (WebPI) or downloading the extension from [IIS.net](https://www.iis.net/downloads/microsoft/application-request-routing)
|
||||||
|
- Once the module is installed in IIS, you will see a new Icon in the IIS Administration Console called URL Rewrite.
|
||||||
|
- Open the IIS Manager Console and click on the `Gitea Proxy` Website from the tree view on the left. Select and double click the URL Rewrite Icon from the middle pane to load the URL Rewrite interface.
|
||||||
|
- Choose the `Add Rule` action from the right pane of the management console and select the `Reverse Proxy Rule` from the `Inbound and Outbound Rules` category.
|
||||||
|
- In the Inbound Rules section, set the server name to be the host that Gitea is running on with its port. e.g. if you are running Gitea on the localhost with port 3000, the following should work: `127.0.0.1:3000`
|
||||||
|
- Enable SSL Offloading
|
||||||
|
- In the Outbound Rules, ensure `Rewrite the domain names of the links in HTTP response` is set and set the `From:` field as above and the `To:` to your external hostname, say: `git.example.com`
|
||||||
|
- Now edit the `web.config` for your website to match the following: (changing `127.0.0.1:3000` and `git.example.com` as appropriate)
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<configuration>
|
||||||
|
<system.web>
|
||||||
|
<httpRuntime requestPathInvalidCharacters="" />
|
||||||
|
</system.web>
|
||||||
|
<system.webServer>
|
||||||
|
<security>
|
||||||
|
<requestFiltering>
|
||||||
|
<hiddenSegments>
|
||||||
|
<clear />
|
||||||
|
</hiddenSegments>
|
||||||
|
<denyUrlSequences>
|
||||||
|
<clear />
|
||||||
|
</denyUrlSequences>
|
||||||
|
<fileExtensions allowUnlisted="true">
|
||||||
|
<clear />
|
||||||
|
</fileExtensions>
|
||||||
|
</requestFiltering>
|
||||||
|
</security>
|
||||||
|
<rewrite>
|
||||||
|
<rules useOriginalURLEncoding="false">
|
||||||
|
<rule name="ReverseProxyInboundRule1" stopProcessing="true">
|
||||||
|
<match url="(.*)" />
|
||||||
|
<action type="Rewrite" url="http://127.0.0.1:3000{UNENCODED_URL}" />
|
||||||
|
<serverVariables>
|
||||||
|
<set name="HTTP_X_ORIGINAL_ACCEPT_ENCODING" value="HTTP_ACCEPT_ENCODING" />
|
||||||
|
<set name="HTTP_ACCEPT_ENCODING" value="" />
|
||||||
|
</serverVariables>
|
||||||
|
</rule>
|
||||||
|
</rules>
|
||||||
|
<outboundRules>
|
||||||
|
<rule name="ReverseProxyOutboundRule1" preCondition="ResponseIsHtml1">
|
||||||
|
<!-- set the pattern correctly here - if you only want to accept http or https -->
|
||||||
|
<!-- change the pattern and the action value as appropriate -->
|
||||||
|
<match filterByTags="A, Form, Img" pattern="^http(s)?://127.0.0.1:3000/(.*)" />
|
||||||
|
<action type="Rewrite" value="http{R:1}://git.example.com/{R:2}" />
|
||||||
|
</rule>
|
||||||
|
<rule name="RestoreAcceptEncoding" preCondition="NeedsRestoringAcceptEncoding">
|
||||||
|
<match serverVariable="HTTP_ACCEPT_ENCODING" pattern="^(.*)" />
|
||||||
|
<action type="Rewrite" value="{HTTP_X_ORIGINAL_ACCEPT_ENCODING}" />
|
||||||
|
</rule>
|
||||||
|
<preConditions>
|
||||||
|
<preCondition name="ResponseIsHtml1">
|
||||||
|
<add input="{RESPONSE_CONTENT_TYPE}" pattern="^text/html" />
|
||||||
|
</preCondition>
|
||||||
|
<preCondition name="NeedsRestoringAcceptEncoding">
|
||||||
|
<add input="{HTTP_X_ORIGINAL_ACCEPT_ENCODING}" pattern=".+" />
|
||||||
|
</preCondition>
|
||||||
|
</preConditions>
|
||||||
|
</outboundRules>
|
||||||
|
</rewrite>
|
||||||
|
<urlCompression doDynamicCompression="true" />
|
||||||
|
<handlers>
|
||||||
|
<clear />
|
||||||
|
<add name="StaticFile" path="*" verb="*" modules="StaticFileModule,DefaultDocumentModule,DirectoryListingModule" resourceType="Either" requireAccess="Read" />
|
||||||
|
</handlers>
|
||||||
|
<!-- Map all extensions to the same MIME type, so all files can be
|
||||||
|
downloaded. -->
|
||||||
|
<staticContent>
|
||||||
|
<clear />
|
||||||
|
<mimeMap fileExtension="*" mimeType="application/octet-stream" />
|
||||||
|
</staticContent>
|
||||||
|
</system.webServer>
|
||||||
|
</configuration>
|
||||||
|
```
|
||||||
|
|
||||||
|
## HAProxy
|
||||||
|
|
||||||
|
If you want HAProxy to serve your Gitea instance, you can add the following to your HAProxy configuration
|
||||||
|
|
||||||
|
add an acl in the frontend section to redirect calls to gitea.example.com to the correct backend
|
||||||
|
|
||||||
|
```
|
||||||
|
frontend http-in
|
||||||
|
...
|
||||||
|
acl acl_gitea hdr(host) -i gitea.example.com
|
||||||
|
use_backend gitea if acl_gitea
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
add the previously defined backend section
|
||||||
|
|
||||||
|
```
|
||||||
|
backend gitea
|
||||||
|
server localhost:3000 check
|
||||||
|
```
|
||||||
|
|
||||||
|
If you redirect the http content to https, the configuration work the same way, just remember that the connection between HAProxy and Gitea will be done via http so you do not have to enable https in Gitea's configuration.
|
||||||
|
|
||||||
|
## HAProxy with a sub-path
|
||||||
|
|
||||||
|
In case you already have a site, and you want Gitea to share the domain name, you can setup HAProxy to serve Gitea under a sub-path by adding the following to you HAProxy configuration:
|
||||||
|
|
||||||
|
```
|
||||||
|
frontend http-in
|
||||||
|
...
|
||||||
|
acl acl_gitea path_beg /gitea
|
||||||
|
use_backend gitea if acl_gitea
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
With that configuration http://example.com/gitea/ will redirect to your Gitea instance.
|
||||||
|
|
||||||
|
then for the backend section
|
||||||
|
|
||||||
|
```
|
||||||
|
backend gitea
|
||||||
|
http-request replace-path /gitea\/?(.*) \/\1
|
||||||
|
server localhost:3000 check
|
||||||
|
```
|
||||||
|
|
||||||
|
The added http-request will automatically add a trailing slash if needed and internally remove /gitea from the path to allow it to work correctly with Gitea by setting properly http://example.com/gitea as the root.
|
||||||
|
|
||||||
|
Then you **MUST** set something like `[server] ROOT_URL = http://example.com/gitea/` correctly in your configuration.
|
||||||
|
|
||||||
|
## Traefik
|
||||||
|
|
||||||
|
If you want traefik to serve your Gitea instance, you can add the following label section to your `docker-compose.yaml` (Assuming the provider is docker).
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
gitea:
|
||||||
|
image: docker.io/gitea/gitea
|
||||||
|
...
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
- "traefik.http.routers.gitea.rule=Host(`example.com`)"
|
||||||
|
- "traefik.http.services.gitea-websecure.loadbalancer.server.port=3000"
|
||||||
|
```
|
||||||
|
|
||||||
|
This config assumes that you are handling HTTPS on the traefik side and using HTTP between Gitea and traefik.
|
||||||
|
|
||||||
|
## Traefik with a sub-path
|
||||||
|
|
||||||
|
In case you already have a site, and you want Gitea to share the domain name, you can setup Traefik to serve Gitea under a sub-path by adding the following to your `docker-compose.yaml` (Assuming the provider is docker) :
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
gitea:
|
||||||
|
image: docker.io/gitea/gitea
|
||||||
|
...
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
- "traefik.http.routers.gitea.rule=Host(`example.com`) && PathPrefix(`/gitea`)"
|
||||||
|
- "traefik.http.services.gitea-websecure.loadbalancer.server.port=3000"
|
||||||
|
- "traefik.http.middlewares.gitea-stripprefix.stripprefix.prefixes=/gitea"
|
||||||
|
- "traefik.http.routers.gitea.middlewares=gitea-stripprefix"
|
||||||
|
```
|
||||||
|
|
||||||
|
This config assumes that you are handling HTTPS on the traefik side and using HTTP between Gitea and traefik.
|
||||||
|
|
||||||
|
Then you **MUST** set something like `[server] ROOT_URL = http://example.com/gitea/` correctly in your configuration.
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
---
|
||||||
|
date: "2019-12-31T13:55:00+05:00"
|
||||||
|
slug: "search-engines-indexation"
|
||||||
|
sidebar_position: 60
|
||||||
|
aliases:
|
||||||
|
- /en-us/search-engines-indexation
|
||||||
|
---
|
||||||
|
|
||||||
|
# Search Engines Indexation
|
||||||
|
|
||||||
|
By default your Gitea installation will be indexed by search engines.
|
||||||
|
If you don't want your repository to be visible for search engines read further.
|
||||||
|
|
||||||
|
## Block search engines indexation using robots.txt
|
||||||
|
|
||||||
|
To make Gitea serve a custom `robots.txt` (default: empty 404) for top level installations,
|
||||||
|
create a file with path `public/robots.txt` in the [`custom` folder or `CustomPath`](../administration/customizing-gitea.md)
|
||||||
|
|
||||||
|
Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).
|
||||||
|
|
||||||
|
```txt
|
||||||
|
User-agent: *
|
||||||
|
Disallow: /
|
||||||
|
```
|
||||||
|
|
||||||
|
If you installed Gitea in a subdirectory, you will need to create or edit the `robots.txt` in the top level directory.
|
||||||
|
|
||||||
|
```txt
|
||||||
|
User-agent: *
|
||||||
|
Disallow: /gitea/
|
||||||
|
```
|
||||||
@@ -0,0 +1,212 @@
|
|||||||
|
---
|
||||||
|
date: "2019-08-17T10:20:00+01:00"
|
||||||
|
slug: "signing"
|
||||||
|
sidebar_position: 50
|
||||||
|
aliases:
|
||||||
|
- /en-us/signing
|
||||||
|
---
|
||||||
|
|
||||||
|
# GPG/SSH Commit Signatures
|
||||||
|
|
||||||
|
Gitea will verify gpg/ssh commit signatures in the provided tree by
|
||||||
|
checking if the commits are signed by a key within the Gitea database,
|
||||||
|
or if the commit matches the default key for Git.
|
||||||
|
|
||||||
|
Additionally Gitea will verify commits signed by ssh keys, which public keys are part of [`TRUSTED_SSH_KEYS`](#general-configuration).
|
||||||
|
|
||||||
|
Keys are not checked to determine if they have expired or revoked.
|
||||||
|
Keys are also not checked with keyservers.
|
||||||
|
|
||||||
|
A commit will be marked with a grey unlocked icon if no key can be
|
||||||
|
found to verify it. If a commit is marked with a red unlocked icon,
|
||||||
|
it is reported to be signed with a key with an id.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
The signer of a commit does not have to be an author or
|
||||||
|
committer of a commit.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Automatic Signing
|
||||||
|
|
||||||
|
There are a number of places where Gitea will generate commits itself:
|
||||||
|
|
||||||
|
- Repository Initialisation
|
||||||
|
- Wiki Changes
|
||||||
|
- CRUD actions using the editor or the API
|
||||||
|
- Merges from Pull Requests
|
||||||
|
|
||||||
|
Depending on configuration and server trust you may want Gitea to
|
||||||
|
sign these commits.
|
||||||
|
|
||||||
|
## Installing and generating a GPG key for Gitea
|
||||||
|
|
||||||
|
It is up to a server administrator to determine how best to install
|
||||||
|
a signing key. Gitea generates all its commits using the server `git`
|
||||||
|
command at present - and therefore the server `gpg` will be used for
|
||||||
|
signing (if configured.) Administrators should review best-practices
|
||||||
|
for GPG - in particular it is probably advisable to only install a
|
||||||
|
signing secret subkey without the master signing and certifying secret
|
||||||
|
key.
|
||||||
|
|
||||||
|
## Installing and generating a SSH key for Gitea
|
||||||
|
|
||||||
|
You can run `ssh-keygen -t ed25519 -f gitea-signing-key` to generate the private/public keypair for commit signing without any password. Usually you would store the key next to the gitea configuration, then point `SIGNING_KEY` to the generated public key `/path/to/gitea-signing-key.pub`. Gitea generates all its commits using the server `git` command at present - and therefore the server `ssh-keygen` will be used for
|
||||||
|
signing (if configured.)
|
||||||
|
|
||||||
|
## General Configuration
|
||||||
|
|
||||||
|
Gitea's configuration for signing can be found with the
|
||||||
|
`[repository.signing]` section of `app.ini`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
...
|
||||||
|
[repository.signing]
|
||||||
|
SIGNING_KEY = default
|
||||||
|
SIGNING_NAME =
|
||||||
|
SIGNING_EMAIL =
|
||||||
|
INITIAL_COMMIT = always
|
||||||
|
CRUD_ACTIONS = pubkey, twofa, parentsigned
|
||||||
|
WIKI = never
|
||||||
|
MERGES = pubkey, twofa, basesigned, commitssigned
|
||||||
|
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
For SSH commit signing, you need to specify the `SIGNING_FORMAT` to `ssh` instead of the default `openpgp`. `SIGNING_NAME` and `SIGNING_EMAIL` are required for verifing the signatures.
|
||||||
|
|
||||||
|
This looks like this:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
...
|
||||||
|
[repository.signing]
|
||||||
|
SIGNING_KEY = /path/to/gitea-signing-key.pub
|
||||||
|
SIGNING_NAME =
|
||||||
|
SIGNING_EMAIL =
|
||||||
|
SIGNING_FORMAT = ssh
|
||||||
|
INITIAL_COMMIT = always
|
||||||
|
CRUD_ACTIONS = pubkey, twofa, parentsigned
|
||||||
|
WIKI = never
|
||||||
|
MERGES = pubkey, twofa, basesigned, commitssigned
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
- `/path/to/gitea-signing-key` is expected to be the private key for `/path/to/gitea-signing-key.pub` [see here how to generate a new ssh keypair](#installing-and-generating-a-ssh-key-for-gitea).
|
||||||
|
- `TRUSTED_SSH_KEYS = ssh-<algorithm> <key>` or `TRUSTED_SSH_KEYS = ssh-<algorithm> <key1>, ssh-<algorithm> <key2>` can be used for rotating the global ssh signing key to continue verifying commits signed by the previous keys.
|
||||||
|
|
||||||
|
### `SIGNING_KEY`
|
||||||
|
|
||||||
|
The first option to discuss is the `SIGNING_KEY`. There are three main
|
||||||
|
options:
|
||||||
|
|
||||||
|
- `none` - this prevents Gitea from signing any commits
|
||||||
|
- `default` - Gitea will default to the gpg key configured within `git config`
|
||||||
|
- `KEYID` - Gitea will sign commits with the gpg key with the ID
|
||||||
|
`KEYID`. In this case you should provide a `SIGNING_NAME` and
|
||||||
|
`SIGNING_EMAIL` to be displayed for this key.
|
||||||
|
- `/path/to/gitea-signing-key.pub` - Gitea will sign commits with the ssh key without the `.pub` suffix `/path/to/gitea-signing-key`. In this case you should provide a `SIGNING_NAME` and
|
||||||
|
`SIGNING_EMAIL` to be displayed for this key and set `SIGNING_FORMAT` to `ssh`.
|
||||||
|
|
||||||
|
The `default` option will interrogate `git config` for
|
||||||
|
`commit.gpgsign` option - if this is set, then it will use the results
|
||||||
|
of the `user.signingkey`, `user.name` and `user.email` as appropriate.
|
||||||
|
|
||||||
|
By adjusting Git's `config` file within Gitea's
|
||||||
|
repositories, `SIGNING_KEY=default` could be used to provide different
|
||||||
|
signing keys on a per-repository basis. However, this is clearly not an
|
||||||
|
ideal UI and therefore subject to change.
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
**Since 1.17**, Gitea runs git in its own home directory `[git].HOME_PATH` (default to `%(APP_DATA_PATH)/home`)
|
||||||
|
and uses its own config `{[git].HOME_PATH}/.gitconfig`.
|
||||||
|
|
||||||
|
If you have your own customized git config for Gitea, you should set these configs in system git config (aka `/etc/gitconfig`)
|
||||||
|
or the Gitea internal git config `{[git].HOME_PATH}/.gitconfig`.
|
||||||
|
|
||||||
|
Related home files for git command (like `.gnupg`) should also be put in Gitea's git home directory `[git].HOME_PATH`.
|
||||||
|
|
||||||
|
If you like to keep the `.gnupg` directory outside of `{[git].HOME_PATH}/`, consider setting the `$GNUPGHOME` environment variable to your preferred location, otherwise Gitea will use the gpg keys only under `{[git].HOME_PATH}/.gnupg`.
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
The default option and repository specific signing keys are not supported for ssh keys
|
||||||
|
:::
|
||||||
|
|
||||||
|
### `INITIAL_COMMIT`
|
||||||
|
|
||||||
|
This option determines whether Gitea should sign the initial commit
|
||||||
|
when creating a repository. The possible values are:
|
||||||
|
|
||||||
|
- `never`: Never sign
|
||||||
|
- `pubkey`: Only sign if the user has a public key
|
||||||
|
- `twofa`: Only sign if the user logs in with two factor authentication
|
||||||
|
- `always`: Always sign
|
||||||
|
|
||||||
|
Options other than `never` and `always` can be combined as a comma
|
||||||
|
separated list. The commit will be signed if all selected options are true.
|
||||||
|
|
||||||
|
### `WIKI`
|
||||||
|
|
||||||
|
This options determines if Gitea should sign commits to the Wiki.
|
||||||
|
The possible values are:
|
||||||
|
|
||||||
|
- `never`: Never sign
|
||||||
|
- `pubkey`: Only sign if the user has a public key
|
||||||
|
- `twofa`: Only sign if the user logs in with two-factor authentication
|
||||||
|
- `parentsigned`: Only sign if the parent commit is signed.
|
||||||
|
- `always`: Always sign
|
||||||
|
|
||||||
|
Options other than `never` and `always` can be combined as a comma
|
||||||
|
separated list. The commit will be signed if all selected options are true.
|
||||||
|
|
||||||
|
### `CRUD_ACTIONS`
|
||||||
|
|
||||||
|
This option determines if Gitea should sign commits from the web
|
||||||
|
editor or API CRUD actions. The possible values are:
|
||||||
|
|
||||||
|
- `never`: Never sign
|
||||||
|
- `pubkey`: Only sign if the user has a public key
|
||||||
|
- `twofa`: Only sign if the user logs in with two-factor authentication
|
||||||
|
- `parentsigned`: Only sign if the parent commit is signed.
|
||||||
|
- `always`: Always sign
|
||||||
|
|
||||||
|
Options other than `never` and `always` can be combined as a comma
|
||||||
|
separated list. The change will be signed if all selected options are true.
|
||||||
|
|
||||||
|
### `MERGES`
|
||||||
|
|
||||||
|
This option determines if Gitea should sign merge commits from PRs.
|
||||||
|
The possible options are:
|
||||||
|
|
||||||
|
- `never`: Never sign
|
||||||
|
- `pubkey`: Only sign if the user has a public key
|
||||||
|
- `twofa`: Only sign if the user logs in with two-factor authentication
|
||||||
|
- `basesigned`: Only sign if the parent commit in the base repo is signed.
|
||||||
|
- `headsigned`: Only sign if the head commit in the head branch is signed.
|
||||||
|
- `commitssigned`: Only sign if all the commits in the head branch to the merge point are signed.
|
||||||
|
- `approved`: Only sign approved merges to a protected branch.
|
||||||
|
- `always`: Always sign
|
||||||
|
|
||||||
|
Options other than `never` and `always` can be combined as a comma
|
||||||
|
separated list. The merge will be signed if all selected options are true.
|
||||||
|
|
||||||
|
## Obtaining the Public Key of the Signing Key
|
||||||
|
|
||||||
|
The public key used to sign Gitea's commits can be obtained from the API at:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
/api/v1/signing-key.gpg
|
||||||
|
```
|
||||||
|
|
||||||
|
In cases where there is a repository specific key this can be obtained from:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
/api/v1/repos/:username/:reponame/signing-key.gpg
|
||||||
|
```
|
||||||
|
|
||||||
|
For ssh commit signing the default ssh public key can be obtained via the API at:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
/api/v1/signing-key.pub
|
||||||
|
```
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
date: "2021-01-22T00:00:00+02:00"
|
||||||
|
title: "Contributing"
|
||||||
|
slug: "contributing"
|
||||||
|
sidebar_position: 35
|
||||||
|
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
name: "Contributing"
|
||||||
|
sidebar_position: 50
|
||||||
|
identifier: "contributing"
|
||||||
|
---
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
---
|
||||||
|
date: "2021-11-01T23:41:00+08:00"
|
||||||
|
slug: "guidelines-backend"
|
||||||
|
sidebar_position: 20
|
||||||
|
aliases:
|
||||||
|
- /en-us/guidelines-backend
|
||||||
|
---
|
||||||
|
|
||||||
|
# Guidelines for Backend Development
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
Gitea uses Golang as the backend programming language. It uses many third-party packages and also write some itself.
|
||||||
|
For example, Gitea uses [Chi](https://github.com/go-chi/chi) as basic web framework. [Xorm](https://xorm.io) is an ORM framework that is used to interact with the database.
|
||||||
|
So it's very important to manage these packages. Please take the below guidelines before you start to write backend code.
|
||||||
|
|
||||||
|
## Package Design Guideline
|
||||||
|
|
||||||
|
### Packages List
|
||||||
|
|
||||||
|
To maintain understandable code and avoid circular dependencies it is important to have a good code structure. The Gitea backend is divided into the following parts:
|
||||||
|
|
||||||
|
- `build`: Scripts to help build Gitea.
|
||||||
|
- `cmd`: All Gitea actual sub commands includes web, doctor, serv, hooks, admin and etc. `web` will start the web service. `serv` and `hooks` will be invoked by Git or OpenSSH. Other sub commands could help to maintain Gitea.
|
||||||
|
- `tests`: Common test utility functions
|
||||||
|
- `tests/integration`: Integration tests, to test back-end regressions
|
||||||
|
- `tests/e2e`: E2e tests, to test front-end and back-end compatibility and visual regressions.
|
||||||
|
- `models`: Contains the data structures used by xorm to construct database tables. It also contains functions to query and update the database. Dependencies to other Gitea code should be avoided. You can make exceptions in cases such as logging.
|
||||||
|
- `models/db`: Basic database operations. All other `models/xxx` packages should depend on this package. The `GetEngine` function should only be invoked from `models/`.
|
||||||
|
- `models/fixtures`: Sample data used in unit tests and integration tests. One `yml` file means one table which will be loaded into database when beginning the tests.
|
||||||
|
- `models/migrations`: Stores database migrations between versions. PRs that change a database structure **MUST** also have a migration step.
|
||||||
|
- `modules`: Different modules to handle specific functionality in Gitea. Work in Progress: Some of them should be moved to `services`, in particular those that depend on models because they rely on the database.
|
||||||
|
- `modules/setting`: Store all system configurations read from ini files and has been referenced by everywhere. But they should be used as function parameters when possible.
|
||||||
|
- `modules/git`: Package to interactive with `Git` command line or Gogit package.
|
||||||
|
- `public`: Compiled frontend files (javascript, images, css, etc.)
|
||||||
|
- `routers`: Handling of server requests. As it uses other Gitea packages to serve the request, other packages (models, modules or services) must not depend on routers.
|
||||||
|
- `routers/api` Contains routers for `/api/v1` aims to handle RESTful API requests.
|
||||||
|
- `routers/install` Could only respond when system is in INSTALL mode (INSTALL_LOCK=false).
|
||||||
|
- `routers/private` will only be invoked by internal sub commands, especially `serv` and `hooks`.
|
||||||
|
- `routers/web` will handle HTTP requests from web browsers or Git SMART HTTP protocols.
|
||||||
|
- `services`: Support functions for common routing operations or command executions. Uses `models` and `modules` to handle the requests.
|
||||||
|
- `templates`: Golang templates for generating the html output.
|
||||||
|
|
||||||
|
### Package Dependencies
|
||||||
|
|
||||||
|
Since Golang doesn't support import cycles, we have to decide the package dependencies carefully. There are some levels between those packages. Below is the ideal package dependencies direction.
|
||||||
|
|
||||||
|
`cmd` -> `routers` -> `services` -> `models` -> `modules`
|
||||||
|
|
||||||
|
From left to right, left packages could depend on right packages, but right packages MUST not depend on left packages. The sub packages on the same level could depend on according this level's rules.
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
Why do we need database transactions outside of `models`? And how?
|
||||||
|
Some actions should allow for rollback when database record insertion/update/deletion failed.
|
||||||
|
So services must be allowed to create a database transaction. Here is some example,
|
||||||
|
|
||||||
|
```go
|
||||||
|
// services/repository/repository.go
|
||||||
|
func CreateXXXX() error {
|
||||||
|
return db.WithTx(func(ctx context.Context) error {
|
||||||
|
// do something, if err is returned, it will rollback automatically
|
||||||
|
if err := issues.UpdateIssue(ctx, repoID); err != nil {
|
||||||
|
// ...
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// ...
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
You should **not** use `db.GetEngine(ctx)` in `services` directly, but just write a function under `models/`.
|
||||||
|
If the function will be used in the transaction, just let `context.Context` as the function's first parameter.
|
||||||
|
|
||||||
|
```go
|
||||||
|
// models/issues/issue.go
|
||||||
|
func UpdateIssue(ctx context.Context, repoID int64) error {
|
||||||
|
e := db.GetEngine(ctx)
|
||||||
|
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Package Name
|
||||||
|
|
||||||
|
For the top level package, use a plural as package name, i.e. `services`, `models`, for sub packages, use singular,
|
||||||
|
i.e. `services/user`, `models/repository`.
|
||||||
|
|
||||||
|
### Import Alias
|
||||||
|
|
||||||
|
Since there are some packages which use the same package name, it is possible that you find packages like `modules/user`, `models/user`, and `services/user`. When these packages are imported in one Go file, it's difficult to know which package we are using and if it's a variable name or an import name. So, we always recommend to use import aliases. To differ from package variables which are commonly in camelCase, just use **snake_case** for import aliases.
|
||||||
|
i.e. `import user_service "code.gitea.io/gitea/services/user"`
|
||||||
|
|
||||||
|
### Implementing `io.Closer`
|
||||||
|
|
||||||
|
If a type implements `io.Closer`, calling `Close` multiple times must not fail or `panic` but return an error or `nil`.
|
||||||
|
|
||||||
|
### Important Gotchas
|
||||||
|
|
||||||
|
- Never write `x.Update(exemplar)` without an explicit `WHERE` clause:
|
||||||
|
- This will cause all rows in the table to be updated with the non-zero values of the exemplar - including IDs.
|
||||||
|
- You should usually write `x.ID(id).Update(exemplar)`.
|
||||||
|
- If during a migration you are inserting into a table using `x.Insert(exemplar)` where the ID is preset:
|
||||||
|
- You will need to ``SET IDENTITY_INSERT `table` ON`` for the MSSQL variant (the migration will fail otherwise)
|
||||||
|
- However, you will also need to update the id sequence for postgres - the migration will silently pass here but later insertions will fail:
|
||||||
|
``SELECT setval('table_name_id_seq', COALESCE((SELECT MAX(id)+1 FROM `table_name`), 1), false)``
|
||||||
|
|
||||||
|
### Future Tasks
|
||||||
|
|
||||||
|
Currently, we are creating some refactors to do the following things:
|
||||||
|
|
||||||
|
- Correct that codes which doesn't follow the rules.
|
||||||
|
- There are too many files in `models`, so we are moving some of them into a sub package `models/xxx`.
|
||||||
|
- Some `modules` sub packages should be moved to `services` because they depend on `models`.
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
---
|
||||||
|
date: "2021-10-13T16:00:00+02:00"
|
||||||
|
slug: "guidelines-frontend"
|
||||||
|
sidebar_position: 30
|
||||||
|
aliases:
|
||||||
|
- /en-us/guidelines-frontend
|
||||||
|
---
|
||||||
|
|
||||||
|
# Guidelines for Frontend Development
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
Gitea uses [Fomantic-UI](https://fomantic-ui.com/introduction/getting-started.html) (based on [jQuery](https://api.jquery.com)) and [Vue3](https://vuejs.org/) for its frontend.
|
||||||
|
|
||||||
|
The HTML pages are rendered by [Go HTML Template](https://pkg.go.dev/html/template).
|
||||||
|
|
||||||
|
The source files can be found in the following directories:
|
||||||
|
|
||||||
|
* **CSS styles:** `web_src/css/`
|
||||||
|
* **JavaScript files:** `web_src/js/`
|
||||||
|
* **Vue components:** `web_src/js/components/`
|
||||||
|
* **Go HTML templates:** `templates/`
|
||||||
|
|
||||||
|
## General Guidelines
|
||||||
|
|
||||||
|
We recommend [Google HTML/CSS Style Guide](https://google.github.io/styleguide/htmlcssguide.html) and [Google JavaScript Style Guide](https://google.github.io/styleguide/jsguide.html)
|
||||||
|
|
||||||
|
### Gitea specific guidelines
|
||||||
|
|
||||||
|
1. Every feature (Fomantic-UI/jQuery module) should be put in separate files/directories.
|
||||||
|
2. HTML ids and classes should use kebab-case, it's preferred to contain 2-3 feature related keywords.
|
||||||
|
3. HTML ids and classes used in JavaScript should be unique for the whole project, and should contain 2-3 feature related keywords. We recommend to use the `js-` prefix for classes that are only used in JavaScript.
|
||||||
|
4. CSS styling for classes provided by frameworks should not be overwritten. Always use new class names with 2-3 feature related keywords to overwrite framework styles. Gitea's helper CSS classes in `helpers.less` could be helpful.
|
||||||
|
5. The backend can pass complex data to the frontend by using `ctx.PageData["myModuleData"] = map[]{}`, but do not expose whole models to the frontend to avoid leaking sensitive data.
|
||||||
|
6. Simple pages and SEO-related pages use Go HTML Template render to generate static Fomantic-UI HTML output. Complex pages can use Vue3.
|
||||||
|
7. Clarify variable types, prefer `elem.disabled = true` instead of `elem.setAttribute('disabled', 'anything')`, prefer `$el.prop('checked', var === 'yes')` instead of `$el.prop('checked', var)`.
|
||||||
|
8. Use semantic elements, prefer `<button class="ui button">` instead of `<div class="ui button">`.
|
||||||
|
9. Avoid unnecessary `!important` in CSS, add comments to explain why it's necessary if it can't be avoided.
|
||||||
|
10. Avoid mixing different events in one event listener, prefer to use individual event listeners for every event.
|
||||||
|
11. Custom event names are recommended to use `ce-` prefix.
|
||||||
|
12. Prefer using Tailwind CSS which is available via `tw-` prefix, e.g. `tw-relative`. Gitea's helper CSS classes use `gt-` prefix (`gt-ellipsis`), while Gitea's own private framework-level CSS classes use `g-` prefix (`g-modal-confirm`).
|
||||||
|
13. Avoid inline scripts & styles as much as possible, it's recommended to put JS code into JS files and use CSS classes. If inline scripts & styles are unavoidable, explain the reason why it can't be avoided.
|
||||||
|
|
||||||
|
### Accessibility / ARIA
|
||||||
|
|
||||||
|
In history, Gitea heavily uses Fomantic UI which is not an accessibility-friendly framework.
|
||||||
|
Gitea uses some patches to make Fomantic UI more accessible (see `aria.md` and related JS files),
|
||||||
|
but there are still many problems which need a lot of work and time to fix.
|
||||||
|
|
||||||
|
### Framework Usage
|
||||||
|
|
||||||
|
Mixing different frameworks together is discouraged, it makes the code difficult to be maintained.
|
||||||
|
A JavaScript module should follow one major framework and follow the framework's best practice.
|
||||||
|
|
||||||
|
Recommended implementations:
|
||||||
|
|
||||||
|
* Vue + Vanilla JS
|
||||||
|
* Fomantic-UI (jQuery)
|
||||||
|
* htmx (partial page reloads for otherwise static components)
|
||||||
|
* Vanilla JS
|
||||||
|
|
||||||
|
Discouraged implementations:
|
||||||
|
|
||||||
|
* Vue + Fomantic-UI (jQuery)
|
||||||
|
* jQuery + Vanilla JS
|
||||||
|
* htmx + any other framework which requires heavy JS code, or unnecessary features like htmx scripting (`hx-on`)
|
||||||
|
|
||||||
|
To make UI consistent, Vue components can use Fomantic-UI CSS classes.
|
||||||
|
We use htmx for simple interactions. You can see an example for simple interactions where htmx should be used in this [PR](https://github.com/go-gitea/gitea/pull/28908). Do not use htmx if you require more advanced reactivity, use another framework (Vue/Vanilla JS).
|
||||||
|
Although mixing different frameworks is discouraged,
|
||||||
|
it should also work if the mixing is necessary and the code is well-designed and maintainable.
|
||||||
|
|
||||||
|
### Typescript
|
||||||
|
|
||||||
|
Gitea is in the process of migrating to type-safe Typescript. Here are some specific guidelines regarding Typescript in the codebase:
|
||||||
|
|
||||||
|
#### Use type aliases instead of interfaces
|
||||||
|
|
||||||
|
Prefer to use type aliases because they can represent any type and are generally more flexible to use than interfaces.
|
||||||
|
|
||||||
|
#### Use separate type imports
|
||||||
|
|
||||||
|
We use `verbatimModuleSyntax` so type and non-type imports from the same file must be split into two `import type` statements. This enables the typescript compiler to completely eliminate the type import statements during compilation.
|
||||||
|
|
||||||
|
#### Use `@ts-expect-error` instead of `@ts-ignore`
|
||||||
|
|
||||||
|
Both annotations should be avoided, but if you have to use them, use `@ts-expect-error` because it will not leave ineffective statements after the issue is fixed.
|
||||||
|
|
||||||
|
### `async` Functions
|
||||||
|
|
||||||
|
Only mark a function as `async` if and only if there are `await` calls
|
||||||
|
or `Promise` returns inside the function.
|
||||||
|
|
||||||
|
It's not recommended to use `async` event listeners, which may lead to problems.
|
||||||
|
The reason is that the code after await is executed outside the event dispatch.
|
||||||
|
Reference: https://github.com/github/eslint-plugin-github/blob/main/docs/rules/async-preventdefault.md
|
||||||
|
|
||||||
|
If an event listener must be `async`, the `e.preventDefault()` should be before any `await`,
|
||||||
|
it's recommended to put it at the beginning of the function.
|
||||||
|
|
||||||
|
If we want to call an `async` function in a non-async context,
|
||||||
|
it's recommended to use `const _promise = asyncFoo()` to tell readers
|
||||||
|
that this is done by purpose, we want to call the async function and ignore the Promise.
|
||||||
|
Some lint rules and IDEs also have warnings if the returned Promise is not handled.
|
||||||
|
|
||||||
|
### Fetching data
|
||||||
|
|
||||||
|
To fetch data, use the wrapper functions `GET`, `POST` etc. from `modules/fetch.js`. They
|
||||||
|
accept a `data` option for the content, will automatically set CSRF token and return a
|
||||||
|
Promise for a [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response).
|
||||||
|
|
||||||
|
### HTML Attributes and `dataset`
|
||||||
|
|
||||||
|
The usage of `dataset` is forbidden, its camel-casing behaviour makes it hard to grep for attributes.
|
||||||
|
However, there are still some special cases, so the current guideline is:
|
||||||
|
|
||||||
|
* For legacy code:
|
||||||
|
* `$.data()` should be refactored to `$.attr()`.
|
||||||
|
* `$.data()` can be used to bind some non-string data to elements in rare cases, but it is highly discouraged.
|
||||||
|
|
||||||
|
* For new code:
|
||||||
|
* `node.dataset` should not be used, use `node.getAttribute` instead.
|
||||||
|
* never bind any user data to a DOM node, use a suitable design pattern to describe the relation between node and data.
|
||||||
|
|
||||||
|
### Show/Hide Elements
|
||||||
|
|
||||||
|
* Vue components are recommended to use `v-if` and `v-show` to show/hide elements.
|
||||||
|
* Go template code should use `.tw-hidden` and `showElem()/hideElem()/toggleElem()`, see more details in `.tw-hidden`'s comment.
|
||||||
|
|
||||||
|
### Styles and Attributes in Go HTML Template
|
||||||
|
|
||||||
|
It's recommended to use:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div class="gt-name1 gt-name2 {{if .IsFoo}}gt-foo{{end}}" {{if .IsFoo}}data-foo{{end}}></div>
|
||||||
|
```
|
||||||
|
|
||||||
|
instead of:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div class="gt-name1 gt-name2{{if .IsFoo}} gt-foo{{end}}"{{if .IsFoo}} data-foo{{end}}></div>
|
||||||
|
```
|
||||||
|
|
||||||
|
to make the code more readable.
|
||||||
|
|
||||||
|
### Legacy Code
|
||||||
|
|
||||||
|
A lot of legacy code already existed before this document's written. It's recommended to refactor legacy code to follow the guidelines.
|
||||||
|
|
||||||
|
### Vue3 and JSX
|
||||||
|
|
||||||
|
Gitea is using Vue3 now. We decided not to introduce JSX to keep the HTML and the JavaScript code separated.
|
||||||
|
|
||||||
|
### UI Examples
|
||||||
|
|
||||||
|
Gitea uses some self-made UI elements and customizes others to integrate them better into the general UI approach. When running Gitea in development mode (`RUN_MODE=dev`), a page with some standardized UI examples is available under `http(s)://your-gitea-url:port/devtest`.
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
---
|
||||||
|
date: "2023-02-14T00:00:00+00:00"
|
||||||
|
slug: "guidelines-refactoring"
|
||||||
|
sidebar_position: 40
|
||||||
|
aliases:
|
||||||
|
- /en-us/guidelines-refactoring
|
||||||
|
---
|
||||||
|
|
||||||
|
# Guidelines for Refactoring
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
Since the first line of code was written at Feb 12, 2014, Gitea has grown to be a large project.
|
||||||
|
As a result, the codebase has become larger and larger. The larger the codebase is, the more difficult it is to maintain.
|
||||||
|
A lot of outdated mechanisms exist, a lot of frameworks are mixed together, some legacy code might cause bugs and block new features.
|
||||||
|
To make the codebase more maintainable and make Gitea better, developers should keep in mind to use modern mechanisms to refactor the old code.
|
||||||
|
|
||||||
|
This document is a collection of guidelines for refactoring the codebase.
|
||||||
|
|
||||||
|
## Refactoring Suggestions
|
||||||
|
|
||||||
|
* Design more about the future, but not only resolve the current problem.
|
||||||
|
* Reduce ambiguity, reduce conflicts, improve maintainability.
|
||||||
|
* Describe the refactoring, for example:
|
||||||
|
* Why the refactoring is needed.
|
||||||
|
* How the legacy problems would be solved.
|
||||||
|
* What's the Pros/Cons of the refactoring.
|
||||||
|
* Only do necessary changes, keep the old logic as much as possible.
|
||||||
|
* Introduce some intermediate steps to make the refactoring easier to review, a complete refactoring plan could be done in several PRs.
|
||||||
|
* If there is any divergence, the TOC(Technical Oversight Committee) should be involved to help to make decisions.
|
||||||
|
* Add necessary tests to make sure the refactoring is correct.
|
||||||
|
* Non-bug refactoring is preferred to be done at the beginning of a milestone, it would be easier to find problems before the release.
|
||||||
|
|
||||||
|
## Reviewing & Merging Suggestions
|
||||||
|
|
||||||
|
* A refactoring PR shouldn't be kept open for a long time (usually 7 days), it should be reviewed as soon as possible.
|
||||||
|
* A refactoring PR should be merged as soon as possible, it should not be blocked by other PRs.
|
||||||
|
* If there is no objection from TOC, a refactoring PR could be merged after 7 days with one core member's approval (not the author).
|
||||||
|
* Tolerate some dirty/hacky intermediate steps if the final result is good.
|
||||||
|
* Tolerate some regression bugs if the refactoring is necessary, fix bugs as soon as possible.
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
slug: "localization"
|
||||||
|
sidebar_position: 70
|
||||||
|
aliases:
|
||||||
|
- /en-us/localization
|
||||||
|
---
|
||||||
|
|
||||||
|
# Localization
|
||||||
|
|
||||||
|
Gitea's localization happens through our [Crowdin project](https://crowdin.com/project/gitea).
|
||||||
|
|
||||||
|
For changes to an **English** translation, a pull request can be made that changes the appropriate key in
|
||||||
|
the [english locale](https://github.com/go-gitea/gitea/blob/main/options/locale/locale_en-US.ini).
|
||||||
|
|
||||||
|
For changes to a **non-English** translation, refer to the Crowdin project above.
|
||||||
|
|
||||||
|
## Supported Languages
|
||||||
|
|
||||||
|
Any language listed in the above Crowdin project will be supported as long as 25% or more has been translated.
|
||||||
|
|
||||||
|
After a translation has been accepted, it will be reflected in the main repository after the next Crowdin sync, which is generally after any PR is merged.
|
||||||
|
|
||||||
|
At the time of writing, this means that a changed translation may not appear until the following Gitea release.
|
||||||
|
|
||||||
|
If you use a bleeding edge build, it should appear as soon as you update after the change is synced.
|
||||||
|
|
||||||
|
# How to Contribute
|
||||||
|
|
||||||
|
Different Languages have different translation guidelines. Please visit the respective page for more information.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
title: "Development"
|
||||||
|
slug: "development"
|
||||||
|
sidebar_position: 40
|
||||||
|
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
name: "Development"
|
||||||
|
sidebar_position: 40
|
||||||
|
identifier: "development"
|
||||||
|
---
|
||||||
@@ -0,0 +1,125 @@
|
|||||||
|
---
|
||||||
|
date: "2018-06-24:00:00+02:00"
|
||||||
|
slug: "api-usage"
|
||||||
|
sidebar_position: 40
|
||||||
|
aliases:
|
||||||
|
- /en-us/api-usage
|
||||||
|
---
|
||||||
|
|
||||||
|
# API Usage
|
||||||
|
|
||||||
|
## Enabling/configuring API access
|
||||||
|
|
||||||
|
By default, `ENABLE_SWAGGER` is true, and `MAX_RESPONSE_ITEMS` is set to 50. See [Config Cheat Sheet](../administration/config-cheat-sheet.md) for more information.
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
Gitea supports these methods of API authentication:
|
||||||
|
|
||||||
|
- HTTP basic authentication
|
||||||
|
- `token=...` parameter in URL query string
|
||||||
|
- `access_token=...` parameter in URL query string
|
||||||
|
- `Authorization: token ...` header in HTTP headers
|
||||||
|
|
||||||
|
All of these methods accept the same API key token type. You can
|
||||||
|
better understand this by looking at the code -- as of this writing,
|
||||||
|
Gitea parses queries and headers to find the token in
|
||||||
|
[modules/auth/auth.go](https://github.com/go-gitea/gitea/blob/6efdcaed86565c91a3dc77631372a9cc45a58e89/modules/auth/auth.go#L47).
|
||||||
|
|
||||||
|
## Generating and listing API tokens
|
||||||
|
|
||||||
|
A new token can be generated with a `POST` request to
|
||||||
|
`/users/:name/tokens`.
|
||||||
|
|
||||||
|
Note that `/users/:name/tokens` is a special endpoint and requires you
|
||||||
|
to authenticate using `BasicAuth` and a password, as follows:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ curl -H "Content-Type: application/json" \
|
||||||
|
-d '{"name":"test_token","scopes":["read:activitypub","read:issue", "write:misc", "read:notification", "read:organization", "read:package", "read:repository", "read:user"]}' \
|
||||||
|
-u 'username:password' "https://gitea.your.host/api/v1/users/{username}/tokens"
|
||||||
|
{"id":1,"name":"test_token","sha1":"9fcb1158165773dd010fca5f0cf7174316c3e37d","token_last_eight":"16c3e37d"}
|
||||||
|
```
|
||||||
|
|
||||||
|
The ``sha1`` (the token) is only returned once and is not stored in
|
||||||
|
plain-text. It will not be displayed when listing tokens with a `GET`
|
||||||
|
request; e.g.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ curl --url https://yourusername:[email protected]/api/v1/users/<username>/tokens
|
||||||
|
[{"name":"test","sha1":"","token_last_eight:"........":},{"name":"dev","sha1":"","token_last_eight":"........"}]
|
||||||
|
```
|
||||||
|
|
||||||
|
To use the API with basic authentication with two factor authentication
|
||||||
|
enabled, you'll need to send an additional header that contains the one
|
||||||
|
time password (6 digitrotating token).
|
||||||
|
An example of the header is `X-Gitea-OTP: 123456` where `123456`
|
||||||
|
is where you'd place the code from your authenticator.
|
||||||
|
Here is how the request would look like in curl:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ curl -H "X-Gitea-OTP: 123456" --url https://yourusername:[email protected]/api/v1/users/yourusername/tokens
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also create an API key token via your Gitea installation's web
|
||||||
|
interface: `Settings | Applications | Generate New Token`.
|
||||||
|
|
||||||
|
## OAuth2 Provider
|
||||||
|
|
||||||
|
Access tokens obtained from Gitea's [OAuth2 provider](development/oauth2-provider.md) are accepted by these methods:
|
||||||
|
|
||||||
|
- `Authorization bearer ...` header in HTTP headers
|
||||||
|
- `token=...` parameter in URL query string
|
||||||
|
- `access_token=...` parameter in URL query string
|
||||||
|
|
||||||
|
### More on the `Authorization:` header
|
||||||
|
|
||||||
|
For historical reasons, Gitea needs the word `token` included before
|
||||||
|
the API key token in an authorization header, like this:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
Authorization: token 65eaa9c8ef52460d22a93307fe0aee76289dc675
|
||||||
|
```
|
||||||
|
|
||||||
|
In a `curl` command, for instance, this would look like:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl "http://localhost:4000/api/v1/repos/test1/test1/issues" \
|
||||||
|
-H "accept: application/json" \
|
||||||
|
-H "Authorization: token 65eaa9c8ef52460d22a93307fe0aee76289dc675" \
|
||||||
|
-H "Content-Type: application/json" -d "{ \"body\": \"testing\", \"title\": \"test 20\"}" -i
|
||||||
|
```
|
||||||
|
|
||||||
|
As mentioned above, the token used is the same one you would use in
|
||||||
|
the `token=` string in a GET request.
|
||||||
|
|
||||||
|
## Pagination
|
||||||
|
|
||||||
|
The API supports pagination. The `page` and `limit` parameters are used to specify the page number and the number of items per page. As well, the `Link` header is returned with the next, previous, and last page links if there are more than one pages. The `x-total-count` is also returned to indicate the total number of items.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -v "http://localhost/api/v1/repos/search?limit=1"
|
||||||
|
...
|
||||||
|
< link: <http://localhost/api/v1/repos/search?limit=1&page=2>; rel="next",<http://localhost/api/v1/repos/search?limit=1&page=5252>; rel="last"
|
||||||
|
...
|
||||||
|
< x-total-count: 5252
|
||||||
|
```
|
||||||
|
|
||||||
|
## API Guide
|
||||||
|
|
||||||
|
API Reference guide is auto-generated by swagger and available on:
|
||||||
|
`https://gitea.your.host/api/swagger`
|
||||||
|
or on the
|
||||||
|
[Gitea instance](https://gitea.com/api/swagger)
|
||||||
|
|
||||||
|
The OpenAPI document is at:
|
||||||
|
`https://gitea.your.host/swagger.v1.json`
|
||||||
|
|
||||||
|
## Sudo
|
||||||
|
|
||||||
|
The API allows admin users to sudo API requests as another user. Simply add either a `sudo=` parameter or `Sudo:` request header with the username of the user to sudo.
|
||||||
|
|
||||||
|
## SDKs
|
||||||
|
|
||||||
|
- [Official go-sdk](https://gitea.com/gitea/go-sdk)
|
||||||
|
- [more](https://gitea.com/gitea/awesome-gitea#user-content-sdk)
|
||||||
@@ -0,0 +1,372 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
slug: "hacking-on-gitea"
|
||||||
|
sidebar_position: 10
|
||||||
|
aliases:
|
||||||
|
- /en-us/hacking-on-gitea
|
||||||
|
---
|
||||||
|
|
||||||
|
# Hacking on Gitea
|
||||||
|
|
||||||
|
## Quickstart
|
||||||
|
|
||||||
|
To get a quick working development environment you could use Gitpod.
|
||||||
|
|
||||||
|
[](https://gitpod.io/#https://github.com/go-gitea/gitea)
|
||||||
|
|
||||||
|
## Installing go
|
||||||
|
|
||||||
|
You should [install go](https://go.dev/doc/install) and set up your go
|
||||||
|
environment correctly.
|
||||||
|
|
||||||
|
Next, [install Node.js with npm](https://nodejs.org/en/download/) which is
|
||||||
|
required to build the JavaScript and CSS files. The minimum supported Node.js
|
||||||
|
version is @minNodeVersion@ and the latest LTS version is recommended.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
When executing make tasks that require external tools, like
|
||||||
|
`make watch-backend`, Gitea will automatically download and build these as
|
||||||
|
necessary. To be able to use these you must have the `"$GOPATH"/bin` directory
|
||||||
|
on the executable path. If you don't add the go bin directory to the
|
||||||
|
executable path you will have to manage this yourself.
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Go version @minGoVersion@ or higher is required.
|
||||||
|
Gitea uses `gofmt` to format source code. However, the results of
|
||||||
|
`gofmt` can differ by the version of `go`. Therefore it is
|
||||||
|
recommended to install the version of Go that our continuous integration is
|
||||||
|
running. As of last update, the Go version should be @goVersion@.
|
||||||
|
:::
|
||||||
|
|
||||||
|
To lint the template files, ensure [Python](https://www.python.org/) and
|
||||||
|
[Poetry](https://python-poetry.org/) are installed.
|
||||||
|
|
||||||
|
## Installing Make
|
||||||
|
|
||||||
|
Gitea makes heavy use of Make to automate tasks and improve development. This
|
||||||
|
guide covers how to install Make.
|
||||||
|
|
||||||
|
### On Linux
|
||||||
|
|
||||||
|
Install with the package manager.
|
||||||
|
|
||||||
|
On Ubuntu/Debian:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get install make
|
||||||
|
```
|
||||||
|
|
||||||
|
On Fedora/RHEL/CentOS:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo yum install make
|
||||||
|
```
|
||||||
|
|
||||||
|
### On Windows
|
||||||
|
|
||||||
|
One of these three distributions of Make will run on Windows:
|
||||||
|
|
||||||
|
- [Single binary build](http://www.equation.com/servlet/equation.cmd?fa=make). Copy somewhere and add to `PATH`.
|
||||||
|
- [32-bits version](http://www.equation.com/ftpdir/make/32/make.exe)
|
||||||
|
- [64-bits version](http://www.equation.com/ftpdir/make/64/make.exe)
|
||||||
|
- [MinGW-w64](https://www.mingw-w64.org) / [MSYS2](https://www.msys2.org/).
|
||||||
|
- MSYS2 is a collection of tools and libraries providing you with an easy-to-use environment for building, installing and running native Windows software, it includes MinGW-w64.
|
||||||
|
- In MingGW-w64, the binary is called `mingw32-make.exe` instead of `make.exe`. Add the `bin` folder to `PATH`.
|
||||||
|
- In MSYS2, you can use `make` directly. See [MSYS2 Porting](https://www.msys2.org/wiki/Porting/).
|
||||||
|
- To compile Gitea with CGO_ENABLED (eg: SQLite3), you might need to use [tdm-gcc](https://jmeubank.github.io/tdm-gcc/) instead of MSYS2 gcc, because MSYS2 gcc headers lack some Windows-only CRT functions like `_beginthread`.
|
||||||
|
- [Chocolatey package](https://chocolatey.org/packages/make). Run `choco install make`
|
||||||
|
|
||||||
|
:::note
|
||||||
|
If you are attempting to build using make with Windows Command Prompt, you may run into issues. The above prompts (Git bash, or MinGW) are recommended, however if you only have command prompt (or potentially PowerShell) you can set environment variables using the [set](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/set_1) command, e.g. `set TAGS=bindata`.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Downloading and cloning the Gitea source code
|
||||||
|
|
||||||
|
The recommended method of obtaining the source code is by using `git clone`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/go-gitea/gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
(Since the advent of go modules, it is no longer necessary to build go projects
|
||||||
|
from within the `$GOPATH`, hence the `go get` approach is no longer recommended.)
|
||||||
|
|
||||||
|
## Forking Gitea
|
||||||
|
|
||||||
|
Download the main Gitea source code as above. Then, fork the
|
||||||
|
[Gitea repository](https://github.com/go-gitea/gitea) on GitHub,
|
||||||
|
and either switch the git remote origin for your fork or add your fork as another remote:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Rename original Gitea origin to upstream
|
||||||
|
git remote rename origin upstream
|
||||||
|
git remote add origin "[email protected]:$GITHUB_USERNAME/gitea.git"
|
||||||
|
git fetch --all --prune
|
||||||
|
```
|
||||||
|
|
||||||
|
or:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Add new remote for our fork
|
||||||
|
git remote add "$FORK_NAME" "[email protected]:$GITHUB_USERNAME/gitea.git"
|
||||||
|
git fetch --all --prune
|
||||||
|
```
|
||||||
|
|
||||||
|
To be able to create pull requests, the forked repository should be added as a remote
|
||||||
|
to the Gitea sources. Otherwise, changes can't be pushed.
|
||||||
|
|
||||||
|
## Building Gitea (Basic)
|
||||||
|
|
||||||
|
Take a look at our
|
||||||
|
[instructions](installation/from-source.md)
|
||||||
|
for [building from source](installation/from-source.md).
|
||||||
|
|
||||||
|
The simplest recommended way to build from source is:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" make build
|
||||||
|
```
|
||||||
|
|
||||||
|
The `build` target will execute both `frontend` and `backend` sub-targets. If the `bindata` tag is present, the frontend files will be compiled into the binary. It is recommended to leave out the tag when doing frontend development so that changes will be reflected.
|
||||||
|
|
||||||
|
See `make help` for all available `make` targets. Also see [`.drone.yml`](https://github.com/go-gitea/gitea/blob/main/.drone.yml) to see how our continuous integration works.
|
||||||
|
|
||||||
|
## Building continuously
|
||||||
|
|
||||||
|
To run and continuously rebuild when source files change:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# for both frontend and backend
|
||||||
|
make watch
|
||||||
|
|
||||||
|
# or: watch frontend files (html/js/css) only
|
||||||
|
make watch-frontend
|
||||||
|
|
||||||
|
# or: watch backend files (go) only
|
||||||
|
make watch-backend
|
||||||
|
```
|
||||||
|
|
||||||
|
On macOS, watching all backend source files may hit the default open files limit which can be increased via `ulimit -n 12288` for the current shell or in your shell startup file for all future shells.
|
||||||
|
|
||||||
|
### Formatting, code analysis and spell check
|
||||||
|
|
||||||
|
Our continuous integration will reject PRs that fail the code linters (including format check, code analysis and spell check).
|
||||||
|
|
||||||
|
You should format your code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make fmt
|
||||||
|
```
|
||||||
|
|
||||||
|
and lint the source code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# lint both frontend and backend code
|
||||||
|
make lint
|
||||||
|
# lint only backend code
|
||||||
|
make lint-backend
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note**: The results of `gofmt` are dependent on the version of `go` present.
|
||||||
|
You should run the same version of go that is on the continuous integration
|
||||||
|
server as mentioned above.
|
||||||
|
|
||||||
|
### Working on JS and CSS
|
||||||
|
|
||||||
|
Frontend development should follow [Guidelines for Frontend Development](contributing/guidelines-frontend.md)
|
||||||
|
|
||||||
|
To build with frontend resources, either use the `watch-frontend` target mentioned above or just build once:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make build && ./gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
Before committing, make sure the linters pass:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make lint-frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuring local ElasticSearch instance
|
||||||
|
|
||||||
|
Start local ElasticSearch instance using docker:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mkdir -p $(pwd)/data/elasticsearch
|
||||||
|
sudo chown -R 1000:1000 $(pwd)/data/elasticsearch
|
||||||
|
docker run --rm --memory="4g" -p 127.0.0.1:9200:9200 -p 127.0.0.1:9300:9300 -e "discovery.type=single-node" -v "$(pwd)/data/elasticsearch:/usr/share/elasticsearch/data" docker.elastic.co/elasticsearch/elasticsearch:7.16.3
|
||||||
|
```
|
||||||
|
|
||||||
|
Configure `app.ini`:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[indexer]
|
||||||
|
ISSUE_INDEXER_TYPE = elasticsearch
|
||||||
|
ISSUE_INDEXER_CONN_STR = http://elastic:changeme@localhost:9200
|
||||||
|
REPO_INDEXER_ENABLED = true
|
||||||
|
REPO_INDEXER_TYPE = elasticsearch
|
||||||
|
REPO_INDEXER_CONN_STR = http://elastic:changeme@localhost:9200
|
||||||
|
```
|
||||||
|
|
||||||
|
### Building and adding SVGs
|
||||||
|
|
||||||
|
SVG icons are built using the `make svg` target which compiles the icon sources into the output directory `public/assets/img/svg`. Custom icons can be added in the `web_src/svg` directory.
|
||||||
|
|
||||||
|
### Building the Logo
|
||||||
|
|
||||||
|
The PNG and SVG versions of the Gitea logo are built from a single SVG source file `assets/logo.svg` using the `TAGS="gitea" make generate-images` target. To run it, Node.js and npm must be available.
|
||||||
|
|
||||||
|
The same process can also be used to generate custom logo PNGs from a SVG source file by updating `assets/logo.svg` and running `make generate-images`. Omitting the `gitea` tag will update only the user-designated logo files.
|
||||||
|
|
||||||
|
### Updating the API
|
||||||
|
|
||||||
|
When creating new API routes or modifying existing API routes, you **MUST**
|
||||||
|
update and/or create [Swagger](https://swagger.io/docs/specification/2-0/what-is-swagger/)
|
||||||
|
documentation for these using [go-swagger](https://goswagger.io/) comments.
|
||||||
|
The structure of these comments is described in the [specification](https://goswagger.io/use/spec.html#annotation-syntax).
|
||||||
|
If you want more information about the Swagger structure, you can look at the
|
||||||
|
[Swagger 2.0 Documentation](https://swagger.io/docs/specification/2-0/basic-structure/)
|
||||||
|
or compare with a previous PR adding a new API endpoint, e.g. [PR #5483](https://github.com/go-gitea/gitea/pull/5843/files#diff-2e0a7b644cf31e1c8ef7d76b444fe3aaR20)
|
||||||
|
|
||||||
|
You should be careful not to break the API for downstream users which depend
|
||||||
|
on a stable API. In general, this means additions are acceptable, but deletions
|
||||||
|
or fundamental changes to the API will be rejected.
|
||||||
|
|
||||||
|
Once you have created or changed an API endpoint, please regenerate the Swagger
|
||||||
|
documentation using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make generate-swagger
|
||||||
|
```
|
||||||
|
|
||||||
|
You should validate your generated Swagger file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make swagger-validate
|
||||||
|
```
|
||||||
|
|
||||||
|
You should commit the changed swagger JSON file. The continuous integration
|
||||||
|
server will check that this has been done using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make swagger-check
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Please note you should use the Swagger 2.0 documentation, not the OpenAPI 3 documentation.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Creating new configuration options
|
||||||
|
|
||||||
|
When creating new configuration options, it is not enough to add them to the
|
||||||
|
`modules/setting` files. You should add information to `custom/conf/app.ini`
|
||||||
|
and to the
|
||||||
|
[configuration cheat sheet](../administration/config-cheat-sheet.md)
|
||||||
|
found in `docs/content/doc/administer/config-cheat-sheet.en-us.md`
|
||||||
|
|
||||||
|
### Changing the logo
|
||||||
|
|
||||||
|
When changing the Gitea logo SVG, you will need to run and commit the results
|
||||||
|
of:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make generate-images
|
||||||
|
```
|
||||||
|
|
||||||
|
This will create the necessary Gitea favicon and others.
|
||||||
|
|
||||||
|
### Database Migrations
|
||||||
|
|
||||||
|
If you make breaking changes to any of the database persisted structs in the
|
||||||
|
`models/` directory, you will need to make a new migration. These can be found
|
||||||
|
in `models/migrations/`. You can ensure that your migrations work for the main
|
||||||
|
database types using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make test-sqlite-migration # with SQLite switched for the appropriate database
|
||||||
|
```
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
There are two types of test run by Gitea: Unit tests and Integration Tests.
|
||||||
|
|
||||||
|
### Unit Tests
|
||||||
|
|
||||||
|
Unit tests are covered by `*_test.go` in `go test` system.
|
||||||
|
You can set the environment variable `GITEA_UNIT_TESTS_LOG_SQL=1` to display all SQL statements when running the tests in verbose mode (i.e. when `GOTESTFLAGS=-v` is set).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" make test # Runs the unit tests
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integration Tests
|
||||||
|
|
||||||
|
Unit tests will not and cannot completely test Gitea alone. Therefore, we
|
||||||
|
have written integration tests; however, these are database dependent.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" make build test-sqlite
|
||||||
|
```
|
||||||
|
|
||||||
|
will run the integration tests in an SQLite environment. Integration tests
|
||||||
|
require `git lfs` to be installed. Other database tests are available but
|
||||||
|
may need adjustment to the local environment.
|
||||||
|
|
||||||
|
Take a look at [`tests/integration/README.md`](https://github.com/go-gitea/gitea/blob/main/tests/integration/README.md)
|
||||||
|
for more information and how to run a single test.
|
||||||
|
|
||||||
|
### Testing for a PR
|
||||||
|
|
||||||
|
Our continuous integration will test the code passes its unit tests and that
|
||||||
|
all supported databases will pass integration test in a Docker environment.
|
||||||
|
Migration from several recent versions of Gitea will also be tested.
|
||||||
|
|
||||||
|
Please submit your PR with additional tests and integration tests as
|
||||||
|
appropriate.
|
||||||
|
|
||||||
|
## Documentation for the website
|
||||||
|
|
||||||
|
Documentation for the website is found in `docs/`. If you change this you
|
||||||
|
can test your changes to ensure that they pass continuous integration using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make lint-md
|
||||||
|
```
|
||||||
|
|
||||||
|
## Visual Studio Code
|
||||||
|
|
||||||
|
A `launch.json` and `tasks.json` are provided within `contrib/ide/vscode` for
|
||||||
|
Visual Studio Code. Look at
|
||||||
|
[`contrib/ide/README.md`](https://github.com/go-gitea/gitea/blob/main/contrib/ide/README.md)
|
||||||
|
for more information.
|
||||||
|
|
||||||
|
## GoLand
|
||||||
|
|
||||||
|
Clicking the `Run Application` arrow on the function `func main()` in `/main.go`
|
||||||
|
can quickly start a debuggable Gitea instance.
|
||||||
|
|
||||||
|
The `Output Directory` in `Run/Debug Configuration` MUST be set to the
|
||||||
|
gitea project directory (which contains `main.go` and `go.mod`),
|
||||||
|
otherwise, the started instance's working directory is a GoLand's temporary directory
|
||||||
|
and prevents Gitea from loading dynamic resources (eg: templates) in a development environment.
|
||||||
|
|
||||||
|
To run unit tests with SQLite in GoLand, set `-tags sqlite,sqlite_unlock_notify`
|
||||||
|
in `Go tool arguments` of `Run/Debug Configuration`.
|
||||||
|
|
||||||
|
## Submitting PRs
|
||||||
|
|
||||||
|
Once you're happy with your changes, push them up and open a pull request. It
|
||||||
|
is recommended that you allow Gitea Managers and Owners to modify your PR
|
||||||
|
branches as we will need to update it to main before merging and/or may be
|
||||||
|
able to help fix issues directly.
|
||||||
|
|
||||||
|
Any PR requires two approvals from the Gitea maintainers and needs to pass the
|
||||||
|
continuous integration. Take a look at our
|
||||||
|
[`CONTRIBUTING.md`](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md)
|
||||||
|
document.
|
||||||
|
|
||||||
|
If you need more help pop on to [Discord](https://discord.gg/gitea) #Develop
|
||||||
|
and chat there.
|
||||||
|
|
||||||
|
That's it! You are ready to hack on Gitea.
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
date: "2019-04-15T17:29:00+08:00"
|
||||||
|
slug: "integrations"
|
||||||
|
sidebar_position: 65
|
||||||
|
aliases:
|
||||||
|
- /en-us/integrations
|
||||||
|
---
|
||||||
|
|
||||||
|
# Integrations
|
||||||
|
|
||||||
|
Gitea has a wonderful community of third-party integrations, as well as first-class support in various other
|
||||||
|
projects.
|
||||||
|
|
||||||
|
We are curating a list over at [awesome-gitea](https://gitea.com/gitea/awesome-gitea) to track these!
|
||||||
|
|
||||||
|
If you are looking for [CI/CD](https://gitea.com/gitea/awesome-gitea#user-content-devops),
|
||||||
|
an [SDK](https://gitea.com/gitea/awesome-gitea#user-content-sdk),
|
||||||
|
or even some extra [themes](https://gitea.com/gitea/awesome-gitea#user-content-themes),
|
||||||
|
you can find them listed in the [awesome-gitea](https://gitea.com/gitea/awesome-gitea) repository!
|
||||||
|
|
||||||
|
## Pre-Fill New File name and contents
|
||||||
|
|
||||||
|
If you'd like to open a new file with a given name and contents,
|
||||||
|
you can do so with query parameters:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
GET /{{org}}/{{repo}}/_new/{{filepath}}
|
||||||
|
?filename={{filename}}
|
||||||
|
&value={{content}}
|
||||||
|
```
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
GET https://git.example.com/johndoe/bliss/_new/articles/
|
||||||
|
?filename=hello-world.md
|
||||||
|
&value=Hello%2C%20World!
|
||||||
|
```
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
date: "2019-04-15T17:29:00+08:00"
|
||||||
|
slug: "migrations-interfaces"
|
||||||
|
sidebar_position: 55
|
||||||
|
aliases:
|
||||||
|
- /en-us/migrations-interfaces
|
||||||
|
---
|
||||||
|
|
||||||
|
# Migration Interfaces
|
||||||
|
|
||||||
|
Complete migrations were introduced in Gitea 1.9.0. It defines two interfaces to support migrating
|
||||||
|
repository data from other Git host platforms to Gitea or, in the future, migrating Gitea data to other Git host platforms.
|
||||||
|
|
||||||
|
Currently, migrations from GitHub, GitLab, and other Gitea instances are implemented.
|
||||||
|
|
||||||
|
First of all, Gitea defines some standard objects in packages [modules/migration](https://github.com/go-gitea/gitea/tree/main/modules/migration).
|
||||||
|
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`.
|
||||||
|
|
||||||
|
## Downloader Interfaces
|
||||||
|
|
||||||
|
To migrate from a new Git host platform, there are two steps to be updated.
|
||||||
|
|
||||||
|
- You should implement a `Downloader` which will be used to get repository information.
|
||||||
|
- You should implement a `DownloaderFactory` which will be used to detect if the URL matches and create the above `Downloader`.
|
||||||
|
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on `init()`.
|
||||||
|
|
||||||
|
You can find these interfaces in [downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/downloader.go).
|
||||||
|
|
||||||
|
## Uploader Interface
|
||||||
|
|
||||||
|
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded
|
||||||
|
data via this `Uploader` to the local Gitea instance. Other uploaders are not supported at this time.
|
||||||
|
|
||||||
|
You can find these interfaces in [uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migration/uploader.go).
|
||||||
@@ -0,0 +1,271 @@
|
|||||||
|
---
|
||||||
|
date: "2023-06-01T08:40:00+08:00"
|
||||||
|
slug: "oauth2-provider"
|
||||||
|
sidebar_position: 41
|
||||||
|
aliases:
|
||||||
|
- /en-us/oauth2-provider
|
||||||
|
---
|
||||||
|
|
||||||
|
# OAuth2 Provider
|
||||||
|
|
||||||
|
Gitea supports acting as an OAuth2 Provider, allowing third-party applications to access its resources with user consent.
|
||||||
|
|
||||||
|
When acting as the OAuth2 Provider, Gitea verifies every authorization request against the related OAuth2 Application. This application can be set up by an individual user, an organization admin, or a Gitea instance admin.
|
||||||
|
|
||||||
|
Regardless of who configured the application, the first authorization attempt opens a new page in the user's web browser, prompting them to authorize the application.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
An OAuth2 Application in Gitea requires the following configuration made in two steps:
|
||||||
|
|
||||||
|
### Gitea Step 1
|
||||||
|
- Name (`/admin/applications/`)
|
||||||
|
- Redirect URL (`/admin/applications/`)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Gitea Step 2
|
||||||
|
- Client ID (`/admin/applications/oauth2/_id_`)
|
||||||
|
- Client Secret (`/admin/applications/oauth2/_id_`)
|
||||||
|
- Confidential client status (`/admin/applications/oauth2/_id_`)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Third Party Step 3
|
||||||
|
|
||||||
|
The third-party (Relaying Parties) application's request must include:
|
||||||
|
|
||||||
|
- Credentials (Client ID and Client Secret)
|
||||||
|
- Desired scope and claims (expected to be provided by Gitea)
|
||||||
|
|
||||||
|
An example of MinIO:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
### Gitea's User Approval Step 3
|
||||||
|
|
||||||
|
For example, logging in with a Gitea account on MinIO...
|
||||||
|

|
||||||
|
|
||||||
|
...will display the approval popup after a successful login:
|
||||||
|

|
||||||
|
|
||||||
|
By default, if the third party sets the scopes to `openid`, `email`, `profile`, and `groups`, and the user approves, the application gains full access to all of the user's public and private resources (repositories, issues, user information, etc.).
|
||||||
|
|
||||||
|
> **NOTE:** At present, an admin who sets up the OAuth2 Application in Gitea must rely on the scopes sent by the third party and an approval decision by the informed user if restrictive access is expected. There is no way for the admin to set restrictive access via scopes during the application setup process.
|
||||||
|
|
||||||
|
|
||||||
|
## Granular Scopes
|
||||||
|
|
||||||
|
As of version v1.23, Gitea supports granular scopes, allowing third parties to request more limited access. These scopes, previously available only for [Personal Access Tokens](#scopes), enable users to restrict access to specific URL routes.
|
||||||
|
|
||||||
|
Scopes are grouped by high-level API routes and further refined as follows:
|
||||||
|
|
||||||
|
- `read`: `GET` routes
|
||||||
|
- `write`: `POST`, `PUT`, `PATCH`, and `DELETE` routes (in addition to `GET`)
|
||||||
|
|
||||||
|
For example, a third party can request minimal access, allowing Gitea to act as a simple OpenID Connect (OIDC) Provider. If the third party adds only `public-only` to 'openid', no other or any combination of the scopes `email`, `userinfo`, or `groups`, Gitea will act as a basic Single Sign-On provider. This configuration provides only verification that the user can log in with the correct credentials, supplying only basic information such as username, email, and a list of public memberships in organizations and teams.
|
||||||
|
|
||||||
|
When any of the granular scopes known from Personal Access Tokens is introduced, Gitea will not allow full access (as it does by default). Instead, it will build granular access following read or write permissions to resources such as Repositories, Issues, ActivityPub, Admin functions, Organizations, Users, Packages, or miscellaneous features.
|
||||||
|
|
||||||
|
> **NOTE:** If third party adds any scope other than the OIDC ones: `openid`, `email`, `profile`, and `groups` or the ones found already in Personal Access Token the scope will fallback to full access as it was the case before v1.23
|
||||||
|
|
||||||
|
The approval page displayed to the user shows the list of scopes requested by the third party. Once approved, this decision is remembered. If the third party changes its requested scopes in future requests, the entire flow will fail, requiring re-authorization.
|
||||||
|
|
||||||
|
## Endpoints
|
||||||
|
|
||||||
|
| Endpoint | URL |
|
||||||
|
| ------------------------ | ----------------------------------- |
|
||||||
|
| OpenID Connect Discovery | `/.well-known/openid-configuration` |
|
||||||
|
| Authorization Endpoint | `/login/oauth/authorize` |
|
||||||
|
| Access Token Endpoint | `/login/oauth/access_token` |
|
||||||
|
| Token Introspection Endpoint | `/login/oauth/introspect` |
|
||||||
|
| OpenID Connect UserInfo | `/login/oauth/userinfo` |
|
||||||
|
| JSON Web Key Set | `/login/oauth/keys` |
|
||||||
|
|
||||||
|
## Supported OAuth2 Grants
|
||||||
|
|
||||||
|
At the moment Gitea only supports the [**Authorization Code Grant**](https://tools.ietf.org/html/rfc6749#section-1.3.1) standard with additional support of the following extensions:
|
||||||
|
|
||||||
|
- [Proof Key for Code Exchange (PKCE)](https://tools.ietf.org/html/rfc7636)
|
||||||
|
- [OpenID Connect (OIDC)](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)
|
||||||
|
|
||||||
|
To use the Authorization Code Grant as a third party application it is required to register a new application via the "Settings" (`/user/settings/applications`) section of the settings. To test or debug you can use the web-tool https://oauthdebugger.com/.
|
||||||
|
|
||||||
|
## Scopes
|
||||||
|
|
||||||
|
Gitea supports scoped access tokens, which allow users the ability to restrict tokens to operate only on selected url routes. Scopes are grouped by high-level API routes, and further refined to the following:
|
||||||
|
|
||||||
|
- `read`: `GET` routes
|
||||||
|
- `write`: `POST`, `PUT`, `PATCH`, and `DELETE` routes (in addition to `GET`)
|
||||||
|
|
||||||
|
Gitea token scopes are as follows:
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| ---- |------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| **(no scope)** | Not supported. A scope is required even for public repositories. |
|
||||||
|
| **activitypub** | `activitypub` API routes: ActivityPub related operations. |
|
||||||
|
| **read:activitypub** | Grants read access for ActivityPub operations. |
|
||||||
|
| **write:activitypub** | Grants read/write/delete access for ActivityPub operations. |
|
||||||
|
| **admin** | `/admin/*` API routes: Site-wide administrative operations (hidden for non-admin accounts). |
|
||||||
|
| **read:admin** | Grants read access for admin operations, such as getting cron jobs or registered user emails. |
|
||||||
|
| **write:admin** | Grants read/write/delete access for admin operations, such as running cron jobs or updating user accounts. |
|
||||||
|
| **issue** | `issues/*`, `labels/*`, `milestones/*` API routes: Issue-related operations. |
|
||||||
|
| **read:issue** | Grants read access for issues operations, such as getting issue comments, issue attachments, and milestones. |
|
||||||
|
| **write:issue** | Grants read/write/delete access for issues operations, such as posting or editing an issue comment or attachment, and updating milestones. |
|
||||||
|
| **misc** | Reserved for future usage. |
|
||||||
|
| **read:misc** | Reserved for future usage. |
|
||||||
|
| **write:misc** | Reserved for future usage. |
|
||||||
|
| **notification** | `notification/*` API routes: user notification operations. |
|
||||||
|
| **read:notification** | Grants read access to user notifications, such as which notifications users are subscribed to and read new notifications. |
|
||||||
|
| **write:notification** | Grants read/write/delete access to user notifications, such as marking notifications as read. |
|
||||||
|
| **organization** | `orgs/*` and `teams/*` API routes: Organization and team management operations. |
|
||||||
|
| **read:organization** | Grants read access to org and team status, such as listing all orgs a user has visibility to, teams, and team members. |
|
||||||
|
| **write:organization** | Grants read/write/delete access to org and team status, such as creating and updating teams and updating org settings. |
|
||||||
|
| **package** | `/packages/*` API routes: Packages operations |
|
||||||
|
| **read:package** | Grants read access to package operations, such as reading and downloading available packages. |
|
||||||
|
| **write:package** | Grants read/write/delete access to package operations. Currently the same as `read:package`. |
|
||||||
|
| **repository** | `/repos/*` API routes except `/repos/issues/*`: Repository file, pull-request, and release operations. |
|
||||||
|
| **read:repository** | Grants read access to repository operations, such as getting repository files, releases, collaborators. |
|
||||||
|
| **write:repository** | Grants read/write/delete access to repository operations, such as getting updating repository files, creating pull requests, updating collaborators. |
|
||||||
|
| **user** | `/user/*` and `/users/*` API routes: User-related operations. |
|
||||||
|
| **read:user** | Grants read access to user operations, such as getting user repo subscriptions and user settings. |
|
||||||
|
| **write:user** | Grants read/write/delete access to user operations, such as updating user repo subscriptions, followed users, and user settings. |
|
||||||
|
|
||||||
|
## Pre-configured Applications
|
||||||
|
|
||||||
|
Gitea creates OAuth applications for the following services by default on startup, as we assume that these are universally useful.
|
||||||
|
|
||||||
|
|Application|Description|Client ID|
|
||||||
|
|-----------|-----------|---------|
|
||||||
|
|[git-credential-oauth](https://github.com/hickford/git-credential-oauth)|Git credential helper|`a4792ccc-144e-407e-86c9-5e7d8d9c3269`|
|
||||||
|
|[Git Credential Manager](https://github.com/git-ecosystem/git-credential-manager)|Git credential helper|`e90ee53c-94e2-48ac-9358-a874fb9e0662`|
|
||||||
|
|[tea](https://gitea.com/gitea/tea)|tea|`d57cb8c4-630c-4168-8324-ec79935e18d4`|
|
||||||
|
|
||||||
|
To prevent unexpected behavior, they are being displayed as locked in the UI and their creation can instead be controlled by the `DEFAULT_APPLICATIONS` parameter in `app.ini`.
|
||||||
|
|
||||||
|
## Client types
|
||||||
|
|
||||||
|
Gitea supports both confidential and public client types, [as defined by RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1).
|
||||||
|
|
||||||
|
For public clients, a redirect URI of a loopback IP address such as `http://127.0.0.1/` allows any port. Avoid using `localhost`, [as recommended by RFC 8252](https://datatracker.ietf.org/doc/html/rfc8252#section-8.3).
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Confidential client
|
||||||
|
|
||||||
|
:::note
|
||||||
|
This example does not use PKCE.
|
||||||
|
:::
|
||||||
|
|
||||||
|
1. Redirect the user to the authorization endpoint in order to get their consent for accessing the resources:
|
||||||
|
|
||||||
|
```curl
|
||||||
|
https://[YOUR-GITEA-URL]/login/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&state=STATE
|
||||||
|
```
|
||||||
|
|
||||||
|
The `CLIENT_ID` can be obtained by registering an application in the settings. The `STATE` is a random string that will be sent back to your application after the user authorizes. The `state` parameter is optional, but should be used to prevent CSRF attacks.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The user will now be asked to authorize your application. If they authorize it, the user will be redirected to the `REDIRECT_URL`, for example:
|
||||||
|
|
||||||
|
```curl
|
||||||
|
https://[REDIRECT_URI]?code=RETURNED_CODE&state=STATE
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Using the provided `code` from the redirect, you can request a new application and refresh token. The access token endpoint accepts POST requests with `application/json` and `application/x-www-form-urlencoded` body, for example:
|
||||||
|
|
||||||
|
```curl
|
||||||
|
POST https://[YOUR-GITEA-URL]/login/oauth/access_token
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_id": "YOUR_CLIENT_ID",
|
||||||
|
"client_secret": "YOUR_CLIENT_SECRET",
|
||||||
|
"code": "RETURNED_CODE",
|
||||||
|
"grant_type": "authorization_code",
|
||||||
|
"redirect_uri": "REDIRECT_URI"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Response:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJnbnQiOjIsInR0IjowLCJleHAiOjE1NTUxNzk5MTIsImlhdCI6MTU1NTE3NjMxMn0.0-iFsAwBtxuckA0sNZ6QpBQmywVPz129u75vOM7wPJecw5wqGyBkmstfJHAjEOqrAf_V5Z-1QYeCh_Cz4RiKug",
|
||||||
|
"token_type": "bearer",
|
||||||
|
"expires_in": 3600,
|
||||||
|
"refresh_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJnbnQiOjIsInR0IjoxLCJjbnQiOjEsImV4cCI6MTU1NzgwNDMxMiwiaWF0IjoxNTU1MTc2MzEyfQ.S_HZQBy4q9r5SEzNGNIoFClT43HPNDbUdHH-GYNYYdkRfft6XptJBkUQscZsGxOW975Yk6RbgtGvq1nkEcklOw"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `CLIENT_SECRET` is the unique secret code generated for this application. Please note that the secret will only be visible after you created/registered the application with Gitea and cannot be recovered. If you lose the secret, you must regenerate the secret via the application's settings.
|
||||||
|
|
||||||
|
The `REDIRECT_URI` in the `access_token` request must match the `REDIRECT_URI` in the `authorize` request.
|
||||||
|
|
||||||
|
3. Use the `access_token` to make [API requests](development/api-usage.md#oauth2-provider) to access the user's resources.
|
||||||
|
|
||||||
|
### Public client (PKCE)
|
||||||
|
|
||||||
|
PKCE (Proof Key for Code Exchange) is an extension to the OAuth flow which allows for a secure credential exchange without the requirement to provide a client secret.
|
||||||
|
|
||||||
|
**Note**: Please ensure you have registered your OAuth application as a public client.
|
||||||
|
|
||||||
|
To achieve this, you have to provide a `code_verifier` for every authorization request. A `code_verifier` has to be a random string with a minimum length of 43 characters and a maximum length of 128 characters. It can contain alphanumeric characters as well as the characters `-`, `.`, `_` and `~`.
|
||||||
|
|
||||||
|
Using this `code_verifier` string, a new one called `code_challenge` is created by using one of two methods:
|
||||||
|
|
||||||
|
- If you have the required functionality on your client, set `code_challenge` to be a URL-safe base64-encoded string of the SHA256 hash of `code_verifier`. In that case, your `code_challenge_method` becomes `S256`.
|
||||||
|
- If you are unable to do so, you can provide your `code_verifier` as a plain string to `code_challenge`. Then you have to set your `code_challenge_method` as `plain`.
|
||||||
|
|
||||||
|
After you have generated this values, you can continue with your request.
|
||||||
|
|
||||||
|
1. Redirect the user to the authorization endpoint in order to get their consent for accessing the resources:
|
||||||
|
|
||||||
|
```curl
|
||||||
|
https://[YOUR-GITEA-URL]/login/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&code_challenge_method=CODE_CHALLENGE_METHOD&code_challenge=CODE_CHALLENGE&state=STATE
|
||||||
|
```
|
||||||
|
|
||||||
|
The `CLIENT_ID` can be obtained by registering an application in the settings. The `STATE` is a random string that will be sent back to your application after the user authorizes. The `state` parameter is optional, but should be used to prevent CSRF attacks.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The user will now be asked to authorize your application. If they authorize it, the user will be redirected to the `REDIRECT_URL`, for example:
|
||||||
|
|
||||||
|
```curl
|
||||||
|
https://[REDIRECT_URI]?code=RETURNED_CODE&state=STATE
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Using the provided `code` from the redirect, you can request a new application and refresh token. The access token endpoint accepts POST requests with `application/json` and `application/x-www-form-urlencoded` body, for example:
|
||||||
|
|
||||||
|
```curl
|
||||||
|
POST https://[YOUR-GITEA-URL]/login/oauth/access_token
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_id": "YOUR_CLIENT_ID",
|
||||||
|
"code": "RETURNED_CODE",
|
||||||
|
"grant_type": "authorization_code",
|
||||||
|
"redirect_uri": "REDIRECT_URI",
|
||||||
|
"code_verifier": "CODE_VERIFIER",
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Response:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"access_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJnbnQiOjIsInR0IjowLCJleHAiOjE1NTUxNzk5MTIsImlhdCI6MTU1NTE3NjMxMn0.0-iFsAwBtxuckA0sNZ6QpBQmywVPz129u75vOM7wPJecw5wqGyBkmstfJHAjEOqrAf_V5Z-1QYeCh_Cz4RiKug",
|
||||||
|
"token_type": "bearer",
|
||||||
|
"expires_in": 3600,
|
||||||
|
"refresh_token": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJnbnQiOjIsInR0IjoxLCJjbnQiOjEsImV4cCI6MTU1NzgwNDMxMiwiaWF0IjoxNTU1MTc2MzEyfQ.S_HZQBy4q9r5SEzNGNIoFClT43HPNDbUdHH-GYNYYdkRfft6XptJBkUQscZsGxOW975Yk6RbgtGvq1nkEcklOw"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `REDIRECT_URI` in the `access_token` request must match the `REDIRECT_URI` in the `authorize` request.
|
||||||
|
|
||||||
|
3. Use the `access_token` to make [API requests](development/api-usage.md#oauth2-provider) to access the user's resources.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
date: "2017-01-20T15:00:00+08:00"
|
||||||
|
title: "Help"
|
||||||
|
slug: "help"
|
||||||
|
sidebar_position: 5
|
||||||
|
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
name: "Help"
|
||||||
|
sidebar_position: 100
|
||||||
|
identifier: "help"
|
||||||
|
---
|
||||||
@@ -0,0 +1,352 @@
|
|||||||
|
---
|
||||||
|
date: "2019-04-05T16:00:00+02:00"
|
||||||
|
slug: "faq"
|
||||||
|
sidebar_position: 5
|
||||||
|
aliases:
|
||||||
|
- /en-us/faq
|
||||||
|
---
|
||||||
|
|
||||||
|
# FAQ
|
||||||
|
|
||||||
|
This page contains some common questions and answers.
|
||||||
|
|
||||||
|
For more help resources, check all [Support Options](help/support.md).
|
||||||
|
|
||||||
|
## Difference between 1.x and 1.x.x downloads, how can I get latest stable release with bug fixes?
|
||||||
|
|
||||||
|
Version 1.20.x will be used for this example.
|
||||||
|
|
||||||
|
On our [downloads page](https://dl.gitea.com/gitea/) you will see a 1.20 directory, as well as directories for 1.20.0, 1.20.1.
|
||||||
|
|
||||||
|
The 1.20 directory is the nightly build, which is built on each merged commit to the [`release/v1.20`](https://github.com/go-gitea/gitea/tree/release/v1.20) branch.
|
||||||
|
|
||||||
|
The 1.20.0 directory is a release build that was created when the [`v1.20.0`](https://github.com/go-gitea/gitea/releases/tag/v1.20.0) tag was created.
|
||||||
|
|
||||||
|
The nightly builds (1.x) downloads will change as commits are merged to their respective branch, they contain the latest changes/fixes before a tag release is built.
|
||||||
|
|
||||||
|
If a bug fix is targeted on 1.20.1 but 1.20.1 is not released yet, you can get the "1.20-nightly" build to get the bug fix.
|
||||||
|
|
||||||
|
## How to find the config file "app.ini"
|
||||||
|
|
||||||
|
It depends on how you installed Gitea. If you didn't set a path for custom path or config file manually,
|
||||||
|
then the config file (app.ini) should exists in the "custom/conf" directory of your Gitea's working path.
|
||||||
|
Some package vendors might use "/etc/gitea" to store the config file, while some others don't.
|
||||||
|
|
||||||
|
You could manually find the config file (app.ini) by checking Gitea's startup logs
|
||||||
|
or reading the Gitea Web's Site Administrator -> Confugiraton Summary.
|
||||||
|
|
||||||
|
If you are using some isolated enviroments like container (docker),
|
||||||
|
the path you see usually is not what it is in the host's filesystem.
|
||||||
|
In this case you need to check the container's filesystem volume mapping
|
||||||
|
and figure out the real path of the config file on the host.
|
||||||
|
|
||||||
|
## Where does Gitea store what file
|
||||||
|
|
||||||
|
- _`AppWorkPath`_
|
||||||
|
- The `WORK_PATH` option in `app.ini`
|
||||||
|
- Else the `--work-path` flag
|
||||||
|
- Else Environment variable `GITEA_WORK_DIR`
|
||||||
|
- Else a built-in value set at build time
|
||||||
|
- Else the directory that contains the Gitea binary
|
||||||
|
- `AppDataPath` (default for database, indexers, etc.)
|
||||||
|
- `APP_DATA_PATH` from `app.ini`
|
||||||
|
- Else _`AppWorkPath`_`/data`
|
||||||
|
- _`CustomPath`_ (custom templates)
|
||||||
|
- The `--custom-path` flag
|
||||||
|
- Else Environment variable `GITEA_CUSTOM`
|
||||||
|
- Else a built-in value set at build time
|
||||||
|
- Else _`AppWorkPath`_`/custom`
|
||||||
|
- HomeDir
|
||||||
|
- Unix: Environment variable `HOME`
|
||||||
|
- Windows: Environment variable `USERPROFILE`, else environment variables `HOMEDRIVE`+`HOMEPATH`
|
||||||
|
- RepoRootPath
|
||||||
|
- `ROOT` in the \[repository] section of `app.ini` if absolute
|
||||||
|
- Else _`AppWorkPath`_`/ROOT` if `ROOT` in the \[repository] section of `app.ini` if relative
|
||||||
|
- Default `%(APP_DATA_PATH)/gitea-repositories`
|
||||||
|
- INI (config file)
|
||||||
|
- `--config` flag
|
||||||
|
- A possible built-in value set a build time
|
||||||
|
- Else _`CustomPath`_`/conf/app.ini`
|
||||||
|
- SQLite Database
|
||||||
|
- `PATH` in `database` section of `app.ini`
|
||||||
|
- Else `%(APP_DATA_PATH)/gitea.db`
|
||||||
|
|
||||||
|
## Not seeing a clone URL or the clone URL being incorrect
|
||||||
|
|
||||||
|
There are a few places that could make this show incorrectly.
|
||||||
|
|
||||||
|
1. If using a reverse proxy, make sure you have followed the correction directions in the [reverse proxy guide](../administration/reverse-proxies.md)
|
||||||
|
2. Make sure you have correctly set `ROOT_URL` in the `server` section of your `app.ini`
|
||||||
|
|
||||||
|
If certain clone options aren't showing up (HTTP/S or SSH), the following options can be checked in your `app.ini`
|
||||||
|
|
||||||
|
- `DISABLE_HTTP_GIT`: if set to true, there will be no HTTP/HTTPS link
|
||||||
|
- `DISABLE_SSH`: if set to true, there will be no SSH link
|
||||||
|
- `SSH_EXPOSE_ANONYMOUS`: if set to false, SSH links will be hidden for anonymous users
|
||||||
|
|
||||||
|
## File upload fails with: 413 Request Entity Too Large
|
||||||
|
|
||||||
|
This error occurs when the reverse proxy limits the file upload size.
|
||||||
|
|
||||||
|
See the [reverse proxy guide](../administration/reverse-proxies.md) for a solution with nginx.
|
||||||
|
|
||||||
|
## Custom Templates not loading or working incorrectly
|
||||||
|
|
||||||
|
Gitea's custom templates must be added to the correct location or Gitea will not find and use them.
|
||||||
|
|
||||||
|
The correct path for the template(s) will be relative to the `CustomPath`
|
||||||
|
|
||||||
|
1. To find `CustomPath`, look for Custom File Root Path in Site Administration -> Configuration
|
||||||
|
2. If you are still unable to find a path, the default can be [calculated above](#where-does-gitea-store-what-file)
|
||||||
|
3. Once you have figured out the correct custom path, you can refer to the [customizing Gitea](../administration/customizing-gitea.md) page to add your template to the correct location.
|
||||||
|
|
||||||
|
## Does Gitea have a "GitHub/GitLab pages" feature?
|
||||||
|
|
||||||
|
Gitea doesn't provide a built-in Pages server. You need a dedicated domain to serve static pages to avoid CSRF security risks.
|
||||||
|
|
||||||
|
For simple usage, you can use a reverse proxy to rewrite & serve static contents from Gitea's raw file URLs.
|
||||||
|
|
||||||
|
And there are already available third-party services, like a standalone [pages server](https://codeberg.org/Codeberg/pages-server) or a [caddy plugin](https://github.com/42wim/caddy-gitea), that can provide the required functionality.
|
||||||
|
|
||||||
|
## Active user vs login prohibited user
|
||||||
|
|
||||||
|
In Gitea, an "active" user refers to a user that has activated their account via email.
|
||||||
|
|
||||||
|
A "login prohibited" user is a user that is not allowed to log in to Gitea anymore
|
||||||
|
|
||||||
|
|
||||||
|
## What is Swagger?
|
||||||
|
|
||||||
|
[Swagger](https://swagger.io/) is what Gitea uses for its API documentation.
|
||||||
|
|
||||||
|
All Gitea instances have the built-in API and there is no way to disable it completely.
|
||||||
|
You can, however, disable showing its documentation by setting `ENABLE_SWAGGER` to `false` in the `api` section of your `app.ini`.
|
||||||
|
For more information, refer to Gitea's [API docs](development/api-usage.md).
|
||||||
|
|
||||||
|
You can see the latest API (for example) on https://gitea.com/api/swagger
|
||||||
|
|
||||||
|
You can also see an example of the `swagger.json` file at https://gitea.com/swagger.v1.json
|
||||||
|
|
||||||
|
## Adjusting your server for public/private use
|
||||||
|
|
||||||
|
### Preventing spammers
|
||||||
|
|
||||||
|
There are multiple things you can combine to prevent spammers.
|
||||||
|
|
||||||
|
1. By whitelisting or blocklisting certain email domains
|
||||||
|
2. By only whitelisting certain domains with OpenID (see below)
|
||||||
|
3. Setting `ENABLE_CAPTCHA` to `true` in your `app.ini` and properly configuring `RECAPTCHA_SECRET` and `RECAPTCHA_SITEKEY`
|
||||||
|
4. Settings `DISABLE_REGISTRATION` to `true` and creating new users via the [CLI](../administration/command-line.md), [API](development/api-usage.md), or Gitea's Admin UI
|
||||||
|
|
||||||
|
### Only allow/block certain email domains
|
||||||
|
|
||||||
|
You can configure `EMAIL_DOMAIN_WHITELIST` or `EMAIL_DOMAIN_BLOCKLIST` in your app.ini under `[service]`
|
||||||
|
|
||||||
|
### Only allow/block certain OpenID providers
|
||||||
|
|
||||||
|
You can configure `WHITELISTED_URIS` or `BLACKLISTED_URIS` under `[openid]` in your `app.ini`
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Whitelisted takes precedence, so if it is non-blank then blacklisted is ignored.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Issue only users
|
||||||
|
|
||||||
|
The current way to achieve this is to create/modify a user with a max repo creation limit of 0.
|
||||||
|
|
||||||
|
### Restricted users
|
||||||
|
|
||||||
|
Restricted users are limited to a subset of the content based on their organization/team memberships and collaborations, ignoring the public flag on organizations/repos etc.\_\_
|
||||||
|
|
||||||
|
Example use case: A company runs a Gitea instance that requires login. Most repos are public (accessible/browsable by all co-workers).
|
||||||
|
|
||||||
|
At some point, a customer or third party needs access to a specific repo and only that repo. Making such a customer account restricted and granting any needed access using team membership(s) and/or collaboration(s) is a simple way to achieve that without the need to make everything private.
|
||||||
|
|
||||||
|
### Enable Fail2ban
|
||||||
|
|
||||||
|
Use [Fail2Ban](../administration/fail2ban-setup.md) to monitor and stop automated login attempts or other malicious behavior based on log patterns
|
||||||
|
|
||||||
|
## SSHD vs built-in SSH
|
||||||
|
|
||||||
|
SSHD is the built-in SSH server on most Unix systems.
|
||||||
|
|
||||||
|
Gitea also provides its own SSH server, for usage when SSHD is not available.
|
||||||
|
|
||||||
|
## Translation is incorrect/how to add more translations
|
||||||
|
|
||||||
|
Our translations are currently crowd-sourced on our [Crowdin project](https://crowdin.com/project/gitea)
|
||||||
|
|
||||||
|
Whether you want to change a translation or add a new one, it will need to be there as all translations are overwritten in our CI via the Crowdin integration.
|
||||||
|
|
||||||
|
## Push Hook / Webhook / Actions aren't running
|
||||||
|
|
||||||
|
If you can push but can't see push activities on the home dashboard, or the push doesn't trigger webhook and Actions workflows, it's likely that the git hooks are not working.
|
||||||
|
|
||||||
|
There are a few possibilities:
|
||||||
|
|
||||||
|
1. The git hooks are out of sync. Run the following actions on the site admin panel:
|
||||||
|
- "Sync missed branches from git data to databases"
|
||||||
|
- "Sync tags from git data to database"
|
||||||
|
- "Resynchronize pre-receive, update and post-receive hooks of all repositories"
|
||||||
|
2. The git repositories (and hooks) are stored on some filesystems (ex: mounted by NAS) which don't support script execution, make sure the filesystem supports `chmod a+x any-script`. Also make sure that the filesystem of the repositories is not mounted with the `noexec` option.
|
||||||
|
3. If you are using docker, make sure Docker Server (not the client) >= 20.10.6
|
||||||
|
|
||||||
|
## SSH issues
|
||||||
|
|
||||||
|
If you cannot reach repositories over `ssh`, but `https` works fine, consider looking into the following.
|
||||||
|
|
||||||
|
First, make sure you can access Gitea via SSH.
|
||||||
|
|
||||||
|
`ssh [email protected]`
|
||||||
|
|
||||||
|
If the connection is successful, you should receive an error message like the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
Hi there, You've successfully authenticated, but Gitea does not provide shell access.
|
||||||
|
If this is unexpected, please log in with password and setup Gitea under another user.
|
||||||
|
```
|
||||||
|
|
||||||
|
If you do not get the above message but still connect, it means your SSH key is **not** being managed by Gitea. This means hooks won't run, among other potential problems.
|
||||||
|
|
||||||
|
If you cannot connect at all, your SSH key may not be configured correctly locally.
|
||||||
|
This is specific to SSH and not Gitea, so will not be covered here.
|
||||||
|
|
||||||
|
### SSH Common Errors
|
||||||
|
|
||||||
|
```
|
||||||
|
Permission denied (publickey).
|
||||||
|
fatal: Could not read from remote repository.
|
||||||
|
```
|
||||||
|
|
||||||
|
This error signifies that the server rejected a log in attempt, check the
|
||||||
|
following things:
|
||||||
|
|
||||||
|
- On the client:
|
||||||
|
- Ensure the public and private ssh keys are added to the correct Gitea user.
|
||||||
|
- Make sure there are no issues in the remote url. In particular, ensure the name of the
|
||||||
|
Git user (before the `@`) is spelled correctly.
|
||||||
|
- Ensure public and private ssh keys are correct on client machine.
|
||||||
|
- On the server:
|
||||||
|
- Make sure the repository exists and is correctly named.
|
||||||
|
- Check the permissions of the `.ssh` directory in the system user's home directory.
|
||||||
|
- Verify that the correct public keys are added to `.ssh/authorized_keys`.
|
||||||
|
|
||||||
|
Try to run `Rewrite '.ssh/authorized_keys' file (for Gitea SSH keys)` on the
|
||||||
|
Gitea admin panel.
|
||||||
|
- Read Gitea logs.
|
||||||
|
- Read /var/log/auth (or similar).
|
||||||
|
- Check permissions of repositories.
|
||||||
|
|
||||||
|
The following is an example of a missing public SSH key where authentication
|
||||||
|
succeeded, but some other setting is preventing SSH from reaching the correct
|
||||||
|
repository.
|
||||||
|
|
||||||
|
```
|
||||||
|
fatal: Could not read from remote repository.
|
||||||
|
|
||||||
|
Please make sure you have the correct access rights
|
||||||
|
and the repository exists.
|
||||||
|
```
|
||||||
|
|
||||||
|
In this case, look into the following settings:
|
||||||
|
|
||||||
|
- On the server:
|
||||||
|
- Make sure that the `git` system user has a usable shell set
|
||||||
|
- Verify this with `getent passwd git | cut -d: -f7`
|
||||||
|
- `usermod` or `chsh` can be used to modify this.
|
||||||
|
- Ensure that the `gitea serv` command in `.ssh/authorized_keys` uses the
|
||||||
|
correct configuration file.
|
||||||
|
|
||||||
|
## Missing releases after migrating repository with tags
|
||||||
|
|
||||||
|
To migrate an repository _with_ all tags, you need to do two things:
|
||||||
|
|
||||||
|
- Push tags to the repository:
|
||||||
|
|
||||||
|
```
|
||||||
|
git push --tags
|
||||||
|
```
|
||||||
|
|
||||||
|
- (Re-)sync tags of all repositories within Gitea:
|
||||||
|
|
||||||
|
```
|
||||||
|
gitea admin repo-sync-releases
|
||||||
|
```
|
||||||
|
|
||||||
|
## How can I create users before starting Gitea
|
||||||
|
|
||||||
|
Gitea provides a sub-command `gitea migrate` to initialize the database, after which you can use the [admin CLI commands](../administration/command-line.md#admin) to add users like normal.
|
||||||
|
|
||||||
|
## How can I enable password reset
|
||||||
|
|
||||||
|
There is no setting for password resets. It is enabled when a [mail service](../administration/email-setup.md) is configured, and disabled otherwise.
|
||||||
|
|
||||||
|
## How can a user's password be changed
|
||||||
|
|
||||||
|
- As an **admin**, you can change any user's password (and optionally force them to change it on next login)...
|
||||||
|
- By navigating to your `Site Administration -> User Accounts` page and editing a user.
|
||||||
|
- By using the [admin CLI commands](../administration/command-line.md#admin).
|
||||||
|
|
||||||
|
Keep in mind most commands will also need a [global flag](../administration/command-line.md#global-options) to point the CLI at the correct configuration.
|
||||||
|
- As a **user** you can change it...
|
||||||
|
- In your account `Settings -> Account` page (this method **requires** you to know your current password).
|
||||||
|
- By using the `Forgot Password` link.
|
||||||
|
|
||||||
|
If the `Forgot Password/Account Recovery` page is disabled, please contact your administrator to configure a [mail service](../administration/email-setup.md).
|
||||||
|
|
||||||
|
## Warnings about struct defaults during database startup
|
||||||
|
|
||||||
|
Sometimes when there are migrations the old columns and default values may be left
|
||||||
|
unchanged in the database schema. This may lead to warning such as:
|
||||||
|
|
||||||
|
```
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
These can safely be ignored, but you are able to stop these warnings by getting Gitea to recreate these tables using:
|
||||||
|
|
||||||
|
```
|
||||||
|
gitea doctor recreate-table user
|
||||||
|
```
|
||||||
|
|
||||||
|
This will cause Gitea to recreate the user table and copy the old data into the new table
|
||||||
|
with the defaults set appropriately.
|
||||||
|
|
||||||
|
You can ask Gitea to recreate multiple tables using:
|
||||||
|
|
||||||
|
```
|
||||||
|
gitea doctor recreate-table table1 table2 ...
|
||||||
|
```
|
||||||
|
|
||||||
|
And if you would like Gitea to recreate all tables simply call:
|
||||||
|
|
||||||
|
```
|
||||||
|
gitea doctor recreate-table
|
||||||
|
```
|
||||||
|
|
||||||
|
It is highly recommended to back-up your database before running these commands.
|
||||||
|
|
||||||
|
## How to adopt repositories from disk
|
||||||
|
|
||||||
|
- Add your (bare) repositories to the correct spot for your configuration (`repository.ROOT`), ensuring they are in the correct layout `<REPO_ROOT>/[user]/[repo].git`.
|
||||||
|
- **Note:** the directory names must be lowercase.
|
||||||
|
- You can also check `<ROOT_URL>/-/admin/config` for the repository root path.
|
||||||
|
- Ensure that the user/org exists that you want to adopt repositories for.
|
||||||
|
- As an admin, go to `<ROOT_URL>/-/admin/repos/unadopted` and search.
|
||||||
|
- Users can also be given similar permissions via config [`ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`](../administration/config-cheat-sheet.md#repository-repository).
|
||||||
|
- If the above steps are done correctly, you should be able to select repositories to adopt.
|
||||||
|
- If no repositories are found, enable [debug logging](../administration/config-cheat-sheet.md#repository-repository) to check for any specific errors.
|
||||||
|
|
||||||
|
## Gitea can't start on NFS
|
||||||
|
|
||||||
|
In most cases, it's caused by broken NFS lock system. You can try to stop Gitea process and
|
||||||
|
run `flock -n /data-nfs/gitea/queues/LOCK echo 'lock acquired'` to see whether the lock can be acquired immediately.
|
||||||
|
If the lock can't be acquired, NFS might report some errors like `lockd: cannot monitor node-3, statd: server rpc.statd not responding, timed out` in its server logs.
|
||||||
|
|
||||||
|
Then the NFS lock could be reset by:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# /etc/init.d/nfs stop
|
||||||
|
# rm -rf /var/lib/nfs/sm/*
|
||||||
|
# /etc/init.d/nfs start
|
||||||
|
```
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
---
|
||||||
|
date: "2018-05-21T15:00:00+00:00"
|
||||||
|
slug: "support"
|
||||||
|
sidebar_position: 20
|
||||||
|
aliases:
|
||||||
|
- /en-us/seek-help
|
||||||
|
---
|
||||||
|
|
||||||
|
# Support Options
|
||||||
|
|
||||||
|
- [Paid Commercial Support](https://about.gitea.com/)
|
||||||
|
- [Discord](https://discord.gg/Gitea)
|
||||||
|
- [Forum](https://forum.gitea.com/)
|
||||||
|
- [Matrix](https://matrix.to/#/#gitea-space:matrix.org)
|
||||||
|
- NOTE: Most of the Matrix channels are bridged with their counterpart in Discord and may experience some degree of flakiness with the bridge process.
|
||||||
|
- Chinese Support
|
||||||
|
- [Discourse Chinese Category](https://forum.gitea.com/c/5-category/5)
|
||||||
|
- QQ Group 328432459
|
||||||
|
|
||||||
|
# Bug Report
|
||||||
|
|
||||||
|
If you found a bug, please [create an issue on GitHub](https://github.com/go-gitea/gitea/issues).
|
||||||
|
|
||||||
|
:::note
|
||||||
|
When asking for support, it may be a good idea to have the following available so that the person helping has all the info they need:
|
||||||
|
:::
|
||||||
|
|
||||||
|
1. Your `app.ini` (with any sensitive data scrubbed as necessary).
|
||||||
|
2. Any error messages you are seeing.
|
||||||
|
3. The Gitea logs, and all other related logs for the situation.
|
||||||
|
- It's more useful to collect `trace` / `debug` level logs (see the next section).
|
||||||
|
- When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs.
|
||||||
|
- When using docker, use `docker logs --tail 1000 <gitea-container>` to collect logs.
|
||||||
|
4. Reproducible steps so that others could reproduce and understand the problem more quickly and easily.
|
||||||
|
- [demo.gitea.com](https://demo.gitea.com) could be used to reproduce the problem.
|
||||||
|
5. If you encounter slow/hanging/deadlock problems, please report the stacktrace when the problem occurs.
|
||||||
|
Go to the "Site Admin" -> "Monitoring" -> "Stacktrace" -> "Download diagnosis report".
|
||||||
|
|
||||||
|
# Advanced Bug Report Tips
|
||||||
|
|
||||||
|
## More Config Options for Logs
|
||||||
|
|
||||||
|
By default, the logs are outputted to console with `info` level.
|
||||||
|
If you need to set log level and/or collect logs from files,
|
||||||
|
you could just copy the following config into your `app.ini` (remove all other `[log]` sections),
|
||||||
|
then you will find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`).
|
||||||
|
|
||||||
|
```ini
|
||||||
|
; To show all SQL logs, you can also set LOG_SQL=true in the [database] section
|
||||||
|
[log]
|
||||||
|
LEVEL=debug
|
||||||
|
MODE=console,file
|
||||||
|
```
|
||||||
|
|
||||||
|
## Collecting Stacktrace by Command Line
|
||||||
|
|
||||||
|
Gitea could use Golang's pprof handler and toolchain to collect stacktrace and other runtime information.
|
||||||
|
|
||||||
|
If the web UI stops working, you could try to collect the stacktrace by command line:
|
||||||
|
|
||||||
|
1. Set `app.ini`:
|
||||||
|
|
||||||
|
```
|
||||||
|
[server]
|
||||||
|
ENABLE_PPROF = true
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Restart Gitea
|
||||||
|
|
||||||
|
3. Try to trigger the bug, when the requests get stuck for a while,
|
||||||
|
use `curl` or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` to get the stacktrace.
|
||||||
@@ -0,0 +1,110 @@
|
|||||||
|
---
|
||||||
|
date: "2016-11-08T16:00:00+02:00"
|
||||||
|
slug: /
|
||||||
|
sidebar_position: 10
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# What is Gitea?
|
||||||
|
|
||||||
|
Gitea is a painless, self-hosted, all-in-one software development service. It includes Git hosting, code review, team collaboration, package registry, and CI/CD. It is similar to GitHub, Bitbucket and GitLab.
|
||||||
|
|
||||||
|
Gitea was originally forked from [Gogs](https://gogs.io) and almost all the code has been changed. See the [Gitea Announcement](https://blog.gitea.com/welcome-to-gitea/) blog post to read about the justification for a fork.
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
|
||||||
|
Gitea does not send commits to upstream or cherry-pick commits from it, so there is no guarantee it will work if you upgrade from Gogs to Gitea. The recommended method is to migrate repositories from Gogs to Gitea.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
The goal of this project is to provide the easiest, fastest, and most painless way of setting
|
||||||
|
up a self-hosted Git service.
|
||||||
|
|
||||||
|
With Go, this can be done platform-independently across
|
||||||
|
**all platforms** which Go supports, including Linux, macOS, and Windows,
|
||||||
|
on x86, amd64, ARM and PowerPC architectures.
|
||||||
|
You can try it out using [the online demo](https://demo.gitea.com).
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Code Hosting**
|
||||||
|
|
||||||
|
Gitea supports creating and managing repositories, browsing commit history and code files, reviewing and merging code submissions, managing collaborators, handling branches, and more. It also supports many common Git features such as tags, cherry-picking, hooks, integrated collaboration tools, and more.
|
||||||
|
|
||||||
|
- **Lightweight and Fast**
|
||||||
|
|
||||||
|
One of Gitea's design goals is to be lightweight and fast in response. Unlike some large code hosting platforms, it remains lean, performs well in terms of speed, and is suitable for resource-limited server environments.
|
||||||
|
|
||||||
|
- **Easy Deployment and Maintenance**
|
||||||
|
|
||||||
|
It can be easily deployed on various servers without complex configurations or dependencies. This makes it convenient for individual developers or small teams to set up and manage their own Git services.
|
||||||
|
|
||||||
|
- **Security**
|
||||||
|
|
||||||
|
Gitea places a strong emphasis on security, offering features such as user permission management, access control lists, and more to ensure the security of code and data.
|
||||||
|
|
||||||
|
- **Code Review**
|
||||||
|
|
||||||
|
Code review supports both the Pull Request workflow and AGit workflow. Reviewers can browse code online and provide review comments or feedback. Submitters can receive review comments and respond or modify code online. Code reviews can help individuals and organizations enhance code quality.
|
||||||
|
|
||||||
|
- **CI/CD**
|
||||||
|
|
||||||
|
Gitea Actions supports CI/CD functionality, compatible with GitHub Actions. Users can write workflows in familiar YAML format and reuse a variety of existing Actions plugins. Actions plugins support downloading from any Git website.
|
||||||
|
|
||||||
|
- **Project Management**
|
||||||
|
|
||||||
|
Gitea tracks project requirements, features, and bugs through columns and issues. Issues support features like branches, tags, milestones, assignments, time tracking, due dates, dependencies, and more.
|
||||||
|
|
||||||
|
- **Artifact Repository**
|
||||||
|
|
||||||
|
Gitea supports over 20 different types of public or private software package management, including Cargo, Chef, Composer, Conan, Conda, Container, Helm, Maven, npm, NuGet, Pub, PyPI, RubyGems, Vagrant, and more.
|
||||||
|
|
||||||
|
- **Open Source Community Support**
|
||||||
|
|
||||||
|
Gitea is an open-source project based on the MIT license. It has an active open-source community that continuously develops and improves the platform. The project also actively welcomes community contributions, ensuring updates and innovation.
|
||||||
|
|
||||||
|
- **Multilingual Support**
|
||||||
|
|
||||||
|
Gitea provides interfaces in multiple languages, catering to users globally and promoting internationalization and localization.
|
||||||
|
|
||||||
|
For more detailed information, please refer to: https://docs.gitea.com/installation/comparison#general-features
|
||||||
|
|
||||||
|
## System Requirements
|
||||||
|
|
||||||
|
- A Raspberry Pi 3 is powerful enough to run Gitea for small workloads.
|
||||||
|
- 2 CPU cores and 1GB RAM is typically sufficient for small teams/projects.
|
||||||
|
- Gitea should be run with a dedicated non-root system account on UNIX-type systems.
|
||||||
|
- Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in.
|
||||||
|
- [Git](https://git-scm.com/) version 2.0.0 or later is required.
|
||||||
|
- [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled and if your Git version is >= 2.1.2
|
||||||
|
- Git commit-graph rendering will be enabled automatically if your Git version is >= 2.18
|
||||||
|
|
||||||
|
## Browser Support
|
||||||
|
|
||||||
|
- Last 2 versions of Chrome, Firefox, Safari and Edge
|
||||||
|
- Firefox ESR
|
||||||
|
|
||||||
|
## Components
|
||||||
|
|
||||||
|
- Web server framework: [Chi](http://github.com/go-chi/chi)
|
||||||
|
- ORM: [XORM](https://xorm.io)
|
||||||
|
- UI frameworks:
|
||||||
|
- [jQuery](https://jquery.com)
|
||||||
|
- [Fomantic UI](https://fomantic-ui.com)
|
||||||
|
- [Vue3](https://vuejs.org)
|
||||||
|
- and various components (see package.json)
|
||||||
|
- Editors:
|
||||||
|
- [CodeMirror](https://codemirror.net)
|
||||||
|
- [EasyMDE](https://github.com/Ionaru/easy-markdown-editor)
|
||||||
|
- [Monaco Editor](https://microsoft.github.io/monaco-editor)
|
||||||
|
- Database drivers:
|
||||||
|
- [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
|
||||||
|
- [github.com/lib/pq](https://github.com/lib/pq)
|
||||||
|
- [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
|
||||||
|
- [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
|
||||||
|
|
||||||
|
## Integrated Support
|
||||||
|
|
||||||
|
Please visit [Awesome Gitea](https://gitea.com/gitea/awesome-gitea/) to get more third-party integrated support
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
title: "Installation"
|
||||||
|
slug: "installation"
|
||||||
|
sidebar_position: 10
|
||||||
|
|
||||||
|
menu:
|
||||||
|
sidebar:
|
||||||
|
name: "Installation"
|
||||||
|
sidebar_position: 10
|
||||||
|
identifier: "installation"
|
||||||
|
---
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
---
|
||||||
|
date: "2018-05-07T13:00:00+02:00"
|
||||||
|
slug: "comparison"
|
||||||
|
sidebar_position: 5
|
||||||
|
aliases:
|
||||||
|
- /en-us/comparison
|
||||||
|
---
|
||||||
|
|
||||||
|
# Compared to other Git hosting
|
||||||
|
|
||||||
|
To help decide if Gitea is suited for your needs, here is how it compares to other Git self hosted options.
|
||||||
|
|
||||||
|
Be warned that we don't regularly check for feature changes in other products, so this list may be outdated. If you find anything that needs to be updated in the table below, please [open an issue](https://github.com/go-gitea/gitea/issues/new/choose).
|
||||||
|
|
||||||
|
_Symbols used in table:_
|
||||||
|
|
||||||
|
- _✓ - supported_
|
||||||
|
|
||||||
|
- _⁄ - supported with limited functionality_
|
||||||
|
|
||||||
|
- _✘ - unsupported_
|
||||||
|
|
||||||
|
- _⚙️ - supported through third-party software_
|
||||||
|
|
||||||
|
## General Features
|
||||||
|
|
||||||
|
| Feature | Gitea | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | RhodeCode EE |
|
||||||
|
| ------------------------------------------------ | --------------------------------------------------- | --------- | --------- | --------- | --------- | ------------ | ------------ |
|
||||||
|
| Open source and free | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ✓ |
|
||||||
|
| Low RAM/ CPU usage | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ |
|
||||||
|
| Multiple database support | ✓ | ✘ | ⁄ | ⁄ | ✓ | ✓ | ✓ |
|
||||||
|
| Multiple OS support | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ✓ |
|
||||||
|
| Easy upgrades | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | ✓ |
|
||||||
|
| Telemetry | **✘** | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Third-party render tool support | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | ✘ |
|
||||||
|
| WebAuthn (2FA) | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✓ |
|
||||||
|
| Extensive API | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Built-in Package/Container Registry | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Sync commits to an external repo (push mirror) | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | ✓ |
|
||||||
|
| Sync commits from an external repo (pull mirror) | ✓ | ✘ | ✓ | ✓ | ✘ | ✓ | ✓ |
|
||||||
|
| Light and Dark Theme | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Custom Theme Support | ✓ | ✘ | ✘ | ✘ | ✓ | ✓ | ✓ |
|
||||||
|
| Markdown support | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| CSV support | ✓ | ✓ | ✘ | ✘ | ✓ | ✘ | ✘ |
|
||||||
|
| 'GitHub / GitLab pages' | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Gists / Snippets | [⚙️][opengist] | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Repo-specific wiki (as a repo itself) | ✓ | ✓ | ✓ | ✓ | / | ✘ | ✘ |
|
||||||
|
| Deploy Tokens | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Repository Tokens with write rights | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| RSS Feeds | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✓ |
|
||||||
|
| Built-in CI/CD | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Subgroups: groups within groups | [✘](https://github.com/go-gitea/gitea/issues/1872) | ✘ | ✓ | ✓ | ✘ | ✓ | ✓ |
|
||||||
|
| Interaction with other instances | [/](https://github.com/go-gitea/gitea/issues/18240) | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ |
|
||||||
|
| Mermaid diagrams in Markdown | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Math syntax in Markdown | ✓ | ✓ | ✓ | ✓ | ✘ | ✓ | ✓ |
|
||||||
|
|
||||||
|
## Code management
|
||||||
|
|
||||||
|
| Feature | Gitea | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | RhodeCode EE |
|
||||||
|
| ------------------------------------------- | --------------------------------------------------- | --------- | --------- | --------- | --------- | ------------ | ------------ |
|
||||||
|
| Repository topics | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Repository code search | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Global code search | ✓ | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Git LFS 2.0 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Group Milestones | [✘](https://github.com/go-gitea/gitea/issues/14622) | ✘ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Granular user roles (Code, Issues, Wiki, …) | ✓ | ✘ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Verified Committer | ⁄ | ? | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| GPG Signed Commits | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| SSH Signed Commits | ✓ | ✓ | ✓ | ✓ | ? | ✘ | ✘ |
|
||||||
|
| Reject unsigned commits | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Migrating repos from other services | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Repository Activity page | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Branch manager | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Create new branches | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Web code editor | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Commit graph | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Template Repositories | ✓ | ✓ | ✘ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Git Blame | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Visual comparison of image changes | ✓ | ✓ | ? | ? | ? | ✘ | ✘ |
|
||||||
|
|
||||||
|
- Gitea has builtin repository-level code search
|
||||||
|
- Better code search support could be achieved by [using a repository indexer](../administration/repo-indexer.md)
|
||||||
|
|
||||||
|
## Issue Tracker
|
||||||
|
|
||||||
|
| Feature | Gitea | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | RhodeCode EE |
|
||||||
|
| ----------------------------- | --------------------------------------------------- | --------- | --------- | --------- | --------- | ------------ | ------------ |
|
||||||
|
| Issue tracker | ✓ | ✓ | ✓ | ✓ | / | ✘ | ✘ |
|
||||||
|
| Issue templates | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Labels | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Time tracking | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Multiple assignees for issues | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Related issues | ✘ | ⁄ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Confidential issues | [✘](https://github.com/go-gitea/gitea/issues/3217) | ✘ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Comment reactions | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Lock Discussion | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Batch issue handling | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Projects | [/](https://github.com/go-gitea/gitea/issues/14710) | ✘ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Create branch from issue | [✘](https://github.com/go-gitea/gitea/issues/20226) | ✘ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Convert comment to new issue | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Issue search | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Global issue search | [/](https://github.com/go-gitea/gitea/issues/2434) | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Issue dependency | ✓ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ |
|
||||||
|
| Create issue via email | [✘](https://github.com/go-gitea/gitea/issues/6226) | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Service Desk | [✘](https://github.com/go-gitea/gitea/issues/6219) | ✘ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
|
||||||
|
## Pull/Merge requests
|
||||||
|
|
||||||
|
| Feature | Gitea | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | RhodeCode EE |
|
||||||
|
| ----------------------------------------------- | -------------------------------------------------- | --------- | --------- | --------- | --------- | ------------ | ------------ |
|
||||||
|
| Pull/Merge requests | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Squash merging | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Rebase merging | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Pull/Merge request inline comments | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Pull/Merge request approval | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Pull/Merge require approval | ✓ | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Pull/Merge multiple reviewers | ✓ | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Merge conflict resolution | [✘](https://github.com/go-gitea/gitea/issues/9014) | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Restrict push and merge access to certain users | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Revert specific commits | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Pull/Merge requests templates | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
| Cherry-picking changes | ✓ | ✘ | ✓ | ✓ | ✘ | ✘ | ✓ |
|
||||||
|
| Download Patch | ✓ | ✓ | ✓ | ✓ | / | ✓ | ✓ |
|
||||||
|
| Merge queues | ✓ | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ |
|
||||||
|
|
||||||
|
## 3rd-party integrations
|
||||||
|
|
||||||
|
| Feature | Gitea | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | RhodeCode EE |
|
||||||
|
| ---------------------------------------------- | -------------------------------------------------- | --------- | --------- | --------- | --------- | ------------ | ------------ |
|
||||||
|
| Webhooks | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Git Hooks | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| AD / LDAP integration | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| Multiple LDAP / AD server support | ✓ | ✘ | ✘ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
| LDAP user synchronization | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✓ |
|
||||||
|
| SAML 2.0 service provider | [✘](https://github.com/go-gitea/gitea/issues/5512) | ✓ | ✓ | ✓ | ✓ | ✘ | ✓ |
|
||||||
|
| OpenID Connect support | ✓ | ✓ | ✓ | ✓ | ? | ✘ | ✓ |
|
||||||
|
| OAuth 2.0 integration (external authorization) | ✓ | ⁄ | ✓ | ✓ | ? | ✘ | ✓ |
|
||||||
|
| Act as OAuth 2.0 provider | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ |
|
||||||
|
| Two factor authentication (2FA) | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✓ |
|
||||||
|
| Integration with the most common services | ✓ | ⁄ | ✓ | ✓ | ⁄ | ✓ | ✓ |
|
||||||
|
| Incorporate external CI/CD | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
|
||||||
|
|
||||||
|
[gitea-caddy-plugin]: https://github.com/42wim/caddy-gitea
|
||||||
|
[gitea-pages-server]: https://codeberg.org/Codeberg/pages-server
|
||||||
|
[opengist]: https://github.com/thomiceli/opengist
|
||||||
@@ -0,0 +1,311 @@
|
|||||||
|
---
|
||||||
|
date: "2020-01-16"
|
||||||
|
slug: "database-prep"
|
||||||
|
sidebar_position: 10
|
||||||
|
aliases:
|
||||||
|
- /en-us/database-prep
|
||||||
|
---
|
||||||
|
|
||||||
|
# Database Preparation
|
||||||
|
|
||||||
|
You need a database to use Gitea. Gitea supports PostgreSQL (>= 12), MySQL (>= 8.0), MariaDB (>= 10.4), SQLite (builtin), and MSSQL (>= 2012 SP4). This page will guide into preparing database. Only PostgreSQL and MySQL will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter.
|
||||||
|
|
||||||
|
:::warning
|
||||||
|
Converting one database type to another is not a well-tested process and you may experience issues. It is better to choose the final database type at the type of the first installation. Be aware that SQLite does not scale; if you expect your instance to grow at a later time, you should choose another database type.
|
||||||
|
:::
|
||||||
|
|
||||||
|
If you use an unsupported database version, please [get in touch](/help/support) with us for information on our Extended Support Contracts. We can provide testing and support for older databases and integrate those fixes into the Gitea codebase.
|
||||||
|
|
||||||
|
Database instance can be on same machine as Gitea (local database setup), or on different machine (remote database).
|
||||||
|
|
||||||
|
:::note
|
||||||
|
All steps below requires that the database engine of your choice is installed on your system. For remote database setup, install the server application on database instance and client program on your Gitea server. The client program is used to test connection to the database from Gitea server, while Gitea itself use database driver provided by Go to accomplish the same thing. In addition, make sure you use same engine version for both server and client for some engine features to work. For security reason, protect `root` (MySQL) or `postgres` (PostgreSQL) database superuser with secure password. The steps assumes that you run Linux for both database and Gitea servers.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## MySQL/MariaDB
|
||||||
|
|
||||||
|
1. For remote database setup, you will need to make MySQL listen to your IP address. Configure the `bind-address` option in `/etc/mysql/my.cnf` on database instance by adding the following lines:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[mysqld]
|
||||||
|
bind-address = 203.0.113.3
|
||||||
|
```
|
||||||
|
|
||||||
|
2. On database instance, login to database console as root:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mysql -u root -p
|
||||||
|
```
|
||||||
|
|
||||||
|
Enter the password as prompted.
|
||||||
|
|
||||||
|
3. Create database user which will be used by Gitea, authenticated by password. This example uses `'gitea'` as password. Please use a secure password for your instance.
|
||||||
|
|
||||||
|
For local database:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
SET old_passwords=0;
|
||||||
|
CREATE USER 'gitea'@'%' IDENTIFIED BY 'gitea';
|
||||||
|
```
|
||||||
|
|
||||||
|
For remote database:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
SET old_passwords=0;
|
||||||
|
CREATE USER 'gitea'@'192.0.2.10' IDENTIFIED BY 'gitea';
|
||||||
|
```
|
||||||
|
|
||||||
|
where `192.0.2.10` is the IP address of your Gitea instance.
|
||||||
|
|
||||||
|
Replace username and password above as appropriate.
|
||||||
|
|
||||||
|
4. Create database with UTF-8 charset and case-sensitive collation.
|
||||||
|
|
||||||
|
`utf8mb4_bin` is a common collation for both MySQL/MariaDB.
|
||||||
|
When Gitea starts, it will try to find a better collation (`utf8mb4_0900_as_cs` or `uca1400_as_cs`) and alter the database if it is possible.
|
||||||
|
If you would like to use other collation, you can set `[database].CHARSET_COLLATION` in the `app.ini` file.
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE DATABASE giteadb CHARACTER SET 'utf8mb4' COLLATE 'utf8mb4_bin';
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace database name as appropriate.
|
||||||
|
|
||||||
|
5. Grant all privileges on the database to database user created above.
|
||||||
|
|
||||||
|
For local database:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea';
|
||||||
|
FLUSH PRIVILEGES;
|
||||||
|
```
|
||||||
|
|
||||||
|
For remote database:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
GRANT ALL PRIVILEGES ON giteadb.* TO 'gitea'@'192.0.2.10';
|
||||||
|
FLUSH PRIVILEGES;
|
||||||
|
```
|
||||||
|
|
||||||
|
6. Quit from database console by `exit`.
|
||||||
|
|
||||||
|
7. On your Gitea server, test connection to the database:
|
||||||
|
|
||||||
|
```
|
||||||
|
mysql -u gitea -h 203.0.113.3 -p giteadb
|
||||||
|
```
|
||||||
|
|
||||||
|
where `gitea` is database username, `giteadb` is database name, and `203.0.113.3` is IP address of database instance. Omit `-h` option for local database.
|
||||||
|
|
||||||
|
You should be connected to the database.
|
||||||
|
|
||||||
|
## PostgreSQL
|
||||||
|
|
||||||
|
1. For remote database setup, configure PostgreSQL on database instance to listen to your IP address by editing `listen_addresses` on `postgresql.conf` to:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
listen_addresses = 'localhost, 203.0.113.3'
|
||||||
|
```
|
||||||
|
|
||||||
|
2. PostgreSQL uses `md5` challenge-response encryption scheme for password authentication by default. Nowadays this scheme is not considered secure anymore. Use SCRAM-SHA-256 scheme instead by editing the `postgresql.conf` configuration file on the database server to:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
password_encryption = scram-sha-256
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart PostgreSQL to apply the setting.
|
||||||
|
|
||||||
|
3. On the database server, login to the database console as superuser:
|
||||||
|
|
||||||
|
```
|
||||||
|
su -c "psql" - postgres
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Create database user (role in PostgreSQL terms) with login privilege and password. Please use a secure, strong password instead of `'gitea'` below:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE ROLE gitea WITH LOGIN PASSWORD 'gitea';
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace username and password as appropriate.
|
||||||
|
|
||||||
|
5. Create database with UTF-8 charset and owned by the database user created earlier. Any `libc` collations can be specified with `LC_COLLATE` and `LC_CTYPE` parameter, depending on expected content:
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE DATABASE giteadb WITH OWNER gitea TEMPLATE template0 ENCODING UTF8 LC_COLLATE 'en_US.UTF-8' LC_CTYPE 'en_US.UTF-8';
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace database name as appropriate.
|
||||||
|
|
||||||
|
6. Allow the database user to access the database created above by adding the following authentication rule to `pg_hba.conf`.
|
||||||
|
|
||||||
|
For local database:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
local giteadb gitea scram-sha-256
|
||||||
|
```
|
||||||
|
|
||||||
|
For remote database:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
host giteadb gitea 192.0.2.10/32 scram-sha-256
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace database name, user, and IP address of Gitea instance with your own.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Rules on `pg_hba.conf` are evaluated sequentially, that is the first matching rule will be used for authentication. Your PostgreSQL installation may come with generic authentication rules that match all users and databases. You may need to place the rules presented here above such generic rules if it is the case.
|
||||||
|
:::
|
||||||
|
|
||||||
|
Restart PostgreSQL to apply new authentication rules.
|
||||||
|
|
||||||
|
7. On your Gitea server, test connection to the database.
|
||||||
|
|
||||||
|
For local database:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
psql -U gitea -d giteadb
|
||||||
|
```
|
||||||
|
|
||||||
|
For remote database:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
psql "postgres://[email protected]/giteadb"
|
||||||
|
```
|
||||||
|
|
||||||
|
where `gitea` is database user, `giteadb` is database name, and `203.0.113.3` is IP address of your database instance.
|
||||||
|
|
||||||
|
You should be prompted to enter password for the database user, and connected to the database.
|
||||||
|
|
||||||
|
## Database Connection over TLS
|
||||||
|
|
||||||
|
If the communication between Gitea and your database instance is performed through a private network, or if Gitea and the database are running on the same server, this section can be omitted since the security between Gitea and the database instance is not critically exposed. If instead the database instance is on a public network, use TLS to encrypt the connection to the database, as it is possible for third-parties to intercept the traffic data.
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- You need two valid TLS certificates, one for the database instance (database server) and one for the Gitea instance (database client). Both certificates must be signed by a trusted CA.
|
||||||
|
- The database certificate must contain `TLS Web Server Authentication` in the `X509v3 Extended Key Usage` extension attribute, while the client certificate needs `TLS Web Client Authentication` in the corresponding attribute.
|
||||||
|
- On the database server certificate, one of `Subject Alternative Name` or `Common Name` entries must be the fully-qualified domain name (FQDN) of the database instance (e.g. `db.example.com`). On the database client certificate, one of the entries mentioned above must contain the database username that Gitea will be using to connect.
|
||||||
|
- You need domain name mappings of both Gitea and database servers to their respective IP addresses. Either set up DNS records for them or add local mappings to `/etc/hosts` (`%WINDIR%\System32\drivers\etc\hosts` in Windows) on each system. This allows the database connections to be performed by domain name instead of IP address. See documentation of your system for details.
|
||||||
|
|
||||||
|
### PostgreSQL TLS
|
||||||
|
|
||||||
|
The PostgreSQL driver used by Gitea supports two-way TLS. In two-way TLS, both database client and server authenticate each other by sending their respective certificates to their respective opposite for validation. In other words, the server verifies client certificate, and the client verifies server certificate.
|
||||||
|
|
||||||
|
1. On the server with the database instance, place the following credentials:
|
||||||
|
|
||||||
|
- `/path/to/postgresql.crt`: Database instance certificate
|
||||||
|
- `/path/to/postgresql.key`: Database instance private key
|
||||||
|
- `/path/to/root.crt`: CA certificate chain to validate client certificates
|
||||||
|
|
||||||
|
2. Add following options to `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'
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Adjust credentials ownership and permission, as required by 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
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Edit `pg_hba.conf` rule to only allow Gitea database user to connect over SSL, and to require client certificate verification.
|
||||||
|
|
||||||
|
For PostgreSQL 12:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=verify-full
|
||||||
|
```
|
||||||
|
|
||||||
|
For PostgreSQL 11 and earlier:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
hostssl giteadb gitea 192.0.2.10/32 scram-sha-256 clientcert=1
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace database name, user, and IP address of Gitea instance as appropriate.
|
||||||
|
|
||||||
|
5. Restart PostgreSQL to apply configurations above.
|
||||||
|
|
||||||
|
6. On the server running the Gitea instance, place the following credentials under the home directory of the user who runs Gitea (e.g. `git`):
|
||||||
|
|
||||||
|
- `~/.postgresql/postgresql.crt`: Database client certificate
|
||||||
|
- `~/.postgresql/postgresql.key`: Database client private key
|
||||||
|
- `~/.postgresql/root.crt`: CA certificate chain to validate server certificate
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Those file names above are hardcoded in PostgreSQL and it is not possible to change them.
|
||||||
|
:::
|
||||||
|
|
||||||
|
7. Adjust credentials, ownership and permission as required:
|
||||||
|
|
||||||
|
```
|
||||||
|
chown git:git ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt
|
||||||
|
chown 0600 ~/.postgresql/postgresql.crt ~/.postgresql/postgresql.key ~/.postgresql/root.crt
|
||||||
|
```
|
||||||
|
|
||||||
|
8. Test the connection to the database:
|
||||||
|
|
||||||
|
```
|
||||||
|
psql "postgres://[email protected]/giteadb?sslmode=verify-full"
|
||||||
|
```
|
||||||
|
|
||||||
|
You should be prompted to enter password for the database user, and then be connected to the database.
|
||||||
|
|
||||||
|
### MySQL/MariaDB TLS
|
||||||
|
|
||||||
|
While the MySQL driver used by Gitea also supports two-way TLS, Gitea currently supports only one-way TLS. See issue #10828 for details.
|
||||||
|
|
||||||
|
In one-way TLS, the database client verifies the certificate sent from server during the connection handshake, and the server assumes that the connected client is legitimate, since client certificate verification doesn't take place.
|
||||||
|
|
||||||
|
1. On the database instance, place the following credentials:
|
||||||
|
|
||||||
|
- `/path/to/mysql.crt`: Database instance certificate
|
||||||
|
- `/path/to/mysql.key`: Database instance key
|
||||||
|
- `/path/to/ca.crt`: CA certificate chain. This file isn't used on one-way TLS, but is used to validate client certificates on two-way TLS.
|
||||||
|
|
||||||
|
2. Add following options to `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
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Adjust credentials ownership and permission:
|
||||||
|
|
||||||
|
```
|
||||||
|
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. Restart MySQL to apply the setting.
|
||||||
|
|
||||||
|
5. The database user for Gitea may have been created earlier, but it would authenticate only against the IP addresses of the server running Gitea. To authenticate against its domain name, recreate the user, and this time also set it to require TLS for connecting to the database:
|
||||||
|
|
||||||
|
```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;
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace database user name, password, and Gitea instance domain as appropriate.
|
||||||
|
|
||||||
|
6. Make sure that the CA certificate chain required to validate the database server certificate is on the system certificate store of both the database and Gitea servers. Consult your system documentation for instructions on adding a CA certificate to the certificate store.
|
||||||
|
|
||||||
|
7. On the server running Gitea, test connection to the database:
|
||||||
|
|
||||||
|
```
|
||||||
|
mysql -u gitea -h example.db -p --ssl
|
||||||
|
```
|
||||||
|
|
||||||
|
You should be connected to the database.
|
||||||
@@ -0,0 +1,240 @@
|
|||||||
|
---
|
||||||
|
date: "2017-06-19T12:00:00+02:00"
|
||||||
|
slug: "install-from-binary"
|
||||||
|
sidebar_position: 15
|
||||||
|
aliases:
|
||||||
|
- /en-us/install-from-binary
|
||||||
|
---
|
||||||
|
|
||||||
|
# Installation from binary
|
||||||
|
|
||||||
|
All downloads come with SQLite, MySQL and PostgreSQL support, and are built with
|
||||||
|
embedded assets. This can be different from Gogs.
|
||||||
|
|
||||||
|
## Download
|
||||||
|
|
||||||
|
You can find the file matching your platform from the [downloads page](https://dl.gitea.com/gitea/) after navigating to the version you want to download.
|
||||||
|
|
||||||
|
### Choosing the right file
|
||||||
|
|
||||||
|
**For Linux**, you will likely want `linux-amd64`. It's for 64-bit Intel/AMD platforms, but there are other platforms available, including `arm64` (e.g. Raspberry PI 4), `386` (i.e. 32-bit), `arm-5`, and `arm-6`.
|
||||||
|
|
||||||
|
**For Windows**, you will likely want `windows-4.0-amd64`. It's for all modern versions of Windows, but there is also a `386` platform available designed for older, 32-bit versions of Windows.
|
||||||
|
|
||||||
|
:::info
|
||||||
|
There is also a `gogit-windows` file available that was created to help with some [performance problems](https://github.com/go-gitea/gitea/pull/15482) reported by some Windows users on older systems/versions. You should consider using this file if you're experiencing performance issues, and let us know if it improves performance.
|
||||||
|
:::
|
||||||
|
|
||||||
|
**For macOS**, you should choose `darwin-arm64` if your hardware uses Apple Silicon, or `darwin-amd64` for Intel.
|
||||||
|
|
||||||
|
**For FreeBSD**, you should choose `freebsd12-amd64` for 64-bit Intel/AMD platforms.
|
||||||
|
|
||||||
|
### Downloading with wget
|
||||||
|
|
||||||
|
Copy the commands below and replace the URL within the one you wish to download.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
wget -O gitea https://dl.gitea.com/gitea/@version@/gitea-@version@-linux-amd64
|
||||||
|
chmod +x gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the above command will download Gitea @version@ for 64-bit Linux.
|
||||||
|
|
||||||
|
## Verify GPG signature
|
||||||
|
|
||||||
|
Gitea signs all binaries with a [GPG key](https://keys.openpgp.org/search?q=teabot%40gitea.io) to prevent against unwanted modification of binaries.
|
||||||
|
To validate the binary, download the signature file which ends in `.asc` for the binary you downloaded and use the GPG command line tool.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
gpg --keyserver hkps://keys.openpgp.org --recv 7C9E68152594688862D62AF62D9AE806EC1592E2
|
||||||
|
gpg --verify gitea-@[email protected] gitea-@version@-linux-amd64
|
||||||
|
```
|
||||||
|
|
||||||
|
Look for the text `Good signature from "Teabot <[email protected]>"` to assert a good binary,
|
||||||
|
despite warnings like `This key is not certified with a trusted signature!`.
|
||||||
|
|
||||||
|
## Recommended server configuration
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Many of the following directories can be configured using [Environment Variables](../administration/environment-variables.md) as well!
|
||||||
|
Of note, configuring `GITEA_WORK_DIR` will tell Gitea where to base its working directory, as well as ease installation.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Prepare environment
|
||||||
|
|
||||||
|
Check that Git is installed on the server. If it is not, install it first. Gitea requires Git version >= 2.0.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git --version
|
||||||
|
```
|
||||||
|
|
||||||
|
Create a user to run Gitea (e.g. `git`)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# On Ubuntu/Debian:
|
||||||
|
adduser \
|
||||||
|
--system \
|
||||||
|
--shell /bin/bash \
|
||||||
|
--gecos 'Git Version Control' \
|
||||||
|
--group \
|
||||||
|
--disabled-password \
|
||||||
|
--home /home/git \
|
||||||
|
git
|
||||||
|
|
||||||
|
# On Fedora/RHEL/CentOS:
|
||||||
|
groupadd --system git
|
||||||
|
adduser \
|
||||||
|
--system \
|
||||||
|
--shell /bin/bash \
|
||||||
|
--comment 'Git Version Control' \
|
||||||
|
--gid git \
|
||||||
|
--home-dir /home/git \
|
||||||
|
--create-home \
|
||||||
|
git
|
||||||
|
```
|
||||||
|
|
||||||
|
### Create required directory structure
|
||||||
|
|
||||||
|
```sh
|
||||||
|
mkdir -p /var/lib/gitea/{custom,data,log}
|
||||||
|
chown -R git:git /var/lib/gitea/
|
||||||
|
chmod -R 750 /var/lib/gitea/
|
||||||
|
mkdir /etc/gitea
|
||||||
|
chown root:git /etc/gitea
|
||||||
|
chmod 770 /etc/gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
:::note
|
||||||
|
> `/etc/gitea` is temporarily set with write permissions for user `git` so that the web installer can write the configuration file. After the installation is finished, it is recommended to set permissions to read-only using:
|
||||||
|
:::
|
||||||
|
|
||||||
|
>
|
||||||
|
> ```sh
|
||||||
|
> chmod 750 /etc/gitea
|
||||||
|
> chmod 640 /etc/gitea/app.ini
|
||||||
|
> ```
|
||||||
|
|
||||||
|
If you don't want the web installer to be able to write to the config file, it is possible to make the config file read-only for the Gitea user (owner/group `root:git`, mode `0640`) however you will need to edit your config file manually to:
|
||||||
|
|
||||||
|
* Set `INSTALL_LOCK= true`,
|
||||||
|
* Ensure all database configuration details are set correctly
|
||||||
|
* Ensure that the `SECRET_KEY` and `INTERNAL_TOKEN` values are set. (You may want to use the `gitea generate secret` to generate these secret keys.)
|
||||||
|
* Ensure that any other secret keys you need are set.
|
||||||
|
|
||||||
|
See the [command line documentation](../administration/command-line.md) for information on using `gitea generate secret`.
|
||||||
|
|
||||||
|
### Configure Gitea's working directory
|
||||||
|
|
||||||
|
:::note
|
||||||
|
If you plan on running Gitea as a Linux service, you can skip this step, as the service file allows you to set `WorkingDirectory`. Otherwise, consider setting this environment variable (semi-)permanently so that Gitea consistently uses the correct working directory.
|
||||||
|
:::
|
||||||
|
|
||||||
|
```sh
|
||||||
|
export GITEA_WORK_DIR=/var/lib/gitea/
|
||||||
|
```
|
||||||
|
|
||||||
|
### Copy the Gitea binary to a global location
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cp gitea /usr/local/bin/gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
### Adding bash/zsh autocompletion (from 1.19)
|
||||||
|
|
||||||
|
A script to enable bash-completion can be found at [`contrib/autocompletion/bash_autocomplete`](https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/autocompletion/bash_autocomplete). This can be copied to `/usr/share/bash-completion/completions/gitea`
|
||||||
|
or sourced within your `.bashrc`.
|
||||||
|
|
||||||
|
Similarly a script for zsh-completion can be found at [`contrib/autocompletion/zsh_autocomplete`](https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/autocompletion/zsh_autocomplete). This can be copied to `/usr/share/zsh/_gitea` or sourced within your
|
||||||
|
`.zshrc`.
|
||||||
|
|
||||||
|
YMMV and these scripts may need further improvement.
|
||||||
|
|
||||||
|
## Running Gitea
|
||||||
|
|
||||||
|
After you complete the above steps, you can run Gitea two ways:
|
||||||
|
|
||||||
|
### 1. Creating a service file to start Gitea automatically (recommended)
|
||||||
|
|
||||||
|
See how to create [Linux service](installation/run-as-service-in-ubuntu.md)
|
||||||
|
|
||||||
|
### 2. Running from command-line/terminal
|
||||||
|
|
||||||
|
```sh
|
||||||
|
GITEA_WORK_DIR=/var/lib/gitea/ /usr/local/bin/gitea web -c /etc/gitea/app.ini
|
||||||
|
```
|
||||||
|
|
||||||
|
## Updating to a new version
|
||||||
|
|
||||||
|
You can update to a new version of Gitea by stopping Gitea, replacing the binary at `/usr/local/bin/gitea` and restarting the instance.
|
||||||
|
The binary file name should not be changed during the update to avoid problems in existing repositories.
|
||||||
|
|
||||||
|
It is recommended that you make a [backup](../administration/backup-and-restore.md) before updating your installation.
|
||||||
|
|
||||||
|
If you have carried out the installation steps as described above, the binary should
|
||||||
|
have the generic name `gitea`. Do not change this, i.e. to include the version number.
|
||||||
|
|
||||||
|
### 1. Restarting Gitea with systemd (recommended)
|
||||||
|
|
||||||
|
As we explained before, we recommend to use systemd as the service manager. In this case, `systemctl restart gitea` should be fine.
|
||||||
|
|
||||||
|
### 2. Restarting Gitea without systemd
|
||||||
|
|
||||||
|
To restart your Gitea instance, we recommend to use SIGHUP signal. If you know your Gitea PID, use `kill -1 $GITEA_PID`, otherwise you can use `killall -1 gitea`.
|
||||||
|
|
||||||
|
To gracefully stop the Gitea instance, a simple `kill $GITEA_PID` or `killall gitea` is enough.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
We don't recommend to use the SIGKILL signal (`-9`); you may be forcefully stopping some of Gitea's internal tasks, and it will not gracefully stop (tasks in queues, indexers, etc.)
|
||||||
|
:::
|
||||||
|
|
||||||
|
See below for troubleshooting instructions to repair broken repositories after
|
||||||
|
an update of your Gitea version.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Old glibc versions
|
||||||
|
|
||||||
|
Older Linux distributions (such as Debian 7 and CentOS 6) may not be able to load the
|
||||||
|
Gitea binary, usually producing an error such as `./gitea: /lib/x86_64-linux-gnu/libc.so.6:
|
||||||
|
version 'GLIBC\_2.14' not found (required by ./gitea)`. This is due to the integrated
|
||||||
|
SQLite support in the binaries provided by dl.gitea.com. In this situation, it is usually
|
||||||
|
possible to [install from source](installation/from-source.md), without including
|
||||||
|
SQLite support.
|
||||||
|
|
||||||
|
### Running Gitea on another port
|
||||||
|
|
||||||
|
For errors like `702 runWeb()] [E] Failed to start server: listen tcp 0.0.0.0:3000:
|
||||||
|
bind: address already in use`, Gitea needs to be started on another free port. This
|
||||||
|
is possible using `./gitea web -p $PORT`. It's possible another instance of Gitea
|
||||||
|
is already running.
|
||||||
|
|
||||||
|
### Running Gitea on Raspbian
|
||||||
|
|
||||||
|
As of v1.8, there is a problem with the arm7 version of Gitea, and it doesn't run on Raspberry Pis and similar devices.
|
||||||
|
|
||||||
|
It is recommended to switch to the arm6 version, which has been tested and shown to work on Raspberry Pis and similar devices.
|
||||||
|
|
||||||
|
<!---
|
||||||
|
please remove after fixing the arm7 bug
|
||||||
|
--->
|
||||||
|
### Git error after updating to a new version of Gitea
|
||||||
|
|
||||||
|
If during the update, the binary file name has been changed to a new version of Gitea,
|
||||||
|
Git Hooks in existing repositories will not work any more. In that case, a Git
|
||||||
|
error will be displayed when pushing to the repository.
|
||||||
|
|
||||||
|
```
|
||||||
|
remote: ./hooks/pre-receive.d/gitea: line 2: [...]: No such file or directory
|
||||||
|
```
|
||||||
|
|
||||||
|
The `[...]` part of the error message will contain the path to your previous Gitea
|
||||||
|
binary.
|
||||||
|
|
||||||
|
To solve this, go to the admin options and run the task `Resynchronize pre-receive,
|
||||||
|
update and post-receive hooks of all repositories` to update all hooks to contain
|
||||||
|
the new binary path. Please note that this overwrites all Git Hooks, including ones
|
||||||
|
with customizations made.
|
||||||
|
|
||||||
|
If you aren't using the Gitea built-in SSH server, you will also need to re-write
|
||||||
|
the authorized key file by running the `Update the '.ssh/authorized_keys' file with
|
||||||
|
Gitea SSH keys.` task in the admin options.
|
||||||
@@ -0,0 +1,109 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
slug: "install-from-package"
|
||||||
|
sidebar_position: 20
|
||||||
|
aliases:
|
||||||
|
- /en-us/install-from-package
|
||||||
|
---
|
||||||
|
|
||||||
|
# Installation from Package
|
||||||
|
|
||||||
|
## Official packages
|
||||||
|
|
||||||
|
### macOS
|
||||||
|
|
||||||
|
Currently, the only supported method of installation on MacOS is [Homebrew](http://brew.sh/).
|
||||||
|
Following the [deployment from binary](installation/from-binary.md) guide may work,
|
||||||
|
but is not supported. To install Gitea via `brew`:
|
||||||
|
|
||||||
|
```
|
||||||
|
brew install gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
## Unofficial packages
|
||||||
|
|
||||||
|
### Alpine Linux
|
||||||
|
|
||||||
|
Alpine Linux has [Gitea](https://pkgs.alpinelinux.org/packages?name=gitea&branch=edge) in its community repository which follows the latest stable version.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
apk add gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
### Arch Linux
|
||||||
|
|
||||||
|
The rolling release distribution has [Gitea](https://www.archlinux.org/packages/extra/x86_64/gitea/) in their official extra repository and package updates are provided with new Gitea releases.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pacman -S gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
### Arch Linux ARM
|
||||||
|
|
||||||
|
Arch Linux ARM provides packages for [aarch64](https://archlinuxarm.org/packages/aarch64/gitea), [armv7h](https://archlinuxarm.org/packages/armv7h/gitea) and [armv6h](https://archlinuxarm.org/packages/armv6h/gitea).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pacman -S gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
### Gentoo Linux
|
||||||
|
|
||||||
|
The rolling release distribution has [Gitea](https://packages.gentoo.org/packages/www-apps/gitea) in their official community repository and package updates are provided with new Gitea releases.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
emerge gitea -va
|
||||||
|
```
|
||||||
|
|
||||||
|
### Canonical Snap
|
||||||
|
|
||||||
|
There is a [Gitea Snap](https://snapcraft.io/gitea) package which follows the latest stable version.
|
||||||
|
*Note: The Gitea snap package is [strictly confined](https://snapcraft.io/docs/snap-confinement). Strictly confined snaps run in complete isolation, so some of the Gitea functionals may not work with the confinement*
|
||||||
|
|
||||||
|
```sh
|
||||||
|
snap install gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
### SUSE and openSUSE
|
||||||
|
|
||||||
|
OpenSUSE build service provides packages for [openSUSE and SLE](https://software.opensuse.org/download/package?package=gitea&project=devel%3Atools%3Ascm)
|
||||||
|
in the Development Software Configuration Management Repository
|
||||||
|
|
||||||
|
### Windows
|
||||||
|
|
||||||
|
There is a [Gitea](https://chocolatey.org/packages/gitea) package for Windows by [Chocolatey](https://chocolatey.org/).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
choco install gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
Or follow the [deployment from binary](installation/from-binary.md) guide.
|
||||||
|
|
||||||
|
### FreeBSD
|
||||||
|
|
||||||
|
A FreeBSD port `www/gitea` is available. To install the pre-built binary package:
|
||||||
|
|
||||||
|
```
|
||||||
|
pkg install gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
For the most up to date version, or to build the port with custom options,
|
||||||
|
[install it from the port](https://www.freebsd.org/doc/handbook/ports-using.html):
|
||||||
|
|
||||||
|
```
|
||||||
|
su -
|
||||||
|
cd /usr/ports/www/gitea
|
||||||
|
make install clean
|
||||||
|
```
|
||||||
|
|
||||||
|
The port uses the standard FreeBSD file system layout: config files are in `/usr/local/etc/gitea`,
|
||||||
|
bundled templates, options, plugins and themes are in `/usr/local/share/gitea`, and a start script
|
||||||
|
is in `/usr/local/etc/rc.d/gitea`.
|
||||||
|
|
||||||
|
To enable Gitea to run as a service, run `sysrc gitea_enable=YES` and start it with `service gitea start`.
|
||||||
|
|
||||||
|
### Others
|
||||||
|
|
||||||
|
Various other third-party packages of Gitea exist.
|
||||||
|
To see a curated list, head over to [awesome-gitea](https://gitea.com/gitea/awesome-gitea/src/branch/master/README.md#user-content-packages).
|
||||||
|
|
||||||
|
Do you know of an existing package that isn't on the list? Send in a PR to get it added!
|
||||||
@@ -0,0 +1,255 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
slug: "install-from-source"
|
||||||
|
sidebar_position: 30
|
||||||
|
aliases:
|
||||||
|
- /en-us/install-from-source
|
||||||
|
---
|
||||||
|
|
||||||
|
# Installation from source
|
||||||
|
|
||||||
|
You should [install go](https://go.dev/doc/install) and set up your go
|
||||||
|
environment correctly. In particular, it is recommended to set the `$GOPATH`
|
||||||
|
environment variable and to add the go bin directory or directories
|
||||||
|
`${GOPATH//://bin:}/bin` to the `$PATH`. See the Go wiki entry for
|
||||||
|
[GOPATH](https://github.com/golang/go/wiki/GOPATH).
|
||||||
|
|
||||||
|
Next, [install Node.js with npm](https://nodejs.org/en/download/) which is
|
||||||
|
required to build the JavaScript and CSS files. The minimum supported Node.js
|
||||||
|
version is @minNodeVersion@ and the latest LTS version is recommended.
|
||||||
|
|
||||||
|
:::note
|
||||||
|
Go version @minGoVersion@ or higher is required. However, it is recommended to
|
||||||
|
obtain the same version as our continuous integration, see the advice given in
|
||||||
|
[Hacking on Gitea](development/hacking-on-gitea.md)
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Download
|
||||||
|
|
||||||
|
First, we must retrieve the source code. Since, the advent of go modules, the
|
||||||
|
simplest way of doing this is to use Git directly as we no longer have to have
|
||||||
|
Gitea built from within the GOPATH.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/go-gitea/gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
(Previous versions of this document recommended using `go get`. This is
|
||||||
|
no longer necessary.)
|
||||||
|
|
||||||
|
Decide which version of Gitea to build and install. Currently, there are
|
||||||
|
multiple options to choose from. The `main` branch represents the current
|
||||||
|
development version. To build with main, skip to the [build section](#build).
|
||||||
|
|
||||||
|
To work with tagged releases, the following commands can be used:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git branch -a
|
||||||
|
git checkout @sourceBranch@
|
||||||
|
```
|
||||||
|
|
||||||
|
To validate a Pull Request, first enable the new branch (`xyz` is the PR id;
|
||||||
|
for example `2663` for [#2663](https://github.com/go-gitea/gitea/pull/2663)):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git fetch origin pull/xyz/head:pr-xyz
|
||||||
|
```
|
||||||
|
|
||||||
|
To build Gitea from source at a specific tagged release (like @sourceVersion@), list the
|
||||||
|
available tags and check out the specific tag.
|
||||||
|
|
||||||
|
List available tags with the following.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git tag -l
|
||||||
|
git checkout @sourceVersion@ # or git checkout pr-xyz
|
||||||
|
```
|
||||||
|
|
||||||
|
## Build
|
||||||
|
|
||||||
|
To build from source, the following programs must be present on the system:
|
||||||
|
|
||||||
|
- `go` @minGoVersion@ or higher, see [here](https://go.dev/dl/)
|
||||||
|
- `node` @minNodeVersion@ or higher with `npm`, see [here](https://nodejs.org/en/download/)
|
||||||
|
- `make`, see [here](development/hacking-on-gitea.md#installing-make)
|
||||||
|
|
||||||
|
Various [make tasks](https://github.com/go-gitea/gitea/blob/main/Makefile)
|
||||||
|
are provided to keep the build process as simple as possible.
|
||||||
|
|
||||||
|
Depending on requirements, the following build tags can be included.
|
||||||
|
|
||||||
|
- `bindata`: Build a single monolithic binary, with all assets included. Required for production build.
|
||||||
|
- `sqlite sqlite_unlock_notify`: Enable support for a
|
||||||
|
[SQLite3](https://sqlite.org/) database. Suggested only for tiny
|
||||||
|
installations.
|
||||||
|
- `pam`: Enable support for PAM (Linux Pluggable Authentication Modules). Can
|
||||||
|
be used to authenticate local users or extend authentication to methods
|
||||||
|
available to PAM.
|
||||||
|
- `gogit`: (EXPERIMENTAL) Use go-git variants of Git commands.
|
||||||
|
|
||||||
|
Bundling all assets (JS/CSS/templates, etc) into the binary. Using the `bindata` build tag is required for
|
||||||
|
production deployments. You could exclude `bindata` when you are developing/testing Gitea or able to separate the assets correctly.
|
||||||
|
|
||||||
|
To include all assets, use the `bindata` tag:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TAGS="bindata" make build
|
||||||
|
```
|
||||||
|
|
||||||
|
In the default release build of our continuous integration system, the build
|
||||||
|
tags are: `TAGS="bindata sqlite sqlite_unlock_notify"`. The simplest
|
||||||
|
recommended way to build from source is therefore:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" make build
|
||||||
|
```
|
||||||
|
|
||||||
|
The `build` target is split into two sub-targets:
|
||||||
|
|
||||||
|
- `make backend` which requires [Go @minGoVersion@](https://go.dev/dl/) or greater.
|
||||||
|
- `make frontend` which requires [Node.js @minNodeVersion@](https://nodejs.org/en/download/) or greater.
|
||||||
|
|
||||||
|
If pre-built frontend files are present it is possible to only build the backend:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
TAGS="bindata" make backend
|
||||||
|
```
|
||||||
|
|
||||||
|
## Test
|
||||||
|
|
||||||
|
After following the steps above, a `gitea` binary will be available in the working directory.
|
||||||
|
It can be tested from this directory or moved to a directory with test data. When Gitea is
|
||||||
|
launched manually from command line, it can be killed by pressing `Ctrl + C`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./gitea web
|
||||||
|
```
|
||||||
|
|
||||||
|
## Changing default paths
|
||||||
|
|
||||||
|
Gitea will search for a number of things from the _`CustomPath`_. By default this is
|
||||||
|
the `custom/` directory in the current working directory when running Gitea. It will also
|
||||||
|
look for its configuration file _`CustomConf`_ in `$(CustomPath)/conf/app.ini`, and will use the
|
||||||
|
current working directory as the relative base path _`AppWorkPath`_ for a number configurable
|
||||||
|
values. Finally the static files will be served from _`StaticRootPath`_ which defaults to the _`AppWorkPath`_.
|
||||||
|
|
||||||
|
These values, although useful when developing, may conflict with downstream users preferences.
|
||||||
|
|
||||||
|
One option is to use a script file to shadow the `gitea` binary and create an appropriate
|
||||||
|
environment before running Gitea. However, when building you can change these defaults
|
||||||
|
using the `LDFLAGS` environment variable for `make`. The appropriate settings are as follows
|
||||||
|
|
||||||
|
- To set the _`CustomPath`_ use `LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.CustomPath=custom-path\""`
|
||||||
|
- For _`CustomConf`_ you should use `-X \"code.gitea.io/gitea/modules/setting.CustomConf=conf.ini\"`
|
||||||
|
- For _`AppWorkPath`_ you should use `-X \"code.gitea.io/gitea/modules/setting.AppWorkPath=working-path\"`
|
||||||
|
- For _`StaticRootPath`_ you should use `-X \"code.gitea.io/gitea/modules/setting.StaticRootPath=static-root-path\"`
|
||||||
|
- To change the default PID file location use `-X \"code.gitea.io/gitea/cmd.PIDFile=/run/gitea.pid\"`
|
||||||
|
|
||||||
|
Add as many of the strings with their preceding `-X` to the `LDFLAGS` variable and run `make build`
|
||||||
|
with the appropriate `TAGS` as above.
|
||||||
|
|
||||||
|
Running `gitea help` will allow you to review what the computed settings will be for your `gitea`.
|
||||||
|
|
||||||
|
## Cross Build
|
||||||
|
|
||||||
|
The `go` compiler toolchain supports cross-compiling to different architecture targets that are supported by the toolchain. See [`GOOS` and `GOARCH` environment variable](https://go.dev/doc/install/source#environment) for the list of supported targets. Cross compilation is helpful if you want to build Gitea for less-powerful systems (such as Raspberry Pi).
|
||||||
|
|
||||||
|
To cross build Gitea with build tags (`TAGS`), you also need a C cross compiler which targets the same architecture as selected by the `GOOS` and `GOARCH` variables. For example, to cross build for Linux ARM64 (`GOOS=linux` and `GOARCH=arm64`), you need the `aarch64-unknown-linux-gnu-gcc` cross compiler. This is required because Gitea build tags uses `cgo`'s foreign-function interface (FFI).
|
||||||
|
|
||||||
|
Cross-build Gitea for Linux ARM64, without any tags:
|
||||||
|
|
||||||
|
```
|
||||||
|
GOOS=linux GOARCH=arm64 make build
|
||||||
|
```
|
||||||
|
|
||||||
|
Cross-build Gitea for Linux ARM64, with recommended build tags:
|
||||||
|
|
||||||
|
```
|
||||||
|
CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sqlite_unlock_notify" make build
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace `CC`, `GOOS`, and `GOARCH` as appropriate for your architecture target.
|
||||||
|
|
||||||
|
You will sometimes need to build a static compiled image. To do this you will need to add:
|
||||||
|
|
||||||
|
```
|
||||||
|
LDFLAGS="-linkmode external -extldflags '-static' $LDFLAGS" TAGS="netgo osusergo $TAGS" make build
|
||||||
|
```
|
||||||
|
|
||||||
|
This can be combined with `CC`, `GOOS`, and `GOARCH` as above.
|
||||||
|
|
||||||
|
### Adding bash/zsh autocompletion (from 1.19)
|
||||||
|
|
||||||
|
A script to enable bash-completion can be found at [`contrib/autocompletion/bash_autocomplete`](https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/autocompletion/bash_autocomplete). This should be altered as appropriate and can be `source` in your `.bashrc`
|
||||||
|
or copied as `/usr/share/bash-completion/completions/gitea`.
|
||||||
|
|
||||||
|
Similarly, a script for zsh-completion can be found at [`contrib/autocompletion/zsh_autocomplete`](https://raw.githubusercontent.com/go-gitea/gitea/main/contrib/autocompletion/zsh_autocomplete). This can be copied to `/usr/share/zsh/_gitea` or sourced within your
|
||||||
|
`.zshrc`.
|
||||||
|
|
||||||
|
YMMV and these scripts may need further improvement.
|
||||||
|
|
||||||
|
## Compile or cross-compile using Linux with Zig
|
||||||
|
|
||||||
|
Follow [Getting Started of Zig](https://ziglang.org/learn/getting-started/#installing-zig) to install zig.
|
||||||
|
|
||||||
|
- Compile (Linux ➝ Linux)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
CC="zig cc -target x86_64-linux-gnu" \
|
||||||
|
CGO_ENABLED=1 \
|
||||||
|
CGO_CFLAGS="-O2 -g -pthread" \
|
||||||
|
CGO_LDFLAGS="-linkmode=external -v"
|
||||||
|
GOOS=linux \
|
||||||
|
GOARCH=amd64 \
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" \
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
- Cross-compile (Linux ➝ Windows)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
CC="zig cc -target x86_64-windows-gnu" \
|
||||||
|
CGO_ENABLED=1 \
|
||||||
|
CGO_CFLAGS="-O2 -g -pthread" \
|
||||||
|
GOOS=windows \
|
||||||
|
GOARCH=amd64 \
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" \
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Compile or cross-compile with Zig using Windows
|
||||||
|
|
||||||
|
Compile with `GIT BASH`.
|
||||||
|
|
||||||
|
- Compile (Windows ➝ Windows)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
CC="zig cc -target x86_64-windows-gnu" \
|
||||||
|
CGO_ENABLED=1 \
|
||||||
|
CGO_CFLAGS="-O2 -g -pthread" \
|
||||||
|
GOOS=windows \
|
||||||
|
GOARCH=amd64 \
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" \
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
- Cross-compile (Windows ➝ Linux)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
CC="zig cc -target x86_64-linux-gnu" \
|
||||||
|
CGO_ENABLED=1 \
|
||||||
|
CGO_CFLAGS="-O2 -g -pthread" \
|
||||||
|
CGO_LDFLAGS="-linkmode=external -v"
|
||||||
|
GOOS=linux \
|
||||||
|
GOARCH=amd64 \
|
||||||
|
TAGS="bindata sqlite sqlite_unlock_notify" \
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
## Source Maps
|
||||||
|
|
||||||
|
By default, gitea generates reduced source maps for frontend files to conserve space. This can be controlled with the `ENABLE_SOURCEMAP` environment variable:
|
||||||
|
|
||||||
|
- `ENABLE_SOURCEMAP=true` generates all source maps, the default for development builds
|
||||||
|
- `ENABLE_SOURCEMAP=reduced` generates limited source maps, the default for production builds
|
||||||
|
- `ENABLE_SOURCEMAP=false` generates no source maps
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
date: "2016-12-01T16:00:00+02:00"
|
||||||
|
slug: "install-on-cloud-provider"
|
||||||
|
sidebar_position: 90
|
||||||
|
aliases:
|
||||||
|
- /en-us/install-on-cloud-provider
|
||||||
|
---
|
||||||
|
|
||||||
|
# Installation on Cloud Provider
|
||||||
|
|
||||||
|
## Cloudron
|
||||||
|
|
||||||
|
Gitea is available as a 1-click install on [Cloudron](https://cloudron.io).
|
||||||
|
Cloudron makes it easy to run apps like Gitea on your server and keep them up-to-date and secure.
|
||||||
|
|
||||||
|
[](https://cloudron.io/button.html?app=io.gitea.cloudronapp)
|
||||||
|
|
||||||
|
The Gitea package is maintained [here](https://git.cloudron.io/cloudron/gitea-app).
|
||||||
|
|
||||||
|
There is a [demo instance](https://my.demo.cloudron.io) (username: cloudron password: cloudron) where
|
||||||
|
you can experiment with running Gitea.
|
||||||
|
|
||||||
|
## Linode
|
||||||
|
|
||||||
|
[Linode](https://www.linode.com/) has Gitea as an app in their marketplace.
|
||||||
|
|
||||||
|
To deploy Gitea to Linode, have a look at the [Linode Marketplace](https://www.linode.com/marketplace/apps/linode/gitea/).
|
||||||
|
|
||||||
|
## alwaysdata
|
||||||
|
|
||||||
|
[alwaysdata](https://www.alwaysdata.com/) has Gitea as an app in their marketplace.
|
||||||
|
|
||||||
|
To deploy Gitea to alwaysdata, have a look at the [alwaysdata Marketplace](https://www.alwaysdata.com/en/marketplace/gitea/).
|
||||||
|
|
||||||
|
## Exoscale
|
||||||
|
|
||||||
|
[Exoscale](https://www.exoscale.com/) provides Gitea managed by [Glasskube](https://glasskube.eu/) in their marketplace.
|
||||||
|
|
||||||
|
Exoscale is a European cloud service provider.
|
||||||
|
|
||||||
|
The package is maintained and update via the open source [Glasskube Kubernetes Operator](https://github.com/glasskube/operator).
|
||||||
|
|
||||||
|
To deploy Gitea to Exoscale, have a look at the [Exoscale Marketplace](https://www.exoscale.com/marketplace/listing/glasskube-gitea/).
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
---
|
||||||
|
date: "2020-03-19T19:27:00+02:00"
|
||||||
|
slug: "install-on-kubernetes"
|
||||||
|
sidebar_position: 80
|
||||||
|
aliases:
|
||||||
|
- /en-us/install-on-kubernetes
|
||||||
|
---
|
||||||
|
|
||||||
|
# Install on Kubernetes
|
||||||
|
|
||||||
|
Gitea provides a Helm Chart to allow for installation on kubernetes.
|
||||||
|
|
||||||
|
A non-customized install can be done with:
|
||||||
|
|
||||||
|
```
|
||||||
|
helm repo add gitea-charts https://dl.gitea.com/charts/
|
||||||
|
helm install gitea gitea-charts/gitea
|
||||||
|
```
|
||||||
|
|
||||||
|
If you would like to customize your install, which includes kubernetes ingress, please refer to the complete [Gitea helm chart configuration details](https://gitea.com/gitea/helm-chart/)
|
||||||
|
|
||||||
|
## Health check endpoint
|
||||||
|
|
||||||
|
Gitea comes with a health check endpoint `/api/healthz`, you can configure it in kubernetes like this:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
livenessProbe:
|
||||||
|
httpGet:
|
||||||
|
path: /api/healthz
|
||||||
|
port: http
|
||||||
|
initialDelaySeconds: 200
|
||||||
|
timeoutSeconds: 5
|
||||||
|
periodSeconds: 10
|
||||||
|
successThreshold: 1
|
||||||
|
failureThreshold: 10
|
||||||
|
```
|
||||||
|
|
||||||
|
a successful health check response will respond with http code `200`, here's example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
HTTP/1.1 200 OK
|
||||||
|
|
||||||
|
{
|
||||||
|
"status": "pass",
|
||||||
|
"description": "Gitea: Git with a cup of tea",
|
||||||
|
"checks": {
|
||||||
|
"cache:ping": [
|
||||||
|
{
|
||||||
|
"status": "pass",
|
||||||
|
"time": "2022-02-19T09:16:08Z"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"database:ping": [
|
||||||
|
{
|
||||||
|
"status": "pass",
|
||||||
|
"time": "2022-02-19T09:16:08Z"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
for more information, please reference to kubernetes documentation [Define a liveness HTTP request](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request)
|
||||||
Loaded 50 of 112 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user