aboutsummaryrefslogtreecommitdiff
path: root/conf
diff options
context:
space:
mode:
authorUnknwon <u@gogs.io>2017-01-31 18:08:34 -0500
committerUnknwon <u@gogs.io>2017-01-31 18:08:34 -0500
commit0cfcaca351b78e3e2affd030d110662c537d6328 (patch)
tree82ed96af2187b90df387758ef026c99501f71820 /conf
parent412ba5b2a97ec224f6cf6b78ceba711c8dda3835 (diff)
conf: minor comments fix
Diffstat (limited to 'conf')
-rw-r--r--conf/app.ini31
1 files changed, 17 insertions, 14 deletions
diff --git a/conf/app.ini b/conf/app.ini
index 3c0ee503..a62aaaf0 100644
--- a/conf/app.ini
+++ b/conf/app.ini
@@ -1,17 +1,20 @@
-# NEVER EVER MODIFY THIS FILE
-# PLEASE MAKE CHANGES ON CORRESPONDING CUSTOM CONFIG FILE
+# !!! NEVER EVER MODIFY THIS FILE !!!
+# !!! PLEASE MAKE CHANGES ON CORRESPONDING CUSTOM CONFIG FILE !!!
+# !!! IF YOU ARE PACKAGING PROVIDER, PLEASE MAKE OWN COPY OF IT !!!
; App name that shows on every page title
APP_NAME = Gogs: Go Git Service
-; Change it if you run locally
+; The name of the system user that runs Gogs
RUN_USER = git
-; Either "dev", "prod" or "test", default is "dev"
+; Either "dev", "prod" or "test"
RUN_MODE = dev
[repository]
+; Root path for storing repositories's data, default is "~/<username>/gogs-repositories"
ROOT =
+; The script type server supports, sometimes could be "sh"
SCRIPT_TYPE = bash
-; Default ANSI charset
+; Default ANSI charset for an unrecognized charset
ANSI_CHARSET =
; Force every new repository to be private
FORCE_PRIVATE = false
@@ -21,7 +24,7 @@ MAX_CREATION_LIMIT = -1
MIRROR_QUEUE_LENGTH = 1000
; Patch test queue length, increase if pull request patch testing starts hanging
PULL_REQUEST_QUEUE_LENGTH = 1000
-; Preferred Licenses to place at the top of the List
+; Preferred Licenses to place at the top of the list
; Name must match file name in conf/license or custom/conf/license
PREFERRED_LICENSES = Apache License 2.0,MIT License
; Disable ability to interact with repositories by HTTP protocol
@@ -30,23 +33,23 @@ DISABLE_HTTP_GIT = false
ENABLE_LOCAL_PATH_MIGRATION = false
[repository.editor]
-; List of file extensions that should have line wraps in the CodeMirror editor
-; Separate extensions with a comma. To line wrap files w/o extension, just put a comma
+; List of file extensions that should have line wraps in the CodeMirror editor.
+; Separate extensions with a comma. To line wrap files without extension, just put a comma
LINE_WRAP_EXTENSIONS = .txt,.md,.markdown,.mdown,.mkd,
-; Valid file modes that have a preview API associated with them, such as api/v1/markdown
+; Valid file modes that have a preview API associated with them, such as api/v1/markdown.
; Separate values by commas. Preview tab in edit mode won't show if the file extension doesn't match
PREVIEWABLE_FILE_MODES = markdown
[repository.upload]
-; Whether repository file uploads are enabled. Defaults to `true`
+; Enable repository file uploads.
ENABLED = true
-; Path for uploads. Defaults to `data/tmp/uploads` (tmp gets deleted on gogs restart)
+; Path to temporarily store uploads (default path gets cleaned by Gogs in every start)
TEMP_PATH = data/tmp/uploads
-; One or more allowed types, e.g. image/jpeg|image/png. Nothing means any file type
+; File types that are allowed to be uploaded, e.g. image/jpeg|image/png. Leave empty means allow any file type
ALLOWED_TYPES =
-; Max size of each file in MB. Defaults to 3MB
+; Maximum size of each file in MB
FILE_MAX_SIZE = 3
-; Max number of files per upload. Defaults to 5
+; Maximum number of files per upload
MAX_FILES = 5
[ui]