You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

app.ini.sample 34KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875
  1. ; This file lists the default values used by Gitea
  2. ; Copy required sections to your own app.ini (default is custom/conf/app.ini)
  3. ; and modify as needed.
  4. ; see https://docs.gitea.io/en-us/config-cheat-sheet/ for additional documentation.
  5. ; App name that shows in every page title
  6. APP_NAME = Gitea: Git with a cup of tea
  7. ; Change it if you run locally
  8. RUN_USER = git
  9. ; Either "dev", "prod" or "test", default is "dev"
  10. RUN_MODE = dev
  11. [repository]
  12. ROOT =
  13. SCRIPT_TYPE = bash
  14. ; Default ANSI charset
  15. ANSI_CHARSET =
  16. ; Force every new repository to be private
  17. FORCE_PRIVATE = false
  18. ; Default privacy setting when creating a new repository, allowed values: last, private, public. Default is last which means the last setting used.
  19. DEFAULT_PRIVATE = last
  20. ; Global limit of repositories per user, applied at creation time. -1 means no limit
  21. MAX_CREATION_LIMIT = -1
  22. ; Mirror sync queue length, increase if mirror syncing starts hanging
  23. MIRROR_QUEUE_LENGTH = 1000
  24. ; Patch test queue length, increase if pull request patch testing starts hanging
  25. PULL_REQUEST_QUEUE_LENGTH = 1000
  26. ; Preferred Licenses to place at the top of the List
  27. ; The name here must match the filename in conf/license or custom/conf/license
  28. PREFERRED_LICENSES = Apache License 2.0,MIT License
  29. ; Disable the ability to interact with repositories using the HTTP protocol
  30. DISABLE_HTTP_GIT = false
  31. ; Value for Access-Control-Allow-Origin header, default is not to present
  32. ; WARNING: This maybe harmful to you website if you do not give it a right value.
  33. ACCESS_CONTROL_ALLOW_ORIGIN =
  34. ; Force ssh:// clone url instead of scp-style uri when default SSH port is used
  35. USE_COMPAT_SSH_URI = false
  36. ; Close issues as long as a commit on any branch marks it as fixed
  37. DEFAULT_CLOSE_ISSUES_VIA_COMMITS_IN_ANY_BRANCH = false
  38. [repository.editor]
  39. ; List of file extensions for which lines should be wrapped in the CodeMirror editor
  40. ; Separate extensions with a comma. To line wrap files without an extension, just put a comma
  41. LINE_WRAP_EXTENSIONS = .txt,.md,.markdown,.mdown,.mkd,
  42. ; Valid file modes that have a preview API associated with them, such as api/v1/markdown
  43. ; Separate the values by commas. The preview tab in edit mode won't be displayed if the file extension doesn't match
  44. PREVIEWABLE_FILE_MODES = markdown
  45. [repository.local]
  46. ; Path for local repository copy. Defaults to `tmp/local-repo`
  47. LOCAL_COPY_PATH = tmp/local-repo
  48. ; Path for local wiki copy. Defaults to `tmp/local-wiki`
  49. LOCAL_WIKI_PATH = tmp/local-wiki
  50. [repository.upload]
  51. ; Whether repository file uploads are enabled. Defaults to `true`
  52. ENABLED = true
  53. ; Path for uploads. Defaults to `data/tmp/uploads` (tmp gets deleted on gitea restart)
  54. TEMP_PATH = data/tmp/uploads
  55. ; One or more allowed types, e.g. image/jpeg|image/png. Nothing means any file type
  56. ALLOWED_TYPES =
  57. ; Max size of each file in megabytes. Defaults to 3MB
  58. FILE_MAX_SIZE = 3
  59. ; Max number of files per upload. Defaults to 5
  60. MAX_FILES = 5
  61. [repository.pull-request]
  62. ; List of prefixes used in Pull Request title to mark them as Work In Progress
  63. WORK_IN_PROGRESS_PREFIXES=WIP:,[WIP]
  64. [repository.issue]
  65. ; List of reasons why a Pull Request or Issue can be locked
  66. LOCK_REASONS=Too heated,Off-topic,Resolved,Spam
  67. [repository.signing]
  68. ; GPG key to use to sign commits, Defaults to the default - that is the value of git config --get user.signingkey
  69. ; run in the context of the RUN_USER
  70. ; Switch to none to stop signing completely
  71. SIGNING_KEY = default
  72. ; If a SIGNING_KEY ID is provided and is not set to default, use the provided Name and Email address as the signer.
  73. ; These should match a publicized name and email address for the key. (When SIGNING_KEY is default these are set to
  74. ; the results of git config --get user.name and git config --get user.email respectively and can only be overrided
  75. ; by setting the SIGNING_KEY ID to the correct ID.)
  76. SIGNING_NAME =
  77. SIGNING_EMAIL =
  78. ; Determines when gitea should sign the initial commit when creating a repository
  79. ; Either:
  80. ; - never
  81. ; - pubkey: only sign if the user has a pubkey
  82. ; - twofa: only sign if the user has logged in with twofa
  83. ; - always
  84. ; options other than none and always can be combined as comma separated list
  85. INITIAL_COMMIT = always
  86. ; Determines when to sign for CRUD actions
  87. ; - as above
  88. ; - parentsigned: requires that the parent commit is signed.
  89. CRUD_ACTIONS = pubkey, twofa, parentsigned
  90. ; Determines when to sign Wiki commits
  91. ; - as above
  92. WIKI = never
  93. ; Determines when to sign on merges
  94. ; - basesigned: require that the parent of commit on the base repo is signed.
  95. ; - commitssigned: require that all the commits in the head branch are signed.
  96. MERGES = pubkey, twofa, basesigned, commitssigned
  97. [cors]
  98. ; More information about CORS can be found here: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#The_HTTP_response_headers
  99. ; enable cors headers (disabled by default)
  100. ENABLED=false
  101. ; scheme of allowed requests
  102. SCHEME=http
  103. ; list of requesting domains that are allowed
  104. ALLOW_DOMAIN=*
  105. ; allow subdomains of headers listed above to request
  106. ALLOW_SUBDOMAIN=false
  107. ; list of methods allowed to request
  108. METHODS=GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS
  109. ; max time to cache response
  110. MAX_AGE=10m
  111. ; allow request with credentials
  112. ALLOW_CREDENTIALS=false
  113. [ui]
  114. ; Number of repositories that are displayed on one explore page
  115. EXPLORE_PAGING_NUM = 20
  116. ; Number of issues that are displayed on one page
  117. ISSUE_PAGING_NUM = 10
  118. ; Number of maximum commits displayed in one activity feed
  119. FEED_MAX_COMMIT_NUM = 5
  120. ; Number of maximum commits displayed in commit graph.
  121. GRAPH_MAX_COMMIT_NUM = 100
  122. ; Number of line of codes shown for a code comment
  123. CODE_COMMENT_LINES = 4
  124. ; Value of `theme-color` meta tag, used by Android >= 5.0
  125. ; An invalid color like "none" or "disable" will have the default style
  126. ; More info: https://developers.google.com/web/updates/2014/11/Support-for-theme-color-in-Chrome-39-for-Android
  127. THEME_COLOR_META_TAG = `#6cc644`
  128. ; Max size of files to be displayed (default is 8MiB)
  129. MAX_DISPLAY_FILE_SIZE = 8388608
  130. ; Whether the email of the user should be shown in the Explore Users page
  131. SHOW_USER_EMAIL = true
  132. ; Set the default theme for the Gitea install
  133. DEFAULT_THEME = gitea
  134. ; All available themes. Allow users select personalized themes regardless of the value of `DEFAULT_THEME`.
  135. THEMES = gitea,arc-green
  136. ; Whether the full name of the users should be shown where possible. If the full name isn't set, the username will be used.
  137. DEFAULT_SHOW_FULL_NAME = false
  138. ; Whether to search within description at repository search on explore page.
  139. SEARCH_REPO_DESCRIPTION = true
  140. [ui.admin]
  141. ; Number of users that are displayed on one page
  142. USER_PAGING_NUM = 50
  143. ; Number of repos that are displayed on one page
  144. REPO_PAGING_NUM = 50
  145. ; Number of notices that are displayed on one page
  146. NOTICE_PAGING_NUM = 25
  147. ; Number of organizations that are displayed on one page
  148. ORG_PAGING_NUM = 50
  149. [ui.user]
  150. ; Number of repos that are displayed on one page
  151. REPO_PAGING_NUM = 15
  152. [ui.meta]
  153. AUTHOR = Gitea - Git with a cup of tea
  154. DESCRIPTION = Gitea (Git with a cup of tea) is a painless self-hosted Git service written in Go
  155. KEYWORDS = go,git,self-hosted,gitea
  156. [markdown]
  157. ; Enable hard line break extension
  158. ENABLE_HARD_LINE_BREAK = false
  159. ; Comma separated list of custom URL-Schemes that are allowed as links when rendering Markdown
  160. ; for example git,magnet,ftp (more at https://en.wikipedia.org/wiki/List_of_URI_schemes)
  161. ; URLs starting with http and https are always displayed, whatever is put in this entry.
  162. CUSTOM_URL_SCHEMES =
  163. ; List of file extensions that should be rendered/edited as Markdown
  164. ; Separate the extensions with a comma. To render files without any extension as markdown, just put a comma
  165. FILE_EXTENSIONS = .md,.markdown,.mdown,.mkd
  166. [server]
  167. ; The protocol the server listens on. One of 'http', 'https', 'unix' or 'fcgi'.
  168. PROTOCOL = http
  169. DOMAIN = localhost
  170. ROOT_URL = %(PROTOCOL)s://%(DOMAIN)s:%(HTTP_PORT)s/
  171. ; The address to listen on. Either a IPv4/IPv6 address or the path to a unix socket.
  172. HTTP_ADDR = 0.0.0.0
  173. HTTP_PORT = 3000
  174. ; If REDIRECT_OTHER_PORT is true, and PROTOCOL is set to https an http server
  175. ; will be started on PORT_TO_REDIRECT and it will redirect plain, non-secure http requests to the main
  176. ; ROOT_URL. Defaults are false for REDIRECT_OTHER_PORT and 80 for
  177. ; PORT_TO_REDIRECT.
  178. REDIRECT_OTHER_PORT = false
  179. PORT_TO_REDIRECT = 80
  180. ; Permission for unix socket
  181. UNIX_SOCKET_PERMISSION = 666
  182. ; Local (DMZ) URL for Gitea workers (such as SSH update) accessing web service.
  183. ; In most cases you do not need to change the default value.
  184. ; Alter it only if your SSH server node is not the same as HTTP node.
  185. ; Do not set this variable if PROTOCOL is set to 'unix'.
  186. LOCAL_ROOT_URL = %(PROTOCOL)s://%(HTTP_ADDR)s:%(HTTP_PORT)s/
  187. ; Disable SSH feature when not available
  188. DISABLE_SSH = false
  189. ; Whether to use the builtin SSH server or not.
  190. START_SSH_SERVER = false
  191. ; Username to use for the builtin SSH server. If blank, then it is the value of RUN_USER.
  192. BUILTIN_SSH_SERVER_USER =
  193. ; Domain name to be exposed in clone URL
  194. SSH_DOMAIN = %(DOMAIN)s
  195. ; The network interface the builtin SSH server should listen on
  196. SSH_LISTEN_HOST =
  197. ; Port number to be exposed in clone URL
  198. SSH_PORT = 22
  199. ; The port number the builtin SSH server should listen on
  200. SSH_LISTEN_PORT = %(SSH_PORT)s
  201. ; Root path of SSH directory, default is '~/.ssh', but you have to use '/home/git/.ssh'.
  202. SSH_ROOT_PATH =
  203. ; Gitea will create a authorized_keys file by default when it is not using the internal ssh server
  204. ; If you intend to use the AuthorizedKeysCommand functionality then you should turn this off.
  205. SSH_CREATE_AUTHORIZED_KEYS_FILE = true
  206. ; For the built-in SSH server, choose the ciphers to support for SSH connections,
  207. ; for system SSH this setting has no effect
  208. SSH_SERVER_CIPHERS = aes128-ctr, aes192-ctr, aes256-ctr, aes128-gcm@openssh.com, arcfour256, arcfour128
  209. ; For the built-in SSH server, choose the key exchange algorithms to support for SSH connections,
  210. ; for system SSH this setting has no effect
  211. SSH_SERVER_KEY_EXCHANGES = diffie-hellman-group1-sha1, diffie-hellman-group14-sha1, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, curve25519-sha256@libssh.org
  212. ; For the built-in SSH server, choose the MACs to support for SSH connections,
  213. ; for system SSH this setting has no effect
  214. SSH_SERVER_MACS = hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1, hmac-sha1-96
  215. ; Directory to create temporary files in when testing public keys using ssh-keygen,
  216. ; default is the system temporary directory.
  217. SSH_KEY_TEST_PATH =
  218. ; Path to ssh-keygen, default is 'ssh-keygen' which means the shell is responsible for finding out which one to call.
  219. SSH_KEYGEN_PATH = ssh-keygen
  220. ; Enable SSH Authorized Key Backup when rewriting all keys, default is true
  221. SSH_BACKUP_AUTHORIZED_KEYS = true
  222. ; Enable exposure of SSH clone URL to anonymous visitors, default is false
  223. SSH_EXPOSE_ANONYMOUS = false
  224. ; Indicate whether to check minimum key size with corresponding type
  225. MINIMUM_KEY_SIZE_CHECK = false
  226. ; Disable CDN even in "prod" mode
  227. OFFLINE_MODE = false
  228. DISABLE_ROUTER_LOG = false
  229. ; Generate steps:
  230. ; $ ./gitea cert -ca=true -duration=8760h0m0s -host=myhost.example.com
  231. ;
  232. ; Or from a .pfx file exported from the Windows certificate store (do
  233. ; not forget to export the private key):
  234. ; $ openssl pkcs12 -in cert.pfx -out cert.pem -nokeys
  235. ; $ openssl pkcs12 -in cert.pfx -out key.pem -nocerts -nodes
  236. CERT_FILE = custom/https/cert.pem
  237. KEY_FILE = custom/https/key.pem
  238. ; Root directory containing templates and static files.
  239. ; default is the path where Gitea is executed
  240. STATIC_ROOT_PATH =
  241. ; Default path for App data
  242. APP_DATA_PATH = data
  243. ; Application level GZIP support
  244. ENABLE_GZIP = false
  245. ; Application profiling (memory and cpu)
  246. ; For "web" command it listens on localhost:6060
  247. ; For "serve" command it dumps to disk at PPROF_DATA_PATH as (cpuprofile|memprofile)_<username>_<temporary id>
  248. ENABLE_PPROF = false
  249. ; PPROF_DATA_PATH, use an absolute path when you start gitea as service
  250. PPROF_DATA_PATH = data/tmp/pprof
  251. ; Landing page, can be "home", "explore", or "organizations"
  252. LANDING_PAGE = home
  253. ; Enables git-lfs support. true or false, default is false.
  254. LFS_START_SERVER = false
  255. ; Where your lfs files reside, default is data/lfs.
  256. LFS_CONTENT_PATH = data/lfs
  257. ; LFS authentication secret, change this yourself
  258. LFS_JWT_SECRET =
  259. ; LFS authentication validity period (in time.Duration), pushes taking longer than this may fail.
  260. LFS_HTTP_AUTH_EXPIRY = 20m
  261. ; Allow graceful restarts using SIGHUP to fork
  262. ALLOW_GRACEFUL_RESTARTS = true
  263. ; After a restart the parent will finish ongoing requests before
  264. ; shutting down. Force shutdown if this process takes longer than this delay.
  265. ; set to a negative value to disable
  266. GRACEFUL_HAMMER_TIME = 60s
  267. ; Static resources, includes resources on custom/, public/ and all uploaded avatars web browser cache time, default is 6h
  268. STATIC_CACHE_TIME = 6h
  269. ; Define allowed algorithms and their minimum key length (use -1 to disable a type)
  270. [ssh.minimum_key_sizes]
  271. ED25519 = 256
  272. ECDSA = 256
  273. RSA = 2048
  274. DSA = 1024
  275. [database]
  276. ; Either "mysql", "postgres", "mssql" or "sqlite3", it's your choice
  277. DB_TYPE = mysql
  278. HOST = 127.0.0.1:3306
  279. NAME = gitea
  280. USER = root
  281. ; Use PASSWD = `your password` for quoting if you use special characters in the password.
  282. PASSWD =
  283. ; For Postgres, either "disable" (default), "require", or "verify-full"
  284. ; For MySQL, either "false" (default), "true", or "skip-verify"
  285. SSL_MODE = disable
  286. ; For MySQL only, either "utf8" or "utf8mb4", default is "utf8".
  287. ; NOTICE: for "utf8mb4" you must use MySQL InnoDB > 5.6. Gitea is unable to check this.
  288. CHARSET = utf8
  289. ; For "sqlite3" and "tidb", use an absolute path when you start gitea as service
  290. PATH = data/gitea.db
  291. ; For "sqlite3" only. Query timeout
  292. SQLITE_TIMEOUT = 500
  293. ; For iterate buffer, default is 50
  294. ITERATE_BUFFER_SIZE = 50
  295. ; Show the database generated SQL
  296. LOG_SQL = true
  297. ; Maximum number of DB Connect retries
  298. DB_RETRIES = 10
  299. ; Backoff time per DB retry (time.Duration)
  300. DB_RETRY_BACKOFF = 3s
  301. ; Max idle database connections on connnection pool, default is 0
  302. MAX_IDLE_CONNS = 0
  303. ; Database connection max life time, default is 3s
  304. CONN_MAX_LIFETIME = 3s
  305. [indexer]
  306. ; Issue indexer type, currently support: bleve or db, default is bleve
  307. ISSUE_INDEXER_TYPE = bleve
  308. ; Issue indexer storage path, available when ISSUE_INDEXER_TYPE is bleve
  309. ISSUE_INDEXER_PATH = indexers/issues.bleve
  310. ; Issue indexer queue, currently support: channel, levelqueue or redis, default is levelqueue
  311. ISSUE_INDEXER_QUEUE_TYPE = levelqueue
  312. ; When ISSUE_INDEXER_QUEUE_TYPE is levelqueue, this will be the queue will be saved path,
  313. ; default is indexers/issues.queue
  314. ISSUE_INDEXER_QUEUE_DIR = indexers/issues.queue
  315. ; When `ISSUE_INDEXER_QUEUE_TYPE` is `redis`, this will store the redis connection string.
  316. ISSUE_INDEXER_QUEUE_CONN_STR = "addrs=127.0.0.1:6379 db=0"
  317. ; Batch queue number, default is 20
  318. ISSUE_INDEXER_QUEUE_BATCH_NUMBER = 20
  319. ; Timeout the indexer if it takes longer than this to start.
  320. ; Set to zero to disable timeout.
  321. STARTUP_TIMEOUT=30s
  322. ; repo indexer by default disabled, since it uses a lot of disk space
  323. REPO_INDEXER_ENABLED = false
  324. REPO_INDEXER_PATH = indexers/repos.bleve
  325. UPDATE_BUFFER_LEN = 20
  326. MAX_FILE_SIZE = 1048576
  327. ; A comma separated list of glob patterns (see https://github.com/gobwas/glob) to include
  328. ; in the index; default is empty
  329. REPO_INDEXER_INCLUDE =
  330. ; A comma separated list of glob patterns to exclude from the index; ; default is empty
  331. REPO_INDEXER_EXCLUDE =
  332. [admin]
  333. ; Disallow regular (non-admin) users from creating organizations.
  334. DISABLE_REGULAR_ORG_CREATION = false
  335. ; Default configuration for email notifications for users (user configurable). Options: enabled, onmention, disabled
  336. DEFAULT_EMAIL_NOTIFICATIONS = enabled
  337. [security]
  338. ; Whether the installer is disabled
  339. INSTALL_LOCK = false
  340. ; !!CHANGE THIS TO KEEP YOUR USER DATA SAFE!!
  341. SECRET_KEY = !#@FDEWREWR&*(
  342. ; How long to remember that a user is logged in before requiring relogin (in days)
  343. LOGIN_REMEMBER_DAYS = 7
  344. COOKIE_USERNAME = gitea_awesome
  345. COOKIE_REMEMBER_NAME = gitea_incredible
  346. ; Reverse proxy authentication header name of user name
  347. REVERSE_PROXY_AUTHENTICATION_USER = X-WEBAUTH-USER
  348. REVERSE_PROXY_AUTHENTICATION_EMAIL = X-WEBAUTH-EMAIL
  349. ; The minimum password length for new Users
  350. MIN_PASSWORD_LENGTH = 6
  351. ; Set to true to allow users to import local server paths
  352. IMPORT_LOCAL_PATHS = false
  353. ; Set to true to prevent all users (including admin) from creating custom git hooks
  354. DISABLE_GIT_HOOKS = false
  355. ;Comma separated list of character classes required to pass minimum complexity.
  356. ;If left empty or no valid values are specified, the default values ("lower,upper,digit,spec") will be used.
  357. ;Use "off" to disable checking.
  358. PASSWORD_COMPLEXITY = lower,upper,digit,spec
  359. ; Password Hash algorithm, either "pbkdf2", "argon2", "scrypt" or "bcrypt"
  360. PASSWORD_HASH_ALGO = pbkdf2
  361. ; Set false to allow JavaScript to read CSRF cookie
  362. CSRF_COOKIE_HTTP_ONLY = true
  363. [openid]
  364. ;
  365. ; OpenID is an open, standard and decentralized authentication protocol.
  366. ; Your identity is the address of a webpage you provide, which describes
  367. ; how to prove you are in control of that page.
  368. ;
  369. ; For more info: https://en.wikipedia.org/wiki/OpenID
  370. ;
  371. ; Current implementation supports OpenID-2.0
  372. ;
  373. ; Tested to work providers at the time of writing:
  374. ; - Any GNUSocial node (your.hostname.tld/username)
  375. ; - Any SimpleID provider (http://simpleid.koinic.net)
  376. ; - http://openid.org.cn/
  377. ; - openid.stackexchange.com
  378. ; - login.launchpad.net
  379. ; - <username>.livejournal.com
  380. ;
  381. ; Whether to allow signin in via OpenID
  382. ENABLE_OPENID_SIGNIN = true
  383. ; Whether to allow registering via OpenID
  384. ; Do not include to rely on rhw DISABLE_REGISTRATION setting
  385. ;ENABLE_OPENID_SIGNUP = true
  386. ; Allowed URI patterns (POSIX regexp).
  387. ; Space separated.
  388. ; Only these would be allowed if non-blank.
  389. ; Example value: trusted.domain.org trusted.domain.net
  390. WHITELISTED_URIS =
  391. ; Forbidden URI patterns (POSIX regexp).
  392. ; Space separated.
  393. ; Only used if WHITELISTED_URIS is blank.
  394. ; Example value: loadaverage.org/badguy stackexchange.com/.*spammer
  395. BLACKLISTED_URIS =
  396. [service]
  397. ; Time limit to confirm account/email registration
  398. ACTIVE_CODE_LIVE_MINUTES = 180
  399. ; Time limit to perform the reset of a forgotten password
  400. RESET_PASSWD_CODE_LIVE_MINUTES = 180
  401. ; Whether a new user needs to confirm their email when registering.
  402. REGISTER_EMAIL_CONFIRM = false
  403. ; List of domain names that are allowed to be used to register on a Gitea instance
  404. ; gitea.io,example.com
  405. EMAIL_DOMAIN_WHITELIST=
  406. ; Disallow registration, only allow admins to create accounts.
  407. DISABLE_REGISTRATION = false
  408. ; Allow registration only using third-party services, it works only when DISABLE_REGISTRATION is false
  409. ALLOW_ONLY_EXTERNAL_REGISTRATION = false
  410. ; User must sign in to view anything.
  411. REQUIRE_SIGNIN_VIEW = false
  412. ; Mail notification
  413. ENABLE_NOTIFY_MAIL = false
  414. ; This setting enables gitea to be signed in with HTTP BASIC Authentication using the user's password
  415. ; If you set this to false you will not be able to access the tokens endpoints on the API with your password
  416. ; Please note that setting this to false will not disable OAuth Basic or Basic authentication using a token
  417. ENABLE_BASIC_AUTHENTICATION = true
  418. ; More detail: https://github.com/gogits/gogs/issues/165
  419. ENABLE_REVERSE_PROXY_AUTHENTICATION = false
  420. ENABLE_REVERSE_PROXY_AUTO_REGISTRATION = false
  421. ENABLE_REVERSE_PROXY_EMAIL = false
  422. ; Enable captcha validation for registration
  423. ENABLE_CAPTCHA = false
  424. ; Type of captcha you want to use. Options: image, recaptcha
  425. CAPTCHA_TYPE = image
  426. ; Enable recaptcha to use Google's recaptcha service
  427. ; Go to https://www.google.com/recaptcha/admin to sign up for a key
  428. RECAPTCHA_SECRET =
  429. RECAPTCHA_SITEKEY =
  430. ; Change this to use recaptcha.net or other recaptcha service
  431. RECAPTCHA_URL = https://www.google.com/recaptcha/
  432. ; Default value for KeepEmailPrivate
  433. ; Each new user will get the value of this setting copied into their profile
  434. DEFAULT_KEEP_EMAIL_PRIVATE = false
  435. ; Default value for AllowCreateOrganization
  436. ; Every new user will have rights set to create organizations depending on this setting
  437. DEFAULT_ALLOW_CREATE_ORGANIZATION = true
  438. ; Either "public", "limited" or "private", default is "public"
  439. ; Limited is for signed user only
  440. ; Private is only for member of the organization
  441. ; Public is for everyone
  442. DEFAULT_ORG_VISIBILITY = public
  443. ; Default value for DefaultOrgMemberVisible
  444. ; True will make the membership of the users visible when added to the organisation
  445. DEFAULT_ORG_MEMBER_VISIBLE = false
  446. ; Default value for EnableDependencies
  447. ; Repositories will use dependencies by default depending on this setting
  448. DEFAULT_ENABLE_DEPENDENCIES = true
  449. ; Enable heatmap on users profiles.
  450. ENABLE_USER_HEATMAP = true
  451. ; Enable Timetracking
  452. ENABLE_TIMETRACKING = true
  453. ; Default value for EnableTimetracking
  454. ; Repositories will use timetracking by default depending on this setting
  455. DEFAULT_ENABLE_TIMETRACKING = true
  456. ; Default value for AllowOnlyContributorsToTrackTime
  457. ; Only users with write permissions can track time if this is true
  458. DEFAULT_ALLOW_ONLY_CONTRIBUTORS_TO_TRACK_TIME = true
  459. ; Default value for the domain part of the user's email address in the git log
  460. ; if he has set KeepEmailPrivate to true. The user's email will be replaced with a
  461. ; concatenation of the user name in lower case, "@" and NO_REPLY_ADDRESS.
  462. NO_REPLY_ADDRESS = noreply.example.org
  463. ; Show Registration button
  464. SHOW_REGISTRATION_BUTTON = true
  465. ; Default value for AutoWatchNewRepos
  466. ; When adding a repo to a team or creating a new repo all team members will watch the
  467. ; repo automatically if enabled
  468. AUTO_WATCH_NEW_REPOS = true
  469. [webhook]
  470. ; Hook task queue length, increase if webhook shooting starts hanging
  471. QUEUE_LENGTH = 1000
  472. ; Deliver timeout in seconds
  473. DELIVER_TIMEOUT = 5
  474. ; Allow insecure certification
  475. SKIP_TLS_VERIFY = false
  476. ; Number of history information in each page
  477. PAGING_NUM = 10
  478. [mailer]
  479. ENABLED = false
  480. ; Buffer length of channel, keep it as it is if you don't know what it is.
  481. SEND_BUFFER_LEN = 100
  482. ; Prefix displayed before subject in mail
  483. SUBJECT_PREFIX =
  484. ; Mail server
  485. ; Gmail: smtp.gmail.com:587
  486. ; QQ: smtp.qq.com:465
  487. ; Note, if the port ends with "465", SMTPS will be used. Using STARTTLS on port 587 is recommended per RFC 6409. If the server supports STARTTLS it will always be used.
  488. HOST =
  489. ; Disable HELO operation when hostnames are different.
  490. DISABLE_HELO =
  491. ; Custom hostname for HELO operation, if no value is provided, one is retrieved from system.
  492. HELO_HOSTNAME =
  493. ; Do not verify the certificate of the server. Only use this for self-signed certificates
  494. SKIP_VERIFY =
  495. ; Use client certificate
  496. USE_CERTIFICATE = false
  497. CERT_FILE = custom/mailer/cert.pem
  498. KEY_FILE = custom/mailer/key.pem
  499. ; Should SMTP connection use TLS
  500. IS_TLS_ENABLED = false
  501. ; Mail from address, RFC 5322. This can be just an email address, or the `"Name" <email@example.com>` format
  502. FROM =
  503. ; Mailer user name and password
  504. USER =
  505. ; Use PASSWD = `your password` for quoting if you use special characters in the password.
  506. PASSWD =
  507. ; Send mails as plain text
  508. SEND_AS_PLAIN_TEXT = false
  509. ; Set Mailer Type (either SMTP, sendmail or dummy to just send to the log)
  510. MAILER_TYPE = smtp
  511. ; Specify an alternative sendmail binary
  512. SENDMAIL_PATH = sendmail
  513. ; Specify any extra sendmail arguments
  514. SENDMAIL_ARGS =
  515. [cache]
  516. ; Either "memory", "redis", or "memcache", default is "memory"
  517. ADAPTER = memory
  518. ; For "memory" only, GC interval in seconds, default is 60
  519. INTERVAL = 60
  520. ; For "redis" and "memcache", connection host address
  521. ; redis: network=tcp,addr=:6379,password=macaron,db=0,pool_size=100,idle_timeout=180
  522. ; memcache: `127.0.0.1:11211`
  523. HOST =
  524. ; Time to keep items in cache if not used, default is 16 hours.
  525. ; Setting it to 0 disables caching
  526. ITEM_TTL = 16h
  527. [session]
  528. ; Either "memory", "file", or "redis", default is "memory"
  529. PROVIDER = memory
  530. ; Provider config options
  531. ; memory: doesn't have any config yet
  532. ; file: session file path, e.g. `data/sessions`
  533. ; redis: network=tcp,addr=:6379,password=macaron,db=0,pool_size=100,idle_timeout=180
  534. ; mysql: go-sql-driver/mysql dsn config string, e.g. `root:password@/session_table`
  535. PROVIDER_CONFIG = data/sessions
  536. ; Session cookie name
  537. COOKIE_NAME = i_like_gitea
  538. ; If you use session in https only, default is false
  539. COOKIE_SECURE = false
  540. ; Enable set cookie, default is true
  541. ENABLE_SET_COOKIE = true
  542. ; Session GC time interval in seconds, default is 86400 (1 day)
  543. GC_INTERVAL_TIME = 86400
  544. ; Session life time in seconds, default is 86400 (1 day)
  545. SESSION_LIFE_TIME = 86400
  546. [picture]
  547. AVATAR_UPLOAD_PATH = data/avatars
  548. REPOSITORY_AVATAR_UPLOAD_PATH = data/repo-avatars
  549. ; How Gitea deals with missing repository avatars
  550. ; none = no avatar will be displayed; random = random avatar will be displayed; image = default image will be used
  551. REPOSITORY_AVATAR_FALLBACK = none
  552. REPOSITORY_AVATAR_FALLBACK_IMAGE = /img/repo_default.png
  553. ; Max Width and Height of uploaded avatars.
  554. ; This is to limit the amount of RAM used when resizing the image.
  555. AVATAR_MAX_WIDTH = 4096
  556. AVATAR_MAX_HEIGHT = 3072
  557. ; Maximum alloved file size for uploaded avatars.
  558. ; This is to limit the amount of RAM used when resizing the image.
  559. AVATAR_MAX_FILE_SIZE = 1048576
  560. ; Chinese users can choose "duoshuo"
  561. ; or a custom avatar source, like: http://cn.gravatar.com/avatar/
  562. GRAVATAR_SOURCE = gravatar
  563. ; This value will always be true in offline mode.
  564. DISABLE_GRAVATAR = false
  565. ; Federated avatar lookup uses DNS to discover avatar associated
  566. ; with emails, see https://www.libravatar.org
  567. ; This value will always be false in offline mode or when Gravatar is disabled.
  568. ENABLE_FEDERATED_AVATAR = false
  569. [attachment]
  570. ; Whether attachments are enabled. Defaults to `true`
  571. ENABLED = true
  572. ; Path for attachments. Defaults to `data/attachments`
  573. PATH = data/attachments
  574. ; One or more allowed types, e.g. image/jpeg|image/png
  575. ALLOWED_TYPES = image/jpeg|image/png|application/zip|application/gzip
  576. ; Max size of each file. Defaults to 4MB
  577. MAX_SIZE = 4
  578. ; Max number of files per upload. Defaults to 5
  579. MAX_FILES = 5
  580. [time]
  581. ; Specifies the format for fully outputted dates. Defaults to RFC1123
  582. ; Special supported values are ANSIC, UnixDate, RubyDate, RFC822, RFC822Z, RFC850, RFC1123, RFC1123Z, RFC3339, RFC3339Nano, Kitchen, Stamp, StampMilli, StampMicro and StampNano
  583. ; For more information about the format see http://golang.org/pkg/time/#pkg-constants
  584. FORMAT =
  585. ; Location the UI time display i.e. Asia/Shanghai
  586. ; Empty means server's location setting
  587. DEFAULT_UI_LOCATION =
  588. [log]
  589. ROOT_PATH =
  590. ; Either "console", "file", "conn", "smtp" or "database", default is "console"
  591. ; Use comma to separate multiple modes, e.g. "console, file"
  592. MODE = console
  593. ; Buffer length of the channel, keep it as it is if you don't know what it is.
  594. BUFFER_LEN = 10000
  595. REDIRECT_MACARON_LOG = false
  596. MACARON = file
  597. ; Either "Trace", "Debug", "Info", "Warn", "Error", "Critical", default is "Info"
  598. ROUTER_LOG_LEVEL = Info
  599. ROUTER = console
  600. ENABLE_ACCESS_LOG = false
  601. ACCESS_LOG_TEMPLATE = {{.Ctx.RemoteAddr}} - {{.Identity}} {{.Start.Format "[02/Jan/2006:15:04:05 -0700]" }} "{{.Ctx.Req.Method}} {{.Ctx.Req.RequestURI}} {{.Ctx.Req.Proto}}" {{.ResponseWriter.Status}} {{.ResponseWriter.Size}} "{{.Ctx.Req.Referer}}\" \"{{.Ctx.Req.UserAgent}}"
  602. ACCESS = file
  603. ; Either "Trace", "Debug", "Info", "Warn", "Error", "Critical", default is "Trace"
  604. LEVEL = Info
  605. ; Either "Trace", "Debug", "Info", "Warn", "Error", "Critical", default is "None"
  606. STACKTRACE_LEVEL = None
  607. ; Generic log modes
  608. [log.x]
  609. FLAGS = stdflags
  610. EXPRESSION =
  611. PREFIX =
  612. COLORIZE = false
  613. ; For "console" mode only
  614. [log.console]
  615. LEVEL =
  616. STDERR = false
  617. ; For "file" mode only
  618. [log.file]
  619. LEVEL =
  620. ; Set the file_name for the logger. If this is a relative path this
  621. ; will be relative to ROOT_PATH
  622. FILE_NAME =
  623. ; This enables automated log rotate(switch of following options), default is true
  624. LOG_ROTATE = true
  625. ; Max number of lines in a single file, default is 1000000
  626. MAX_LINES = 1000000
  627. ; Max size shift of a single file, default is 28 means 1 << 28, 256MB
  628. MAX_SIZE_SHIFT = 28
  629. ; Segment log daily, default is true
  630. DAILY_ROTATE = true
  631. ; delete the log file after n days, default is 7
  632. MAX_DAYS = 7
  633. ; compress logs with gzip
  634. COMPRESS = true
  635. ; compression level see godoc for compress/gzip
  636. COMPRESSION_LEVEL = -1
  637. ; For "conn" mode only
  638. [log.conn]
  639. LEVEL =
  640. ; Reconnect host for every single message, default is false
  641. RECONNECT_ON_MSG = false
  642. ; Try to reconnect when connection is lost, default is false
  643. RECONNECT = false
  644. ; Either "tcp", "unix" or "udp", default is "tcp"
  645. PROTOCOL = tcp
  646. ; Host address
  647. ADDR =
  648. ; For "smtp" mode only
  649. [log.smtp]
  650. LEVEL =
  651. ; Name displayed in mail title, default is "Diagnostic message from server"
  652. SUBJECT = Diagnostic message from server
  653. ; Mail server
  654. HOST =
  655. ; Mailer user name and password
  656. USER =
  657. ; Use PASSWD = `your password` for quoting if you use special characters in the password.
  658. PASSWD =
  659. ; Receivers, can be one or more, e.g. 1@example.com,2@example.com
  660. RECEIVERS =
  661. [cron]
  662. ; Enable running cron tasks periodically.
  663. ENABLED = true
  664. ; Run cron tasks when Gitea starts.
  665. RUN_AT_START = false
  666. ; Update mirrors
  667. [cron.update_mirrors]
  668. SCHEDULE = @every 10m
  669. ; Repository health check
  670. [cron.repo_health_check]
  671. SCHEDULE = @every 24h
  672. TIMEOUT = 60s
  673. ; Arguments for command 'git fsck', e.g. "--unreachable --tags"
  674. ; see more on http://git-scm.com/docs/git-fsck
  675. ARGS =
  676. ; Check repository statistics
  677. [cron.check_repo_stats]
  678. RUN_AT_START = true
  679. SCHEDULE = @every 24h
  680. ; Clean up old repository archives
  681. [cron.archive_cleanup]
  682. ; Whether to enable the job
  683. ENABLED = true
  684. ; Whether to always run at least once at start up time (if ENABLED)
  685. RUN_AT_START = true
  686. ; Time interval for job to run
  687. SCHEDULE = @every 24h
  688. ; Archives created more than OLDER_THAN ago are subject to deletion
  689. OLDER_THAN = 24h
  690. ; Synchronize external user data (only LDAP user synchronization is supported)
  691. [cron.sync_external_users]
  692. ; Synchronize external user data when starting server (default false)
  693. RUN_AT_START = false
  694. ; Interval as a duration between each synchronization (default every 24h)
  695. SCHEDULE = @every 24h
  696. ; Create new users, update existing user data and disable users that are not in external source anymore (default)
  697. ; or only create new users if UPDATE_EXISTING is set to false
  698. UPDATE_EXISTING = true
  699. ; Update migrated repositories' issues and comments' posterid, it will always attempt synchronization when the instance starts.
  700. [cron.update_migration_post_id]
  701. ; Interval as a duration between each synchronization. (default every 24h)
  702. SCHEDULE = @every 24h
  703. [git]
  704. ; The path of git executable. If empty, Gitea searches through the PATH environment.
  705. PATH =
  706. ; Disables highlight of added and removed changes
  707. DISABLE_DIFF_HIGHLIGHT = false
  708. ; Max number of lines allowed in a single file in diff view
  709. MAX_GIT_DIFF_LINES = 1000
  710. ; Max number of allowed characters in a line in diff view
  711. MAX_GIT_DIFF_LINE_CHARACTERS = 5000
  712. ; Max number of files shown in diff view
  713. MAX_GIT_DIFF_FILES = 100
  714. ; Arguments for command 'git gc', e.g. "--aggressive --auto"
  715. ; see more on http://git-scm.com/docs/git-gc/
  716. GC_ARGS =
  717. ; If use git wire protocol version 2 when git version >= 2.18, default is true, set to false when you always want git wire protocol version 1
  718. EnableAutoGitWireProtocol = true
  719. ; Operation timeout in seconds
  720. [git.timeout]
  721. DEFAULT = 360
  722. MIGRATE = 600
  723. MIRROR = 300
  724. CLONE = 300
  725. PULL = 300
  726. GC = 60
  727. [mirror]
  728. ; Default interval as a duration between each check
  729. DEFAULT_INTERVAL = 8h
  730. ; Min interval as a duration must be > 1m
  731. MIN_INTERVAL = 10m
  732. [api]
  733. ; Enables Swagger. True or false; default is true.
  734. ENABLE_SWAGGER = true
  735. ; Max number of items in a page
  736. MAX_RESPONSE_ITEMS = 50
  737. ; Default paging number of api
  738. DEFAULT_PAGING_NUM = 30
  739. ; Default and maximum number of items per page for git trees api
  740. DEFAULT_GIT_TREES_PER_PAGE = 1000
  741. ; Default size of a blob returned by the blobs API (default is 10MiB)
  742. DEFAULT_MAX_BLOB_SIZE = 10485760
  743. [oauth2]
  744. ; Enables OAuth2 provider
  745. ENABLE = true
  746. ; Lifetime of an OAuth2 access token in seconds
  747. ACCESS_TOKEN_EXPIRATION_TIME=3600
  748. ; Lifetime of an OAuth2 access token in hours
  749. REFRESH_TOKEN_EXPIRATION_TIME=730
  750. ; Check if refresh token got already used
  751. INVALIDATE_REFRESH_TOKENS=false
  752. ; OAuth2 authentication secret for access and refresh tokens, change this to a unique string.
  753. JWT_SECRET=Bk0yK7Y9g_p56v86KaHqjSbxvNvu3SbKoOdOt2ZcXvU
  754. [i18n]
  755. LANGS = en-US,zh-CN,zh-HK,zh-TW,de-DE,fr-FR,nl-NL,lv-LV,ru-RU,uk-UA,ja-JP,es-ES,pt-BR,pl-PL,bg-BG,it-IT,fi-FI,tr-TR,cs-CZ,sr-SP,sv-SE,ko-KR
  756. NAMES = English,简体中文,繁體中文(香港),繁體中文(台灣),Deutsch,français,Nederlands,latviešu,русский,Українська,日本語,español,português do Brasil,polski,български,italiano,suomi,Türkçe,čeština,српски,svenska,한국어
  757. ; Used for datetimepicker
  758. [i18n.datelang]
  759. en-US = en
  760. zh-CN = zh
  761. zh-HK = zh-HK
  762. zh-TW = zh-TW
  763. de-DE = de
  764. fr-FR = fr
  765. nl-NL = nl
  766. lv-LV = lv
  767. ru-RU = ru
  768. uk-UA = uk
  769. ja-JP = ja
  770. es-ES = es
  771. pt-BR = pt-BR
  772. pl-PL = pl
  773. bg-BG = bg
  774. it-IT = it
  775. fi-FI = fi
  776. tr-TR = tr
  777. cs-CZ = cs-CZ
  778. sr-SP = sr
  779. sv-SE = sv
  780. ko-KR = ko
  781. [U2F]
  782. ; NOTE: THE DEFAULT VALUES HERE WILL NEED TO BE CHANGED
  783. ; Two Factor authentication with security keys
  784. ; https://developers.yubico.com/U2F/App_ID.html
  785. ;APP_ID = http://localhost:3000/
  786. ; Comma seperated list of trusted facets
  787. ;TRUSTED_FACETS = http://localhost:3000/
  788. ; Extension mapping to highlight class
  789. ; e.g. .toml=ini
  790. [highlight.mapping]
  791. [other]
  792. SHOW_FOOTER_BRANDING = false
  793. ; Show version information about Gitea and Go in the footer
  794. SHOW_FOOTER_VERSION = true
  795. ; Show template execution time in the footer
  796. SHOW_FOOTER_TEMPLATE_LOAD_TIME = true
  797. [markup.asciidoc]
  798. ENABLED = false
  799. ; List of file extensions that should be rendered by an external command
  800. FILE_EXTENSIONS = .adoc,.asciidoc
  801. ; External command to render all matching extensions
  802. RENDER_COMMAND = "asciidoc --out-file=- -"
  803. ; Don't pass the file on STDIN, pass the filename as argument instead.
  804. IS_INPUT_FILE = false
  805. [metrics]
  806. ; Enables metrics endpoint. True or false; default is false.
  807. ENABLED = false
  808. ; If you want to add authorization, specify a token here
  809. TOKEN =
  810. [task]
  811. ; Task queue type, could be `channel` or `redis`.
  812. QUEUE_TYPE = channel
  813. ; Task queue length, available only when `QUEUE_TYPE` is `channel`.
  814. QUEUE_LENGTH = 1000
  815. ; Task queue connction string, available only when `QUEUE_TYPE` is `redis`.
  816. ; If there is a password of redis, use `addrs=127.0.0.1:6379 password=123 db=0`.
  817. QUEUE_CONN_STR = "addrs=127.0.0.1:6379 db=0"