feat: add docs for install

This commit is contained in:
raiots 2023-01-06 10:23:41 +08:00
parent b0433783c8
commit 8d710ac088
6 changed files with 807 additions and 671 deletions

View File

@ -1,5 +1,37 @@
module.exports = { // module.exports = {
lang: 'zh-CN', // lang: 'zh-CN',
title: 'TasksManager', // title: 'TasksManager',
description: '超好用的任务分配管理系统', // description: '超好用的任务分配管理系统',
} // }
//
import {defaultTheme, defineUserConfig} from 'vuepress'
export default defineUserConfig({
lang: 'zh-CN',
title: 'TasksManager',
description: '超好用的任务分配管理系统',
theme: defaultTheme({
navbar: [
{
text: '指南',
link: '/guide/',
},
{
text: '部署',
link: '/install/',
}
],
sidebar: "auto",
repo: 'https://github.com/raiots/TasksManager',
repoLabel: '✨Github',
docsDir: 'docs',
docsBranch: 'master',
lastUpdatedText: "📑 最后更新",
contributorsText: "💕 参与贡献",
editLinkText: "🖊️ 编辑本文",
notFound: ["👻 页面不存在"],
}),
})

View File

@ -9,4 +9,12 @@ actions:
- text: 快速部署 - text: 快速部署
link: /install/ link: /install/
type: secondary type: secondary
features:
- title: 任务分发
details: TasksManager 管理员能够以年度任务为主线,向用户发送待办任务
- title: 任务提交
details: 用户可以查看自己的待办任务、并提交完成度与完成情况说明,帮助管理员掌握部门工作情况
- title: 评价考核
details: TasksManager 会对用户完成任务数量与质量进行综合评价,并直观显示于首页
--- ---

View File

@ -1,10 +1,81 @@
--- ---
sidebar: auto sidebar: auto
navbar: True
--- ---
# 部署 # 部署
你可以使用两种方式部署 TasksManager这里推荐使用 Docker compose 的方式进行部署。 你可以使用两种方式部署 TasksManager这里推荐使用 Docker compose 的方式进行部署。
## Docker 部署 ## Docker Compose 部署
> Docker Compose 是一个用于在使用Compose 文件格式定义的 Docker 上运行多容器应用程序的工具。
### 安装
拉取 TaskManager 程序源码
```shell
git clone https://github.com/raiots/TasksManager.git
```
### 启动
使用 cd 命令进入程序文件夹后启动程序:
```shell
docker-compose up -d
```
TasksManager 将会运行在服务器的 8000 端口,在浏览器中打开 http://ip地址:8000 即可访问
## 使用源码手动部署
> 程序使用 Python3.8 开发,请提前配置 Python 环境
### 安装
使用 git 下载 TasksManager 源码:
```shell
git clone https://github.com/raiots/TasksManager.git
cd TasksManager
```
创建并激活 Python 虚拟环境
```shell
python -m venv venv
.\venv\Scripts\activate.sh
```
安装 TasksManager 依赖
```shell
pip install -r requirements.txt
```
### 启动
```shell
python3 manage.py runserver 0.0.0.0:8000
```
TasksManager 将会运行在服务器的 8000 端口,在浏览器中打开 http://ip地址:8000 即可访问
## 使用 Nginx 配置反向代理
```
server
{
listen 443 ssl http2;
server_name your.domain.com ;
location / {
proxy_pass http://127.0.0.1:8000; # 转发规则
proxy_set_header Host $proxy_host; # 修改转发请求头让8000端口的应用可以受到真实的请求
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
```

View File

@ -1,6 +1,6 @@
{ {
"devDependencies": { "devDependencies": {
"vuepress": "^2.0.0-beta.49" "vuepress": "^2.0.0-beta.60"
}, },
"scripts": { "scripts": {
"docs:dev": "vuepress dev docs", "docs:dev": "vuepress dev docs",

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 8.7 KiB

1352
yarn.lock

File diff suppressed because it is too large Load Diff