Merge pull request 'Seek assistance' (#152) from dachary/website:wip-help into main

Reviewed-on: https://codeberg.org/forgejo/website/pulls/152
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Reviewed-by: André Jaenisch <ryuno-ki@noreply.codeberg.org>

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 Assistance](seek-assistance)
 - [Configuration Cheat Sheet](config-cheat-sheet)
 - [Upgrade guide](upgrade)
 - [Command Line](command-line)

v1.19/admin/seek-assistance.md

@@ -0,0 +1,49 @@
+---
+layout: '~/layouts/Markdown.astro'
+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'
+---
+
+- [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 <forgejo-container>` 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 <container-name> curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"`.
+   4. Report the output (the stack trace doesn't contain sensitive data)