Installing¶
This section provides an overview and guidance for installing docproc.
Binary Releases¶
You can download pre-built binary releases of docproc for different platforms from https://github.com/marcusva/docproc/releases. If your platform is not listed, you can also build docproc from source. Take a look at Building From Source for more details, if necessary.
Installation¶
Unpack the matching distribution package for your operating system and copy the required binaries into the desired target location.
Example for Windows:
> unzip docproc-0.0.1-windows-amd64.zip
> cd docproc-0.0.1-windows-amd64
> copy docproc*.exe C:\docproc\bin
Example for Linux:
$ unzip docproc-0.0.1-linux-amd64.zip
$ cd docproc-0.0.1-linux-amd64
$ cp docproc*. /usr/local/bin
Set up the configuration files as appropriate and you are good to go.
Building From Source¶
You can download source snapshots of docproc from https://github.com/marcusva/docproc/tags. Besides the source distribution, you also will need the following tools:
- Golang 1.8 or newer (https://golang.org/)
- dep (https://golang.github.io/dep/)
docproc relies on a message queue implementation. It currently supports the following message queues:
- beanstalk - http://kr.github.io/beanstalkd/
- NSQ - http://nsq.io/
- NATS - https://nats.io/
Unpack the source snapshot into your GOPATH
, run the dep
command and build docproc.
On Unix and Linux, unpack docproc-0.0.3.tar.gz into GOPATH
, then
run
$ cd $GOPATH/github.com/marcusva/docproc
$ make install
This will install the docproc binaries into /usr/local/bin
by default. You
can change the PREFIX
as well as DESTDIR
for your own
installation scheme.
On Windows, unpack docproc-0.0.3.zip into GOPATH
, then run
> cd %GOPATH%/github.com/marcusva/docproc
> make.bat
Those commands will build docproc and put the binaries, documentation and examples into the dist folder. Copy them into the desired locations.