2017-11-27 05:44:32 +08:00
|
|
|
---
|
|
|
|
|
date: "2017-04-08T11:34:00+02:00"
|
2020-10-23 23:59:45 +08:00
|
|
|
title: "Environment variables"
|
|
|
|
|
slug: "environment-variables"
|
2023-07-26 10:00:14 +08:00
|
|
|
sidebar_position: 10
|
2017-11-27 05:44:32 +08:00
|
|
|
toc: false
|
|
|
|
|
draft: false
|
Refactor docs (#23752)
This was intended to be a small followup for
https://github.com/go-gitea/gitea/pull/23712, but...here we are.
1. Our docs currently use `slug` as the entire URL, which makes
refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712).
Instead, this PR attempts to make future refactoring easier by using
slugs as an extension of the section. (Hugo terminology)
- What the above boils down to is this PR attempts to use directory
organization as URL management. e.g. `usage/comparison.en-us.md` ->
`en-us/usage/comparison/`, `usage/packages/overview.en-us.md` ->
`en-us/usage/packages/overview/`
- Technically we could even remove `slug`, as Hugo defaults to using
filename, however at least with this PR it means `slug` only needs to be
the name for the **current file** rather than an entire URL
2. This PR adds appropriate aliases (redirects) for pages, so anything
on the internet that links to our docs should hopefully not break.
3. A minor nit I've had for a while, renaming `seek-help` to `support`.
It's a minor thing, but `seek-help` has a strange connotation to it.
4. The commits are split such that you can review the first which is the
"actual" change, and the second is added redirects so that the first
doesn't break links elsewhere.
---------
Signed-off-by: jolheiser <john.olheiser@gmail.com>
2023-04-28 11:33:41 +08:00
|
|
|
aliases:
|
|
|
|
|
- /en-us/environment-variables
|
2017-11-27 05:44:32 +08:00
|
|
|
menu:
|
|
|
|
|
sidebar:
|
2023-03-23 23:18:24 +08:00
|
|
|
parent: "administration"
|
2020-10-23 23:59:45 +08:00
|
|
|
name: "Environment variables"
|
2023-07-26 10:00:14 +08:00
|
|
|
sidebar_position: 10
|
2020-10-23 23:59:45 +08:00
|
|
|
identifier: "environment-variables"
|
2017-11-27 05:44:32 +08:00
|
|
|
---
|
|
|
|
|
|
2020-10-23 23:59:45 +08:00
|
|
|
# Environment variables
|
2017-11-27 05:44:32 +08: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 14:47:06 +08:00
|
|
|
```sh
|
2017-11-27 05:44:32 +08:00
|
|
|
GITEA_CUSTOM=/home/gitea/custom ./gitea web
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## From Go language
|
|
|
|
|
|
2018-01-09 06:48:42 +08:00
|
|
|
As Gitea is written in Go, it uses some Go variables, such as:
|
2017-11-27 05:44:32 +08:00
|
|
|
|
2020-12-09 14:47:06 +08:00
|
|
|
- `GOOS`
|
|
|
|
|
- `GOARCH`
|
|
|
|
|
- [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
|
2017-11-27 05:44:32 +08:00
|
|
|
|
2018-01-09 06:48:42 +08: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-27 05:44:32 +08:00
|
|
|
|
|
|
|
|
## Gitea files
|
|
|
|
|
|
2020-12-09 14:47:06 +08:00
|
|
|
- `GITEA_WORK_DIR`: Absolute path of working directory.
|
2023-07-19 17:48:54 +08:00
|
|
|
- `GITEA_CUSTOM`: Gitea uses `WorkPath`/custom folder by default. Use this variable to change _custom_ directory.
|
2017-11-27 05:44:32 +08:00
|
|
|
|
|
|
|
|
## Operating system specifics
|
|
|
|
|
|
2020-12-09 14:47:06 +08: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-27 05:44:32 +08:00
|
|
|
|
|
|
|
|
### Only on Windows
|
|
|
|
|
|
2020-12-09 14:47:06 +08: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-27 05:44:32 +08:00
|
|
|
|
|
|
|
|
## Miscellaneous
|
|
|
|
|
|
2020-12-09 14:47:06 +08:00
|
|
|
- `SKIP_MINWINSVC`: If set to 1, do not run as a service on Windows.
|