From 13de89b2f73cea5b678e010e21e1239863c0838c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dachary?= Date: Tue, 7 Mar 2023 09:20:56 +0100 Subject: [PATCH 1/5] seek-help.md: verbatim copy --- v1.19/admin/seek-help.md | 67 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 v1.19/admin/seek-help.md diff --git a/v1.19/admin/seek-help.md b/v1.19/admin/seek-help.md new file mode 100644 index 00000000..fe474816 --- /dev/null +++ b/v1.19/admin/seek-help.md @@ -0,0 +1,67 @@ +--- +date: "2018-05-21T15:00:00+00:00" +title: "Support Options" +slug: "seek-help" +weight: 10 +toc: false +draft: false +menu: + sidebar: + parent: "help" + name: "Support Options" + weight: 20 + identifier: "seek-help" +--- + +# Support Options + +- [Discord](https://discord.gg/Gitea) +- [Discourse Forum](https://discourse.gitea.io/) + +**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. The Gitea logs, and any other appropriate log files for the situation. + - When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs. + - When using docker, use `docker logs --tail 1000 ` to collect logs. + - By default, the logs are outputted to console. If you need to collect logs from files, + you could copy the following config into your `app.ini` (remove all other `[log]` sections), + then you can 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 + ROUTER=console,file + XORM=console,file + ENABLE_XORM_LOG=true + FILE_NAME=gitea.log + [log.file.router] + FILE_NAME=router.log + [log.file.xorm] + FILE_NAME=xorm.log + ``` + +3. Any error messages you are seeing. +4. When possible, try to replicate the issue on [try.gitea.io](https://try.gitea.io) and include steps so that others can reproduce the issue. + - This will greatly improve the chance that the root of the issue can be quickly discovered and resolved. +5. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs: + 1. Enable pprof in `app.ini` and restart Gitea + + ```ini + [server] + ENABLE_PPROF = true + ``` + + 2. Trigger the bug, when Gitea gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP must be `127.0.0.1` and port must be `6060`). + 3. If you are using Docker, please use `docker exec -it curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"`. + 4. Report the output (the stack trace doesn't contain sensitive data) + +## Bugs + +If you found a bug, please create an [issue on GitHub](https://github.com/go-gitea/gitea/issues). + +## Chinese Support + +Support for the Chinese language is provided at [Our discourse](https://discourse.gitea.io/c/5-category/5) or QQ Group 328432459. From 9a69e3aef1b3f8bf13a61e8cd8031f3125ed936e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dachary?= Date: Tue, 7 Mar 2023 09:23:32 +0100 Subject: [PATCH 2/5] seek-help.md: adapt to Forgejo --- v1.19/admin/index.md | 1 + v1.19/admin/seek-help.md | 46 ++++++++++++---------------------------- 2 files changed, 14 insertions(+), 33 deletions(-) diff --git a/v1.19/admin/index.md b/v1.19/admin/index.md index 5c6ec7ee..f3d0ac58 100644 --- a/v1.19/admin/index.md +++ b/v1.19/admin/index.md @@ -5,6 +5,7 @@ title: 'Forgejo v1.19 administrator guide' These documents are targeted to people who run Forgejo on their machines. +- [Seek help](seek-help) - [Configuration Cheat Sheet](config-cheat-sheet) - [Upgrade guide](upgrade) - [Command Line](command-line) diff --git a/v1.19/admin/seek-help.md b/v1.19/admin/seek-help.md index fe474816..7bf27134 100644 --- a/v1.19/admin/seek-help.md +++ b/v1.19/admin/seek-help.md @@ -1,32 +1,22 @@ --- -date: "2018-05-21T15:00:00+00:00" -title: "Support Options" -slug: "seek-help" -weight: 10 -toc: false -draft: false -menu: - sidebar: - parent: "help" - name: "Support Options" - weight: 20 - identifier: "seek-help" +layout: '~/layouts/Markdown.astro' +title: 'Seek help' +license: 'Apache-2.0' +origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/help/seek-help.en-us.md' --- -# Support Options - -- [Discord](https://discord.gg/Gitea) -- [Discourse Forum](https://discourse.gitea.io/) +- [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org) +- [Issue tracker](https://codeberg.org/forgejo/forgejo/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. The Gitea logs, and any other appropriate log files for the situation. - - When using systemd, use `journalctl --lines 1000 --unit gitea` to collect logs. - - When using docker, use `docker logs --tail 1000 ` to collect logs. +2. The Forgejo logs, and any other appropriate log files for the situation. + - When using systemd, use `journalctl --lines 1000 --unit forgejo` to collect logs. + - When using docker, use `docker logs --tail 1000 ` to collect logs. - By default, the logs are outputted to console. If you need to collect logs from files, you could copy the following config into your `app.ini` (remove all other `[log]` sections), - then you can find the `*.log` files in Gitea's log directory (default: `%(GITEA_WORK_DIR)/log`). + then you can find the `*.log` files in Forgejo's log directory (default: `%(FORGEJO_WORK_DIR)/log`). ```ini ; To show all SQL logs, you can also set LOG_SQL=true in the [database] section @@ -44,24 +34,14 @@ menu: ``` 3. Any error messages you are seeing. -4. When possible, try to replicate the issue on [try.gitea.io](https://try.gitea.io) and include steps so that others can reproduce the issue. - - This will greatly improve the chance that the root of the issue can be quickly discovered and resolved. -5. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs: - 1. Enable pprof in `app.ini` and restart Gitea +4. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs: + 1. Enable pprof in `app.ini` and restart Forgejo ```ini [server] ENABLE_PPROF = true ``` - 2. Trigger the bug, when Gitea gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP must be `127.0.0.1` and port must be `6060`). + 2. Trigger the bug, when Forgejo gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP must be `127.0.0.1` and port must be `6060`). 3. If you are using Docker, please use `docker exec -it curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"`. 4. Report the output (the stack trace doesn't contain sensitive data) - -## Bugs - -If you found a bug, please create an [issue on GitHub](https://github.com/go-gitea/gitea/issues). - -## Chinese Support - -Support for the Chinese language is provided at [Our discourse](https://discourse.gitea.io/c/5-category/5) or QQ Group 328432459. From c5c1d9e4e9ba659c0a8d28f27c30ef37d17604e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dachary?= Date: Tue, 7 Mar 2023 20:52:26 +0100 Subject: [PATCH 3/5] s/Seek help/Getting Support/ --- v1.19/admin/index.md | 2 +- v1.19/admin/seek-help.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/v1.19/admin/index.md b/v1.19/admin/index.md index f3d0ac58..434973d2 100644 --- a/v1.19/admin/index.md +++ b/v1.19/admin/index.md @@ -5,7 +5,7 @@ title: 'Forgejo v1.19 administrator guide' These documents are targeted to people who run Forgejo on their machines. -- [Seek help](seek-help) +- [Getting Support](seek-help) - [Configuration Cheat Sheet](config-cheat-sheet) - [Upgrade guide](upgrade) - [Command Line](command-line) diff --git a/v1.19/admin/seek-help.md b/v1.19/admin/seek-help.md index 7bf27134..a882628f 100644 --- a/v1.19/admin/seek-help.md +++ b/v1.19/admin/seek-help.md @@ -1,6 +1,6 @@ --- layout: '~/layouts/Markdown.astro' -title: 'Seek help' +title: 'Getting Support' license: 'Apache-2.0' origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/help/seek-help.en-us.md' --- From ffe15dffc09b31e47eca04a32aee6a9878f4f57f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Jaenisch?= Date: Wed, 8 Mar 2023 15:48:32 +0100 Subject: [PATCH 4/5] Rename file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: André Jaenisch --- v1.19/admin/seek-assistance.md | 49 ++++++++++++++++++++++++++++++++++ v1.19/admin/seek-help.md | 47 -------------------------------- 2 files changed, 49 insertions(+), 47 deletions(-) create mode 100644 v1.19/admin/seek-assistance.md delete mode 100644 v1.19/admin/seek-help.md diff --git a/v1.19/admin/seek-assistance.md b/v1.19/admin/seek-assistance.md new file mode 100644 index 00000000..228b4638 --- /dev/null +++ b/v1.19/admin/seek-assistance.md @@ -0,0 +1,49 @@ +--- +layout: '~/layouts/Markdown.astro' +title: 'Getting Support' +license: 'Apache-2.0' +origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/help/seek-help.en-us.md' +--- + +- [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org) +- [Issue tracker](https://codeberg.org/forgejo/forgejo/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. The Forgejo logs, and any other appropriate log files for the situation. + + - When using systemd, use `journalctl --lines 1000 --unit forgejo` to collect logs. + - When using docker, use `docker logs --tail 1000 ` to collect logs. + - By default, the logs are outputted to console. If you need to collect logs from files, + you could copy the following config into your `app.ini` (remove all other `[log]` sections), + then you can find the `*.log` files in Forgejo's log directory (default: `%(FORGEJO_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 + ROUTER=console,file + XORM=console,file + ENABLE_XORM_LOG=true + FILE_NAME=gitea.log + [log.file.router] + FILE_NAME=router.log + [log.file.xorm] + FILE_NAME=xorm.log + ``` + +3. Any error messages you are seeing. +4. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs: + + 1. Enable pprof in `app.ini` and restart Forgejo + + ```ini + [server] + ENABLE_PPROF = true + ``` + + 2. Trigger the bug, when Forgejo gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP must be `127.0.0.1` and port must be `6060`). + 3. If you are using Docker, please use `docker exec -it curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"`. + 4. Report the output (the stack trace doesn't contain sensitive data) diff --git a/v1.19/admin/seek-help.md b/v1.19/admin/seek-help.md deleted file mode 100644 index a882628f..00000000 --- a/v1.19/admin/seek-help.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: '~/layouts/Markdown.astro' -title: 'Getting Support' -license: 'Apache-2.0' -origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/help/seek-help.en-us.md' ---- - -- [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org) -- [Issue tracker](https://codeberg.org/forgejo/forgejo/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. The Forgejo logs, and any other appropriate log files for the situation. - - When using systemd, use `journalctl --lines 1000 --unit forgejo` to collect logs. - - When using docker, use `docker logs --tail 1000 ` to collect logs. - - By default, the logs are outputted to console. If you need to collect logs from files, - you could copy the following config into your `app.ini` (remove all other `[log]` sections), - then you can find the `*.log` files in Forgejo's log directory (default: `%(FORGEJO_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 - ROUTER=console,file - XORM=console,file - ENABLE_XORM_LOG=true - FILE_NAME=gitea.log - [log.file.router] - FILE_NAME=router.log - [log.file.xorm] - FILE_NAME=xorm.log - ``` - -3. Any error messages you are seeing. -4. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs: - 1. Enable pprof in `app.ini` and restart Forgejo - - ```ini - [server] - ENABLE_PPROF = true - ``` - - 2. Trigger the bug, when Forgejo gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP must be `127.0.0.1` and port must be `6060`). - 3. If you are using Docker, please use `docker exec -it curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"`. - 4. Report the output (the stack trace doesn't contain sensitive data) From e0cade7597d0b3b46f0cf7c959317d23023e4596 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Jaenisch?= Date: Wed, 8 Mar 2023 15:49:33 +0100 Subject: [PATCH 5/5] Fix references MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: André Jaenisch --- v1.19/admin/index.md | 2 +- v1.19/admin/seek-assistance.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/v1.19/admin/index.md b/v1.19/admin/index.md index 434973d2..32d34384 100644 --- a/v1.19/admin/index.md +++ b/v1.19/admin/index.md @@ -5,7 +5,7 @@ title: 'Forgejo v1.19 administrator guide' These documents are targeted to people who run Forgejo on their machines. -- [Getting Support](seek-help) +- [Seek Assistance](seek-assistance) - [Configuration Cheat Sheet](config-cheat-sheet) - [Upgrade guide](upgrade) - [Command Line](command-line) diff --git a/v1.19/admin/seek-assistance.md b/v1.19/admin/seek-assistance.md index 228b4638..8d548747 100644 --- a/v1.19/admin/seek-assistance.md +++ b/v1.19/admin/seek-assistance.md @@ -1,6 +1,6 @@ --- layout: '~/layouts/Markdown.astro' -title: 'Getting Support' +title: 'Seek Assistance' license: 'Apache-2.0' origin_url: 'https://github.com/go-gitea/gitea/blob/699f20234b9f7cdbbeeee3be004470c598fa1147/docs/content/doc/help/seek-help.en-us.md' ---