Skip to content

Commit

Permalink
[skip ci] Updated INSTALL.md. (#3016)
Browse files Browse the repository at this point in the history
* Minor editorial updates.

Signed-off-by: Amy Hong <yun.hong@zilliz.com>

* [skip ci] Updated INSTALL.md.

Signed-off-by: Amy Hong <yun.hong@zilliz.com>

* [skip ci] Deleted "cd/home".

Signed-off-by: Amy Hong <yun.hong@zilliz.com>
  • Loading branch information
AmyYH committed Jul 25, 2020
1 parent 290e253 commit fa0f149
Showing 1 changed file with 25 additions and 39 deletions.
64 changes: 25 additions & 39 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@

- [Build from source](#build-from-source)

- [Requirements](#requirements)
- [Requirements](#requirements)

- [Compilation](#compilation)
- [Compilation](#compilation)

- [Launch Milvus server](#launch-milvus-server)
- [Launch Milvus server](#launch-milvus-server)

- [Compile Milvus on Docker](#compile-milvus-on-docker)
- [Compile Milvus on Docker](#compile-milvus-on-docker)

- [Step 1 Pull Milvus Docker images](#step-1-pull-milvus-docker-images)
- [Step 1 Pull Milvus Docker images](#step-1-pull-milvus-docker-images)

- [Step 2 Start the Docker container](#step-2-start-the-docker-container)
- [Step 2 Start the Docker container](#step-2-start-the-docker-container)

- [Step 3 Download Milvus source code](#step-3-download-milvus-source-code)
- [Step 3 Download Milvus source code](#step-3-download-milvus-source-code)

- [Step 4 Compile Milvus in the container](#step-4-compile-milvus-in-the-container)
- [Step 4 Compile Milvus in the container](#step-4-compile-milvus-in-the-container)

- [Troubleshooting](#troubleshooting)

- [Error message: `protocol https not supported or disabled in libcurl`](#error-message-protocol-https-not-supported-or-disabled-in-libcurl)
- [Error message: `protocol https not supported or disabled in libcurl`](#error-message-protocol-https-not-supported-or-disabled-in-libcurl)

- [Error message: `internal compiler error`](#error-message-internal-compiler-error)
- [Error message: `internal compiler error`](#error-message-internal-compiler-error)

- [Error message: `error while loading shared libraries: libmysqlpp.so.3`](#error-message-error-while-loading-shared-libraries-libmysqlppso3)
- [Error message: `error while loading shared libraries: libmysqlpp.so.3`](#error-message-error-while-loading-shared-libraries-libmysqlppso3)

- [CMake version is not supported](#cmake-version-is-not-supported)
- [CMake version is not supported](#cmake-version-is-not-supported)

<!-- /TOC -->

Expand All @@ -42,7 +42,7 @@

- CentOS 7

> Note: If your Linux operating system does not meet the requirements, we recommend that you pull a Docker image of [Ubuntu 18.04](https://docs.docker.com/install/linux/docker-ce/ubuntu/) or [CentOS 7](https://docs.docker.com/install/linux/docker-ce/centos/) as your compilation environment.
> Note: If your Linux operating system does not meet the requirements, we recommend that you pull a Docker image of [Ubuntu 18.04](https://docs.docker.com/install/linux/docker-ce/ubuntu/) or [CentOS 7](https://docs.docker.com/install/linux/docker-ce/centos/) as your compilation environment.
- GCC 7.0 or higher to support C++ 17

Expand All @@ -58,48 +58,35 @@ For GPU-enabled version, you will also need:

### Compilation

#### Step 1 Install dependencies
#### Step 1 Download Milvus source code

##### Install in Ubuntu
Download the latest Milvus source code and change directory:

```shell
$ cd [Milvus root path]/core
$ ./ubuntu_build_deps.sh
```

##### Install in CentOS

```shell
$ cd [Milvus root path]/core
$ ./centos7_build_deps.sh
$ git clone https://github.com/milvus-io/milvus
$ cd ./milvus/core
```

#### Step 2 Build
#### Step 2 Install dependencies

```shell
$ cd [Milvus root path]/core
$ ./build.sh -t Debug
```

or
##### Install in Ubuntu

```shell
$ ./build.sh -t Release
$ ./ubuntu_build_deps.sh
```

By default, it will build CPU-only version. To build GPU version, add `-g` option.
##### Install in CentOS

```shell
$ ./build.sh -g
$ ./centos7_build_deps.sh
```

If you want to know the complete build options, run the following command.
#### Step 3 Build Milvus source code

```shell
$./build.sh -h
$ ./build.sh -t Debug
```

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

### Launch Milvus server

Expand Down Expand Up @@ -176,7 +163,6 @@ $ docker exec -it [container_id] bash
Download latest Milvus source code:

```shell
$ cd /home
$ git clone https://github.com/milvus-io/milvus
```

Expand Down

0 comments on commit fa0f149

Please sign in to comment.