Skip to content

Commit

Permalink
完善文档
Browse files Browse the repository at this point in the history
  • Loading branch information
newpanjing committed May 13, 2022
1 parent 98c4141 commit 71b51b1
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ go get && go build

## 多语言SDK

> 使用gofound的多语言SDK,可以在不同语言中使用gofound。但是请注意,版本号与gofound需要一致。主版本和子版本号,修订版不一致不影响。
[Java](https://github.com/newpanjing/gofound-java)

[Python](https://github.com/newpanjing/gofound-python)
Expand Down
77 changes: 70 additions & 7 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,25 @@

```shell
./gofound -h

-addr string
set server addr and port. (default "127.0.0.1:5678")
设置监听地址和端口 (default "127.0.0.1:5678")
-auth string
开启认证,例如: admin:123456
-data string
set data dataDir. (default "./data")
设置数据存储目录 (default "./data")
-debug
设置是否开启调试模式 (default true)
-dictionary string
设置词典路径 (default "./data/dictionary.txt")
-enableAdmin
设置是否开启后台管理 (default true)
-enableGzip
是否开启gzip压缩 (default true)
-gomaxprocs int
设置GOMAXPROCS (default 20)
-shard int
文件分片数量 (default 10)

```

Expand All @@ -28,6 +43,14 @@
./gofound --addr=192.168.1.1:5678
```

### auth

设置admin和api接口的用户名密码,采用basic auth

```shell
./gofound --auth=admin:123456
```

### data

指定索引数据存储的目录,可以是相对路径,也可以是绝对路径。
Expand All @@ -41,10 +64,50 @@
./gofound --data=/www/data
```

## 生产模式
在生产模式下,不会输出一些不必要的日志,只输出错误日志。设置生产模式为`export GIN_MODE=release`
与GIN框架保持一致。
### debug

设置是否开启调试模式。默认为`true`

```shell
./gofound --debug=false
```

### dictionary

设置自定义词典路径。默认为`./data/dictionary.txt`

```shell
./gofound --dictionary=./data/dictionary.txt
```

### enableAdmin

设置是否开启后台管理。默认为`true`

```shell
export GIN_MODE=release && ./gofound
```
./gofound --enableAdmin=false
```

### enableGzip

设置是否开启gzip压缩。默认为`true`

```shell
./gofound --enableGzip=false
```

### gomaxprocs

设置GOMAXPROCS。默认为CPU数量X2。

```shell
./gofound --gomaxprocs=10
```

### shard

设置文件分片数量。默认为`10`。分片越多查询会越快,相反的磁盘IO和CPU会越多。

```shell
./gofound --shard=10
```
2 changes: 2 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
+ 优化内存占用
+ 提升查询速度
+ 增加自定义词库配置
+ 增加Admin界面
+ 增加认证功能

## 1.0.2
+ 完成基础功能

0 comments on commit 71b51b1

Please sign in to comment.