diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 4c94d16d..00000000 --- a/INSTALL.md +++ /dev/null @@ -1,92 +0,0 @@ -# 安装说明 - -## 前置要求 -```bash -1.已安装docker-ce -2.选装docker-compose -``` -## 安装方式1 -```bash -1. 新建一个文件夹,用于存放相关数据 -2. 下载本仓库中的`docker-compose.yml`至本地,或是复制文件内容后在本地自行建立并粘贴内容 -3. 使用docker-compose启动 -4. 浏览器输入ip:5700即可进入面板 - -# 新建数据文件夹 -mkdir qinglong -cd qinglong -# 下载docker-compose.yml文件 -wget https://raw.githubusercontent.com/whyour/qinglong/develop/docker-compose.yml -# 启动 -docker-compose up -d -``` - -## 安装方式2 -```bash -# 复制下列命令在ssh执行(先安装docker) -# 注:$PWD请修改为实际你想安装的路径 - docker run -dit \ - -v $PWD/ql/config:/ql/config \ - -v $PWD/ql/log:/ql/log \ - -v $PWD/ql/db:/ql/db \ - -v $PWD/ql/repo:/ql/repo \ - -v $PWD/ql/raw:/ql/raw \ - -v $PWD/ql/scripts:/ql/scripts \ - -v $PWD/ql/jbot:/ql/jbot \ - -p 5700:5700 \ - --name qinglong \ - --hostname qinglong \ - --restart unless-stopped \ - whyour/qinglong:latest -``` -## 登录 -```bash - -打开浏览器访问宿主机ip的5700端口即可 -例如http://192.168.100.123:5700即ip:5700 - -首次登录 -账号:admin 密码:admin -会生成`auth.json` - -在ssh输入 -1.docker exec -it qinglong bash -2.cat /ql/config/auth.json - -cat查看之后返回的结果类似如下字段 - -{"username":"admin","password":"Xb-ZYP526wmg4_h6q1WqIO"} -# admin即为登录名;Xb-ZYP526wmg4_h6q1WqIO为登录密码 -``` - -输入此处记录的`username`及`password`,即可成功登录qinglong面板,登录后即可正常使用 - -## 拉取脚本 -```bash -示例 -ql repo https://github.com/xxx.git #拉取仓库 -ql raw https://raw.githubusercontent.com/xxx #拉取单个脚本 -``` -## 备份 - -所有数据都将保存在`docker-compose.yml`所在的同级目录的`data`文件夹中,如需要备份,请直接备份`docker-compose.yml`及`data`文件夹即可 - -```bash -root@debian:/opt/qinglong# ls -lah -总用量 8.0K -drwxr-xr-x 3 root root 4.0K 8月 30 01:29 . -drwxr-xr-x 4 root root 4.0K 8月 30 00:51 .. -drwxr-xr-x 8 root root 4.0K 8月 30 01:30 data --rw-r--r-- 1 root root 386 8月 30 01:29 docker-compose.yml -``` -## 更新 - -在面板执行"更新面板"任务即可 - -或者 -```bash -cd qinglong -docker-compose down -docker pull whyour/qinglong:latest -docker-compose up -d -``` diff --git a/README.md b/README.md index e5cc69d4..e87234d3 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,99 @@ A timed task management panel that supports typescript, javaScript, python3, and

- - + +

+[简体中文](./README.md) | [English](./README-en.md) + +## 功能 + +- 支持python3、javaScript、shell、typescript脚本语言 +- 支持在线编辑、新增、删除脚本 +- 支持在线编辑、新增、删除环境变量 +- 支持在线查看任务日志 +- 支持秒级任务设置 +- 支持暗黑模式 +- 支持手机端操作 + +## 部署 + +### 本机部署 + +```bash +# 待补充 +``` + +### docker 部署 + +1. docker安装 + +```bash +sudo curl -sSL get.docker.com | sh +``` + +2. 启动容器 + +```bash +docker run -dit \ + -v $PWD/ql/config:/ql/config \ + -v $PWD/ql/log:/ql/log \ + -v $PWD/ql/db:/ql/db \ + -v $PWD/ql/repo:/ql/repo \ + -v $PWD/ql/raw:/ql/raw \ + -v $PWD/ql/scripts:/ql/scripts \ + -p 5700:5700 \ + --name qinglong \ + --hostname qinglong \ + --restart unless-stopped \ + whyour/qinglong:latest +``` + +### docker-compose 部署 + +1. docker-compose 安装 + +```bash +sudo curl -L https://github.com/docker/compose/releases/download/1.16.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose +``` + +2. 启动容器 + +```bash +mkdir qinglong +wget https://raw.githubusercontent.com/whyour/qinglong/develop/docker-compose.yml + +# 启动 +docker-compose up -d +# 停止 +docker-compose down +``` + +## 链接 + +- [nevinee](https://gitee.com/evine) +- [crontab-ui](https://github.com/alseambusher/crontab-ui) +- [Ant Design](https://ant.design) +- [Ant Design Pro](https://pro.ant.design/) +- [Umijs3.0](https://umijs.org) +- [darkreader](https://github.com/darkreader/darkreader) + +## 开发 + +```bash +$ git clone git@github.com:whyour/qinglong.git +$ cd qinglong +$ cp .env.example .env +$ yarn install +$ yarn start-back +$ yarn start +``` + +打开你的浏览器,访问 http://127.0.0.1:5600 + +## 名称来源 + 青龙,又名苍龙,在中国传统文化中是四象之一、[天之四灵](https://zh.wikipedia.org/wiki/%E5%A4%A9%E4%B9%8B%E5%9B%9B%E7%81%B5)之一,根据五行学说,它是代表东方的灵兽,为青色的龙,五行属木,代表的季节是春季,八卦主震。苍龙与应龙一样,都是身具羽翼。《张果星宗》称“又有辅翼,方为真龙”。 《后汉书·律历志下》记载:日周于天,一寒一暑,四时备成,万物毕改,摄提迁次,青龙移辰,谓之岁。 @@ -36,17 +125,3 @@ A timed task management panel that supports typescript, javaScript, python3, and ## 如何安装 请查看[INSTALL.md](INSTALL.md) - -## 多谢 - -* [nevinee](https://gitee.com/evine) - -* [crontab-ui](https://github.com/alseambusher/crontab-ui) - -* [Ant Design](https://ant.design) - -* [Ant Design Pro](https://pro.ant.design/) - -* [Umijs3.0](https://umijs.org) - -* [darkreader](https://github.com/darkreader/darkreader) diff --git a/docker-compose.yml b/docker-compose.yml index c050e814..e5440dba 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -8,9 +8,7 @@ services: - ./data/db:/ql/db - ./data/scripts:/ql/scripts - ./data/repo:/ql/repo + - ./data/raw:/ql/raw ports: - "0.0.0.0:5700:5700" - environment: - - ENABLE_HANGUP=true - - ENABLE_WEB_PANEL=true - restart: always + restart: unless-stopped diff --git a/public/images/1.jpg b/public/images/1.jpg new file mode 100644 index 00000000..0985a7d9 Binary files /dev/null and b/public/images/1.jpg differ diff --git a/public/images/2.jpg b/public/images/2.jpg new file mode 100644 index 00000000..17f61370 Binary files /dev/null and b/public/images/2.jpg differ diff --git a/public/images/home.png b/public/images/home.png deleted file mode 100644 index 58fc0234..00000000 Binary files a/public/images/home.png and /dev/null differ diff --git a/public/images/login.png b/public/images/login.png deleted file mode 100644 index 9f20ed6e..00000000 Binary files a/public/images/login.png and /dev/null differ