diff options
author | techknowlogick <techknowlogick@users.noreply.github.com> | 2017-11-26 16:44:32 -0500 |
---|---|---|
committer | Lauris BH <lauris@nix.lv> | 2017-11-26 23:44:32 +0200 |
commit | fb5c6b644460f94acb8976ad35165230b9d47fb2 (patch) | |
tree | 3811cb3807a9f666e77743cc0fc8bcea4276f421 /docs/content/page | |
parent | f148a4a1ed55c75d391930865185fb7bfbee03ba (diff) | |
download | gitea-fb5c6b644460f94acb8976ad35165230b9d47fb2.tar.gz gitea-fb5c6b644460f94acb8976ad35165230b9d47fb2.zip |
Import docs into main repository (#2874)
* import docs into main repository
Signed-off-by: Matti Ranta <matti@mdranta.net>
Diffstat (limited to 'docs/content/page')
-rw-r--r-- | docs/content/page/index.en-us.md | 279 | ||||
-rw-r--r-- | docs/content/page/index.zh-cn.md | 75 | ||||
-rw-r--r-- | docs/content/page/index.zh-tw.md | 67 |
3 files changed, 421 insertions, 0 deletions
diff --git a/docs/content/page/index.en-us.md b/docs/content/page/index.en-us.md new file mode 100644 index 0000000000..abf5fb2202 --- /dev/null +++ b/docs/content/page/index.en-us.md @@ -0,0 +1,279 @@ +--- +date: "2016-11-08T16:00:00+02:00" +title: "Documentation" +slug: "documentation" +weight: 10 +toc: true +draft: false +--- + +# What is Gitea? + +Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket or Gitlab. The initial development have been done on [Gogs](http://gogs.io) but we have forked it and named it Gitea. If you want to read more about the reasons why we have done that please read [this](https://blog.gitea.io/2016/12/welcome-to-gitea/) blog post. + +## Purpose + +The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service. With Go, this can be done with an independent binary distribution across ALL platforms that Go supports, including Linux, macOS and Windows, even on architectures like ARM or PowerPC. + +## Features + +- User Dashboard + - Context switcher (organization or current user) + - Activity timeline + - Commits + - Issues + - Pull requests + - Repository creation + - Searchable repository list + - List of your organizations + - A list of mirror repositories +- Issues dashboard + - Context switcher (organization or current user) + - Filter by + - Open + - Closed + - Your repositories + - Assigned issues + - Your issues + - Repository + - Sort by + - Oldest + - Last updated + - Number of comments +- Pull request dashboard + - Same as issue dashboard +- Repository types + - Mirror + - Normal + - Migrated +- Notifications (email and web) + - Read + - Unread + - Pin +- Explore page + - Users + - Repos + - Organizations + - Search +- Custom templates +- Override public files (logo, css, etc) +- CSRF and XSS protection +- HTTPS support +- Set allowed upload sizes and types +- Logging +- Configuration + - Databases + - MySQL + - PostgreSQL + - SQLite3 + - MSSQL + - [TiDB](https://github.com/pingcap/tidb) (experimental) + - Configuration file + - See [here](https://github.com/go-gitea/gitea/blob/master/conf/app.ini) + - Admin panel + - Statistics + - Actions + - Delete inactive accounts + - Delete cached repository archives + - Delete repositories records which are missing their files + - Run garbage collection on repositories + - Rewrite SSH keys + - Resync hooks + - Recreate repositories which are missing + - Server status + - Uptime + - Memory + - Current # of goroutines + - And more + - User management + - Search + - Sort + - Last login + - Authentication source + - Maximum repositories + - Disable account + - Admin permissions + - Permission to create git hooks + - Permission to create organizations + - Permission to import repositories + - Organization management + - People + - Teams + - Avatar + - Hooks + - Repository management + - See all repository information and manage repositories + - Authentication sources + - OAuth + - PAM + - LDAP + - SMTP + - Configuration viewer + - Everything in config file + - System notices + - When somthing unexpected happens + - Monitoring + - Current processes + - Cron jobs + - Update mirrors + - Repository health check + - Check repository statstics + - Clean up old archives + - Environment variables + - Command line options +- Multi-language support ([21 languages](https://github.com/go-gitea/gitea/tree/master/options/locale)) +- Mail service + - Notifications + - Registration confirmation + - Password reset +- Reverse proxy support + - Includes subpaths +- Users + - Profile + - Name + - Username + - Email + - Website + - Join date + - Followers and following + - Organizations + - Repositories + - Activity + - Starred repositories + - Settings + - Same as profile and more below + - Keep email private + - Avatar + - Gravatar + - Libravatar + - Custom + - Password + - Mutiple email addresses + - SSH Keys + - Connected applications + - Two factor authentication + - Linked OAuth2 sources + - Delete account +- Repositories + - Clone with SSH/HTTP/HTTPS + - Git LFS + - Watch, Star, Fork + - View watchers, stars, and forks + - Code + - Branch browser + - Web based file upload and creation + - Clone urls + - Download + - ZIP + - TAR.GZ + - Web based editor + - Markdown editor + - Plain text editor + - Syntax highlighting + - Diff preview + - Preview + - Choose where to commit to + - View file history + - Delete file + - View raw + - Issues + - Issue templates + - Milestones + - Labels + - Assign issues + - Filter + - Open + - Closed + - Assigned person + - Created by you + - Mentioning you + - Sort + - Oldest + - Last updated + - Number of comments + - Search + - Comments + - Attachments + - Pull requests + - Same features as issues + - Commits + - Commit graph + - Commits by branch + - Search + - Search in all branches + - View diff + - View SHA + - View author + - Browse files in commit + - Releases + - Attachments + - Title + - Content + - Delete + - Mark as pre-release + - Choose branch + - Wiki + - Import + - Markdown editor + - Settings + - Options + - Name + - Description + - Private/Public + - Website + - Wiki + - Enabled/disabled + - Internal/external + - Issues + - Enabled/disabled + - Internal/external + - External supports url rewriting for better integration + - Enable/disable pull requests + - Transfer repository + - Delete wiki + - Delete repository + - Collaboration + - Read/write/admin + - Branches + - Default branch + - Branch protection + - Webhooks + - Git hooks + - Deploy keys + +## System Requirements + +- A cheap Raspberry Pi is powerful enough for basic functionality. +- 2 CPU cores and 1GB RAM would be the baseline for teamwork. +- Gitea is supposed to be run with a dedicated non-root user account on UNIX systems, no other mode of operation is supported. (**NOTE**: in case you run it with your own user account and the built-in SSH server disabled, Gitea modifies the `~/.ssh/authorized_keys` file so you will **not** be able to interactively log in.) + +## Browser Support + +- Please see [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) for specific versions of supported browsers. +- The official support minimal size is **1024*768**, UI may still looks right in smaller size but no promises and fixes. + +## Components + +* Web framework: [Macaron](http://go-macaron.com/) +* ORM: [XORM](https://github.com/go-xorm/xorm) +* UI components: + * [Semantic UI](http://semantic-ui.com/) + * [GitHub Octicons](https://octicons.github.com/) + * [Font Awesome](http://fontawesome.io/) + * [DropzoneJS](http://www.dropzonejs.com/) + * [Highlight](https://highlightjs.org/) + * [Clipboard](https://zenorocha.github.io/clipboard.js/) + * [Emojify](https://github.com/Ranks/emojify.js) + * [CodeMirror](https://codemirror.net/) + * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker) + * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors) +* Database drivers: + * [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) + * [github.com/lib/pq](https://github.com/lib/pq) + * [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) + * [github.com/pingcap/tidb](https://github.com/pingcap/tidb) + * [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb) + +## Software and Service Support + +- [Drone](https://github.com/drone/drone) (CI) diff --git a/docs/content/page/index.zh-cn.md b/docs/content/page/index.zh-cn.md new file mode 100644 index 0000000000..45a2e9f54d --- /dev/null +++ b/docs/content/page/index.zh-cn.md @@ -0,0 +1,75 @@ +--- +date: "2016-11-08T16:00:00+02:00" +title: "文档" +slug: "documentation" +weight: 10 +toc: true +draft: false +--- + +# 关于Gitea + +Gitea 是一个自己托管的Git服务程序。他和GitHub, Bitbucket or Gitlab等比较类似。他是从 [Gogs](http://gogs.io) 发展而来,不过我们已经Fork并且命名为Gitea。对于我们Fork的原因可以看 [这里](https://blog.gitea.io/2016/12/welcome-to-gitea/)。 + +## 目标 + +Gitea的首要目标是创建一个极易安装,运行非常快速,安装和使用体验良好的自建 Git 服务。我们采用Go作为后端语言,这使我们只要生成一个可执行程序即可。并且他还支持跨平台,支持 Linux, macOS 和 Windows 以及各种架构,除了x86,amd64,还包括 ARM 和 PowerPC。 + +## 功能特性 + +- 支持活动时间线 +- 支持 SSH 以及 HTTP/HTTPS 协议 +- 支持 SMTP、LDAP 和反向代理的用户认证 +- 支持反向代理子路径 +- 支持用户、组织和仓库管理系统 +- 支持添加和删除仓库协作者 +- 支持仓库和组织级别 Web 钩子(包括 Slack 集成) +- 支持仓库 Git 钩子和部署密钥 +- 支持仓库工单(Issue)、合并请求(Pull Request)以及 Wiki +- 支持迁移和镜像仓库以及它的 Wiki +- 支持在线编辑仓库文件和 Wiki +- 支持自定义源的 Gravatar 和 Federated Avatar +- 支持邮件服务 +- 支持后台管理面板 +- 支持 MySQL、PostgreSQL、SQLite3, MSSQL 和 TiDB(实验性支持) 数据库 +- 支持多语言本地化(21 种语言) + +## 系统要求 + +- 最低的系统硬件要求为一个廉价的树莓派 +- 如果用于团队项目,建议使用 2 核 CPU 及 1GB 内存 + +## 浏览器支持 + +- 请根据 [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) 查看具体支持的浏览器版本。 +- 官方支持的最小 UI 尺寸为 **1024*768**,UI 不一定会在更小尺寸的设备上被破坏,但我们无法保证且不会修复。 + +## 组件 + +* Web框架: [Macaron](http://go-macaron.com/) +* ORM: [XORM](https://github.com/go-xorm/xorm) +* UI组件: + * [Semantic UI](http://semantic-ui.com/) + * [GitHub Octicons](https://octicons.github.com/) + * [Font Awesome](http://fontawesome.io/) + * [DropzoneJS](http://www.dropzonejs.com/) + * [Highlight](https://highlightjs.org/) + * [Clipboard](https://zenorocha.github.io/clipboard.js/) + * [Emojify](https://github.com/Ranks/emojify.js) + * [CodeMirror](https://codemirror.net/) + * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker) + * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors) +* 数据库驱动: + * [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) + * [github.com/lib/pq](https://github.com/lib/pq) + * [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) + * [github.com/pingcap/tidb](https://github.com/pingcap/tidb) + * [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb) + +## 软件及服务支持 + +- [Drone](https://github.com/drone/drone) (CI) + +## 需要帮助? + +如果从本页中没有找到你需要的内容,请访问 [帮助页面]({{< relref "seek-help.zh-cn.md" >}}) diff --git a/docs/content/page/index.zh-tw.md b/docs/content/page/index.zh-tw.md new file mode 100644 index 0000000000..bbae83d38a --- /dev/null +++ b/docs/content/page/index.zh-tw.md @@ -0,0 +1,67 @@ +--- +date: "2016-11-08T16:00:00+02:00" +title: "文件" +slug: "documentation" +weight: 10 +toc: true +draft: false +--- + +# 關於 Gitea + +Gitea 是一個可自行託管的 Git 服務。你可以拿 GitHub、Bitbucket 或 Gitlab 來比較看看。初期是從 [Gogs](http://gogs.io) 發展而來,不過我們已經 Fork 並且命名為 Gitea。如果您想更深入了解 Fork 原因,請直接參考[這裡](https://blog.gitea.io/2016/12/welcome-to-gitea/)。 + +## 目標 + +Gitea 的首要目標是建立一個容易安裝,運行快速,安装和使用體驗良好的自建 Git 服務。我們採用 GO 為後端語言,Go 可以產生各平台使用的執行檔。除了支援 Linux、macOS 和 Windows 外,甚至還包含 ARM 和 PowerPC。 + +## 功能 + +- 支援個人活動時間表 +- 支援 SSH 和 HTTP/HTTPS 協定 +- 支援 SMTP/LDAP/Reverse 代理認證 +- 支援反向代理子路徑 +- 支援帳號/組織/儲存庫管理 +- 支援新增/刪除儲存庫合作帳號 +- 支援儲存庫/組織 webhooks (包含 Slack) +- 支援儲存庫 Git hooks/部署金鑰 +- 支援儲存庫問題列表 (issues), 合併請求 (pull requests) 及 wiki +- 支援遷移及複製儲存庫及 wiki +- 支援線上編輯儲存庫檔案及 wiki +- 支援自訂來源 Gravatar 及 Federated avatar +- 支援郵件服務 +- 支援後台管理 +- 支援 MySQL, PostgreSQL, SQLite3, MSSQL 和 [TiDB](https://github.com/pingcap/tidb) (實驗性) +- 支援多國語言 ([21 國語言](https://github.com/go-gitea/gitea/tree/master/options/locale)) + +## 系統需求 + +- 最低的系統需求就是一片便宜的樹莓派 (Raspberry Pi)。 +- 如果用於團隊,建議使用 2 核 CPU 和 1GB 記憶體。 + +## 瀏覽器支援 + +- 請參考 [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) 所支援的瀏覽器列表。 +- 官方支援最小 UI 尺寸為 **1024*768**, UI 在更小尺寸也看起來不錯,但是我們並不保證。 + +## 元件 + +* Web 框架: [Macaron](http://go-macaron.com/) +* ORM: [XORM](https://github.com/go-xorm/xorm) +* UI 元件: + * [Semantic UI](http://semantic-ui.com/) + * [GitHub Octicons](https://octicons.github.com/) + * [Font Awesome](http://fontawesome.io/) + * [DropzoneJS](http://www.dropzonejs.com/) + * [Highlight](https://highlightjs.org/) + * [Clipboard](https://zenorocha.github.io/clipboard.js/) + * [Emojify](https://github.com/Ranks/emojify.js) + * [CodeMirror](https://codemirror.net/) + * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker) + * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors) +* 資料庫: + * [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) + * [github.com/lib/pq](https://github.com/lib/pq) + * [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) + * [github.com/pingcap/tidb](https://github.com/pingcap/tidb) + * [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb) |