aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/upgrade
diff options
context:
space:
mode:
authorLunny Xiao <xiaolunwen@gmail.com>2023-03-23 23:18:24 +0800
committerGitHub <noreply@github.com>2023-03-23 23:18:24 +0800
commite8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9 (patch)
treede72ccf6dda7170f4d8cbd3338294ba4b0ae2ecd /docs/content/doc/upgrade
parentdf411819ebe4d3e6852997ce41fadf837d5d4ea0 (diff)
downloadgitea-e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9.tar.gz
gitea-e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9.zip
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629)
- **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
Diffstat (limited to 'docs/content/doc/upgrade')
-rw-r--r--docs/content/doc/upgrade/from-gitea.en-us.md95
-rw-r--r--docs/content/doc/upgrade/from-gogs.en-us.md114
-rw-r--r--docs/content/doc/upgrade/from-gogs.fr-fr.md83
-rw-r--r--docs/content/doc/upgrade/from-gogs.zh-cn.md26
-rw-r--r--docs/content/doc/upgrade/from-gogs.zh-tw.md107
5 files changed, 0 insertions, 425 deletions
diff --git a/docs/content/doc/upgrade/from-gitea.en-us.md b/docs/content/doc/upgrade/from-gitea.en-us.md
deleted file mode 100644
index 4dc47b05a4..0000000000
--- a/docs/content/doc/upgrade/from-gitea.en-us.md
+++ /dev/null
@@ -1,95 +0,0 @@
----
-date: "2021-09-02T16:00:00+08:00"
-title: "Upgrade from an old Gitea"
-aliases:
- - /en-us/upgrade/
-slug: "upgrade-from-gitea"
-weight: 10
-toc: false
-draft: false
-menu:
- sidebar:
- parent: "upgrade"
- name: "From Gitea"
- weight: 10
- identifier: "upgrade-from-gitea"
----
-
-# Upgrade from an old Gitea
-
-**Table of Contents**
-
-{{< toc >}}
-
-To update Gitea, download a newer version, stop the old one, perform a backup, and run the new one.
-Every time a Gitea instance starts up, it checks whether a database migration should be run.
-If a database migration is required, Gitea will take some time to complete the upgrade and then serve.
-
-## Check the Changelog for breaking changes
-
-To make Gitea better, some breaking changes are unavoidable, especially for big milestone releases.
-Before upgrade, please read the [Changelog on Gitea blog](https://blog.gitea.io/)
-and check whether the breaking changes affect your Gitea instance.
-
-## Backup for downgrade
-
-Gitea keeps compatibility for patch versions whose first two fields are the same (`a.b.x` -> `a.b.y`),
-these patch versions can be upgraded and downgraded with the same database structure.
-Otherwise (`a.b.?` -> `a.c.?`), a newer Gitea version will upgrade the old database
-to a new structure that may differ from the old version.
-
-For example:
-
-| From | To | Result |
-| --- | --- | --- |
-| 1.4.0 | 1.4.1 | ✅ |
-| 1.4.1 | 1.4.0 | ⚠️ Not recommended, take your own risk! Although it may work if the database structure doesn't change, it's highly recommended to use a backup to downgrade. |
-| 1.4.x | 1.5.y | ✅ Database gets upgraded. You can upgrade from 1.4.x to the latest 1.5.y directly. |
-| 1.5.y | 1.4.x | ❌ Database already got upgraded and can not be used for an old Gitea, use a backup to downgrade. |
-
-**Since you can not run an old Gitea with an upgraded database,
-a backup should always be made before a database upgrade.**
-
-If you use Gitea in production, it's always highly recommended to make a backup before upgrade,
-even if the upgrade is between patch versions.
-
-Backup steps:
-
-* Stop Gitea instance
-* Backup database
-* Backup Gitea config
-* Backup Gitea data files in `APP_DATA_PATH`
-* Backup Gitea external storage (eg: S3/MinIO or other storages if used)
-
-If you are using cloud services or filesystems with snapshot feature,
-a snapshot for the Gitea data volume and related object storage is more convenient.
-
-## Upgrade with Docker
-
-* `docker pull` the latest Gitea release.
-* Stop the running instance, backup data.
-* Use `docker` or `docker-compose` to start the newer Gitea Docker container.
-
-## Upgrade from package
-
-* Stop the running instance, backup data.
-* Use your package manager to upgrade Gitea to the latest version.
-* Start the Gitea instance.
-
-## Upgrade from binary
-
-* Download the latest Gitea binary to a temporary directory.
-* Stop the running instance, backup data.
-* Replace the installed Gitea binary with the downloaded one.
-* Start the Gitea instance.
-
-A script automating these steps for a deployment on Linux can be found at [`contrib/upgrade.sh` in Gitea's source tree](https://github.com/go-gitea/gitea/blob/main/contrib/upgrade.sh).
-
-## Take care about customized templates
-
-Gitea's template structure and variables may change between releases, if you are using customized templates,
-do pay attention if your templates are compatible with the Gitea you are using.
-
-If the customized templates don't match Gitea version, you may experience:
-`50x` server error, page components missing or malfunctioning, strange page layout, ...
-Remove or update the incompatible templates and Gitea web will work again.
diff --git a/docs/content/doc/upgrade/from-gogs.en-us.md b/docs/content/doc/upgrade/from-gogs.en-us.md
deleted file mode 100644
index f0bfe96050..0000000000
--- a/docs/content/doc/upgrade/from-gogs.en-us.md
+++ /dev/null
@@ -1,114 +0,0 @@
----
-date: "2016-12-01T16:00:00+02:00"
-title: "Upgrade from Gogs"
-slug: "upgrade-from-gogs"
-weight: 10
-toc: false
-draft: false
-menu:
- sidebar:
- parent: "upgrade"
- name: "From Gogs"
- weight: 10
- identifier: "upgrade-from-gogs"
----
-
-# Upgrade from Gogs
-
-**Table of Contents**
-
-{{< toc >}}
-
-Gogs, version 0.9.146 and older, can be easily migrated to Gitea.
-
-There are some basic steps to follow. On a Linux system run as the Gogs user:
-
-* Create a Gogs backup with `gogs backup`. This creates `gogs-backup-[timestamp].zip` file
- containing all important Gogs data. You would need it if you wanted to move to the `gogs` back later.
-* Download the file matching the destination platform from the [downloads page](https://dl.gitea.io/gitea/).
- It should be `1.0.x` version. Migrating from `gogs` to any other version is impossible.
-* Put the binary at the desired install location.
-* Copy `gogs/custom/conf/app.ini` to `gitea/custom/conf/app.ini`.
-* Copy custom `templates, public` from `gogs/custom/` to `gitea/custom/`.
-* For any other custom folders, such as `gitignore, label, license, locale, readme` in
- `gogs/custom/conf`, copy them to `gitea/custom/options`.
-* Copy `gogs/data/` to `gitea/data/`. It contains issue attachments and avatars.
-* Verify by starting Gitea with `gitea web`.
-* Enter Gitea admin panel on the UI, run `Rewrite '.ssh/authorized_keys' file`.
-* Launch every major version of the binary ( `1.1.4` → `1.2.3` → `1.3.4` → `1.4.2` → etc ) to migrate database.
-* If custom or config path was changed, run `Rewrite all update hook of repositories`.
-
-## Change gogs specific information
-
-* Rename `gogs-repositories/` to `gitea-repositories/`
-* Rename `gogs-data/` to `gitea-data/`
-* In `gitea/custom/conf/app.ini` change:
-
- FROM:
-
- ```ini
- [database]
- PATH = /home/:USER/gogs/data/:DATABASE.db
- [attachment]
- PATH = /home/:USER/gogs-data/attachments
- [picture]
- AVATAR_UPLOAD_PATH = /home/:USER/gogs-data/avatars
- [log]
- ROOT_PATH = /home/:USER/gogs/log
- ```
-
- TO:
-
- ```ini
- [database]
- PATH = /home/:USER/gitea/data/:DATABASE.db
- [attachment]
- PATH = /home/:USER/gitea-data/attachments
- [picture]
- AVATAR_UPLOAD_PATH = /home/:USER/gitea-data/avatars
- [log]
- ROOT_PATH = /home/:USER/gitea/log
- ```
-
-* Verify by starting Gitea with `gitea web`
-
-## Upgrading to most recent `gitea` version
-
-After successful migration from `gogs` to `gitea 1.0.x`, it is possible to upgrade `gitea` to a modern version
-in a two steps process.
-
-Upgrade to [`gitea 1.6.4`](https://dl.gitea.io/gitea/1.6.4/) first. Download the file matching
-the destination platform from the [downloads page](https://dl.gitea.io/gitea/1.6.4/) and replace the binary.
-Run Gitea at least once and check that everything works as expected.
-
-Then repeat the procedure, but this time using the [latest release](https://dl.gitea.io/gitea/{{< version >}}/).
-
-## Upgrading from a more recent version of Gogs
-
-Upgrading from a more recent version of Gogs (up to `0.11.x`) may also be possible, but will require a bit more work.
-See [#4286](https://github.com/go-gitea/gitea/issues/4286), which includes various Gogs `0.11.x` versions.
-
-Upgrading from Gogs `0.12.x` and above will be increasingly more difficult as the projects diverge further apart in configuration and schema.
-
-## Troubleshooting
-
-* If errors are encountered relating to custom templates in the `gitea/custom/templates`
- folder, try moving the templates causing the errors away one by one. They may not be
- compatible with Gitea or an update.
-
-## Add Gitea to startup on Unix
-
-Update the appropriate file from [gitea/contrib](https://github.com/go-gitea/gitea/tree/main/contrib)
-with the right environment variables.
-
-For distros with systemd:
-
-* Copy the updated script to `/etc/systemd/system/gitea.service`
-* Add the service to the startup with: `sudo systemctl enable gitea`
-* Disable old gogs startup script: `sudo systemctl disable gogs`
-
-For distros with SysVinit:
-
-* Copy the updated script to `/etc/init.d/gitea`
-* Add the service to the startup with: `sudo rc-update add gitea`
-* Disable old gogs startup script: `sudo rc-update del gogs`
diff --git a/docs/content/doc/upgrade/from-gogs.fr-fr.md b/docs/content/doc/upgrade/from-gogs.fr-fr.md
deleted file mode 100644
index 98a8edc1a3..0000000000
--- a/docs/content/doc/upgrade/from-gogs.fr-fr.md
+++ /dev/null
@@ -1,83 +0,0 @@
----
-date: "2017-08-23T09:00:00+02:00"
-title: "Mise à jour depuis Gogs"
-slug: "upgrade-from-gogs"
-weight: 10
-toc: false
-draft: false
-menu:
- sidebar:
- parent: "upgrade"
- name: "Depuis Gogs"
- weight: 10
- identifier: "upgrade-from-gogs"
----
-
-# Mise à jour depuis Gogs
-
-À partir de la version 0.9.146 (schéma de la base de données : version 15) de Gogs, Il est possible de migrer vers Gitea simplement et sans encombre.
-
-Veuillez suivre les étapes ci-dessous. Sur Unix, toute les commandes s'exécutent en tant que l'utilisateur utilisé pour votre installation de Gogs :
-
-* Crééer une sauvegarde de Gogs avec la commande `gogs dump`. Le fichier nouvellement créé `gogs-dump-[timestamp].zip` contient toutes les données de votre instance de Gogs.
-* Téléchargez le fichier correspondant à votre plateforme à partir de la [page de téléchargements](https://dl.gitea.io/gitea).
-* Mettez la binaire dans le répertoire d'installation souhaité.
-* Copiez le fichier `gogs/custom/conf/app.ini` vers `gitea/custom/conf/app.ini`.
-* Si vous avez personnalisé les répertoires `templates, public` dans `gogs/custom/`, copiez-les vers `gitea/custom/`.
-* Si vous avez d'autres répertoires personnalisés comme `gitignore, label, license, locale, readme` dans `gogs/custom/conf` copiez-les vers `gitea/custom/options`.
-* Copiez le répertoire `gogs/data/` vers `gitea/data/`.
-* Vérifiez votre installation en exécutant Gitea avec la commande `gitea web`.
-* Lancez le binaire de version majeure en version majeure ( `1.1.4` → `1.2.3` → `1.3.4` → `1.4.2` → etc ) afin de récupérer les migrations de base de données.
-* Connectez vous au panel d'administration de Gitea et exécutez l'action `Rewrite '.ssh/authorized_keys' file`, puis l'action `Rewrite all update hook of repositories` (obligatoire si le chemin menant à votre configuration personnalisée à changé).
-
-## Modifier les informations spécifiques de gogs
-
-* Renommez `gogs-repositories/` vers `gitea-repositories/`
-* Renommez `gogs-data/` to `gitea-data/`
-* Dans votre fichier `gitea/custom/conf/app.ini`, modifiez les éléments suivants:
-
- DE :
-
- ```ini
- [database]
- PATH = /home/:USER/gogs/data/:DATABASE.db
- [attachment]
- PATH = /home/:USER/gogs-data/attachments
- [picture]
- AVATAR_UPLOAD_PATH = /home/:USER/gogs-data/avatars
- [log]
- ROOT_PATH = /home/:USER/gogs/log
- ```
-
- VERS :
-
- ```ini
- [database]
- PATH = /home/:USER/gitea/data/:DATABASE.db
- [attachment]
- PATH = /home/:USER/gitea-data/attachments
- [picture]
- AVATAR_UPLOAD_PATH = /home/:USER/gitea-data/avatars
- [log]
- ROOT_PATH = /home/:USER/gitea/log
- ```
-
-* Vérifiez votre installation en exécutant Gitea avec la commande `gitea web`.
-
-## Dépannage
-
-* Si vous rencontrez des erreurs relatives à des modèles personnalisés dans le dossier `gitea/custom/templates`, essayez de déplacer un par un les modèles provoquant les erreurs. Il est possible qu'ils ne soient pas compatibles avec Gitea.
-
-## Démarrer automatiquement Gitea (Unix)
-
-Distributions utilisant systemd:
-
-* Copiez le script mis à jour vers `/etc/systemd/system/gitea.service`
-* Ajoutez le service avec la commande `sudo systemctl enable gitea`
-* Désactivez Gogs avec la commande `sudo systemctl disable gogs`
-
-Distributions utilisant SysVinit:
-
-* Copiez le script mis à jour vers `/etc/init.d/gitea`
-* Ajoutez le service avec la commande `sudo rc-update add gitea`
-* Désactivez Gogs avec la commande `sudo rc-update del gogs`
diff --git a/docs/content/doc/upgrade/from-gogs.zh-cn.md b/docs/content/doc/upgrade/from-gogs.zh-cn.md
deleted file mode 100644
index 7d391ae822..0000000000
--- a/docs/content/doc/upgrade/from-gogs.zh-cn.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-date: "2016-12-01T16:00:00+02:00"
-title: "从 Gogs 升级"
-slug: "upgrade-from-gogs"
-weight: 10
-toc: false
-draft: false
-menu:
- sidebar:
- parent: "upgrade"
- name: "从 Gogs 升级"
- weight: 10
- identifier: "upgrade-from-gogs"
----
-
-# 从 Gogs 升级
-
-如果你正在运行Gogs 0.9.146以下版本,你可以平滑的升级到Gitea。该升级需要如下的步骤:
-
-* 停止 Gogs 的运行
-* 拷贝 Gogs 的配置文件 `custom/conf/app.ini` 到 Gitea 的相应位置。
-* 拷贝 Gitea 的 `options/` 到 Home 目录下。
-* 如果你还有更多的自定义内容,比如templates和localization文件,你需要手工合并你的修改到 Gitea 的 Options 下对应目录。
-* 拷贝 Gogs 的数据目录 `data/` 到 Gitea 相应位置。这个目录包含附件和头像文件。
-* 运行 Gitea
-* 登录 Gitea 并进入 管理面板, 运行 `重新生成 '.ssh/authorized_keys' 文件(警告:不是 Gitea 的密钥也会被删除)` 和 `重新生成所有仓库的 Update 钩子(用于自定义配置文件被修改)`。
diff --git a/docs/content/doc/upgrade/from-gogs.zh-tw.md b/docs/content/doc/upgrade/from-gogs.zh-tw.md
deleted file mode 100644
index 793d74df88..0000000000
--- a/docs/content/doc/upgrade/from-gogs.zh-tw.md
+++ /dev/null
@@ -1,107 +0,0 @@
----
-date: "2016-12-01T16:00:00+02:00"
-title: "從 Gogs 升級"
-slug: "upgrade-from-gogs"
-weight: 10
-toc: false
-draft: false
-menu:
- sidebar:
- parent: "upgrade"
- name: "從 Gogs"
- weight: 10
- identifier: "upgrade-from-gogs"
----
-
-# 從 Gogs 升級
-
-**目錄**
-
-{{< toc >}}
-
-若您正在執行 Gogs 0.9.146 以下版本,您可以很簡單地遷移到 Gitea。
-
-請參考下列步驟。在 Linux 系統上請以 Gogs 的使用者身份執行:
-
-- 使用 `gogs backup` 建立 Gogs 的備份。這會建立檔案 `gogs-backup-[timestamp].zip` 包含所有重要的 Gogs 資料。
- 如果稍後您要恢復到 `gogs` 時會用到它。
-- 從[下載頁](https://dl.gitea.io/gitea/)下載對應您平臺的檔案。請下載 `1.0.x` 版,從 `gogs` 遷移到其它版本是不可行的。
-- 將二進位檔放到適當的安裝位置。
-- 複製 `gogs/custom/conf/app.ini` 到 `gitea/custom/conf/app.ini`。
-- 從 `gogs/custom/` 複製自訂 `templates, public` 到 `gitea/custom/`。
-- `gogs/custom/conf` 中的其它自訂資料夾如: `gitignore, label, license, locale, readme`,
- 請複製到 `gitea/custom/options`。
-- 複製 `gogs/data/` 到 `gitea/data/`。它包含了問題附件和大頭貼。
-- 以指令 `gitea web` 啟動 Gitea 驗證上列設定是否正確。
-- 從網頁 UI 進入 Gitea 管理員面板, 執行 `Rewrite '.ssh/authorized_keys' file`。
-- 執行每個主要版本的二進位檔 ( `1.1.4` → `1.2.3` → `1.3.4` → `1.4.2` → 等等 ) 以遷移資料庫。
-- 如果變更了自訂檔、設定檔路徑,請執行 `Rewrite all update hook of repositories`。
-
-## 修改指定的 gogs 資訊
-
-- 重新命名 `gogs-repositories/` 為 `gitea-repositories/`
-- 重新命名 `gogs-data/` 為 `gitea-data/`
-- 在 `gitea/custom/conf/app.ini` 中修改:
-
- 修改前:
-
- ```ini
- [database]
- PATH = /home/:USER/gogs/data/:DATABASE.db
- [attachment]
- PATH = /home/:USER/gogs-data/attachments
- [picture]
- AVATAR_UPLOAD_PATH = /home/:USER/gogs-data/avatars
- [log]
- ROOT_PATH = /home/:USER/gogs/log
- ```
-
- 修改後:
-
- ```ini
- [database]
- PATH = /home/:USER/gitea/data/:DATABASE.db
- [attachment]
- PATH = /home/:USER/gitea-data/attachments
- [picture]
- AVATAR_UPLOAD_PATH = /home/:USER/gitea-data/avatars
- [log]
- ROOT_PATH = /home/:USER/gitea/log
- ```
-
-- 執行 `gitea web` 啟動 Gitea 檢查是否正確執行
-
-## 升級到最新版的 `gitea`
-
-成功從 `gogs` 升級到 `gitea 1.0.x` 後再用 2 個步驟即可升級到最新版的 `gitea`。
-
-請先升級到 [`gitea 1.6.4`](https://dl.gitea.io/gitea/1.6.4/),先從[下載頁](https://dl.gitea.io/gitea/1.6.4/)下載
-您平臺的二進位檔取代既有的。至少執行一次 Gitea 並確認一切符合預期。
-
-接著重複上述步驟,但這次請使用[最新發行版本](https://dl.gitea.io/gitea/{{< version >}}/)。
-
-## 從更新版本的 Gogs 升級
-
-您也可以從更新版本的 Gogs 升級,但需要更多步驟。
-請參考 [#4286](https://github.com/go-gitea/gitea/issues/4286)。
-
-## 疑難排解
-
-- 如果錯誤和 `gitea/custom/templates` 中 的自訂樣板有關,請試著逐一移除它們。
- 它們可能和 Gitea 或更新不相容。
-
-## 在 Unix 啟動時執行 Gitea
-
-從 [gitea/contrib](https://github.com/go-gitea/gitea/tree/master/contrib) 更新必要的檔案以取得正確的環境變數。
-
-使用 systemd 的發行版:
-
-- 複製新的腳本到 `/etc/systemd/system/gitea.service`
-- 啟動系統時執行服務: `sudo systemctl enable gitea`
-- 停用舊的 gogs 腳本: `sudo systemctl disable gogs`
-
-使用 SysVinit 的發行版:
-
-- 複製新的腳本到 `/etc/init.d/gitea`
-- 啟動系統時執行服務: `sudo rc-update add gitea`
-- 停用舊的 gogs 腳本: `sudo rc-update del gogs`