Skip to content

Commit 57f1059

Browse files
committed
add readme
1 parent 7463a8c commit 57f1059

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# EasyDFS
2+
> 简洁易用的对象存储系统
3+
4+
## 使用说明
5+
### 1.准备目录
6+
创建或指定一个目录作为存放该系统的根目录
7+
### 2.准备配置
8+
`easy_dfs` 可执行文件和 `app.yml` 配置文件复制到该目录下,可自定义配置 `app.yml` 内的配置信息,比如端口
9+
### 3.运行系统
10+
直接执行 `easy_dfs` 可执行文件即可,比如 `./easy_dfs.exe``./easy_dfs`
11+
### 4.生成密钥
12+
根据API接口中的`AccessKey`目录对应方法生成密钥对
13+
### 5.创建Bucket
14+
根据API接口中的`Bucket`目录创建对应存储桶
15+
### 5.上传/删除文件
16+
根据API接口中的`File`目录调取对应接口上传或删除文件
17+
18+
## 开发说明
19+
- 拉取代码到本地,并将`app.yml.example`复制为`app.yml`
20+
- 安装依赖 `go mod tidy`
21+
- 运行 `go run main.go``go build` 编译后运行
22+
- 访问 `http://localhost:18088` 查看接口文档
23+
- 代码中的 `app.yml` 是配置文件,可自定义配置
24+
25+
## 其他说明
26+
- 非生产环境时上传的文件和配置都在 `tmp/`
27+
- 生产环境上传的文件在 `storage/` 下,配置文件在 `config/`

0 commit comments

Comments
 (0)