Skip to content

Commit

Permalink
Change Windows build documentation
Browse files Browse the repository at this point in the history 
License: MIT
Signed-off-by: Dominic Della Valle <ddvpublic@gmail.com>
  • Loading branch information
@djdv
djdv committed Feb 13, 2018
1 parent 0f68fcf commit 6fb4fb5
Showing 1 changed file with 68 additions and 116 deletions.
184 changes: 68 additions & 116 deletions docs/windows.md
View file
Original file line number Diff line number Diff line change
@@ -1,142 +1,94 @@
# Building on Windows

## Install Git For Windows

As Git is used by the Go language to download dependencies, you need
to install Git, for example from http://git-scm.com/.

You also must make sure that the directory that contains the Git For
Windows binary is in the Path environment variable. Note that Git For
Windows has a 'git' binary in a 'Git\bin' directory and another one in
a 'Git\cmd' directory. You should only put the 'Git\cmd' directory in
the Path environment variable.

## Install Go

Please install the Go language as explained on
https://golang.org/doc/install.

To properly install Go, you will need to set some environment
variables. We recommend you to set them globally using the Control
Panel, as explained in the documentation above, so that these
environment variables are automatically available in all the possible
environments that you might want to use like Git Bash, Windows's cmd,
Cygwin's terminal, Windows' PowerShell and so on.

You must make sure that the GOROOT environment variable is set and
that the %GOROOT%/bin directory is in the Path environment variable.

The GOPATH environment variable should also be set to a directory that
you have created, and the %GOPATH/bin directory should also be in the
Path environment variable.

## Download go-ipfs and fix Git authentication
`go-ipfs` is built on Golang and thus depends on it for all building methods.
https://golang.org/doc/install
The `GOPATH` environment variable must be set as well.
https://golang.org/doc/code.html#GOPATH

Use the following command to download go-ipfs source code:

```
## Choose the way you want to proceed
`go-ipfs` utilizes `make` to automate builds and testing, but can be built without it using only `git` and `go`.
The `make` portions cover setting up the environment, "minimal" assumes you have a working version of `go` and `git` already.
[make→](#make)
[minimal→](#minimal)

## Make
There are currently 2 documented ways of building with `make` on Windows.
[MSYS2→](#msys2)
[Cygwin→](#cygwin)

## MSYS2
Install msys2 (http://www.msys2.org)
Run the following inside a normal `cmd` prompt (Not the MSYS2 prompt, we only need MSYS2's tools).
An explanation is below.
```
SET PATH=%PATH%;\msys64\usr\bin
pacman --noconfirm -S git make unzip
go get -u github.com/ipfs/go-ipfs
cd %GOPATH%\src\github.com\ipfs\go-ipfs
make install
```

The above command uses Git to download go-ipfs from its GitHub
repository. If you get authentication problems with Git, you might
want to take a look at
https://help.github.com/articles/caching-your-github-password-in-git/
and use the suggested solution:
| | |
| ---: | :--- |
|`SET PATH=%PATH%;\msys64\usr\bin` |Add msys2's bin to `PATH`; Defaults to: (\msys64\usr\bin)|
|`pacman --noconfirm -S git make unzip` |Install `go-ipfs` build dependencies|
|`go get -u github.com/ipfs/go-ipfs` |Fetch / Update `go-ipfs` source|
|`cd %GOPATH%\src\github.com\ipfs\go-ipfs` |Change to `go-ipfs` directory|
|`make install` |Build and install to `%GOPATH%\bin\ipfs.exe`|

You can permenantly append the MSYS2 bin to your `PATH` so that on subsequent builds you can simply run
```
git config --global credential.helper wincred
cd %GOPATH%\src\github.com\ipfs\go-ipfs
make install
```

## Choose the way you want to proceed

Now there are two ways to download, install the dependencies and to
build go-ipfs:

1) There is the "Manual Way", where you don't need to install anymore
software except the dependencies, but you have a number of commands to
type.

2) There is a way by installing 'make' through Cygwin and using it to
do nearly everything. We call this way the "Cygwin Way". It may take
much more time, because installing Cygwin can take a lot of time, but
after that it might be easier as many procedures are just a 'make'
command away.

So use the next steps below that start with "Manual Way" if that's the
way you want, otherwise scroll down a bit and use the "Cygwin Way"
steps below.
## Cygwin
Install Cygwin (https://www.cygwin.com)
During the install, select the devel packages `git` & `make`, archive package `unzip`, and net package `curl`
Run the following inside a normal `cmd` prompt (Not the Cygwin prompt, we only need Cygwin's tools)
An explanation is below.
```
SET PATH=%PATH%;\cygwin64\bin
mkdir %GOPATH%\src\github.com\ipfs
cd %GOPATH%\src\github.com\ipfs
git clone https://github.com/ipfs/go-ipfs.git
cd %GOPATH%\src\github.com\ipfs\go-ipfs
make install
```
| | |
| ---: | :--- |
|`SET PATH=%PATH%;\cygwin64\bin` |Add Cygwin's bin to PATH; Defaults to: (\cygwin64\bin)|
|`mkdir %GOPATH%\src\github.com\ipfs`<br/>`cd %GOPATH%\src\github.com\ipfs`<br/>`git clone https://github.com/ipfs/go-ipfs.git` |Fetch / Update `go-ipfs` source|
|`cd %GOPATH%\src\github.com\ipfs\go-ipfs` |Change to `go-ipfs` directory|
|`make install` |Build and install to `%GOPATH%\bin\ipfs.exe`|

