Skip to content

Commit 0ad5ae0

Browse files
GiteaBotwxiaoguang
andauthored
Improve some documents: release version, logging, NFS lock (#25202) (#25204)
Backport #25202 by @wxiaoguang Close #23654 Close #24684 @techknowlogick I still think we need to rename https://dl.gitea.com/gitea/1.20/ to https://dl.gitea.com/gitea/1.20-nightly/ `/gitea/1.20/` is quite confusing, it needs these words to explain why. If we call it `1.20-nightly`, the FAQ can be simplified a lot. Co-authored-by: wxiaoguang <[email protected]>
1 parent 0cf467e commit 0ad5ae0

File tree

2 files changed

+23
-42
lines changed

2 files changed

+23
-42
lines changed

docs/content/doc/help/faq.en-us.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,19 @@ For more help resources, check all [Support Options]({{< relref "doc/help/suppor
2525

2626
{{< toc >}}
2727

28-
## Difference between 1.x and 1.x.x downloads
28+
## Difference between 1.x and 1.x.x downloads, how can I get latest stable release with bug fixes?
2929

30-
Version 1.7.x will be used for this example.
30+
Version 1.20.x will be used for this example.
3131

32-
**NOTE:** this example applies to Docker images as well!
32+
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.
3333

34-
On our [downloads page](https://dl.gitea.io/gitea/) you will see a 1.7 directory, as well as directories for 1.7.0, 1.7.1, 1.7.2, 1.7.3, 1.7.4, 1.7.5, and 1.7.6.
34+
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.
3535

36-
The 1.7 and 1.7.0 directories are **not** the same. The 1.7 directory is built on each merged commit to the [`release/v1.7`](https://github.com/go-gitea/gitea/tree/release/v1.7) branch.
36+
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.
3737

38-
The 1.7.0 directory, however, is a build that was created when the [`v1.7.0`](https://github.com/go-gitea/gitea/releases/tag/v1.7.0) tag was created.
38+
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.
3939

40-
This means that 1.x downloads will change as commits are merged to their respective branch (think of it as a separate "main" branch for each release).
41-
42-
On the other hand, 1.x.x downloads should never change.
40+
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.
4341

4442
## How to migrate from Gogs/GitHub/etc. to Gitea
4543

@@ -404,14 +402,6 @@ You will also need to change the app.ini database charset to `CHARSET=utf8mb4`.
404402

405403
Gitea requires the system or browser to have one of the supported Emoji fonts installed, which are Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol, Noto Color Emoji and Twemoji Mozilla. Generally, the operating system should already provide one of these fonts, but especially on Linux, it may be necessary to install them manually.
406404

407-
## Stdout logging on SystemD and Docker
408-
409-
Stdout on systemd goes to the journal by default. Try using `journalctl`, `journalctl -u gitea`, or `journalctl <path-to-gitea-binary>`.
410-
411-
Similarly, stdout on docker can be viewed using `docker logs <container>`.
412-
413-
To collect logs for help and issue report, see [Support Options]({{< relref "doc/help/support.en-us.md" >}}).
414-
415405
## Initial logging
416406

417407
Before Gitea has read the configuration file and set-up its logging it will log a number of things to stdout in order to help debug things if logging does not work.
@@ -454,12 +444,6 @@ gitea doctor recreate-table
454444

455445
It is highly recommended to back-up your database before running these commands.
456446

457-
## Why are tabs/indents wrong when viewing files
458-
459-
If you are using Cloudflare, turn off the auto-minify option in the dashboard.
460-
461-
`Speed` -> `Optimization` -> Uncheck `HTML` within the `Auto-Minify` settings.
462-
463447
## How to adopt repositories from disk
464448

465449
- 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`.
@@ -470,3 +454,17 @@ If you are using Cloudflare, turn off the auto-minify option in the dashboard.
470454
- Users can also be given similar permissions via config [`ALLOW_ADOPTION_OF_UNADOPTED_REPOSITORIES`]({{< relref "doc/administration/config-cheat-sheet.en-us.md#repository" >}}).
471455
- If the above steps are done correctly, you should be able to select repositories to adopt.
472456
- If no repositories are found, enable [debug logging]({{< relref "doc/administration/config-cheat-sheet.en-us.md#repository" >}}) to check for any specific errors.
457+
458+
## Gitea can't start on NFS
459+
460+
In most cases, it's caused by broken NFS lock system. You can try to stop Gitea process and
461+
run `flock -n /data-nfs/gitea/queues/LOCK echo 'lock acquired'` to see whether the lock can be acquired immediately.
462+
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.
463+
464+
Then the NFS lock could be reset by:
465+
466+
```bash
467+
# /etc/init.d/nfs stop
468+
# rm -rf /var/lib/nfs/sm/*
469+
# /etc/init.d/nfs start
470+
```

docs/content/doc/help/support.en-us.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,30 +35,13 @@ menu:
3535
[log]
3636
LEVEL=debug
3737
MODE=console,file
38-
ROUTER=console,file
39-
XORM=console,file
40-
ENABLE_XORM_LOG=true
41-
FILE_NAME=gitea.log
42-
[log.file.router]
43-
FILE_NAME=router.log
44-
[log.file.xorm]
45-
FILE_NAME=xorm.log
4638
```
4739

4840
3. Any error messages you are seeing.
4941
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.
5042
- This will greatly improve the chance that the root of the issue can be quickly discovered and resolved.
51-
5. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs:
52-
1. Enable pprof in `app.ini` and restart Gitea
53-
54-
```ini
55-
[server]
56-
ENABLE_PPROF = true
57-
```
58-
59-
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`).
60-
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"`.
61-
4. Report the output (the stack trace doesn't contain sensitive data)
43+
5. If you encounter slow/hanging/deadlock problems, please report the stack trace when the problem occurs.
44+
Go to the "Site Admin" -> "Monitoring" -> "Stacktrace" -> "Download diagnosis report".
6245

6346
## Bugs
6447

0 commit comments

Comments
 (0)