mirror of
https://github.com/kuaifan/dootask.git
synced 2025-12-11 18:42:54 +00:00
no message
This commit is contained in:
kuaifan
parent
e499e2d0dc
commit
261c051052
130
README.md
130
README.md
@ -1,147 +1,139 @@
|
||||
# Install (Docker)
|
||||
# DooTask - Open Source Task Management System
|
||||
|
||||
English | **[中文文档](./README_CN.md)**
|
||||
|
||||
- [Screenshot preview](./README_PREVIEW.md)
|
||||
- [Demo site](http://www.dootask.com/)
|
||||
- [Screenshot Preview](./README_PREVIEW.md)
|
||||
- [Demo Site](http://www.dootask.com/)
|
||||
|
||||
**QQ Group**
|
||||
|
||||
Group No.: `546574618`
|
||||
- Group Number: `546574618`
|
||||
|
||||
## Setup
|
||||
## Installation Requirements
|
||||
|
||||
- `Docker v20.10+` & `Docker Compose v2.0+` must be installed
|
||||
- System: `Centos/Debian/Ubuntu/macOS` and other linux/unix systems
|
||||
- Hardware suggestion: 2 cores and above 4G memory
|
||||
- Required: `Docker v20.10+` and `Docker Compose v2.0+`
|
||||
- Supported Systems: `CentOS/Debian/Ubuntu/macOS` and other Linux/Unix systems
|
||||
- Hardware Recommendation: 2+ cores, 4GB+ memory
|
||||
- Special Note: Windows users can install Linux environment using WSL2 before installing DooTask.
|
||||
|
||||
### Deployment (Pro Edition)
|
||||
### Deploy Project
|
||||
|
||||
```bash
|
||||
# 1、Clone the repository
|
||||
# 1、Clone the project to your local machine or server
|
||||
|
||||
# Clone projects on github
|
||||
git clone -b pro --depth=1 https://github.com/kuaifan/dootask.git
|
||||
# Or you can use gitee
|
||||
git clone -b pro --depth=1 https://gitee.com/aipaw/dootask.git
|
||||
# Clone project from GitHub
|
||||
git clone --depth=1 https://github.com/kuaifan/dootask.git
|
||||
# Or you can use Gitee
|
||||
git clone --depth=1 https://gitee.com/aipaw/dootask.git
|
||||
|
||||
# 2、Enter directory
|
||||
cd dootask
|
||||
|
||||
# 3、Installation（Custom port installation, as: ./cmd install --port 80）
|
||||
# 3、One-click installation (Custom port installation: ./cmd install --port 80)
|
||||
./cmd install
|
||||
```
|
||||
|
||||
### Reset password
|
||||
### Reset Password
|
||||
|
||||
```bash
|
||||
# Reset default account password
|
||||
# Reset default administrator password
|
||||
./cmd repassword
|
||||
```
|
||||
|
||||
### Change port
|
||||
### Change Port
|
||||
|
||||
```bash
|
||||
# This method only replaces the HTTP port. To replace the HTTPS port, please read the SSL configuration below
|
||||
# This method only changes HTTP port. For HTTPS port, please read SSL configuration below
|
||||
./cmd port 80
|
||||
```
|
||||
|
||||
### Stop server
|
||||
### Stop Service
|
||||
|
||||
```bash
|
||||
./cmd stop
|
||||
|
||||
# P.S: Once application is set up, whenever you want to start the server (if it is stopped) run below command
|
||||
./cmd start
|
||||
./cmd down
|
||||
```
|
||||
|
||||
### Development compilation
|
||||
|
||||
- `NodeJs 20+` must be installed
|
||||
### Start Service
|
||||
|
||||
```bash
|
||||
# Development
|
||||
./cmd up
|
||||
```
|
||||
|
||||
### Development & Build
|
||||
|
||||
Please ensure you have installed `NodeJs 20+`
|
||||
|
||||
```bash
|
||||
# Development mode
|
||||
./cmd dev
|
||||
|
||||
# Production (This is web client. For App/PC/Mac clients, Please read README-CLIENT.md)
|
||||
# Build project (This is for web client. For desktop apps, refer to ".github/workflows/publish.yml")
|
||||
./cmd prod
|
||||
```
|
||||
|
||||
### Shortcuts for running command
|
||||
### SSL Configuration
|
||||
|
||||
```bash
|
||||
# You can do this using the following command
|
||||
./cmd artisan "your command" # To run a artisan command
|
||||
./cmd php "your command" # To run a php command
|
||||
./cmd nginx "your command" # To run a nginx command
|
||||
./cmd redis "your command" # To run a redis command
|
||||
./cmd composer "your command" # To run a composer command
|
||||
./cmd supervisorctl "your command" # To run a supervisorctl command
|
||||
./cmd mysql "your command" # To run a mysql command (backup: Backup database, recovery: Restore database, open: Open database external port access, close: Close database external port access)
|
||||
```
|
||||
|
||||
### SSL configuration
|
||||
|
||||
#### Method 1: Automatic configuration
|
||||
#### Method 1: Automatic Configuration
|
||||
|
||||
```bash
|
||||
# Running commands in a project
|
||||
# Run command and follow the prompts
|
||||
./cmd https
|
||||
```
|
||||
|
||||
#### Or Method 2: Nginx Agent Configuration
|
||||
#### Method 2: Nginx Proxy Configuration
|
||||
|
||||
```bash
|
||||
# 1、Nginx config add
|
||||
# 1、Add Nginx proxy configuration
|
||||
proxy_set_header X-Forwarded-Host $http_host;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
|
||||
# 2、Running commands in a project (If you unconfigure the NGINX agent, run: ./cmd https close)
|
||||
# 2、Run command (To cancel Nginx proxy configuration: ./cmd https close)
|
||||
./cmd https agent
|
||||
```
|
||||
|
||||
## Upgrade
|
||||
## Upgrade & Update
|
||||
|
||||
**Note: Please back up your data before upgrading!**
|
||||
**Note: Please backup your data before upgrading!**
|
||||
|
||||
```bash
|
||||
# Method 1: Running commands in a project
|
||||
./cmd update
|
||||
|
||||
# Or method 2: use this method if method 1 fails
|
||||
git pull
|
||||
./cmd mysql backup
|
||||
./cmd uninstall
|
||||
./cmd install
|
||||
./cmd mysql recovery
|
||||
```
|
||||
|
||||
* Please try again if the upgrade fails across a large version.
|
||||
* If 502 after the upgrade please run `./cmd reup` restart the service.
|
||||
* Please retry if upgrade fails across major versions.
|
||||
* If you encounter 502 errors after upgrade, run `./cmd reup` to restart services.
|
||||
|
||||
## Transfer
|
||||
## Project Migration
|
||||
|
||||
Follow these steps to complete the project migration after the new project is installed:
|
||||
After installing the new project, follow these steps to complete migration:
|
||||
|
||||
1. Backup original database
|
||||
1、Backup original database
|
||||
|
||||
```bash
|
||||
# Run command under old project
|
||||
# Run command in the old project
|
||||
./cmd mysql backup
|
||||
```
|
||||
|
||||
2. Copy `database backup file` and `public/uploads` directory to the new project.
|
||||
2、Copy the following files and directories from old project to the same paths in new project
|
||||
|
||||
3. Restore database to new project
|
||||
- `Database backup file`
|
||||
- `docker/appstore`
|
||||
- `public/uploads`
|
||||
|
||||
3、Restore database to new project
|
||||
```bash
|
||||
# Run command under new project
|
||||
# Run command in the new project
|
||||
./cmd mysql recovery
|
||||
```
|
||||
|
||||
## Uninstall
|
||||
## Uninstall Project
|
||||
|
||||
```bash
|
||||
# Running commands in a project
|
||||
./cmd uninstall
|
||||
```
|
||||
|
||||
### More Commands
|
||||
|
||||
```bash
|
||||
./cmd help
|
||||
```
|
||||
|
||||
67
README_CN.md
67
README_CN.md
@ -1,4 +1,4 @@
|
||||
# Install (Docker)
|
||||
# DooTask - 开源任务管理系统
|
||||
|
||||
**[English](./README.md)** | 中文文档
|
||||
|
||||
@ -14,16 +14,17 @@
|
||||
- 必须安装：`Docker v20.10+` 和 `Docker Compose v2.0+`
|
||||
- 支持环境：`Centos/Debian/Ubuntu/macOS` 等 linux/unix 系统
|
||||
- 硬件建议：2核4G以上
|
||||
- 特别说明：Windows 可以使用 WSL2 安装 Linux 环境后再安装 DooTask。
|
||||
|
||||
### 部署项目（Pro版）
|
||||
### 部署项目
|
||||
|
||||
```bash
|
||||
# 1、克隆项目到您的本地或服务器
|
||||
|
||||
# 通过github克隆项目
|
||||
git clone -b pro --depth=1 https://github.com/kuaifan/dootask.git
|
||||
git clone --depth=1 https://github.com/kuaifan/dootask.git
|
||||
# 或者你也可以使用gitee
|
||||
git clone -b pro --depth=1 https://gitee.com/aipaw/dootask.git
|
||||
git clone --depth=1 https://gitee.com/aipaw/dootask.git
|
||||
|
||||
# 2、进入目录
|
||||
cd dootask
|
||||
@ -49,48 +50,37 @@ cd dootask
|
||||
### 停止服务
|
||||
|
||||
```bash
|
||||
./cmd stop
|
||||
./cmd down
|
||||
```
|
||||
|
||||
# 一旦应用程序被设置，无论何时你想要启动服务器(如果它被停止)运行以下命令
|
||||
./cmd start
|
||||
### 启动服务
|
||||
|
||||
```bash
|
||||
./cmd up
|
||||
```
|
||||
|
||||
### 开发编译
|
||||
|
||||
- 请确保你已经安装了 `NodeJs 20+`
|
||||
请确保你已经安装了 `NodeJs 20+`
|
||||
|
||||
```bash
|
||||
# 开发模式
|
||||
./cmd dev
|
||||
|
||||
# 编译项目（这是网页端的，App/Pc/Mac客户端请查看 README_CLIENT.md）
|
||||
# 编译项目（这是网页端的，客户端请参考“.github/workflows/publish.yml”文件）
|
||||
./cmd prod
|
||||
```
|
||||
|
||||
|
||||
### 运行命令的快捷方式
|
||||
|
||||
```bash
|
||||
# 你可以使用以下命令来执行
|
||||
./cmd artisan "your command" # 运行 artisan 命令
|
||||
./cmd php "your command" # 运行 php 命令
|
||||
./cmd nginx "your command" # 运行 nginx 命令
|
||||
./cmd redis "your command" # 运行 redis 命令
|
||||
./cmd composer "your command" # 运行 composer 命令
|
||||
./cmd supervisorctl "your command" # 运行 supervisorctl 命令
|
||||
./cmd mysql "your command" # 运行 mysql 命令 (backup: 备份数据库，recovery: 还原数据库，open: 开启数据库外部端口访问，close: 关闭数据库外部端口访问)
|
||||
```
|
||||
|
||||
### SSL 配置
|
||||
|
||||
#### 方法1：自动配置
|
||||
|
||||
```bash
|
||||
# 在项目下运行命令，根据提示执行即可
|
||||
# 执行指令，根据提示执行即可
|
||||
./cmd https
|
||||
```
|
||||
|
||||
#### （或者）方法2：Nginx 代理配置
|
||||
#### 方法2：Nginx 代理配置
|
||||
|
||||
```bash
|
||||
# 1、Nginx 代理配置添加
|
||||
@ -98,7 +88,7 @@ proxy_set_header X-Forwarded-Host $http_host;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
|
||||
# 2、在项目下运行命令（如果取消 Nginx 代理配置请运行：./cmd https close）
|
||||
# 2、执行指令（如果取消 Nginx 代理配置请运行：./cmd https close）
|
||||
./cmd https agent
|
||||
```
|
||||
|
||||
@ -107,15 +97,7 @@ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
**注意：在升级之前请备份好你的数据！**
|
||||
|
||||
```bash
|
||||
# 方法1：在项目下运行命令
|
||||
./cmd update
|
||||
|
||||
# （或者）方法2：如果方法1失败请使用此方法
|
||||
git pull
|
||||
./cmd mysql backup
|
||||
./cmd uninstall
|
||||
./cmd install
|
||||
./cmd mysql recovery
|
||||
```
|
||||
|
||||
* 跨越大版本升级失败时请重试执行一次。
|
||||
@ -128,21 +110,30 @@ git pull
|
||||
1、备份原数据库
|
||||
|
||||
```bash
|
||||
# 在旧的项目下运行命令
|
||||
# 在旧的项目下执行指令
|
||||
./cmd mysql backup
|
||||
```
|
||||
|
||||
2、将 `数据库备份文件` 及 `public/uploads` 目录拷贝至新项目
|
||||
2、将旧项目以下文件和目录拷贝至新项目同路径位置
|
||||
|
||||
- `数据库备份文件`
|
||||
- `docker/appstore`
|
||||
- `public/uploads`
|
||||
|
||||
3、还原数据库至新项目
|
||||
```bash
|
||||
# 在新的项目下运行命令
|
||||
# 在新的项目下执行指令
|
||||
./cmd mysql recovery
|
||||
```
|
||||
|
||||
## 卸载项目
|
||||
|
||||
```bash
|
||||
# 在项目下运行命令
|
||||
./cmd uninstall
|
||||
```
|
||||
|
||||
### 更多指令
|
||||
|
||||
```bash
|
||||
./cmd help
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user