Skip to content

Commit 7f01e5e

Browse files
lunnysilverwind
authored andcommitted
Update upgrade documentation to add a check for deprecated configurations (go-gitea#26451)
fix go-gitea#25995 (comment) --------- Co-authored-by: silverwind <[email protected]>
1 parent 368e9e0 commit 7f01e5e

File tree

2 files changed

+25
-8
lines changed

2 files changed

+25
-8
lines changed

docs/content/installation/upgrade-from-gitea.en-us.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,20 @@ menu:
1717

1818
# Upgrade from an old Gitea
1919

20-
To update Gitea, download a newer version, stop the old one, perform a backup, and run the new one.
21-
Every time a Gitea instance starts up, it checks whether a database migration should be run.
22-
If a database migration is required, Gitea will take some time to complete the upgrade and then serve.
20+
Follow below steps to ensure a smooth upgrade to a new Gitea version.
2321

2422
## Check the Changelog for breaking changes
2523

2624
To make Gitea better, some breaking changes are unavoidable, especially for big milestone releases.
27-
Before upgrade, please read the [Changelog on Gitea blog](https://blog.gitea.io/)
25+
Before upgrading, please read the [Changelog on Gitea blog](https://blog.gitea.com/)
2826
and check whether the breaking changes affect your Gitea instance.
2927

28+
## Verify there are no deprecated configuration options
29+
30+
New versions of Gitea often come with changed configuration syntax or options which are usually displayed for
31+
at least one release cycle inside at the top of the Site Administration panel. If these warnings are not
32+
resolved, Gitea may refuse to start in the following version.
33+
3034
## Backup for downgrade
3135

3236
Gitea keeps compatibility for patch versions whose first two fields are the same (`a.b.x` -> `a.b.y`),
@@ -60,6 +64,11 @@ Backup steps:
6064
If you are using cloud services or filesystems with snapshot feature,
6165
a snapshot for the Gitea data volume and related object storage is more convenient.
6266

67+
After all of steps have been prepared, download the new version, stop the application, perform a backup and
68+
then start the new application. On each startup, Gitea verifies that the database is up to date and will automtically
69+
perform any necessary migrations. Depending on the size of the database, this can take some additional time on the
70+
first launch during which the application will be unavailable.
71+
6372
## Upgrade with Docker
6473

6574
* `docker pull` the latest Gitea release.

docs/content/installation/upgrade-from-gitea.zh-cn.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,20 @@ menu:
1515

1616
# 从旧版 Gitea 升级
1717

18-
想要升级 Gitea,只需要下载新版,停止运行旧版,进行数据备份,然后运行新版就好。
19-
每次 Gitea 实例启动时,它都会检查是否要进行数据库迁移。
20-
如果需要进行数据库迁移,Gitea 会花一些时间完成升级然后继续服务。
18+
在升级之前,您需要做如下的准备工作。
2119

2220
## 为重大变更检查更新日志
2321

2422
为了让 Gitea 变得更好,进行重大变更是不可避免的,尤其是一些里程碑更新的发布。
25-
在更新前,请 [在 Gitea 博客上阅读更新日志](https://blog.gitea.io/)
23+
在更新前,请 [在 Gitea 博客上阅读更新日志](https://blog.gitea.com/)
2624
并检查重大变更是否会影响你的 Gitea 实例。
2725

26+
## 在控制面板中检查过期的配置项
27+
28+
一些配置项可能会在后续版本中过期,你需要在控制面板中检查他们。如果不解决过期的配置项,
29+
Gitea也许会在升级后无法重启。你可以访问 https://docs.gitea.com 获得要升级的版本
30+
对应的文档来修改你的配置文件。
31+
2832
## 降级前的备份
2933

3034
Gitea 会保留首二位版本号相同的版本的兼容性 (`a.b.x` -> `a.b.y`),
@@ -56,6 +60,10 @@ Gitea 会保留首二位版本号相同的版本的兼容性 (`a.b.x` -> `a.b.y`
5660
如果你在使用云服务或拥有快照功能的文件系统,
5761
最好对 Gitea 的数据盘及相关资料存储进行一次快照。
5862

63+
在所有上述步骤准备妥当之后,要升级 Gitea,只需要下载新版,停止运行旧版,进行数据备份,然后运行新版就好。
64+
每次 Gitea 实例启动时,它都会检查是否要进行数据库迁移。
65+
如果需要进行数据库迁移,Gitea 会花一些时间完成升级然后继续服务。
66+
5967
## 从 Docker 升级
6068

6169
* `docker pull` 拉取 Gitea 的最新发布版。

0 commit comments

Comments
 (0)