magic_rb/forgejo
Template
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo synced 2024-11-28 12:46:09 +01:00
Code Issues Packages Projects Releases Wiki Activity
forgejo/docs/content/doc/administration/environment-variables.en-us.md
Lunny Xiao e8433b7fe6
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 
- **Installation**: includes how to install Gitea and related other
tools, also includes upgrade Gitea
- **Administration**: includes how to configure Gitea, customize Gitea
and manage Gitea instance out of Gitea admin UI
- **Usage**: includes how to use Gitea's functionalities. A sub
documentation is about packages, in future we could also include CI/CD
and others.
- **Development**: includes how to integrate with Gitea's API, how to
develop new features within Gitea
- **Contributing**: includes how to contribute code to Gitea
repositories.

After this is merged, I think we can have a sub-documentation of `Usage`
part named `Actions` to describe how to use Gitea actions

---------

Co-authored-by: John Olheiser <john.olheiser@gmail.com>
2023-03-23 23:18:24 +08:00

1.7 KiB
Raw Blame History

date title slug weight toc draft menu
2017-04-08T11:34:00+02:00 Environment variables environment-variables 20 false false
sidebar
parent name weight identifier
administration Environment variables 10 environment-variables

Environment variables

Table of Contents

{{< toc >}}

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 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

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.