Shiloh/githaven
Shiloh/githaven
1
0
Fork 1
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
3ee8be3849
githaven/docs/content/doc/installation/from-source.en-us.md
Michael Lustfield 3ee8be3849 General documentation cleanup (#3317) 
* Clean up spelling, grammar, perspective, whitespace, language, markup, etc.
2018-01-08 23:48:42 +01:00

2.8 KiB
Raw Blame History

date title slug weight toc draft menu
2016-12-01T16:00:00+02:00 Installation from source install-from-source 10 true false
sidebar
parent name weight identifier
installation From source 30 install-from-source

Installation from source

This section will not include basic installation instructions.

Note: Go version 1.7 or higher is required

Download

First retrieve the source code. The easiest way is to use the Go tool. Use the following commands to fetch the source and switch into the source directory.

go get -d -u code.gitea.io/gitea
cd $GOPATH/src/code.gitea.io/gitea

Decide which version of Gitea to build and install. Currently, there are multiple options to choose from. The master branch represents the current development version. To build with master, skip to the build section.

To work with tagged releases, the following commands can be used:

git branch -a
git checkout v1.0

To validate a Pull Request, first enable the new branch (xyz is the PR id; for example 2663 for #2663):

git fetch origin pull/xyz/head:pr-xyz

To build Gitea from source at a specific tagged release (like v1.0.0), list the available tags and check out the specific tag.

List available tags with the following.

git tag -l
git checkout v1.0.0  # or git checkout pr-xyz

Build

Since all required libraries are already bundled in the Gitea source, it's possible to build Gitea with no additional downloads. Various make tasks are provided to keep the build process as simple as possible. See here how to get Make. Depending on requirements, the following build tags can be included.

  • bindata: Build a single monolithic binary, with all assets included.
  • sqlite: Enable support for a SQLite3 database. Suggested only for tiny installations.
  • tidb: Enable support for a TiDB database.
  • pam: Enable support for PAM (Linux Pluggable Authentication Modules). Can be used to authenticate local users or extend authentication to methods available to PAM.

Bundling assets into the binary using the bindata build tag can make development and testing easier, but is not ideal for a production deployment. To include assets, they must be built separately using the generate make task.

TAGS="bindata" make generate build

Test

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