## Manual Way: download and install dependencies
You can permanently append the Cygwin bin to your `PATH` so that on subsequent builds you can simply run
```
cd %GOPATH%\src\github.com\ipfs\go-ipfs
make install
```

The following commands should download or update go-ipfs dependencies
and then install them:
## Minimal
While it's possible to build `go-ipfs` with `go` alone, we'll be using `git` and `gx` for practical source management.
You can use whichever version of `git` you wish but the Windows builds at <https://git-scm.com> are recommended. `git` must be in your `PATH` for `go get` to recognize and use it.
`gx` and its go-hook `gx-go` will be built by us. Alternativley you may use [prebuilt binaries](https://dist.ipfs.io/#gx) by placing them in your `PATH` and skipping `go get` for `gx` and `gx-go` below.

```
SET PATH=%PATH%;%GOPATH%\bin
go get -u github.com/whyrusleeping/gx
go get -u github.com/whyrusleeping/gx-go
go get -u -d github.com/ipfs/go-ipfs
cd %GOPATH%/src/github.com/ipfs/go-ipfs
gx --verbose install --global
```

## Manual Way: build go-ipfs

To actually build go-ipfs, first go to the cmd/ipfs directory:

```
cd cmd\ipfs
```

Then get the current Git commit:

```
git rev-parse --short HEAD
```

It will output a small number of hex characters that you must pass to
the actual build command (replace XXXXXXX with these characters):

```
go install -ldflags="-X "github.com/ipfs/go-ipfs/repo/config".CurrentCommit=XXXXXXX"
```

After that ipfs should have been built and should be available in
"%GOPATH%\bin".

You can check that the ipfs you built has the right version using:

```
ipfs version --commit
```

It should output something like "ipfs version 0.4.0-dev-XXXXXXX" where
XXXXXXX is the current commit that you passed to the build command.

## Cygwin way: install Cygwin

Install Cygwin as explained in the Cygwin documentation:

http://cygwin.com/install.html

By default Cygwin will not install 'make', so you should click on the
"Devel" category during the Cygwin installation process and then check
the 'make' package.

## Cygwin way: build go-ipfs

To build go-ipfs using Cygwin you just need to open a Cygwin Terminal
and then type the following commands:

```
cd $GOPATH/src/github.com/ipfs/go-ipfs
make install
```

After that ipfs should have been built and should be available in
"%GOPATH%\bin".

You can check that the ipfs you built has the right version using:
The syntax for the next command is different depending on how it's executed. If you're on the interactive command line vs executing from inside the batch/cmd interpriter.
interactive: `FOR /F %V IN ('git rev-parse --short HEAD') do set SHA=%V`
interpreter: `FOR /F %%V IN ('git rev-parse --short HEAD') do set SHA=%%V`

```
ipfs version --commit
go install -ldflags="-X "github.com/ipfs/go-ipfs/repo/config".CurrentCommit=%SHA%"
```

0 comments on commit 6fb4fb5

Please sign in to comment.