1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-12-14 11:48:09 -05:00
forgejo/docs/content/administration/environment-variables.en-us.md
John Olheiser bd4c7ce578
Docusaurus-ify (#26051)
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>
2023-07-26 04:53:13 +00:00

1.6 KiB

date title slug sidebar_position toc draft aliases menu
2017-04-08T11:34:00+02:00 Environment variables environment-variables 10 false false
/en-us/environment-variables
sidebar
parent name sidebar_position identifier
administration Environment variables 10 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:

GITEA_CUSTOM=/home/gitea/custom ./gitea web

From Go language

As Gitea is written in Go, it uses some Go variables, such as:

For documentation about each of the variables available, refer to the official Go documentation.

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.