2017-11-26 21:44:32 +00:00
|
|
|
---
|
|
|
|
|
date: "2017-04-08T11:34:00+02:00"
|
2020-10-23 15:59:45 +00:00
|
|
|
title: "Environment variables"
|
|
|
|
|
slug: "environment-variables"
|
2017-11-26 21:44:32 +00:00
|
|
|
weight: 20
|
|
|
|
|
toc: false
|
|
|
|
|
draft: false
|
|
|
|
|
menu:
|
|
|
|
|
sidebar:
|
|
|
|
|
parent: "advanced"
|
2020-10-23 15:59:45 +00:00
|
|
|
name: "Environment variables"
|
2017-11-26 21:44:32 +00:00
|
|
|
weight: 20
|
2020-10-23 15:59:45 +00:00
|
|
|
identifier: "environment-variables"
|
2017-11-26 21:44:32 +00:00
|
|
|
---
|
|
|
|
|
|
2020-10-23 15:59:45 +00:00
|
|
|
# Environment variables
|
2017-11-26 21:44:32 +00:00
|
|
|
|
2020-12-09 06:47:06 +00:00
|
|
|
**Table of Contents**
|
|
|
|
|
|
|
|
|
|
{{< toc >}}
|
|
|
|
|
|
2017-11-26 21:44:32 +00:00
|
|
|
This is an inventory of Gitea environment variables. They change Gitea behaviour.
|
|
|
|
|
|
|
|
|
|
Initialize them before Gitea command to be effective, for example:
|
|
|
|
|
|
2020-12-09 06:47:06 +00:00
|
|
|
```sh
|
2017-11-26 21:44:32 +00:00
|
|
|
GITEA_CUSTOM=/home/gitea/custom ./gitea web
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## From Go language
|
|
|
|
|
|
2018-01-08 22:48:42 +00:00
|
|
|
As Gitea is written in Go, it uses some Go variables, such as:
|
2017-11-26 21:44:32 +00:00
|
|
|
|
2020-12-09 06:47:06 +00:00
|
|
|
- `GOOS`
|
|
|
|
|
- `GOARCH`
|
|
|
|
|
- [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
|
2017-11-26 21:44:32 +00:00
|
|
|
|
2018-01-08 22:48:42 +00: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 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Gitea files
|
|
|
|
|
|
2020-12-09 06:47:06 +00: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.
|
|
|
|
|
- `GOGS_WORK_DIR`: Deprecated, use `GITEA_WORK_DIR`
|
|
|
|
|
- `GOGS_CUSTOM`: Deprecated, use `GITEA_CUSTOM`
|
2017-11-26 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Operating system specifics
|
|
|
|
|
|
2020-12-09 06:47:06 +00: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 21:44:32 +00:00
|
|
|
|
|
|
|
|
### Only on Windows
|
|
|
|
|
|
2020-12-09 06:47:06 +00:00
|
|
|
- `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
|
2017-11-26 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Macaron (framework used by Gitea)
|
|
|
|
|
|
2020-12-09 06:47:06 +00:00
|
|
|
- `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".
|
2017-11-26 21:44:32 +00:00
|
|
|
|
|
|
|
|
## Miscellaneous
|
|
|
|
|
|
2020-12-09 06:47:06 +00:00
|
|
|
- `SKIP_MINWINSVC`: If set to 1, do not run as a service on Windows.
|
