From f44a16aefaa0e883755787bb7ca925f75b5e764d Mon Sep 17 00:00:00 2001 From: jmal Date: Sat, 20 Aug 2022 01:01:27 +0800 Subject: [PATCH] update: readme --- README.md | 91 ++++++++++++---------------------------------- README_en_US.md | 96 +++++++++++++++---------------------------------- 2 files changed, 50 insertions(+), 137 deletions(-) diff --git a/README.md b/README.md index b08e3e6..1884ed9 100644 --- a/README.md +++ b/README.md @@ -3,94 +3,47 @@ JmalCloud 是一款私有云存储网盘项目，能够简单安全管理您的 ✅ 支持图片,音频,视频等文件的在线预览 +✅ 支持word、excel、ppt、流程和思维导图的编辑和预览 + +✅ 支持x86、arm64(Centos/Debian/Ubuntu/macOS) + ✅ 提供强大的在线文本编辑器 ✅ 支持超大文件上传，断点续传 ✅ 支持webDAV -### 线上预览地址: +### 线上预览地址: 地址1: https://www.jmal.top , 用户名:admin,密码:jmalcloud (部分权限) 地址2: https://cloud1.jmal.top , 用户名:admin,密码:jmalcloud (所有权限) -部分截图: +### 部署 + +- 必须安装：`Docker` 和 `Docker Compose v2.0+` + +```shell +# 1、克隆项目到您的本地或服务器 +git clone https://github.com/jamebal/jmal-cloud-server.git + +# 2、进入目录 +cd jmal-cloud-server + +# 3、一键安装 +./install.sh +``` +> 访问7070端口试试看 + +### 部分截图: ![image0](https://www.jmal.top/api/file/jmal/jmalcloud/releases/%E6%88%AA%E5%B1%8F%20192.png?shareKey=601b697575858bec45c457a3&o=preview) ![image1](https://www.jmal.top/api/file/jmal/jmalcloud/releases/%E6%88%AA%E5%B1%8F%20191.png?shareKey=601b697575858bec45c457a3&o=preview) -### 部署 -**以下两种启动方式二选一, 推荐使用[docker-compose](https://docs.docker.com/compose//)** - -> docker run 方式启动 - -```shell -docker run \ ---restart=always \ ---name jmalcloud \ --p 7070:80 \ --p 7071:8080 \ --p 7072:8088 \ --p 27018:27017 \ --v /Users/jmal/temp/jmalcloud-docker/files/:/jmalcloud/files/ \ --v /Users/jmal/temp/jmalcloud-docker/db/:/data/db/ \ --d registry.cn-guangzhou.aliyuncs.com/jmalcloud/jmalcloud:latest -``` - -> docker-compose 方式启动 - -编辑docker-compose.yml文件 - -```yaml -version: "3.5" -services: - jmalcloud: - image: registry.cn-guangzhou.aliyuncs.com/jmalcloud/jmalcloud:latest - container_name: jmalcloud - volumes: - - /Users/jmal/temp/jmalcloud-docker/files/:/jmalcloud/files/ - - /Users/jmal/temp/jmalcloud-docker/db/:/data/db/ - ports: - - "7070:80" - - "7071:8080" - - "7072:8088" - - "27018:27017" -``` - -启动：在docker-compose.yml文件目录下运行以下命令 - -```shell -docker-compse up -d -``` - -> 启动参数 - -Port : -`7070` : 网盘入口 -`7071` : 博客入口 -`7072` : 网盘api入口, 例如：http://localhost:7072/public/doc.html -`27018` : MongoDB -Volume : -`/jmalcloud/files/` : 网盘文件存储目录 -`/data/db/` : mongodb数据存储目录 - -> 访问试试看 - -启动后等待40秒左右，访问7070端口看到如下界面，说明部署成功 - -![](https://www.jmal.top/api/file/jmal/Image/Document/2021-03/20210301%E6%88%AA%E5%B1%8F%20144.png) - ### 浏览器支持 | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | | --------- | --------- | --------- | --------- | | IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions -### 后续更新 - -- [ ] iOS APP -- [ ] Android APP -- [ ] PC - ### 许可 [MIT](https://github.com/jamebal/jmal-cloud-view/blob/master/LICENSE) license. diff --git a/README_en_US.md b/README_en_US.md index ec0a3b6..7306699 100644 --- a/README_en_US.md +++ b/README_en_US.md @@ -1,85 +1,45 @@ # JmalCloud Personal Netdisk ｜ [中文](https://github.com/jamebal/jmal-cloud-view/blob/master/README.md) JmalCloud It's a private cloud storage project that makes it simple and secure to manage your files in the cloud -✅ Support online preview of images, audio, video and other files +✅ Supports online preview of images, audio, video and other files -✅ Provide powerful online text editor +✅ Supports editing and previewing of Word, Excel, PPT, process and mind map -✅ Support oversized file upload, breakpoint transfer +✅ support x86, arm64 (Centos/Debian/Ubuntu/macOS) -✅ Support webDAV +✅ provides a powerful online text editor -### Online preview address: +✅ Supports large file uploading and resumable uploading + +✅ supports webDAV + +### Online preview address: Address 1: https://www.jmal.top , Username:admin,Password:jmalcloud (partial access) Address 2: https://cloud1.jmal.top , Username:admin,Password:jmalcloud (all permissions) -Some screenshots: + +### deployment + +- You must install: 'Docker' and 'Docker Compose V2.0 +' + +```shell +# 1. Clone the project to your local or server +git clone https://github.com/jamebal/jmal-cloud-server.git + +# 2. Enter the directory +cd jmal-cloud-server + +# 3. One-click installation +./install.sh +``` + +> Try access port 7070 + +### Some screenshots: ![image0](https://www.jmal.top/api/file/jmal/jmalcloud/releases/%E6%88%AA%E5%B1%8F%20192.png?shareKey=601b697575858bec45c457a3&o=preview) ![image1](https://www.jmal.top/api/file/jmal/jmalcloud/releases/%E6%88%AA%E5%B1%8F%20191.png?shareKey=601b697575858bec45c457a3&o=preview) - -### deploy -**Either of the following two startup methods is recommended[docker-compose](https://docs.docker.com/compose//)** - -> docker run - -```shell -docker run \ ---restart=always \ ---name jmalcloud \ --p 7070:80 \ --p 7071:8080 \ --p 7072:8088 \ --p 27018:27017 \ --v /Users/jmal/temp/jmalcloud-docker/files/:/jmalcloud/files/ \ --v /Users/jmal/temp/jmalcloud-docker/db/:/data/db/ \ --d registry.cn-guangzhou.aliyuncs.com/jmalcloud/jmalcloud:latest -``` - -> docker-compose - -docker-compose.yml - -```yaml -version: "3.5" -services: - jmalcloud: - image: registry.cn-guangzhou.aliyuncs.com/jmalcloud/jmalcloud:latest - container_name: jmalcloud - volumes: - - /Users/jmal/temp/jmalcloud-docker/files/:/jmalcloud/files/ - - /Users/jmal/temp/jmalcloud-docker/db/:/data/db/ - ports: - - "7070:80" - - "7071:8080" - - "7072:8088" - - "27018:27017" -``` - -Start: Run the following command in the docker-compose.yml file directory - -```shell -docker-compse up -d -``` - -> Start-up parameters - -Port : -`7070` : Web portal -`7071` : Blog portal -`7072` : Web api portal, 例如：http://localhost:7072/public/doc.html -`27018` : MongoDB -Volume : -`/jmalcloud/files/` : Netdisk file storage directory -`/data/db/` : mongodb data storage directory - -> Try visiting - -Wait for about 40 seconds after startup, access port 7070 and see the following screen, indicating successful deployment - -![](https://www.jmal.top/api/file/jmal/Image/Document/2021-03/20210301%E6%88%AA%E5%B1%8F%20144.png) - ### Browser Support | [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari |