# 咸鱼云网盘后端

**Repository Path**: qtfy2020/saltedfishcloud-backend

## Basic Information

- **Project Name**: 咸鱼云网盘后端
- **Description**: 使用SpringBoot开发的网盘后端API系统，具备公共网盘和私人网盘两个存储区域，适用于家庭NAS，协作网盘，共享资源
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 58
- **Created**: 2022-10-22
- **Last Updated**: 2022-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基于SpringBoot实现的咸鱼云网盘-后端
![](https://img.shields.io/badge/SpringBoot-2.4-green.svg)
![](https://img.shields.io/badge/Java-11-green.svg)

---

更多内容请参考项目[在线文档](https://mjt233.github.io/saltedfishcloud-backend/)
## 提示 
该项目仅为后端，不带前端，前端项目请移步[Gitee](https://gitee.com/xiaotao233/saltedfishcloud-frontend) 或 [GitHub](https://github.com/mjt233/saltedfishcloud-backend)

## 项目介绍
### 简介
咸鱼云网盘目前是一个用于共享文件和实现私人网盘基本功能的系统，同时具有公共网盘与私人网盘，公共资源站与私有存储云两不误。

具有支持代理的离线下载，FTP访问，在线解压缩，文件搜索，文件收集，文件/目录分享等功能。 

在存储上支持原始目录存储（RAW）与相同文件集中存储（UNIQUE）两种文件存储组织模式，并能随时切换（虽然有点危险）。

### 其他特性  
- 支持加载外部jar拓展（未来会继续完善拓展插件系统）
- 支持存储系统拓展，目前支持本地文件系统存储与hdfs（Hadoop）分布式存储（默认未集成，需要打包sfc-ext-hadoop-store模块jar包放到ext目录）
- 兼容低版本到高版本的升级，自动更新数据库
- 构建与部署简单，大部分参数都能在运行期间通过管理员界面进行动态配置。


## 杂杂念
该项目目前仅由我个人（学生）进行维护，是我从无基础（经验）一边学习一边开发一边重构和维护的项目，难免会有明显bug或明显的设计缺陷，对项目有任何疑问或建议，欢迎各路大佬评论或提出issue。

如果你对我这个玩具项目感兴趣，也想参与项目开发，可以fork该项目，发起Pull Request，审核和测试通过后将合并你的代码。

如果长时间未得到我的回复，可能是我刚好比较忙或忘了回复，可以试着给我发邮件。

## 快速开始    

### 0. 打包与编译
对根项目执行maven的package，执行成功后会在release目录下创建程序主程序jar包和相关文件

### 1. 准备环境
项目依赖以下组件：
- MySQL
- Redis

### 2. 运行项目

#### 方式1：启动命令行指定外部spring yml配置文件（推荐）
这个是推荐的启动方式，配置和启动也非常简单。
将主程序jar包同目录下的config.yml配置完成后，直接执行下面的命令即可启动。
当然你也可以修改file:config.yml这个参数指定任意路径的yml配置文件。
```shell
# 最简单的启动命令
java -jar sfc-core.jar --spring.config.import=file:config.yml
```
配置文件config.yml的配置内容与spring的application.yml完全一致且会覆盖默认的application.yml的内容。而config.yml中未配置的项将取application.yml的配置项作为默认值

#### 方式2：通过预设命令行变量的启动脚本（不推荐）
这是一开始没想到可以用方式1启动时编写的脚本启动方案。  
在script下修改start.bat.template或start.sh.template的程序属性变量后执行脚本即可  
参考命令：
```shell
cd script
cp start.sh.template start.sh
vim start.sh # 可根据实际需求修改start.sh中的参数
./start.sh
```
<font color="red">注意：如果连接的Redis服务器没有配置密码，请移除start脚本的`--spring.redis.password`所在的行</font>

---

项目启动后会自动初始化数据库。若初始化失败，可尝试手动给数据库执行初始化脚本，脚本位于`sfc-core/src/main/resource/sql/full.sql`