1
1
mirror of https://github.com/go-gitea/gitea synced 2024-12-25 01:54:26 +00:00
gitea/docs/content/doc/advanced/specific-variables.en-us.md
2019-03-09 16:15:45 -05:00

2.1 KiB

date title slug weight toc draft menu
2017-04-08T11:34:00+02:00 Specific variables specific-variables 20 false false
sidebar
parent name weight identifier
advanced Specific variables 20 specific-variables

Specific 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 Go variables, such as:

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

Gitea files

  • GITEA_WORK_DIR: Absolute path of working directory.
  • GITEA_CUSTOM: Gitea uses GITEA_WORK_DIR/custom folder by default. Use this variable to change custom directory.
  • GOGS_WORK_DIR: Deprecated, use GITEA_WORK_DIR
  • GOGS_CUSTOM: Deprecated, use GITEA_CUSTOM

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

Macaron (framework used by Gitea)

  • HOST: Host Macaron will listen on
  • PORT: Port Macaron will listen on
  • MACARON_ENV: global variable to provide special functionality for development environments vs. production environments. If MACARON_ENV is set to "" or "development", then templates will be recompiled on every request. For more performance, set the MACARON_ENV environment variable to "production".

Miscellaneous

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