Unverified Commit b0f1ab7e authored by Jin Hai's avatar Jin Hai Committed by GitHub
Browse files

Merge pull request #359 from youny626/0.6.0 

Update build.sh and install.md
parents 140a7a59 817be9a6

CHANGELOG.md

+1 −0
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ Please mark all change in change log and use the ticket from JIRA. 
- \#314 - add Find FAISS in CMake

- \#310 - Add Q&A for 'protocol https not supported or disable in libcurl' issue

- \#322 - Add option to enable / disable prometheus 

- \#358 - Add more information in build.sh and install.md



## Task

core/build.sh

+85 −84
Original line number Diff line number Diff line
@@ -18,8 +18,7 @@ FAISS_ROOT="" #FAISS root path 
FAISS_SOURCE="BUNDLED"

WITH_PROMETHEUS="ON"



while getopts "p:d:t:f:ulrcgjhxzme" arg

do

while getopts "p:d:t:f:ulrcgjhxzme" arg; do

  case $arg in

  p)

    INSTALL_PREFIX=$OPTARG
@@ -35,8 +34,8 @@ do 
    FAISS_SOURCE="AUTO"

    ;;

  u)

                echo "Build and run unittest cases" ;

                BUILD_UNITTEST="ON";

    echo "Build and run unittest cases"

    BUILD_UNITTEST="ON"

    ;;

  l)

    RUN_CPPLINT="ON"
@@ -75,7 +74,9 @@ parameter: 
-p: install prefix(default: $(pwd)/milvus)

-d: db data path(default: /tmp/milvus)

-t: build type(default: Debug)

-f: faiss root path(default: empty)

-f: FAISS root path(default: empty). The path should be an absolute path

    containing the pre-installed lib/ and include/ directory of FAISS. If they can't be found,

    we will build the original FAISS from source instead.

-u: building unit test options(default: OFF)

-l: run cpplint, clang-format and clang-tidy(default: OFF)

-r: remove previous build directory(default: OFF)
@@ -84,7 +85,7 @@ parameter: 
-j: use jfrog cache build directory(default: OFF)

-g: build GPU version(default: OFF)

-m: build with MKL(default: OFF)

-e: build without prometheus

-e: build without prometheus(default: OFF)

-h: help



usage:

install.md

+9 −4
Original line number Diff line number Diff line
@@ -29,10 +29,15 @@ $ ./build.sh -t Release 
```



By default, it will build CPU version. To build GPU version, add `-g` option

```

```shell

$ ./build.sh -g

```



If you want to know the complete build options, run

```shell

$./build.sh -h

```



When the build is completed, all the stuff that you need in order to run Milvus will be installed under `[Milvus root path]/core/milvus`.



## Launch Milvus server
@@ -43,13 +48,13 @@ $ cd [Milvus root path]/core/milvus 


Add `lib/` directory to `LD_LIBRARY_PATH`



```

```shell

$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:[Milvus root path]/core/milvus/lib

```



Then start Milvus server:



```

```shell

$ cd scripts

$ ./start_server.sh

```
@@ -65,7 +70,7 @@ $ ./stop_server.sh 
`protocol https not supported or disabled in libcurl`.

First, make sure you have `libcurl4-openssl-dev` installed in your system.

Then try reinstall CMake from source with `--system-curl` option:

```

```shell

$ ./bootstrap --system-curl 

$ make 

$ sudo make install