diff --git a/configs/development.ini b/configs/development.ini --- a/configs/development.ini +++ b/configs/development.ini @@ -53,7 +53,7 @@ asyncore_use_poll = true ## run with gunicorn --log-config rhodecode.ini --paste rhodecode.ini #use = egg:gunicorn#main -## Sets the number of process workers. More workers means more concurent connections +## Sets the number of process workers. More workers means more concurrent connections ## RhodeCode can handle at the same time. Each additional worker also it increases ## memory usage as each has it's own set of caches. ## Recommended value is (2 * NUMBER_OF_CPUS + 1), eg 2CPU = 5 workers, but no more @@ -133,10 +133,10 @@ rhodecode.api.url = /_admin/api ## `SignatureVerificationError` in case of wrong key, or damaged encryption data. #rhodecode.encrypted_values.strict = false -## return gzipped responses from Rhodecode (static files/application) +## return gzipped responses from RhodeCode (static files/application) gzip_responses = false -## autogenerate javascript routes file on startup +## auto-generate javascript routes file on startup generate_js_files = false ## System global default language. @@ -153,7 +153,7 @@ startup.import_repos = false ## the repository. #archive_cache_dir = /tmp/tarballcache -## URL at which the application is running. This is used for bootstraping +## URL at which the application is running. This is used for Bootstrapping ## requests in context when no web request is available. Used in ishell, or ## SSH calls. Set this for events to receive proper url for SSH calls. app.base_url = http://rhodecode.local @@ -203,7 +203,7 @@ gist_alias_url = ## used for access. ## Adding ?auth_token=TOKEN_HASH to the url authenticates this request as if it ## came from the the logged in user who own this authentication token. -## Additionally @TOKEN syntaxt can be used to bound the view to specific +## Additionally @TOKEN syntax can be used to bound the view to specific ## authentication token. Such view would be only accessible when used together ## with this authentication token ## @@ -227,14 +227,14 @@ default_encoding = UTF-8 ## instance-id prefix ## a prefix key for this instance used for cache invalidation when running -## multiple instances of rhodecode, make sure it's globally unique for -## all running rhodecode instances. Leave empty if you don't use it +## multiple instances of RhodeCode, make sure it's globally unique for +## all running RhodeCode instances. Leave empty if you don't use it instance_id = ## Fallback authentication plugin. Set this to a plugin ID to force the usage ## of an authentication plugin also if it is disabled by it's settings. ## This could be useful if you are unable to log in to the system due to broken -## authentication settings. Then you can enable e.g. the internal rhodecode auth +## authentication settings. Then you can enable e.g. the internal RhodeCode auth ## module to log in again and fix the settings. ## ## Available builtin plugin IDs (hash is part of the ID): @@ -250,7 +250,7 @@ instance_id = ## response is 401 HTTPUnauthorized. Currently HG clients have troubles with ## handling that causing a series of failed authentication calls. ## Set this variable to 403 to return HTTPForbidden, or any other HTTP code -## This will be served instead of default 401 on bad authnetication +## This will be served instead of default 401 on bad authentication auth_ret_code = ## use special detection method when serving auth_ret_code, instead of serving @@ -286,7 +286,7 @@ labs_settings_active = true ## File store configuration. This is used to store and serve uploaded files file_store.enabled = true -## backend, only available one is local +## Storage backend, available options are: local file_store.backend = local ## path to store the uploaded binaries file_store.storage_path = %(here)s/data/file_store @@ -332,6 +332,7 @@ rc_cache.cache_perms.expiration_time = 3 #rc_cache.cache_perms.arguments.host = localhost #rc_cache.cache_perms.arguments.port = 6379 #rc_cache.cache_perms.arguments.db = 0 +## more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends #rc_cache.cache_perms.arguments.distributed_lock = true ## `cache_repo` cache settings for FileTree, Readme, RSS FEEDS @@ -347,6 +348,7 @@ rc_cache.cache_repo.expiration_time = 25 #rc_cache.cache_repo.arguments.host = localhost #rc_cache.cache_repo.arguments.port = 6379 #rc_cache.cache_repo.arguments.db = 1 +## more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends #rc_cache.cache_repo.arguments.distributed_lock = true ## cache settings for SQL queries, this needs to use memory type backend @@ -431,7 +433,7 @@ channelstream.server = 127.0.0.1:9800 ## location of the channelstream server from outside world ## use ws:// for http or wss:// for https. This address needs to be handled ## by external HTTP server such as Nginx or Apache -## see nginx/apache configuration examples in our docs +## see Nginx/Apache configuration examples in our docs channelstream.ws_url = ws://rhodecode.yourserver.com/_channelstream channelstream.secret = secret channelstream.history.location = %(here)s/channelstream_history @@ -448,14 +450,14 @@ channelstream.proxy_path = /_channelstre ## Appenlight is tailored to work with RhodeCode, see ## http://appenlight.com for details how to obtain an account -## appenlight integration enabled +## Appenlight integration enabled appenlight = false appenlight.server_url = https://api.appenlight.com appenlight.api_key = YOUR_API_KEY #appenlight.transport_config = https://api.appenlight.com?threaded=1&timeout=5 -# used for JS client +## used for JS client appenlight.api_public_key = YOUR_API_PUBLIC_KEY ## TWEAK AMOUNT OF INFO SENT HERE @@ -480,7 +482,7 @@ appenlight.logging.level = WARNING ## (saves API quota for intensive logging) appenlight.logging_on_error = false -## list of additonal keywords that should be grabbed from environ object +## list of additional keywords that should be grabbed from environ object ## can be string with comma separated list of words in lowercase ## (by default client will always send following info: ## 'REMOTE_USER', 'REMOTE_ADDR', 'SERVER_NAME', 'CONTENT_TYPE' + all keys that @@ -540,7 +542,7 @@ sqlalchemy.db1.convert_unicode = true vcs.server.enable = true vcs.server = localhost:9900 -## Web server connectivity protocol, responsible for web based VCS operatations +## Web server connectivity protocol, responsible for web based VCS operations ## Available protocols are: ## `http` - use http-rpc backend (default) vcs.server.protocol = http @@ -589,7 +591,8 @@ svn.proxy.config_file_path = %(here)s/mo ## In most cases it should be set to `/`. svn.proxy.location_root = / ## Command to reload the mod dav svn configuration on change. -## Example: `/etc/init.d/apache2 reload` +## Example: `/etc/init.d/apache2 reload` or /home/USER/apache_reload.sh +## Make sure user who runs RhodeCode process is allowed to reload Apache #svn.proxy.reload_cmd = /etc/init.d/apache2 reload ## If the timeout expires before the reload command finishes, the command will ## be killed. Setting it to zero means no timeout. Defaults to 10 seconds. @@ -600,7 +603,7 @@ svn.proxy.location_root = / ############################################################ ## Defines if a custom authorized_keys file should be created and written on -## any change user ssh keys. Setting this to false also disables posibility +## any change user ssh keys. Setting this to false also disables possibility ## of adding SSH keys by users from web interface. Super admins can still ## manage SSH Keys. ssh.generate_authorized_keyfile = false @@ -608,13 +611,13 @@ ssh.generate_authorized_keyfile = false ## Options for ssh, default is `no-pty,no-port-forwarding,no-X11-forwarding,no-agent-forwarding` # ssh.authorized_keys_ssh_opts = -## Path to the authrozied_keys file where the generate entries are placed. +## Path to the authorized_keys file where the generate entries are placed. ## It is possible to have multiple key files specified in `sshd_config` e.g. ## AuthorizedKeysFile %h/.ssh/authorized_keys %h/.ssh/authorized_keys_rhodecode ssh.authorized_keys_file_path = ~/.ssh/authorized_keys_rhodecode ## Command to execute the SSH wrapper. The binary is available in the -## rhodecode installation directory. +## RhodeCode installation directory. ## e.g ~/.rccontrol/community-1/profile/bin/rc-ssh-wrapper ssh.wrapper_cmd = ~/.rccontrol/community-1/rc-ssh-wrapper @@ -622,7 +625,7 @@ ssh.wrapper_cmd = ~/.rccontrol/community ssh.wrapper_cmd_allow_shell = false ## Enables logging, and detailed output send back to the client during SSH -## operations. Usefull for debugging, shouldn't be used in production. +## operations. Useful for debugging, shouldn't be used in production. ssh.enable_debug_logging = true ## Paths to binary executable, by default they are the names, but we can diff --git a/configs/production.ini b/configs/production.ini --- a/configs/production.ini +++ b/configs/production.ini @@ -53,7 +53,7 @@ port = 5000 ## run with gunicorn --log-config rhodecode.ini --paste rhodecode.ini use = egg:gunicorn#main -## Sets the number of process workers. More workers means more concurent connections +## Sets the number of process workers. More workers means more concurrent connections ## RhodeCode can handle at the same time. Each additional worker also it increases ## memory usage as each has it's own set of caches. ## Recommended value is (2 * NUMBER_OF_CPUS + 1), eg 2CPU = 5 workers, but no more @@ -108,10 +108,10 @@ use = egg:rhodecode-enterprise-ce ## `SignatureVerificationError` in case of wrong key, or damaged encryption data. #rhodecode.encrypted_values.strict = false -## return gzipped responses from Rhodecode (static files/application) +## return gzipped responses from RhodeCode (static files/application) gzip_responses = false -## autogenerate javascript routes file on startup +## auto-generate javascript routes file on startup generate_js_files = false ## System global default language. @@ -128,7 +128,7 @@ startup.import_repos = false ## the repository. #archive_cache_dir = /tmp/tarballcache -## URL at which the application is running. This is used for bootstraping +## URL at which the application is running. This is used for Bootstrapping ## requests in context when no web request is available. Used in ishell, or ## SSH calls. Set this for events to receive proper url for SSH calls. app.base_url = http://rhodecode.local @@ -178,7 +178,7 @@ gist_alias_url = ## used for access. ## Adding ?auth_token=TOKEN_HASH to the url authenticates this request as if it ## came from the the logged in user who own this authentication token. -## Additionally @TOKEN syntaxt can be used to bound the view to specific +## Additionally @TOKEN syntax can be used to bound the view to specific ## authentication token. Such view would be only accessible when used together ## with this authentication token ## @@ -202,14 +202,14 @@ default_encoding = UTF-8 ## instance-id prefix ## a prefix key for this instance used for cache invalidation when running -## multiple instances of rhodecode, make sure it's globally unique for -## all running rhodecode instances. Leave empty if you don't use it +## multiple instances of RhodeCode, make sure it's globally unique for +## all running RhodeCode instances. Leave empty if you don't use it instance_id = ## Fallback authentication plugin. Set this to a plugin ID to force the usage ## of an authentication plugin also if it is disabled by it's settings. ## This could be useful if you are unable to log in to the system due to broken -## authentication settings. Then you can enable e.g. the internal rhodecode auth +## authentication settings. Then you can enable e.g. the internal RhodeCode auth ## module to log in again and fix the settings. ## ## Available builtin plugin IDs (hash is part of the ID): @@ -225,7 +225,7 @@ instance_id = ## response is 401 HTTPUnauthorized. Currently HG clients have troubles with ## handling that causing a series of failed authentication calls. ## Set this variable to 403 to return HTTPForbidden, or any other HTTP code -## This will be served instead of default 401 on bad authnetication +## This will be served instead of default 401 on bad authentication auth_ret_code = ## use special detection method when serving auth_ret_code, instead of serving @@ -261,7 +261,7 @@ labs_settings_active = true ## File store configuration. This is used to store and serve uploaded files file_store.enabled = true -## backend, only available one is local +## Storage backend, available options are: local file_store.backend = local ## path to store the uploaded binaries file_store.storage_path = %(here)s/data/file_store @@ -307,6 +307,7 @@ rc_cache.cache_perms.expiration_time = 3 #rc_cache.cache_perms.arguments.host = localhost #rc_cache.cache_perms.arguments.port = 6379 #rc_cache.cache_perms.arguments.db = 0 +## more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends #rc_cache.cache_perms.arguments.distributed_lock = true ## `cache_repo` cache settings for FileTree, Readme, RSS FEEDS @@ -322,6 +323,7 @@ rc_cache.cache_repo.expiration_time = 25 #rc_cache.cache_repo.arguments.host = localhost #rc_cache.cache_repo.arguments.port = 6379 #rc_cache.cache_repo.arguments.db = 1 +## more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends #rc_cache.cache_repo.arguments.distributed_lock = true ## cache settings for SQL queries, this needs to use memory type backend @@ -406,7 +408,7 @@ channelstream.server = 127.0.0.1:9800 ## location of the channelstream server from outside world ## use ws:// for http or wss:// for https. This address needs to be handled ## by external HTTP server such as Nginx or Apache -## see nginx/apache configuration examples in our docs +## see Nginx/Apache configuration examples in our docs channelstream.ws_url = ws://rhodecode.yourserver.com/_channelstream channelstream.secret = secret channelstream.history.location = %(here)s/channelstream_history @@ -423,14 +425,14 @@ channelstream.proxy_path = /_channelstre ## Appenlight is tailored to work with RhodeCode, see ## http://appenlight.com for details how to obtain an account -## appenlight integration enabled +## Appenlight integration enabled appenlight = false appenlight.server_url = https://api.appenlight.com appenlight.api_key = YOUR_API_KEY #appenlight.transport_config = https://api.appenlight.com?threaded=1&timeout=5 -# used for JS client +## used for JS client appenlight.api_public_key = YOUR_API_PUBLIC_KEY ## TWEAK AMOUNT OF INFO SENT HERE @@ -455,7 +457,7 @@ appenlight.logging.level = WARNING ## (saves API quota for intensive logging) appenlight.logging_on_error = false -## list of additonal keywords that should be grabbed from environ object +## list of additional keywords that should be grabbed from environ object ## can be string with comma separated list of words in lowercase ## (by default client will always send following info: ## 'REMOTE_USER', 'REMOTE_ADDR', 'SERVER_NAME', 'CONTENT_TYPE' + all keys that @@ -513,7 +515,7 @@ sqlalchemy.db1.convert_unicode = true vcs.server.enable = true vcs.server = localhost:9900 -## Web server connectivity protocol, responsible for web based VCS operatations +## Web server connectivity protocol, responsible for web based VCS operations ## Available protocols are: ## `http` - use http-rpc backend (default) vcs.server.protocol = http @@ -562,7 +564,8 @@ svn.proxy.config_file_path = %(here)s/mo ## In most cases it should be set to `/`. svn.proxy.location_root = / ## Command to reload the mod dav svn configuration on change. -## Example: `/etc/init.d/apache2 reload` +## Example: `/etc/init.d/apache2 reload` or /home/USER/apache_reload.sh +## Make sure user who runs RhodeCode process is allowed to reload Apache #svn.proxy.reload_cmd = /etc/init.d/apache2 reload ## If the timeout expires before the reload command finishes, the command will ## be killed. Setting it to zero means no timeout. Defaults to 10 seconds. @@ -573,7 +576,7 @@ svn.proxy.location_root = / ############################################################ ## Defines if a custom authorized_keys file should be created and written on -## any change user ssh keys. Setting this to false also disables posibility +## any change user ssh keys. Setting this to false also disables possibility ## of adding SSH keys by users from web interface. Super admins can still ## manage SSH Keys. ssh.generate_authorized_keyfile = false @@ -581,13 +584,13 @@ ssh.generate_authorized_keyfile = false ## Options for ssh, default is `no-pty,no-port-forwarding,no-X11-forwarding,no-agent-forwarding` # ssh.authorized_keys_ssh_opts = -## Path to the authrozied_keys file where the generate entries are placed. +## Path to the authorized_keys file where the generate entries are placed. ## It is possible to have multiple key files specified in `sshd_config` e.g. ## AuthorizedKeysFile %h/.ssh/authorized_keys %h/.ssh/authorized_keys_rhodecode ssh.authorized_keys_file_path = ~/.ssh/authorized_keys_rhodecode ## Command to execute the SSH wrapper. The binary is available in the -## rhodecode installation directory. +## RhodeCode installation directory. ## e.g ~/.rccontrol/community-1/profile/bin/rc-ssh-wrapper ssh.wrapper_cmd = ~/.rccontrol/community-1/rc-ssh-wrapper @@ -595,7 +598,7 @@ ssh.wrapper_cmd = ~/.rccontrol/community ssh.wrapper_cmd_allow_shell = false ## Enables logging, and detailed output send back to the client during SSH -## operations. Usefull for debugging, shouldn't be used in production. +## operations. Useful for debugging, shouldn't be used in production. ssh.enable_debug_logging = false ## Paths to binary executable, by default they are the names, but we can