From 864499369981a3b27f83936beee013ca42f0c3df Mon Sep 17 00:00:00 2001 From: Giteabot Date: Tue, 11 Apr 2023 12:43:35 -0400 Subject: [PATCH] Update documentation to explain which projects allow Gitea to host static pages (#23993) (#24058) Backport #23993 by @6543 close #23521 Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: delvh Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: wxiaoguang --- docs/content/doc/help/faq.en-us.md | 8 ++++++++ docs/content/doc/installation/comparison.en-us.md | 7 ++++++- docs/content/doc/installation/comparison.zh-cn.md | 7 ++++++- docs/content/doc/installation/comparison.zh-tw.md | 7 ++++++- 4 files changed, 26 insertions(+), 3 deletions(-) diff --git a/docs/content/doc/help/faq.en-us.md b/docs/content/doc/help/faq.en-us.md index 60e11d4459..4847e8e03b 100644 --- a/docs/content/doc/help/faq.en-us.md +++ b/docs/content/doc/help/faq.en-us.md @@ -118,6 +118,14 @@ The correct path for the template(s) will be relative to the `CustomPath` 2. If you are still unable to find a path, the default can be [calculated above](#where-does-gitea-store-what-file) 3. Once you have figured out the correct custom path, you can refer to the [customizing Gitea]({{< relref "doc/administration/customizing-gitea.en-us.md" >}}) page to add your template to the correct location. +## Does Gitea have a "GitHub/GitLab pages" feature? + +Gitea doesn't provide a built-in Pages server. You need a dedicated domain to serve static pages to avoid CSRF security risks. + +For simple usage, you can use a reverse proxy to rewrite & serve static contents from Gitea's raw file URLs. + +And there are already available third-party services, like a standalone [pages server](https://codeberg.org/Codeberg/pages-server) or a [caddy plugin](https://github.com/42wim/caddy-gitea), that can provide the required functionality. + ## Active user vs login prohibited user In Gitea, an "active" user refers to a user that has activated their account via email. diff --git a/docs/content/doc/installation/comparison.en-us.md b/docs/content/doc/installation/comparison.en-us.md index 36bef38417..0c340eb94c 100644 --- a/docs/content/doc/installation/comparison.en-us.md +++ b/docs/content/doc/installation/comparison.en-us.md @@ -31,6 +31,8 @@ _Symbols used in table:_ - _✘ - unsupported_ +- _⚙️ - supported through third-party software_ + ## General Features | Feature | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | @@ -51,7 +53,7 @@ _Symbols used in table:_ | Custom Theme Support | ✓ | ✓ | ✘ | ✘ | ✘ | ✓ | ✘ | | Markdown support | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | CSV support | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | -| 'GitHub / GitLab pages' | [✘](https://github.com/go-gitea/gitea/issues/302) | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| 'GitHub / GitLab pages' | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | Repo-specific wiki (as a repo itself) | ✓ | ✓ | ✓ | ✓ | ✓ | / | ✘ | | Deploy Tokens | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | Repository Tokens with write rights | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | @@ -141,3 +143,6 @@ _Symbols used in table:_ | Two factor authentication (2FA) | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | | Integration with the most common services | ✓ | / | ⁄ | ✓ | ✓ | ⁄ | ✓ | | Incorporate external CI/CD | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | + +[gitea-caddy-plugin]: https://github.com/42wim/caddy-gitea +[gitea-pages-server]: https://codeberg.org/Codeberg/pages-server diff --git a/docs/content/doc/installation/comparison.zh-cn.md b/docs/content/doc/installation/comparison.zh-cn.md index b254cf7496..7dfca526eb 100644 --- a/docs/content/doc/installation/comparison.zh-cn.md +++ b/docs/content/doc/installation/comparison.zh-cn.md @@ -29,6 +29,8 @@ _表格中的符号含义:_ * _? - 不确定_ +* _⚙️ - 由第三方服务或插件支持_ + #### 主要特性 | 特性 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | @@ -42,7 +44,7 @@ _表格中的符号含义:_ | 支持 Orgmode | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ? | | 支持 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | | 支持第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| Git 驱动的静态 pages | [✘](https://github.com/go-gitea/gitea/issues/302) | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驱动的静态 pages | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | Git 驱动的集成化 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ (cloud only) | ✘ | | 部署令牌 | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | 仓库写权限令牌 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | @@ -129,3 +131,6 @@ _表格中的符号含义:_ | 集成 Discord | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | | 集成 Microsoft Teams | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 显示外部 CI/CD 的状态 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | + +[gitea-caddy-plugin]: https://github.com/42wim/caddy-gitea +[gitea-pages-server]: https://codeberg.org/Codeberg/pages-server diff --git a/docs/content/doc/installation/comparison.zh-tw.md b/docs/content/doc/installation/comparison.zh-tw.md index f918fbad75..8919052343 100644 --- a/docs/content/doc/installation/comparison.zh-tw.md +++ b/docs/content/doc/installation/comparison.zh-tw.md @@ -31,6 +31,8 @@ menu: - ✘ - 不支援 +- _⚙️ - 由第三方服務或外掛程式支援_ + ## 一般功能 | 功能 | Gitea | Gogs | GitHub EE | GitLab CE | GitLab EE | BitBucket | RhodeCode CE | @@ -44,7 +46,7 @@ menu: | 支援 Orgmode | ✓ | ✘ | ✓ | ✘ | ✘ | ✘ | ? | | 支援 CSV | ✓ | ✘ | ✓ | ✘ | ✘ | ✓ | ? | | 支援第三方渲染工具 | ✓ | ✘ | ✘ | ✘ | ✘ | ✓ | ? | -| Git 驅動的靜態頁面 | [✘](https://github.com/go-gitea/gitea/issues/302) | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | +| Git 驅動的靜態頁面 | [⚙️][gitea-pages-server], [⚙️][gitea-caddy-plugin] | ✘ | ✓ | ✓ | ✓ | ✘ | ✘ | | Git 驅動的整合 wiki | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | | 部署 Token | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | | 有寫入權限的儲存庫 Token | ✓ | ✘ | ✓ | ✓ | ✓ | ✘ | ✓ | @@ -130,3 +132,6 @@ menu: | 整合 Discord | ✓ | ✓ | ✓ | ✓ | ✓ | ✘ | ✘ | | 整合 Microsoft Teams | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✘ | | 顯示外部 CI/CD 狀態 | ✓ | ✘ | ✓ | ✓ | ✓ | ✓ | ✓ | + +[gitea-caddy-plugin]: https://github.com/42wim/caddy-gitea +[gitea-pages-server]: https://codeberg.org/Codeberg/pages-server