From b0777024eb83668b84187cc6db4997488296e68b Mon Sep 17 00:00:00 2001 From: Olivier DOSSMANN Date: Thu, 6 Apr 2017 13:20:16 +0200 Subject: [PATCH 1/3] Add GITEA_CUSTOM configuration in customization section --- content/doc/advanced/customizing-gitea.en-us.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/doc/advanced/customizing-gitea.en-us.md b/content/doc/advanced/customizing-gitea.en-us.md index 98b73f8..be35032 100644 --- a/content/doc/advanced/customizing-gitea.en-us.md +++ b/content/doc/advanced/customizing-gitea.en-us.md @@ -17,6 +17,14 @@ menu: The main way to customize Gitea is by using the `custom` folder. This is the central place to override and configure features. +Use `GITEA_CUSTOM` to define another folder instead. For example: + +``` +GITEA_CUSTOM=/srv/gitea/mycustom ./gitea web +``` + +**Note** that by default Gitea will use the `custom` folder in the current working directory. + ## Customizing /robots.txt To make Gitea serve your own `/robots.txt` (by default, an empty 404 status is served), simply create a file called `robots.txt` in the `custom` folder with the [expected contents](http://www.robotstxt.org/). **Note** that you have to restart Gitea for it to notice the new `robots.txt`. From cfb905a56058d26e0fcaf52695ec8983ea1c5d6a Mon Sep 17 00:00:00 2001 From: Olivier DOSSMANN Date: Tue, 11 Apr 2017 22:05:22 +0200 Subject: [PATCH 2/3] Add new section about Gitea specific environment variables --- .../doc/advanced/specific-variables.en-us.md | 67 +++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 content/doc/advanced/specific-variables.en-us.md diff --git a/content/doc/advanced/specific-variables.en-us.md b/content/doc/advanced/specific-variables.en-us.md new file mode 100644 index 0000000..1fe705a --- /dev/null +++ b/content/doc/advanced/specific-variables.en-us.md @@ -0,0 +1,67 @@ +--- +date: "2017-04-08T11:34:00+02:00" +title: "Specific variables" +slug: "specific-variables" +weight: 20 +toc: false +draft: false +menu: + sidebar: + parent: "advanced" + name: "Specific variables" + weight: 20 + identifier: "specific-variables" +--- + +# Specific 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 as: + + * `GOOS` + * `GOARCH` + * `GOPATH` + +For `GOPATH`, check [official documentation about GOPATH environment variable](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable). + +For others, check [official documentation about variables used when it runs the generator](https://golang.org/cmd/go/#hdr-Generate_Go_files_by_processing_source). + +## Gitea files + + * `GITEA_WORK_DIR`: Gitea absolute path of work 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 launch Gitea. Useful for repository URL address on Gitea interface + * `USERNAME`: if no USER found, Gitea will try `USERNAME` + * `HOME`: User home directory path (**except if** you're running on Windows, check the following `USERPROFILE` variable) + +### Only on Windows + + * `USERPROFILE`: User home directory path. If empty, uses `HOMEDRIVE` + `HOMEPATH` + * `HOMEDRIVE`: Main drive path you will use to get home directory + * `HOMEPATH`: Home relative path in the given home drive path + +## Macaron (framework used by Gitea) + + * `HOST`: Host Macaron will listen on + * `PORT`: Port Macaron will listen on + * `MACARON_ENV`: global variable to provide special functionality for development environments vs production environments. If MACARON_ENV is set to "" or "development" then templates will be recompiled on every request. For more performance, set the MACARON_ENV environment variable to "production". + +## Miscellaneous + + * `SKIP_MINWINSVC`: Do not run as a service on Windows if set to 1 + * `ZOOKEEPER_PATH`: [Zookeeper](http://zookeeper.apache.org/) jar file path + From 8402f85f2c6c4661a37c91cc098f42a2f5a49c24 Mon Sep 17 00:00:00 2001 From: Olivier DOSSMANN Date: Tue, 11 Apr 2017 22:05:55 +0200 Subject: [PATCH 3/3] Revert "Add GITEA_CUSTOM configuration in customization section" This reverts commit b0777024eb83668b84187cc6db4997488296e68b. --- content/doc/advanced/customizing-gitea.en-us.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/content/doc/advanced/customizing-gitea.en-us.md b/content/doc/advanced/customizing-gitea.en-us.md index be35032..98b73f8 100644 --- a/content/doc/advanced/customizing-gitea.en-us.md +++ b/content/doc/advanced/customizing-gitea.en-us.md @@ -17,14 +17,6 @@ menu: The main way to customize Gitea is by using the `custom` folder. This is the central place to override and configure features. -Use `GITEA_CUSTOM` to define another folder instead. For example: - -``` -GITEA_CUSTOM=/srv/gitea/mycustom ./gitea web -``` - -**Note** that by default Gitea will use the `custom` folder in the current working directory. - ## Customizing /robots.txt To make Gitea serve your own `/robots.txt` (by default, an empty 404 status is served), simply create a file called `robots.txt` in the `custom` folder with the [expected contents](http://www.robotstxt.org/). **Note** that you have to restart Gitea for it to notice the new `robots.txt`.