mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-28 18:34:10 -05:00
b9d91694af
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.
59 lines
1.7 KiB
Markdown
59 lines
1.7 KiB
Markdown
---
|
|
date: "2017-04-08T11:34:00+02:00"
|
|
title: "Environment variables"
|
|
slug: "environment-variables"
|
|
sidebar_position: 10
|
|
toc: false
|
|
draft: false
|
|
aliases:
|
|
- /en-us/environment-variables
|
|
menu:
|
|
sidebar:
|
|
parent: "administration"
|
|
name: "Environment variables"
|
|
sidebar_position: 10
|
|
identifier: "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:
|
|
|
|
```sh
|
|
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](https://pkg.go.dev/runtime#hdr-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.
|