date: “2016-12-01T16:00:00+02:00” title: “Installation from source” slug: “install-from-source” weight: 10 toc: false draft: false menu: sidebar:
parent: "installation"
name: "From source"
weight: 30
identifier: "install-from-source"
You should install go and set up your go
environment correctly. In particular, it is recommended to set the $GOPATH
environment variable and to add the go bin directory or directories
${GOPATH//://bin:}/bin
to the $PATH
. See the Go wiki entry for
GOPATH.
Next, install Node.js with npm which is required to build the JavaScript and CSS files. The minimum supported Node.js version is {{< min-node-version >}} and the latest LTS version is recommended.
Note: When executing make tasks that require external tools, like
make misspell-check
, Gitea will automatically download and build these as
necessary. To be able to use these, you must have the "$GOPATH/bin"
directory
on the executable path. If you don’t add the go bin directory to the
executable path, you will have to manage this yourself.
Note 2: Go version {{< min-go-version >}} or higher is required. However, it is recommended to obtain the same version as our continuous integration, see the advice given in
go
{{< min-go-version >}} or higher, see herenode
{{< min-node-version >}} or higher with npm
, see heremake
, see
bindata
: Build a single monolithic binary, with all assets included.sqlite sqlite_unlock_notify
: Enable support for a
SQLite3 database. Suggested only for tiny
installations.pam
: Enable support for PAM (Linux Pluggable Authentication Modules). Can
be used to authenticate local users or extend authentication to methods
available to PAM.gogit
: (EXPERIMENTAL) Use go-git variants of Git commands.Bundling assets into the binary using the bindata
build tag is recommended for
production deployments. It is possible to serve the static assets directly via a reverse proxy,
but in most cases it is not necessary, and assets should still be bundled in the binary.
You may want to exclude bindata while developing/testing Gitea.
To include assets, add the bindata
tag:
TAGS="bindata" make build
In the default release build of our continuous integration system, the build
tags are: TAGS="bindata sqlite sqlite_unlock_notify"
. The simplest
recommended way to build from source is therefore:
TAGS="bindata sqlite sqlite_unlock_notify" make build
The build
target is split into two sub-targets:
make backend
which requires Go {{< min-go-version >}} or greater.make frontend
which requires Node.js {{< min-node-version >}} or greater.If pre-built frontend files are present it is possible to only build the backend:
TAGS="bindata" make backend
After following the steps above, a gitea
binary will be available in the working directory.
It can be tested from this directory or moved to a directory with test data. When Gitea is
launched manually from command line, it can be killed by pressing Ctrl + C
.
./gitea web
Gitea will search for a number of things from the CustomPath
. By default this is
the custom/
directory in the current working directory when running Gitea. It will also
look for its configuration file CustomConf
in $CustomPath/conf/app.ini
, and will use the
current working directory as the relative base path AppWorkPath
for a number configurable
values. Finally the static files will be served from StaticRootPath
which defaults to the AppWorkPath
.
These values, although useful when developing, may conflict with downstream users preferences.
One option is to use a script file to shadow the gitea
binary and create an appropriate
environment before running Gitea. However, when building you can change these defaults
using the LDFLAGS
environment variable for make
. The appropriate settings are as follows
CustomPath
use LDFLAGS="-X \"code.gitea.io/gitea/modules/setting.CustomPath=custom-path\""
CustomConf
you should use -X \"code.gitea.io/gitea/modules/setting.CustomConf=conf.ini\"
AppWorkPath
you should use -X \"code.gitea.io/gitea/modules/setting.AppWorkPath=working-path\"
StaticRootPath
you should use -X \"code.gitea.io/gitea/modules/setting.StaticRootPath=static-root-path\"
-X \"code.gitea.io/gitea/modules/setting.PIDFile=/run/gitea.pid\"
Add as many of the strings with their preceding -X
to the LDFLAGS
variable and run make build
with the appropriate TAGS
as above.
Running gitea help
will allow you to review what the computed settings will be for your gitea
.
The go
compiler toolchain supports cross-compiling to different architecture targets that are supported by the toolchain. See GOOS
and GOARCH
environment variable for the list of supported targets. Cross compilation is helpful if you want to build Gitea for less-powerful systems (such as Raspberry Pi).
To cross build Gitea with build tags (TAGS
), you also need a C cross compiler which targets the same architecture as selected by the GOOS
and GOARCH
variables. For example, to cross build for Linux ARM64 (GOOS=linux
and GOARCH=arm64
), you need the aarch64-unknown-linux-gnu-gcc
cross compiler. This is required because Gitea build tags uses cgo
’s foreign-function interface (FFI).
Cross-build Gitea for Linux ARM64, without any tags:
GOOS=linux GOARCH=arm64 make build
Cross-build Gitea for Linux ARM64, with recommended build tags:
CC=aarch64-unknown-linux-gnu-gcc GOOS=linux GOARCH=arm64 TAGS="bindata sqlite sqlite_unlock_notify" make build
Replace CC
, GOOS
, and GOARCH
as appropriate for your architecture target.
You will sometimes need to build a static compiled image. To do this you will need to add:
LDFLAGS="-linkmode external -extldflags '-static' $LDFLAGS" TAGS="netgo osusergo $TAGS" make build
This can be combined with CC
, GOOS
, and GOARCH
as above.