Skip to content

Latest commit

 

History

History
121 lines (90 loc) · 3.98 KB

BuildingFromSource.md

File metadata and controls

121 lines (90 loc) · 3.98 KB
Raw

Building from Source

Table of Contents generated with DocToc

Requirements

  1. Linux, Unix, OS X or Windows
  2. The Golang compiler tools (1.5-1.6)

Linux, Unix, OS X

Setting up a Go workspace

First you will need to setup a Go workspace. If you already have one setup, you can skip this step.

Replace ~/Golang with any path you'd like to you use. The path should not already exist.

export GOPATH=~/Golang
mkdir -p "$GOPATH"

Also, ensure that the Go binaries are available on the command line by checking that the PATH variable is set correctly. Run echo $PATH to view the current variable. If it doesn't contain the path to your Golang installation's bin folder, add it by running export PATH=$PATH:/usr/local/golang/bin where /usr/local/golang is the path to the Golang installation directory.

Building Log Courier

Run the following commands to download and build the latest version of Log Courier. Ensure you run all commands in the same session to maintain the GO15VENDOREXPERIMENT variable.

export GO15VENDOREXPERIMENT=1
go get -d github.com/driskell/log-courier
cd $GOPATH/src/github.com/driskell/log-courier
go generate . ./lc-admin
go install . ./lc-admin ./lc-tlscert

To build a downloaded copy of Log Courier, such as a beta version, use the following instructions instead. Ensure you run all commands in the same session to maintain the GO15VENDOREXPERIMENT variable.

export GO15VENDOREXPERIMENT=1
mkdir -p $GOPATH/src/github.com/driskell/log-courier
*Place the contents of the downloaded copy into the above folder*
go generate ./lc-lib/config ./lc-lib/core
go install . ./lc-admin ./lc-tlscert

Results

The log-courier binaries (log-courier, lc-tlscert, lc-admin etc.) can then be found in the Go workspace's bin folder (e.g. ~/Golang/bin).

Some ready-made service scripts for various platforms can be found in the contrib/initscripts folder of the Log Courier repository.

Windows

WARNING: These instructions have not yet been tested. If you have any problems please create a new issue. If you needed to do something different, please raise a pull request to update this with what works! Thanks.

Setting up a Go workspace

First you will need to setup a Go workspace. If you already have one setup, you can skip this step.

Replace C:\Golang with any path you'd like to you use. The path should not already exist.

set GOPATH=C:\Golang
mkdir %GOPATH%

Also, ensure that the Go binaries are available on the command line by checking that the PATH variable is set correctly. Run set PATH to view the current variable. If it doesn't contain the path to your Golang installation's bin folder, add it by running set PATH=%PATH%;C:\Go\bin where C:\Go is the path to the Golang installation directory.

Building Log Courier

Run the following commands to download and build the latest version of Log Courier. Ensure you run all commands in the same session to maintain the GO15VENDOREXPERIMENT variable.

set GO15VENDOREXPERIMENT=1
go get -d github.com/driskell/log-courier
cd %GOPATH%/src/github.com/driskell/log-courier
go generate ./lc-lib/config ./lc-lib/core
go install . ./lc-admin ./lc-tlscert

Results

The log-courier binaries (log-courier, lc-tlscert, lc-admin etc.) can then be found in the Go workspace's bin folder (e.g. C:\Golang\bin).