sftpgo/docs/build-from-source.md

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.

The following build tags are available to disable some features:

• nogcs, disable Google Cloud Storage backend
• nos3, disable S3 Compabible Object Storage backends
• nobolt, disable Bolt data provider
• nomysql, disable MySQL data provider
• nopgsql, disable PostgreSQL data provider
• nosqlite, disable SQLite data provider
• noportable, disable portable mode

If no build tag is specified all the features will be included.

The optional SQLite driver 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.

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 -tags nogcs,nos3,nosqlite -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, build date and available features like this one:

$ ./sftpgo -v
SFTPGo 0.9.6-dev-15298b0-dirty-2020-05-22T21:25:51Z -gcs -s3 +bolt +mysql +pgsql -sqlite +portable