foster/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-23 12:59:11 -05:00
Code Issues Wiki Activity
forgejo/docs/content/administration/environment-variables.en-us.md
Mechiel Lukkien b9d91694af
In administration documentation about environment variables, point to those for the Go runtime instead of Go compiler (#28859) 
The previous variables are used by the compiler and aren't too useful
for non-developers. The newly listed variables are more likely to be of
interest.

Apologies for this drive-by PR, I probably missed instructions from the
contributors guide. The patch can be regarded as a simple way to explain
the problem and solution. Feel free to close and possibly create a new
PR that does adhere to the contributors guide.
2024-01-20 10:12:20 +08:00

1.7 KiB
Raw Blame History

date title slug sidebar_position toc draft aliases menu
2017-04-08T11:34:00+02:00 Environment variables environment-variables 10 false false
/en-us/environment-variables
sidebar
parent name sidebar_position identifier
administration Environment variables 10 environment-variables

Environment variables

This is an inventory of Gitea environment variables. They change Gitea behaviour.

Initialize them before Gitea command to be effective, for example:

GITEA_CUSTOM=/home/gitea/custom ./gitea web

From Go language

As Gitea is written in Go, it uses some variables that influence the behaviour of Go's runtime, such as:

  • GOMEMLIMIT
  • GOGC
  • GOMAXPROCS
  • GODEBUG

For documentation about each of the variables available, refer to the official Go documentation on runtime environment variables.

Gitea files

  • GITEA_WORK_DIR: Absolute path of working directory.
  • GITEA_CUSTOM: Gitea uses WorkPath/custom folder by default. Use this variable to change custom directory.

Operating system specifics

  • USER: System user that Gitea will run as. Used for some repository access strings.
  • USERNAME: if no USER found, Gitea will use USERNAME
  • HOME: User home directory path. The USERPROFILE environment variable is used in Windows.

Only on Windows

  • USERPROFILE: User home directory path. If empty, uses HOMEDRIVE + HOMEPATH
  • HOMEDRIVE: Main drive path used to access the home directory (C:)
  • HOMEPATH: Home relative path in the given home drive path

Miscellaneous

  • SKIP_MINWINSVC: If set to 1, do not run as a service on Windows.