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

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