2018-01-08 23:48:42 +01:00
|
|
|
---
|
2018-05-22 07:34:02 +02:00
|
|
|
date: "2018-05-21T15:00:00+00:00"
|
2018-01-08 23:48:42 +01:00
|
|
|
title: "Support Options"
|
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 05:33:41 +02:00
|
|
|
slug: "support"
|
2023-07-26 06:53:13 +02:00
|
|
|
sidebar_position: 20
|
2020-12-09 07:47:06 +01:00
|
|
|
toc: false
|
2018-01-08 23:48:42 +01:00
|
|
|
draft: false
|
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 05:33:41 +02:00
|
|
|
aliases:
|
|
|
|
|
- /en-us/seek-help
|
2018-01-08 23:48:42 +01:00
|
|
|
menu:
|
|
|
|
|
sidebar:
|
|
|
|
|
parent: "help"
|
|
|
|
|
name: "Support Options"
|
2023-07-26 06:53:13 +02:00
|
|
|
sidebar_position: 20
|
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 05:33:41 +02:00
|
|
|
identifier: "support"
|
2018-01-08 23:48:42 +01:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Support Options
|
|
|
|
|
|
2023-06-16 06:08:08 +02:00
|
|
|
- [Paid Commercial Support](https://about.gitea.com/)
|
2019-04-13 04:46:52 +02:00
|
|
|
- [Discord](https://discord.gg/Gitea)
|
2018-05-22 07:34:02 +02:00
|
|
|
- [Discourse Forum](https://discourse.gitea.io/)
|
2023-08-12 16:54:50 +02:00
|
|
|
- [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.
|
2023-08-29 00:37:39 +02:00
|
|
|
- Chinese Support
|
|
|
|
|
- [Discourse Chinese Category](https://discourse.gitea.io/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).
|
2018-01-08 23:48:42 +01:00
|
|
|
|
2019-04-13 04:46:52 +02:00
|
|
|
**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:
|
|
|
|
|
|
2022-06-24 04:56:46 +02:00
|
|
|
1. Your `app.ini` (with any sensitive data scrubbed as necessary).
|
2023-08-29 00:37:39 +02:00
|
|
|
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.
|
|
|
|
|
- [try.gitea.io](https://try.gitea.io) could be used to reproduce the problem.
|
|
|
|
|
5. If you encounter slow/hanging/deadlock problems, please report the stacktrace when the problem occurs.
|
2023-06-12 11:05:49 +02:00
|
|
|
Go to the "Site Admin" -> "Monitoring" -> "Stacktrace" -> "Download diagnosis report".
|
2019-04-13 04:46:52 +02:00
|
|
|
|
2023-08-29 00:37:39 +02:00
|
|
|
# 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
|
|
|
|
|
```
|
2018-01-08 23:48:42 +01:00
|
|
|
|
2023-08-29 00:37:39 +02:00
|
|
|
## 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
|
|
|
|
|
```
|
2018-01-08 23:48:42 +01:00
|
|
|
|
2023-08-29 00:37:39 +02:00
|
|
|
2. Restart Gitea
|
2018-01-08 23:48:42 +01:00
|
|
|
|
2023-08-29 00:37:39 +02:00
|
|
|
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.
|