mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-30 13:56:09 +01:00
bd4c7ce578
This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
59 lines
1.6 KiB
Markdown
59 lines
1.6 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 Go variables, such as:
|
|
|
|
- `GOOS`
|
|
- `GOARCH`
|
|
- [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
|
|
|
|
For documentation about each of the variables available, refer to the
|
|
[official Go documentation](https://golang.org/cmd/go/#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.
|