Skip to content

Commit c3c1a48

Browse files
authored
docs: Update instructions to build from source. (#4300)
These instructions are updated for the build process with Go modules. Dgraph's own dependencies are not fetched when using `go get`, so cloning the repository and running make install (go build / go install) within the source directory works the expected way. * Use make install. * Ratel build instructions are available from github.com/dgraph-io/ratel.
1 parent 0cfbdc3 commit c3c1a48

2 files changed

Lines changed: 27 additions & 6 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,21 @@ docker pull dgraph/dgraph:latest
4343

4444
## Install from Source
4545

46-
If you want to install from source, you can use `go get` to install to `$GOPATH/bin`.
46+
If you want to install from source, install Go 1.11+ or later and the following dependencies:
4747

48+
Ubuntu:
4849
```bash
49-
go get -v github.com/dgraph-io/dgraph/dgraph
50+
sudo apt-get update
51+
sudo apt-get install gcc make
52+
```
53+
54+
Then clone the Dgraph repository and use `make install` to install the Dgraph binary to `$GOPATH/bin`.
55+
56+
57+
```bash
58+
git clone https://github.com/dgraph-io/dgraph.git
59+
cd ./dgraph
60+
make install
5061
```
5162

5263
## Get Started

wiki/content/deploy/index.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,27 @@ dgraph
4949
#### Building from Source
5050

5151
{{% notice "note" %}}
52-
Ratel UI is closed source right now, so you cannot build it from source. But you can connect to your Dgraph instance
53-
through Ratel UI installed using any of the methods listed above.
52+
You can build the Ratel UI from source seperately following its build
53+
[instructions](https://github.com/dgraph-io/ratel/blob/master/INSTRUCTIONS.md).
54+
Ratel UI is distributed via Dgraph releases using any of the download methods
55+
listed above.
5456
{{% /notice %}}
5557

56-
Make sure you have [Go](https://golang.org/dl/) (version >= 1.8) installed.
58+
Make sure you have [Go](https://golang.org/dl/) v1.11+ installed.
59+
60+
You'll need the following dependencies to install Dgraph using `make`:
61+
```bash
62+
sudo apt-get update
63+
sudo apt-get install gcc make
64+
```
5765

5866
After installing Go, run
5967
```sh
6068
# This should install dgraph binary in your $GOPATH/bin.
6169

62-
go get -v github.com/dgraph-io/dgraph/dgraph
70+
git clone https://github.com/dgraph-io/dgraph.git
71+
cd ./dgraph
72+
make install
6373
```
6474

6575
If you get errors related to `grpc` while building them, your

0 commit comments

Comments
 (0)