configs: updated docstrings, and improved explanation of some settings
This commit is contained in:
Marcin Kuzminski
parent
faa8b8bf85
commit
a2aefa6412
2 changed files with 64 additions and 28 deletions
|
|
@ -1,24 +1,37 @@
|
|||
|
||||
|
||||
################################################################################
|
||||
################################################################################
|
||||
# RhodeCode Enterprise - configuration file #
|
||||
# Built-in functions and variables #
|
||||
## RHODECODE ENTERPRISE CONFIGURATION ##
|
||||
# The %(here)s variable will be replaced with the parent directory of this file#
|
||||
# #
|
||||
################################################################################
|
||||
|
||||
[DEFAULT]
|
||||
debug = true
|
||||
|
||||
################################################################################
|
||||
## EMAIL CONFIGURATION ##
|
||||
## Uncomment and replace with the email address which should receive ##
|
||||
## any error reports after an application crash ##
|
||||
## Additionally these settings will be used by the RhodeCode mailing system ##
|
||||
################################################################################
|
||||
#email_to = admin@localhost
|
||||
#error_email_from = paste_error@localhost
|
||||
#app_email_from = rhodecode-noreply@localhost
|
||||
#error_message =
|
||||
|
||||
## prefix all emails subjects with given prefix, helps filtering out emails
|
||||
#email_prefix = [RhodeCode]
|
||||
|
||||
## email FROM address all mails will be sent
|
||||
#app_email_from = rhodecode-noreply@localhost
|
||||
|
||||
## Uncomment and replace with the address which should receive any error report
|
||||
## note: using appenlight for error handling doesn't need this to be uncommented
|
||||
#email_to = admin@localhost
|
||||
|
||||
## in case of Application errors, sent an error email form
|
||||
#error_email_from = rhodecode_error@localhost
|
||||
|
||||
## additional error message to be send in case of server crash
|
||||
#error_message =
|
||||
|
||||
|
||||
#smtp_server = mail.server.com
|
||||
#smtp_username =
|
||||
#smtp_password =
|
||||
|
|
@ -37,6 +50,7 @@ port = 5000
|
|||
## WAITRESS WSGI SERVER ##
|
||||
## Recommended for Development ##
|
||||
##################################
|
||||
|
||||
use = egg:waitress#main
|
||||
## number of worker threads
|
||||
threads = 5
|
||||
|
|
@ -51,6 +65,7 @@ asyncore_use_poll = true
|
|||
## GUNICORN WSGI SERVER ##
|
||||
##########################
|
||||
## run with gunicorn --log-config <inifile.ini> --paste <inifile.ini>
|
||||
|
||||
#use = egg:gunicorn#main
|
||||
## Sets the number of process workers. You must set `instance_id = *`
|
||||
## when this option is set to more than one worker, recommended
|
||||
|
|
@ -400,10 +415,12 @@ search.location = %(here)s/data/index
|
|||
## in the system. It's also used by the chat system
|
||||
|
||||
channelstream.enabled = true
|
||||
# location of channelstream server on the backend
|
||||
## location of channelstream server on the backend
|
||||
channelstream.server = 127.0.0.1:9800
|
||||
# location of the channelstream server from outside world
|
||||
channelstream.ws_url = ws://127.0.0.1:9800
|
||||
## location of the channelstream server from outside world
|
||||
## most likely this would be an http server special backend URL, that handles
|
||||
## websocket connections see nginx example for config
|
||||
channelstream.ws_url = ws://rhodecode.yourserver.com/_channelstream
|
||||
channelstream.secret = secret
|
||||
channelstream.history.location = %(here)s/channelstream_history
|
||||
|
||||
|
|
@ -545,9 +562,10 @@ vcs.connection_timeout = 3600
|
|||
#vcs.svn.compatible_version = pre-1.8-compatible
|
||||
|
||||
|
||||
##############################################
|
||||
### Subversion proxy support (mod_dav_svn) ###
|
||||
##############################################
|
||||
############################################################
|
||||
### Subversion proxy support (mod_dav_svn) ###
|
||||
### Maps RhodeCode repo groups into SVN paths for Apache ###
|
||||
############################################################
|
||||
## Enable or disable the config file generation.
|
||||
svn.proxy.generate_config = false
|
||||
## Generate config file with `SVNListParentPath` set to `On`.
|
||||
|
|
|
|||
|
|
@ -1,24 +1,37 @@
|
|||
|
||||
|
||||
################################################################################
|
||||
################################################################################
|
||||
# RhodeCode Enterprise - configuration file #
|
||||
# Built-in functions and variables #
|
||||
## RHODECODE ENTERPRISE CONFIGURATION ##
|
||||
# The %(here)s variable will be replaced with the parent directory of this file#
|
||||
# #
|
||||
################################################################################
|
||||
|
||||
[DEFAULT]
|
||||
debug = true
|
||||
|
||||
################################################################################
|
||||
## EMAIL CONFIGURATION ##
|
||||
## Uncomment and replace with the email address which should receive ##
|
||||
## any error reports after an application crash ##
|
||||
## Additionally these settings will be used by the RhodeCode mailing system ##
|
||||
################################################################################
|
||||
#email_to = admin@localhost
|
||||
#error_email_from = paste_error@localhost
|
||||
#app_email_from = rhodecode-noreply@localhost
|
||||
#error_message =
|
||||
|
||||
## prefix all emails subjects with given prefix, helps filtering out emails
|
||||
#email_prefix = [RhodeCode]
|
||||
|
||||
## email FROM address all mails will be sent
|
||||
#app_email_from = rhodecode-noreply@localhost
|
||||
|
||||
## Uncomment and replace with the address which should receive any error report
|
||||
## note: using appenlight for error handling doesn't need this to be uncommented
|
||||
#email_to = admin@localhost
|
||||
|
||||
## in case of Application errors, sent an error email form
|
||||
#error_email_from = rhodecode_error@localhost
|
||||
|
||||
## additional error message to be send in case of server crash
|
||||
#error_message =
|
||||
|
||||
|
||||
#smtp_server = mail.server.com
|
||||
#smtp_username =
|
||||
#smtp_password =
|
||||
|
|
@ -37,6 +50,7 @@ port = 5000
|
|||
## WAITRESS WSGI SERVER ##
|
||||
## Recommended for Development ##
|
||||
##################################
|
||||
|
||||
#use = egg:waitress#main
|
||||
## number of worker threads
|
||||
#threads = 5
|
||||
|
|
@ -51,6 +65,7 @@ port = 5000
|
|||
## GUNICORN WSGI SERVER ##
|
||||
##########################
|
||||
## run with gunicorn --log-config <inifile.ini> --paste <inifile.ini>
|
||||
|
||||
use = egg:gunicorn#main
|
||||
## Sets the number of process workers. You must set `instance_id = *`
|
||||
## when this option is set to more than one worker, recommended
|
||||
|
|
@ -374,10 +389,12 @@ search.location = %(here)s/data/index
|
|||
## in the system. It's also used by the chat system
|
||||
|
||||
channelstream.enabled = true
|
||||
# location of channelstream server on the backend
|
||||
## location of channelstream server on the backend
|
||||
channelstream.server = 127.0.0.1:9800
|
||||
# location of the channelstream server from outside world
|
||||
channelstream.ws_url = ws://127.0.0.1:9800
|
||||
## location of the channelstream server from outside world
|
||||
## most likely this would be an http server special backend URL, that handles
|
||||
## websocket connections see nginx example for config
|
||||
channelstream.ws_url = ws://rhodecode.yourserver.com/_channelstream
|
||||
channelstream.secret = secret
|
||||
channelstream.history.location = %(here)s/channelstream_history
|
||||
|
||||
|
|
@ -514,9 +531,10 @@ vcs.connection_timeout = 3600
|
|||
#vcs.svn.compatible_version = pre-1.8-compatible
|
||||
|
||||
|
||||
##############################################
|
||||
### Subversion proxy support (mod_dav_svn) ###
|
||||
##############################################
|
||||
############################################################
|
||||
### Subversion proxy support (mod_dav_svn) ###
|
||||
### Maps RhodeCode repo groups into SVN paths for Apache ###
|
||||
############################################################
|
||||
## Enable or disable the config file generation.
|
||||
svn.proxy.generate_config = false
|
||||
## Generate config file with `SVNListParentPath` set to `On`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue