##// END OF EJS Templates
typing: added typehint
typing: added typehint

File last commit:

r5087:0a27bd22 default
r5141:d2b5dad9 default
Show More
rhodecode.ini
842 lines | 29.9 KiB | text/x-ini | IniLexer
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; #########################################
; RHODECODE COMMUNITY EDITION CONFIGURATION
; #########################################
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
[DEFAULT]
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Debug flag sets all loggers to debug, and enables request tracking
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 debug = true
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ########################################################################
; EMAIL CONFIGURATION
; These settings will be used by the RhodeCode mailing system
; ########################################################################
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; prefix all emails subjects with given prefix, helps filtering out emails
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #email_prefix = [RhodeCode]
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; email FROM address all mails will be sent
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #app_email_from = rhodecode-noreply@localhost
#smtp_server = mail.server.com
#smtp_username =
#smtp_password =
#smtp_port =
#smtp_use_tls = false
#smtp_use_ssl = true
[server:main]
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; COMMON HOST/IP CONFIG
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 host = 0.0.0.0
port = 5000
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; ###########################
; GUNICORN APPLICATION SERVER
; ###########################
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; run with gunicorn --log-config rhodecode.ini --paste rhodecode.ini
; Module to use, this setting shouldn't be changed
tests: use gunicorn for testing. This is close to production testing...
r2453 use = egg:gunicorn#main
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
caches: fixed auth plugin usage of cached settings....
r4836 ; 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
; than 8-10 unless for really big deployments .e.g 700-1000 users.
; `instance_id = *` must be set in the [app:main] section below (which is the default)
; when using more than 1 worker.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #workers = 2
caches: fixed auth plugin usage of cached settings....
r4836
; Gunicorn access log level
#loglevel = info
; Process name visible in process list
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #proc_name = rhodecode
caches: fixed auth plugin usage of cached settings....
r4836
; Type of worker class, one of `sync`, `gevent`
; Recommended type is `gevent`
#worker_class = gevent
; The maximum number of simultaneous clients per worker. Valid only for gevent
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #worker_connections = 10
caches: fixed auth plugin usage of cached settings....
r4836
tests: fixed all tests for python3 BIG changes
r5087 ; The maximum number of pending connections worker will queue to handle
#backlog = 64
caches: fixed auth plugin usage of cached settings....
r4836 ; Max number of requests that worker will handle before being gracefully restarted.
; Prevents memory leaks, jitter adds variability so not all workers are restarted at once.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #max_requests = 1000
#max_requests_jitter = 30
caches: fixed auth plugin usage of cached settings....
r4836
; Amount of time a worker can spend with handling a request before it
; gets killed and restarted. By default set to 21600 (6hrs)
; Examples: 1800 (30min), 3600 (1hr), 7200 (2hr), 43200 (12h)
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #timeout = 21600
caches: fixed auth plugin usage of cached settings....
r4836 ; The maximum size of HTTP request line in bytes.
; 0 for unlimited
#limit_request_line = 0
tests: fixed all tests for python3 BIG changes
r5087 ; Limit the number of HTTP headers fields in a request.
; By default this value is 100 and can't be larger than 32768.
#limit_request_fields = 32768
; Limit the allowed size of an HTTP request header field.
; Value is a positive number or 0.
; Setting it to 0 will allow unlimited header field sizes.
#limit_request_field_size = 0
; Timeout for graceful workers restart.
; After receiving a restart signal, workers have this much time to finish
; serving requests. Workers still alive after the timeout (starting from the
; receipt of the restart signal) are force killed.
; Examples: 1800 (30min), 3600 (1hr), 7200 (2hr), 43200 (12h)
#graceful_timeout = 3600
# The number of seconds to wait for requests on a Keep-Alive connection.
# Generally set in the 1-5 seconds range.
#keepalive = 2
; Maximum memory usage that each worker can use before it will receive a
; graceful restart signal 0 = memory monitoring is disabled
; Examples: 268435456 (256MB), 536870912 (512MB)
; 1073741824 (1GB), 2147483648 (2GB), 4294967296 (4GB)
#memory_max_usage = 0
; How often in seconds to check for memory usage for each gunicorn worker
#memory_usage_check_interval = 60
; Threshold value for which we don't recycle worker if GarbageCollection
; frees up enough resources. Before each restart we try to run GC on worker
; in case we get enough free memory after that, restart will not happen.
#memory_usage_recovery_threshold = 0.8
caches: fixed auth plugin usage of cached settings....
r4836
; Prefix middleware for RhodeCode.
; recommended when using proxy setup.
; allows to set RhodeCode under a prefix in server.
; eg https://server.com/custom_prefix. Enable `filter-with =` option below as well.
; And set your prefix like: `prefix = /custom_prefix`
; be sure to also set beaker.session.cookie_path = /custom_prefix if you need
; to make your cookies only work on prefix url
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 [filter:proxy-prefix]
use = egg:PasteDeploy#prefix
prefix = /
[app:main]
caches: fixed auth plugin usage of cached settings....
r4836 ; The %(here)s variable will be replaced with the absolute path of parent directory
; of this file
; Each option in the app:main can be override by an environmental variable
;
;To override an option:
;
;RC_<KeyName>
;Everything should be uppercase, . and - should be replaced by _.
;For example, if you have these configuration settings:
;rc_cache.repo_object.backend = foo
;can be overridden by
;export RC_CACHE_REPO_OBJECT_BACKEND=foo
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 is_test = True
use = egg:rhodecode-enterprise-ce
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; enable proxy prefix middleware, defined above
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #filter-with = proxy-prefix
tests: fixed all tests for python3 BIG changes
r5087 ; encryption key used to encrypt social plugin tokens,
; remote_urls with credentials etc, if not set it defaults to
; `beaker.session.secret`
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #rhodecode.encrypted_values.secret =
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; decryption strict mode (enabled by default). It controls if decryption raises
; `SignatureVerificationError` in case of wrong key, or damaged encryption data.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #rhodecode.encrypted_values.strict = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Pick algorithm for encryption. Either fernet (more secure) or aes (default)
; fernet is safer, and we strongly recommend switching to it.
; Due to backward compatibility aes is used as default.
#rhodecode.encrypted_values.algorithm = fernet
; Return gzipped responses from RhodeCode (static files/application)
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 gzip_responses = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Auto-generate javascript routes file on startup
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 generate_js_files = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; System global default language.
; All available languages: en (default), be, de, es, fr, it, ja, pl, pt, ru, zh
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 lang = en
caches: fixed auth plugin usage of cached settings....
r4836 ; Perform a full repository scan and import on each server start.
; Settings this to true could lead to very long startup time.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 startup.import_repos = true
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; 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.
ssh: allow customizing the base_url for running application....
r2188 app.base_url = http://rhodecode.local
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Unique application ID. Should be a random unique string for security.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 app_instance_uuid = rc-production
tests: fixed all tests for python3 BIG changes
r5087 ; Cut off limit for large diffs (size in bytes). If overall diff size on
; commit, or pull request exceeds this limit this diff will be displayed
; partially. E.g 512000 == 512Kb
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 cut_off_limit_diff = 1024000
tests: fixed all tests for python3 BIG changes
r5087
; Cut off limit for large files inside diffs (size in bytes). Each individual
; file inside diff which exceeds this limit will be displayed partially.
; E.g 128000 == 128Kb
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 cut_off_limit_file = 256000
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Use cached version of vcs repositories everywhere. Recommended to be `true`
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 vcs_full_cache = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Force https in RhodeCode, fixes https redirects, assumes it's always https.
; Normally this is controlled by proper flags sent from http server such as Nginx or Apache
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 force_https = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; use Strict-Transport-Security headers
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 use_htsts = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Set to true if your repos are exposed using the dumb protocol
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 git_update_server_info = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; RSS/ATOM feed options
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 rss_cut_off_limit = 256000
rss_items_per_page = 10
rss_include_diff = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; gist URL alias, used to create nicer urls for gist. This should be an
; url that does rewrites to _admin/gists/{gistid}.
; example: http://gist.rhodecode.org/{gistid}. Empty means use the internal
; RhodeCode url, ie. http[s]://rhodecode.server/_admin/gists/{gistid}
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 gist_alias_url =
caches: fixed auth plugin usage of cached settings....
r4836 ; List of views (using glob pattern syntax) that AUTH TOKENS could be
; 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 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
; list of all views can be found under `/_admin/permissions/auth_token_access`
; The list should be "," separated and on a single line.
; Most common views to enable:
repo-commits: ported changeset code into pyramid views....
r1951 # RepoCommitsView:repo_commit_download
# RepoCommitsView:repo_commit_patch
# RepoCommitsView:repo_commit_raw
ssh: embedded ssh support...
r2043 # RepoCommitsView:repo_commit_raw@TOKEN
repo-commits: ported changeset code into pyramid views....
r1951 # RepoFilesView:repo_files_diff
# RepoFilesView:repo_archivefile
# RepoFilesView:repo_file_raw
# GistView:*
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 api_access_controllers_whitelist =
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Default encoding used to convert from and to unicode
; can be also a comma separated list of encoding in case of mixed encodings
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 default_encoding = UTF-8
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; 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
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 instance_id =
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; 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
; module to log in again and fix the settings.
; Available builtin plugin IDs (hash is part of the ID):
; egg:rhodecode-enterprise-ce#rhodecode
; egg:rhodecode-enterprise-ce#pam
; egg:rhodecode-enterprise-ce#ldap
; egg:rhodecode-enterprise-ce#jasig_cas
; egg:rhodecode-enterprise-ce#headers
; egg:rhodecode-enterprise-ce#crowd
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #rhodecode.auth_plugin_fallback = egg:rhodecode-enterprise-ce#rhodecode
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Flag to control loading of legacy plugins in py:/path format
auth_plugin.import_legacy_plugins = true
; alternative return HTTP header for failed authentication. Default HTTP
; 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 authentication
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 auth_ret_code =
caches: fixed auth plugin usage of cached settings....
r4836 ; use special detection method when serving auth_ret_code, instead of serving
; ret_code directly, use 401 initially (Which triggers credentials prompt)
; and then serve auth_ret_code to clients
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 auth_ret_code_detection = false
caches: fixed auth plugin usage of cached settings....
r4836 ; locking return code. When repository is locked return this HTTP code. 2XX
; codes don't break the transactions while 4XX codes do
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 lock_ret_code = 423
caches: fixed auth plugin usage of cached settings....
r4836 ; allows to change the repository location in settings page
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 allow_repo_location_change = true
caches: fixed auth plugin usage of cached settings....
r4836 ; allows to setup custom hooks in settings page
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 allow_custom_hooks_settings = true
tests: fixed all tests for python3 BIG changes
r5087 ; Generated license token required for EE edition license.
; New generated token value can be found in Admin > settings > license page.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 license_token = abra-cada-bra1-rce3
tests: fixed all tests for python3 BIG changes
r5087 ; This flag hides sensitive information on the license page such as token, and license data
license.hide_license_info = false
; supervisor connection uri, for managing supervisor and logs.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 supervisor.uri =
tests: fixed all tests for python3 BIG changes
r5087
; supervisord group name/id we only want this RC instance to handle
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 supervisor.group_id = dev
tests: fixed all tests for python3 BIG changes
r5087 ; Display extended labs settings
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 labs_settings_active = true
caches: fixed auth plugin usage of cached settings....
r4836 ; Custom exception store path, defaults to TMPDIR
; This is used to store exception from RhodeCode in shared directory
#exception_tracker.store_path =
; Send email with exception details when it happens
#exception_tracker.send_email = false
; Comma separated list of recipients for exception emails,
; e.g admin@rhodecode.com,devops@rhodecode.com
; Can be left empty, then emails will be sent to ALL super-admins
#exception_tracker.send_email_recipients =
; optional prefix to Add to email Subject
#exception_tracker.email_prefix = [RHODECODE ERROR]
; File store configuration. This is used to store and serve uploaded files
file_store.enabled = true
; 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
tests: fixed all tests for python3 BIG changes
r5087 ; Uncomment and set this path to control settings for archive download cache.
; Generated repo archives will be cached at this location
; and served from the cache during subsequent requests for the same archive of
; the repository. This path is important to be shared across filesystems and with
; RhodeCode and vcsserver
; Default is $cache_dir/archive_cache if not set
archive_cache.store_dir = /tmp/rc-test-data/archive_cache
; The limit in GB sets how much data we cache before recycling last used, defaults to 10 gb
archive_cache.cache_size_gb = 10
; By default cache uses sharding technique, this specifies how many shards are there
archive_cache.cache_shards = 10
caches: fixed auth plugin usage of cached settings....
r4836
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; #############
; CELERY CONFIG
; #############
celery: improve errors handling and logging
r4868 ; manually run celery: /path/to/celery worker --task-events --beat --app rhodecode.lib.celerylib.loader --scheduler rhodecode.lib.celerylib.scheduler.RcScheduler --loglevel DEBUG --ini /path/to/rhodecode.ini
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 use_celery = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; path to store schedule database
#celerybeat-schedule.path =
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; connection url to the message broker (default redis)
celery.broker_url = redis://localhost:6379/8
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; rabbitmq example
#celery.broker_url = amqp://rabbitmq:qweqwe@localhost:5672/rabbitmqhost
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; maximum tasks to execute before worker restart
config: reduce max-task-per-child to 20
r4890 celery.max_tasks_per_child = 20
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; tasks will never be sent to the queue, but executed locally instead.
celery.task_always_eager = false
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; #############
; DOGPILE CACHE
; #############
; Default cache dir for caches. Putting this into a ramdisk can boost performance.
; eg. /tmpfs/data_ramdisk, however this directory might require large amount of space
tests: fixed all tests for python3 BIG changes
r5087 cache_dir = %(here)s/rc-test-data
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
tests: fixed all tests for python3 BIG changes
r5087 ; *********************************************
; `sql_cache_short` cache for heavy SQL queries
; Only supported backend is `memory_lru`
; *********************************************
caches: use dogpile for sql_cache_short region.
r2883 rc_cache.sql_cache_short.backend = dogpile.cache.rc.memory_lru
rc_cache.sql_cache_short.expiration_time = 0
tests: fixed all tests for python3 BIG changes
r5087 ; *****************************************************
; `cache_repo_longterm` cache for repo object instances
; Only supported backend is `memory_lru`
; *****************************************************
rc_cache.cache_repo_longterm.backend = dogpile.cache.rc.memory_lru
; by default we use 30 Days, cache is still invalidated on push
rc_cache.cache_repo_longterm.expiration_time = 2592000
; max items in LRU cache, set to smaller number to save memory, and expire last used caches
rc_cache.cache_repo_longterm.max_size = 10000
; *********************************************
; `cache_general` cache for general purpose use
; for simplicity use rc.file_namespace backend,
; for performance and scale use rc.redis
; *********************************************
rc_cache.cache_general.backend = dogpile.cache.rc.file_namespace
rc_cache.cache_general.expiration_time = 43200
; file cache store path. Defaults to `cache_dir =` value or tempdir if both values are not set
rc_cache.cache_general.arguments.filename = %(here)s/cache-backend/cache_general_db
; alternative `cache_general` redis backend with distributed lock
#rc_cache.cache_general.backend = dogpile.cache.rc.redis
#rc_cache.cache_general.expiration_time = 300
; redis_expiration_time needs to be greater then expiration_time
#rc_cache.cache_general.arguments.redis_expiration_time = 7200
#rc_cache.cache_general.arguments.host = localhost
#rc_cache.cache_general.arguments.port = 6379
#rc_cache.cache_general.arguments.db = 0
#rc_cache.cache_general.arguments.socket_timeout = 30
; more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends
#rc_cache.cache_general.arguments.distributed_lock = true
; auto-renew lock to prevent stale locks, slower but safer. Use only if problems happen
#rc_cache.cache_general.arguments.lock_auto_renewal = true
; *************************************************
; `cache_perms` cache for permission tree, auth TTL
; for simplicity use rc.file_namespace backend,
; for performance and scale use rc.redis
; *************************************************
rc_cache.cache_perms.backend = dogpile.cache.rc.file_namespace
rc_cache.cache_perms.expiration_time = 0
; file cache store path. Defaults to `cache_dir =` value or tempdir if both values are not set
rc_cache.cache_perms.arguments.filename = %(here)s/cache-backend/cache_perms_db
; alternative `cache_perms` redis backend with distributed lock
#rc_cache.cache_perms.backend = dogpile.cache.rc.redis
#rc_cache.cache_perms.expiration_time = 300
; redis_expiration_time needs to be greater then expiration_time
#rc_cache.cache_perms.arguments.redis_expiration_time = 7200
#rc_cache.cache_perms.arguments.host = localhost
#rc_cache.cache_perms.arguments.port = 6379
#rc_cache.cache_perms.arguments.db = 0
#rc_cache.cache_perms.arguments.socket_timeout = 30
; more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends
#rc_cache.cache_perms.arguments.distributed_lock = true
; auto-renew lock to prevent stale locks, slower but safer. Use only if problems happen
#rc_cache.cache_perms.arguments.lock_auto_renewal = true
; ***************************************************
; `cache_repo` cache for file tree, Readme, RSS FEEDS
; for simplicity use rc.file_namespace backend,
; for performance and scale use rc.redis
; ***************************************************
rc_cache.cache_repo.backend = dogpile.cache.rc.file_namespace
rc_cache.cache_repo.expiration_time = 2592000
; file cache store path. Defaults to `cache_dir =` value or tempdir if both values are not set
rc_cache.cache_repo.arguments.filename = %(here)s/cache-backend/cache_repo_db
; alternative `cache_repo` redis backend with distributed lock
#rc_cache.cache_repo.backend = dogpile.cache.rc.redis
#rc_cache.cache_repo.expiration_time = 2592000
; redis_expiration_time needs to be greater then expiration_time
#rc_cache.cache_repo.arguments.redis_expiration_time = 2678400
#rc_cache.cache_repo.arguments.host = localhost
#rc_cache.cache_repo.arguments.port = 6379
#rc_cache.cache_repo.arguments.db = 1
#rc_cache.cache_repo.arguments.socket_timeout = 30
; more Redis options: https://dogpilecache.sqlalchemy.org/en/latest/api.html#redis-backends
#rc_cache.cache_repo.arguments.distributed_lock = true
; auto-renew lock to prevent stale locks, slower but safer. Use only if problems happen
#rc_cache.cache_repo.arguments.lock_auto_renewal = true
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ##############
; BEAKER SESSION
; ##############
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; beaker.session.type is type of storage options for the logged users sessions. Current allowed
; types are file, ext:redis, ext:database, ext:memcached, and memory (default if not specified).
; Fastest ones are Redis and ext:database
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 beaker.session.type = file
tests: fixed all tests for python3 BIG changes
r5087 beaker.session.data_dir = %(here)s/rc-tests/data/sessions
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Redis based sessions
#beaker.session.type = ext:redis
#beaker.session.url = redis://127.0.0.1:6379/2
; DB based session, fast, and allows easy management over logged in users
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #beaker.session.type = ext:database
#beaker.session.table_name = db_session
#beaker.session.sa.url = postgresql://postgres:secret@localhost/rhodecode
#beaker.session.sa.url = mysql://root:secret@127.0.0.1/rhodecode
#beaker.session.sa.pool_recycle = 3600
#beaker.session.sa.echo = false
beaker.session.key = rhodecode
beaker.session.secret = test-rc-uytcxaz
tests: fixed all tests for python3 BIG changes
r5087 beaker.session.lock_dir = %(here)s/data/sessions/lock
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Secure encrypted cookie. Requires AES and AES python libraries
; you must disable beaker.session.secret to use this
repo-commits: ported changeset code into pyramid views....
r1951 #beaker.session.encrypt_key = key_for_encryption
#beaker.session.validate_key = validation_key
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Sets session as invalid (also logging out user) if it haven not been
; accessed for given amount of time in seconds
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 beaker.session.timeout = 2592000
beaker.session.httponly = true
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; Path to use for the cookie. Set to prefix if you use prefix middleware
repo-commits: ported changeset code into pyramid views....
r1951 #beaker.session.cookie_path = /custom_prefix
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Set https secure cookie
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 beaker.session.secure = false
## auto save the session to not to use .save()
beaker.session.auto = false
caches: fixed auth plugin usage of cached settings....
r4836 ; default cookie expiration time in seconds, set to `true` to set expire
; at browser close
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #beaker.session.cookie_expires = 3600
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; #############################
; SEARCH INDEXING CONFIGURATION
; #############################
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
caches: fixed auth plugin usage of cached settings....
r4836 ; Full text search indexer is available in rhodecode-tools under
; `rhodecode-tools index` command
; WHOOSH Backend, doesn't require additional services to run
; it works good with few dozen repos
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 search.module = rhodecode.lib.index.whoosh
search.location = %(here)s/data/index
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ####################
; CHANNELSTREAM CONFIG
; ####################
; channelstream enables persistent connections and live notification
; in the system. It's also used by the chat system
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
channelstream.enabled = false
repo-commits: ported changeset code into pyramid views....
r1951
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; server address for channelstream server on the backend
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 channelstream.server = 127.0.0.1:9800
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; 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
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 channelstream.ws_url = ws://rhodecode.yourserver.com/_channelstream
channelstream.secret = secret
channelstream.history.location = %(here)s/channelstream_history
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Internal application path that Javascript uses to connect into.
; If you use proxy-prefix the prefix should be added before /_channelstream
repo-commits: ported changeset code into pyramid views....
r1951 channelstream.proxy_path = /_channelstream
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ##############################
; MAIN RHODECODE DATABASE CONFIG
; ##############################
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 #sqlalchemy.db1.url = sqlite:///%(here)s/rhodecode.db?timeout=30
#sqlalchemy.db1.url = postgresql://postgres:qweqwe@localhost/rhodecode
#sqlalchemy.db1.url = mysql://root:qweqwe@localhost/rhodecode?charset=utf8
; pymysql is an alternative driver for MySQL, use in case of problems with default one
#sqlalchemy.db1.url = mysql+pymysql://root:qweqwe@localhost/rhodecode
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
repo-commits: ported changeset code into pyramid views....
r1951 sqlalchemy.db1.url = sqlite:///%(here)s/rhodecode_test.db?timeout=30
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; see sqlalchemy docs for other advanced settings
; print the sql statements to output
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 sqlalchemy.db1.echo = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; recycle the connections after this amount of seconds
sqlalchemy.db1.pool_recycle = 3600
; the number of connections to keep open inside the connection pool.
; 0 indicates no limit
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #sqlalchemy.db1.pool_size = 5
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; The number of connections to allow in connection pool "overflow", that is
; connections that can be opened above and beyond the pool_size setting,
; which defaults to five.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 #sqlalchemy.db1.max_overflow = 10
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Connection check ping, used to detect broken database connections
; could be enabled to better handle cases if MySQL has gone away errors
#sqlalchemy.db1.ping_connection = true
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ##########
; VCS CONFIG
; ##########
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 vcs.server.enable = true
tests: fixed all tests for python3 BIG changes
r5087 #vcs.server = localhost:9901
vcs.server = vcsserver:10010
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Web server connectivity protocol, responsible for web based VCS operations
; Available protocols are:
; `http` - use http-rpc backend (default)
Martin Bornhold
tests: Use http backend in rhodecode test ini file.
r973 vcs.server.protocol = http
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Push/Pull operations protocol, available options are:
; `http` - use http-rpc backend (default)
Martin Bornhold
tests: Use http backend in rhodecode test ini file.
r973 vcs.scm_app_implementation = http
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Push/Pull operations hooks protocol, available options are:
; `http` - use http-rpc backend (default)
Martin Bornhold
tests: Use http backend in rhodecode test ini file.
r973 vcs.hooks.protocol = http
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
tests: fixed all tests for python3 BIG changes
r5087 ; Host on which this instance is listening for hooks. vcsserver will call this host to pull/push hooks so it should be
; accessible via network.
; Use vcs.hooks.host = "*" to bind to current hostname (for Docker)
hooks: allow to bind to existing hostname automatically if nothing explicitly is set.
r4859 vcs.hooks.host = *
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Start VCSServer with this instance as a subprocess, useful for development
Martin Bornhold
pytest: Fix settings in test-ini files.
r976 vcs.start_server = false
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; List of enabled VCS backends, available options are:
; `hg` - mercurial
; `git` - git
; `svn` - subversion
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 vcs.backends = hg, git, svn
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Wait this number of seconds before killing connection to the vcsserver
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 vcs.connection_timeout = 3600
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Compatibility version when creating SVN repositories. Defaults to newest version when commented out.
; Set a numeric version for your current SVN e.g 1.8, or 1.12
; Legacy available options are: pre-1.4-compatible, pre-1.5-compatible, pre-1.6-compatible, pre-1.8-compatible, pre-1.9-compatible
#vcs.svn.compatible_version = 1.8
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Cache flag to cache vcsserver remote calls locally
; It uses cache_region `cache_repo`
vcs.methods.cache = false
; ####################################################
; Subversion proxy support (mod_dav_svn)
; Maps RhodeCode repo groups into SVN paths for Apache
; ####################################################
; Enable or disable the config file generation.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 svn.proxy.generate_config = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; Generate config file with `SVNListParentPath` set to `On`.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 svn.proxy.list_parent_path = true
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; Set location and file name of generated config file.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 svn.proxy.config_file_path = %(here)s/mod_dav_svn.conf
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; alternative mod_dav config template. This needs to be a valid mako template
; Example template can be found in the source code:
; rhodecode/apps/svn_support/templates/mod-dav-svn.conf.mako
#svn.proxy.config_template = ~/.rccontrol/enterprise-1/custom_svn_conf.mako
; Used as a prefix to the `Location` block in the generated config file.
; In most cases it should be set to `/`.
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 svn.proxy.location_root = /
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; Command to reload the mod dav svn configuration on change.
; Example: `/etc/init.d/apache2 reload` or /home/USER/apache_reload.sh
; Make sure user who runs RhodeCode process is allowed to reload Apache
repo-commits: ported changeset code into pyramid views....
r1951 #svn.proxy.reload_cmd = /etc/init.d/apache2 reload
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; 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.
repo-commits: ported changeset code into pyramid views....
r1951 #svn.proxy.reload_timeout = 10
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ####################
; SSH Support Settings
; ####################
ssh: embedded ssh support...
r2043
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Defines if a custom authorized_keys file should be created and written on
; 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: fixed tests for disabled ssh support
r2047 ssh.generate_authorized_keyfile = true
ssh: embedded ssh support...
r2043
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Options for ssh, default is `no-pty,no-port-forwarding,no-X11-forwarding,no-agent-forwarding`
ssh: embedded ssh support...
r2043 # ssh.authorized_keys_ssh_opts =
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; 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: fixed tests for disabled ssh support
r2047 ssh.authorized_keys_file_path = %(here)s/rc/authorized_keys_rhodecode
ssh: embedded ssh support...
r2043
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Command to execute the SSH wrapper. The binary is available in the
; RhodeCode installation directory.
; e.g ~/.rccontrol/community-1/profile/bin/rc-ssh-wrapper
binaries: cleanup new upcomming rc-* commands that will replace paster * commands from pylons
r2119 ssh.wrapper_cmd = ~/.rccontrol/community-1/rc-ssh-wrapper
ssh: embedded ssh support...
r2043
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Allow shell when executing the ssh-wrapper command
ssh: embedded ssh support...
r2043 ssh.wrapper_cmd_allow_shell = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Enables logging, and detailed output send back to the client during SSH
; operations. Useful for debugging, shouldn't be used in production.
ssh: embedded ssh support...
r2043 ssh.enable_debug_logging = false
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Paths to binary executable, by default they are the names, but we can
; override them if we want to use a custom one
ssh: embedded ssh support...
r2043 ssh.executable.hg = ~/.rccontrol/vcsserver-1/profile/bin/hg
ssh.executable.git = ~/.rccontrol/vcsserver-1/profile/bin/git
ssh.executable.svn = ~/.rccontrol/vcsserver-1/profile/bin/svnserve
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Enables SSH key generator web interface. Disabling this still allows users
; to add their own keys.
Issue #5536 - ability to disable server-side SSH key generation...
r3478 ssh.enable_ui_key_generator = true
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; Statsd client config, this is used to send metrics to statsd
; We recommend setting statsd_exported and scrape them using Promethues
#statsd.enabled = false
#statsd.statsd_host = 0.0.0.0
#statsd.statsd_port = 8125
#statsd.statsd_prefix =
#statsd.statsd_ipv6 = false
ssh: embedded ssh support...
r2043
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; configure logging automatically at server startup set to false
; to use the below custom logging config.
caches: fixed auth plugin usage of cached settings....
r4836 ; RC_LOGGING_FORMATTER
; RC_LOGGING_LEVEL
; env variables can control the settings for logging in case of autoconfigure
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 logging.autoconfigure = false
; specify your own custom logging config file to configure logging
#logging.logging_conf_file = /path/to/custom_logging.ini
; Dummy marker to add new entries after.
; Add any custom entries below. Please don't remove this marker.
repo-commits: ported changeset code into pyramid views....
r1951 custom.conf = 1
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; #####################
; LOGGING CONFIGURATION
; #####################
caches: fixed auth plugin usage of cached settings....
r4836
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 [loggers]
tests: fixed all tests for python3 BIG changes
r5087 keys = root, sqlalchemy, beaker, celery, rhodecode, ssh_wrapper, dogpile
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
[handlers]
keys = console, console_sql
[formatters]
caches: fixed auth plugin usage of cached settings....
r4836 keys = generic, json, color_formatter, color_formatter_sql
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; #######
; LOGGERS
; #######
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 [logger_root]
level = NOTSET
handlers = console
[logger_routes]
level = DEBUG
handlers =
qualname = routes.middleware
## "level = DEBUG" logs the route matched and routing variables.
propagate = 1
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 [logger_sqlalchemy]
level = INFO
handlers = console_sql
qualname = sqlalchemy.engine
propagate = 0
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 [logger_beaker]
level = DEBUG
handlers =
qualname = beaker.container
propagate = 1
tests: fixed all tests for python3 BIG changes
r5087 [logger_dogpile]
level = INFO
handlers = console
qualname = dogpile
propagate = 1
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 [logger_rhodecode]
level = DEBUG
handlers =
qualname = rhodecode
propagate = 1
ssh: embedded ssh support...
r2043 [logger_ssh_wrapper]
level = DEBUG
handlers =
qualname = ssh_wrapper
propagate = 1
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 [logger_celery]
level = DEBUG
handlers =
qualname = celery
ssh: embedded ssh support...
r2043
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
; ########
; HANDLERS
; ########
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
[handler_console]
class = StreamHandler
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 args = (sys.stderr, )
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 level = DEBUG
caches: fixed auth plugin usage of cached settings....
r4836 ; To enable JSON formatted logs replace 'generic/color_formatter' with 'json'
; This allows sending properly formatted logs to grafana loki or elasticsearch
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 formatter = generic
[handler_console_sql]
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; "level = DEBUG" logs SQL queries and results.
; "level = INFO" logs SQL queries.
; "level = WARN" logs neither. (Recommended for production systems.)
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 class = StreamHandler
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 args = (sys.stderr, )
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 level = WARN
caches: fixed auth plugin usage of cached settings....
r4836 ; To enable JSON formatted logs replace 'generic/color_formatter_sql' with 'json'
; This allows sending properly formatted logs to grafana loki or elasticsearch
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 formatter = generic
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 ; ##########
; FORMATTERS
; ##########
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971
[formatter_generic]
core: removed pyro4 from Enterprise code. Fixes #5198
r1409 class = rhodecode.lib.logging_formatter.ExceptionAwareFormatter
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 format = %(asctime)s.%(msecs)03d [%(process)d] %(levelname)-5.5s [%(name)s] %(message)s
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 datefmt = %Y-%m-%d %H:%M:%S
[formatter_color_formatter]
class = rhodecode.lib.logging_formatter.ColorFormatter
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 format = %(asctime)s.%(msecs)03d [%(process)d] %(levelname)-5.5s [%(name)s] %(message)s
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 datefmt = %Y-%m-%d %H:%M:%S
[formatter_color_formatter_sql]
class = rhodecode.lib.logging_formatter.ColorFormatterSql
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823 format = %(asctime)s.%(msecs)03d [%(process)d] %(levelname)-5.5s [%(name)s] %(message)s
Martin Bornhold
tests: Move rhodecode ini file into tests directory
r971 datefmt = %Y-%m-%d %H:%M:%S
config: major update for the code to make it be almost fully controllable via env for new docker based installer.
r4823
[formatter_json]
caches: fixed auth plugin usage of cached settings....
r4836 format = %(timestamp)s %(levelname)s %(name)s %(message)s %(req_id)s
class = rhodecode.lib._vendor.jsonlogger.JsonFormatter