Files
docs/doc/advanced/environment-variables.en-us.md
T

69 lines
2.1 KiB
Markdown
Raw Normal View History

2017-11-26 16:44:32 -05:00
---
date: "2017-04-08T11:34:00+02:00"
2020-10-23 10:59:45 -05:00
title: "Environment variables"
slug: "environment-variables"
2017-11-26 16:44:32 -05:00
weight: 20
toc: false
draft: false
menu:
sidebar:
parent: "advanced"
2020-10-23 10:59:45 -05:00
name: "Environment variables"
2017-11-26 16:44:32 -05:00
weight: 20
2020-10-23 10:59:45 -05:00
identifier: "environment-variables"
2017-11-26 16:44:32 -05:00
---
2020-10-23 10:59:45 -05:00
# Environment variables
2017-11-26 16:44:32 -05:00
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
2018-01-08 16:48:42 -06:00
As Gitea is written in Go, it uses some Go variables, such as:
2017-11-26 16:44:32 -05:00
* `GOOS`
* `GOARCH`
2018-01-08 16:48:42 -06:00
* [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
2017-11-26 16:44:32 -05:00
2018-01-08 16:48:42 -06:00
For documentation about each of the variables available, refer to the
[official Go documentation](https://golang.org/cmd/go/#hdr-Environment_variables).
2017-11-26 16:44:32 -05:00
## Gitea files
2018-01-08 16:48:42 -06:00
* `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.
2017-11-26 16:44:32 -05:00
* `GOGS_WORK_DIR`: Deprecated, use `GITEA_WORK_DIR`
* `GOGS_CUSTOM`: Deprecated, use `GITEA_CUSTOM`
## Operating system specifics
2018-01-08 16:48:42 -06:00
* `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.
2017-11-26 16:44:32 -05:00
### Only on Windows
* `USERPROFILE`: User home directory path. If empty, uses `HOMEDRIVE` + `HOMEPATH`
2018-01-08 16:48:42 -06:00
* `HOMEDRIVE`: Main drive path used to access the home directory (C:)
2017-11-26 16:44:32 -05:00
* `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
2018-01-08 16:48:42 -06:00
* `MACARON_ENV`: global variable to provide special functionality for development environments
2019-03-09 16:15:45 -05:00
vs. production environments. If MACARON_ENV is set to "" or "development", then templates will
2018-01-08 16:48:42 -06:00
be recompiled on every request. For more performance, set the MACARON_ENV environment variable
to "production".
2017-11-26 16:44:32 -05:00
## Miscellaneous
2018-01-08 16:48:42 -06:00
* `SKIP_MINWINSVC`: If set to 1, do not run as a service on Windows.