轻量级开源在线项目任务管理工具

# Install (Docker) English | **[中文文档](./README_CN.md)** - [Screenshot Preview](README_PREVIEW.md) - [Demo site](http://www.dootask.com/) ## 🙋 Upgrade to Pro version **🎉 The Pro version is now available, and you can upgrade to the Pro version for free with the following command, [Functional compare](https://www.dootask.com/pro)。** ```bash # Upgrade from the regular version to the pro version git checkout -b pro origin/pro ./cmd up -d ./cmd update ``` **QQ Group** Group No.: `546574618` ## Setup - `Docker` & `Docker Compose v2.0+` must be installed - System: `Centos/Debian/Ubuntu/macOS` - Hardware suggestion: 2 cores and above 4G memory ### Deployment（Pro Edition） ```bash # 1、Clone the repository # 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 # 2、Enter directory cd dootask # 3、Installation（Custom port installation: ./cmd install --port 2222） ./cmd install ``` ### Deployment (Normal Edition) ```bash # 1、Clone the repository # Clone projects on github git clone -b v0.13.0 --depth=1 https://github.com/kuaifan/dootask.git # Or you can use gitee git clone -b v0.13.0 --depth=1 https://gitee.com/aipaw/dootask.git # 2、Enter directory cd dootask # 3、Installation（Custom port installation: ./cmd install --port 2222） ./cmd install ``` ### Reset password ```bash # Reset default account password ./cmd repassword ``` ### Change port ```bash ./cmd port 2222 ``` ### Stop server ```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 ``` ### Development compilation ```bash # Development mode, Mac OS only ./cmd dev # Production projects, macOS only ./cmd prod ``` ### Shortcuts for running command ```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 test "your command" # To run a phpunit command ./cmd mysql "your command" # To run a mysql command (backup: Backup database, recovery: Restore database) ``` ### NGINX PROXY SSL ```bash # 1、Nginx config add 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 ./cmd https ``` ## Upgrade **Note: Please back up 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 ``` If 502 after the upgrade please run `./cmd restart` restart the service. ## Transfer Follow these steps to complete the project migration after the new project is installed: 1. Backup original database ```bash # Run command under old project ./cmd mysql backup ``` 2. Copy `database backup file` and `public/uploads` directory to the new project. 3. Restore database to new project ```bash # Run command under new project ./cmd mysql recovery ``` ## Uninstall ```bash # Running commands in a project ./cmd uninstall ```