Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.63 KB

build-from-source.md

File metadata and controls

34 lines (22 loc) · 1.63 KB
Raw

Build SFTPGo from source

Install the package to your $GOPATH with the go tool from shell:

go get -u github.com/drakkan/sftpgo

Make sure Git is installed on your machine and in your system's PATH.

SFTPGo depends on go-sqlite3 which is a CGO package and so it requires a C compiler at build time. On Linux and macOS, a compiler is easy to install or already installed. On Windows, you need to download MinGW-w64 and build SFTPGo from its command prompt.

The compiler is a build time only dependency. It is not required at runtime.

If you don't need SQLite, you can also get/build SFTPGo setting the environment variable GCO_ENABLED to 0. This way, SQLite support will be disabled and PostgreSQL, MySQL, bbolt and memory data providers will keep working. In this way, you don't need a C compiler for building.

Version info, such as git commit and build date, can be embedded setting the following string variables at build time:

  • github.com/drakkan/sftpgo/utils.commit
  • github.com/drakkan/sftpgo/utils.date

For example, you can build using the following command:

go build -i -ldflags "-s -w -X github.com/drakkan/sftpgo/utils.commit=`git describe --always --dirty` -X github.com/drakkan/sftpgo/utils.date=`date -u +%FT%TZ`" -o sftpgo

You should get a version that includes git commit and build date like this one:

$ sftpgo -v
SFTPGo version: 0.9.0-dev-90607d4-dirty-2019-08-08T19:28:36Z