Merge pull request #19 from PGYER/dev/master

change docs
This commit is contained in:
Carney Wu
2022-01-27 18:16:37 +08:00
committed by GitHub
2 changed files with 33 additions and 43 deletions

View File

@@ -75,14 +75,15 @@
- 🆓 **永久免费:** 永久免费提供给大家使用,您无需担心付费
- ❤️ **完整开源:** 毫无保留的完整开源,无任何编译或加密代码
- 🥬 **轻量安装:** 极简设计风格,排除重度冗余的多余功能
- ⚡️ **性能高效** 速度极快对服务器资源要求极低1核CPU/1G内存即可运行
- ♾️ **无限仓库** 没有任何仓库数量、使用数量的限制
- ⌨️ **代码对比** 支持提交代码的不同版本支持高亮显示对比
- 🛤️ **分支和标签** 完整支持 Git 原生功能,帮助更清晰的管理代码
- 🙋‍♂️ **合并请求Merge Request** 支持多人协作,让代码版本控制更顺畅
- 🙅🏻‍♀️ **分支保护** 分支保护功能让代码提交安全可控,代码 Review 更容易清晰
- 👥 **多人协作** 支持多人团队协作,并可以设置每个成员的角色和权限
- 🖥️ **管理后台** 支持超级管理员后台可以让团队leader管理所有项目和用户信息
- ⚡️ **性能高效:** 速度极快对服务器资源要求极低1核CPU/1G内存即可运行
- ♾️ **无限仓库:** 没有任何仓库数量、使用数量的限制
- ⌨️ **代码对比:** 支持提交代码的不同版本支持高亮显示对比
- 🛤️ **分支管理:** 完整支持 Git 原生分支也Tag,帮助更清晰的管理代码
- 🙋‍♂️ **合并请求Merge Request:** 支持多人协作,让代码版本控制更顺畅
- 🙅🏻‍♀️ **分支保护:** 分支保护功能让代码提交安全可控,代码 Review 更容易清晰
- 👥 **多人协作:** 支持多人团队协作,并可以设置每个成员的角色和权限
- 🖥️ **管理后台:** 支持超级管理员后台可以让团队leader管理所有项目和用户信息
- 💬 **中英双语:** 原生支持中文和英文两种语言
### **如何安装**

View File

@@ -1,8 +1,31 @@
# Docker 镜像安装
## 安装步骤
### Docker 镜像说明
`CodeFever Community 版本``Docker 镜像` 是从 `dockerhub` 上的 `centos:centos7.9.2009` 镜像开始按照 [从零开始安装](install_from_scratch.md) 中的步骤进行构建, 构建架构是 `x86_64 (amd64)` 如果有其他需求请自行构建镜像。
### 拉取镜像并启动
启动 `CodeFever Communiy 版本``Docker 镜像`
```shell
docker run -d --privileged=true --name codefever -p 80:80 -p 22:22 -it pgyer/codefever-community:latest /usr/sbin/init
```
1. 服务启动后尝试访问 `http://127.0.0.1``http://<server ip>` 登录
2. 如果你希望使用 `22` 端口作为 `Git``SSH 协议`端口,你需要在启动镜像前将宿主系统的 `SSH 服务` `端口` 先修改成其他端口
3. 如果服务异常你可以登录 Shell 去人工维护, 也可以直接重启容器重启服务。
4. 默认管理员用户: `root@codefever.cn`, 密码: `123456`。登录后请修改密码并绑定 MFA 设备。
### 服务维护
服务维护请参见 [管理员设置/概览和系统服务](../admin/dashboard.md) 中的 `系统服务状态及维护` 一节
## 此文档适用条件
> 如果你的情况符合以下条件, 你需要使用 [从零开始安装](install_from_scratch.md) 的方式安装 `CodeFever` 否则请跳过本章节继续使用 `Docker 镜像安装` 方式安装。
如果你的情况符合以下条件你需要使用 [从零开始安装](install_from_scratch.md) 的方式安装 `CodeFever` 否则请跳过本章节继续使用 `Docker 镜像安装` 方式安装。
- 学习和技术交流
- 需要做定制化修改
@@ -10,37 +33,3 @@
- Docker 镜像不能在当前 `操作系统``硬件架构` 上使用
参见: [从零开始安装](install_from_scratch.md)
## 安装步骤
### 0. Docker 镜像说明
`CodeFever Community 版本``Docker 镜像` 是从 `dockerhub` 上的 `centos:centos7.9.2009` 镜像开始按照 [从零开始安装](install_from_scratch.md) 中的步骤进行构建, 构建架构是 `x86_64 (amd64)` 如果有其他需求请自行构建镜像。
### 1. 获取镜像
`dockerhub` 上获取到 `CodeFever Community 版本` 镜像。
```shell
docker pull pgyer/codefever-community:latest
```
### 2. 启动
在本地启动 `CodeFever Communiy 版本``Docker 镜像`
```shell
docker container run -d --privileged=true --name codefever -p 80:80 -p 22:22 -it pgyer/codefever-community:latest /usr/sbin/init
```
> - 如果你希望使用 `22` 端口作为 `Git` 的 `SSH 协议`端口。 你需要在启动镜像前将宿主系统的 `SSH 服务` `端口` 先修改成其他端口
> - 如果服务异常你可以登录 Shell 去人工维护, 也可以直接重启容器重启服务。
服务启动后尝试访问 `http://127.0.0.1``http://<server ip>` 来登录
默认管理员用户: `root@codefever.cn`, 密码: `123456`。登录后请修改密码并绑定 MFA 设备。
### 3. 服务维护
服务维护请参见 [管理员设置/概览和系统服务](../admin/dashboard.md) 中的 `系统服务状态及维护` 一节