diff options
author | wxiaoguang <wxiaoguang@gmail.com> | 2023-07-19 17:22:57 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-19 11:22:57 +0200 |
commit | 50e14699d3951ece4b9eb3f72cb266056e799f63 (patch) | |
tree | 28422db0087248b2144d7e137de2c46957107388 /custom | |
parent | 06df92b5af1afaedf3883c6aaf2ce9d219cbd089 (diff) | |
download | gitea-50e14699d3951ece4b9eb3f72cb266056e799f63.tar.gz gitea-50e14699d3951ece4b9eb3f72cb266056e799f63.zip |
Update path related documents (#25417)
Update WorkPath/WORK_PATH related documents, remove out-dated
information.
Remove "StaticRootPath" on the admin config display page, because few
end user really need it, it only causes misconfiguration.
![image](https://github.com/go-gitea/gitea/assets/2114189/8095afa4-da76-436b-9e89-2a92c229c01d)
Co-authored-by: Giteabot <teabot@gitea.io>
Diffstat (limited to 'custom')
-rw-r--r-- | custom/conf/app.example.ini | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini index 029a482fcd..36ea7f3d9e 100644 --- a/custom/conf/app.example.ini +++ b/custom/conf/app.example.ini @@ -16,26 +16,23 @@ ;; ;; - _`AppPath`_: This is the absolute path of the running gitea binary. ;; - _`AppWorkPath`_: This refers to "working path" of the `gitea` binary. It is determined by using the first set thing in the following hierarchy: +;; - The "WORK_PATH" option in "app.ini" file ;; - The `--work-path` flag passed to the binary ;; - The environment variable `$GITEA_WORK_DIR` ;; - A built-in value set at build time (see building from source) ;; - Otherwise it defaults to the directory of the _`AppPath`_ -;; - If any of the above are relative paths then they are made absolute against -;; the directory of the _`AppPath`_ -;; - _`CustomPath`_: This is the base directory for custom templates and other options. -;; It is determined by using the first set thing in the following hierarchy: +;; - If any of the above are relative paths then they are made absolute against the directory of the _`AppPath`_ +;; - _`CustomPath`_: This is the base directory for custom templates and other options. It is determined by using the first set thing in the following hierarchy: ;; - The `--custom-path` flag passed to the binary ;; - The environment variable `$GITEA_CUSTOM` ;; - A built-in value set at build time (see building from source) ;; - Otherwise it defaults to _`AppWorkPath`_`/custom` -;; - If any of the above are relative paths then they are made absolute against the -;; the directory of the _`AppWorkPath`_ +;; - If any of the above are relative paths then they are made absolute against the directory of the _`AppWorkPath`_ ;; - _`CustomConf`_: This is the path to the `app.ini` file. ;; - The `--config` flag passed to the binary ;; - A built-in value set at build time (see building from source) ;; - Otherwise it defaults to _`CustomPath`_`/conf/app.ini` -;; - If any of the above are relative paths then they are made absolute against the -;; the directory of the _`CustomPath`_ +;; - If any of the above are relative paths then they are made absolute against the directory of the _`CustomPath`_ ;; ;; In addition there is _`StaticRootPath`_ which can be set as a built-in at build time, but will otherwise default to _`AppWorkPath`_ @@ -52,6 +49,9 @@ RUN_USER = ; git ;; Application run mode, affects performance and debugging: "dev" or "prod", default is "prod" ;; Mode "dev" makes Gitea easier to develop and debug, values other than "dev" are treated as "prod" which is for production use. ;RUN_MODE = prod +;; +;; The working directory, see the comment of AppWorkPath above +;WORK_PATH = ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |