Mailing-List: contact commits-help@allura.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@allura.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: jetmind@apache.org
To: commits@allura.apache.org
Date: Tue, 21 Apr 2015 09:33:31 -0000
Message-Id: <b905ede553c64f73899d8f7fa3de5e3b@git.apache.org>
In-Reply-To: <9b575760572749fdb2c9cc3be3ee5aba@git.apache.org>
References: <9b575760572749fdb2c9cc3be3ee5aba@git.apache.org>
Subject: [04/14] allura git commit: [#7870] Add missing config examples,
 move some configs up from app:tool_test,
 standardize format for example vs default configs

[#7870] Add missing config examples, move some configs up from app:tool_test, standardize format for example vs default configs


Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/c5666811
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/c5666811
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/c5666811

Branch: refs/heads/ib/7866
Commit: c566681169a1f4c95c9b1a6314290d52e82a844a
Parents: 251f413
Author: Dave Brondsema <dave@brondsema.net>
Authored: Thu Apr 9 18:23:55 2015 -0400
Committer: Heith Seewald <hseewald@slashdotmedia.com>
Committed: Mon Apr 20 12:51:30 2015 -0400

----------------------------------------------------------------------
 Allura/development.ini | 258 ++++++++++++++++++++++++++++++--------------
 1 file changed, 178 insertions(+), 80 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/allura/blob/c5666811/Allura/development.ini
----------------------------------------------------------------------
diff --git a/Allura/development.ini b/Allura/development.ini
index b7ccde6..4a4f18c 100644
--- a/Allura/development.ini
+++ b/Allura/development.ini
@@ -14,28 +14,42 @@
 ;       KIND, either express or implied.  See the License for the
 ;       specific language governing permissions and limitations
 ;       under the License.
+
+
+;
+; Allura configuration
 ;
-; allura - Pylons development environment configuration
+; Default config values are shown in this file.
+; Commented-out configurations are examples that you can use if you want.
 ;
-; The %(here)s variable will be replaced with the parent directory of this file
+; Logging configuration is at the end of the file (starting at [loggers])
 ;
-; This file is for deployment specific config options -- other configuration
-; that is always required for the app is done in the config directory,
-; and generally should not be modified by end users.
+; There are many settings you should change for your site (name, domain, secret keys, etc)
+; More settings should be changed for good performance in a production site (no autoreload, no debugging, etc)
+;
+; You may copy this file to make a new configuration file (e.g. production.ini)
+; Just use the new file name instead of development.ini for any paster commands you run.
+
+
+; TODO:
+; remove test config
+; clarify debug settings
 
 [DEFAULT]
 debug = true
 ; Uncomment and replace with the address which should receive any error reports
 ;email_to = you@yourdomain.com
 
-; Smtp settings
-;smtp_tls = False
-;smtp_ssl = True
+; SMTP settings for outgoing mail
+smtp_tls = false
+smtp_ssl = false
 ;smtp_user = some_user
 ;smtp_password = some_password
-;smtp_timeout = 10
+smtp_timeout = 10
 smtp_server = localhost
 smtp_port = 8826
+; Reply-To and From address often used in email notifications:
+forgemail.return_path = noreply@sf.net
 
 error_email_from = paste@localhost
 ; Used to uniquify references to static resources, can be a timestamp or any unique value
@@ -54,17 +68,25 @@ next=main
 [app:main]
 use = egg:Allura
 full_stack = true
-site_name = Allura
 
+; Change this to your website's name
+site_name = Allura
+; Change these to your website's domain
 domain = localhost
 base_url = http://localhost:8080
 
-;lang = ru
 cache_dir = %(here)s/data
 
 ; Cache Neighborhood objects for N seconds (speeds up requests).
 ; Set to 0 to disable (the default).
-; neighborhood.cache.duration = 0
+;neighborhood.cache.duration = 0
+
+; Template cache settings
+; See http://jinja.pocoo.org/docs/api/#jinja2.Environment
+jinja_cache_size = -1
+;jinja_bytecode_cache_type = filesystem
+;jinja_bytecode_cache_type = memcached
+;memcached_host =
 
 ; Docs at http://beaker.readthedocs.org/en/latest/configuration.html#session-options
 ; and http://beaker.readthedocs.org/en/latest/modules/session.html#beaker.session.CookieSession
@@ -77,26 +99,29 @@ beaker.session.secure = false
 beaker.session.validate_key = 714bfe3612c42390726f
 
 ; Google Analytics account for tracking
-; ga.account = UA-XXXXX-X
+;ga.account = UA-XXXXX-X
 
+; Project registration system.  Only local is available, unless you write a custom one for custom integratino.
 registration.method = local
-; theme = sftheme
 theme = allura
-show_export_control = false
 
-; auth.method = ldap
+; For LDAP see https://forge-allura.apache.org/docs/getting_started/installation.html#using-ldap
+;auth.method = ldap
 auth.method = local
 auth.remember_for = 365  ; in days, for the "remember me" checkbox on login
-; auth.login_url = /auth/
-; auth.logout_url = /auth/logout
-; auth.login_fragment_url = /auth/login_fragment
+
+; Customize login/logout URLs only if you have some custom authentication set up.
+auth.login_url = /auth/
+auth.logout_url = /auth/logout
+auth.login_fragment_url = /auth/login_fragment/
+auth.post_logout_url = /
 
 auth.min_password_len = 6
 auth.max_password_len = 30
 
 ; password expiration options (disabled if neither is set)
-; auth.pwdexpire.days = 1
-; auth.pwdexpire.before = 1401949912  ; unix timestamp
+;auth.pwdexpire.days = 1
+;auth.pwdexpire.before = 1401949912  ; unix timestamp
 
 ; if using LDAP, also run `pip install python-ldap` in your Allura environment
 
@@ -124,6 +149,8 @@ auth.allow_user_messages_config = true
 auth.allow_birth_date = true
 auth.allow_non_primary_email_password_reset = true
 auth.require_email_addr = true
+; List of social network options to use on user account settings
+socialnetworks = Facebook, Linkedin, Twitter, Google+
 
 ; In seconds
 auth.recovery_hash_expiry_period = 600
@@ -137,6 +164,13 @@ user_prefs_storage.ldap.fields.display_name = cn
 ; Limit the number of emails a user can claim.
 user_prefs.maximum_claimed_emails = 20
 
+; Control the order of sections on the user profile page
+;user_profile_sections.order = activity, personal-data, skills
+
+; Site admins will be the same as the admins of this project:
+site_admin_project = allura
+site_admin_project_nbhd = Projects
+
 ; Spam filtering service: mollom or akismet
 ;spam.method = akismet
 ; for akismet:
@@ -145,41 +179,39 @@ user_prefs.maximum_claimed_emails = 20
 ;spam.public_key =
 ;spam.private_key =
 
-; webhook.timeout = 30  # seconds, default = 30
-
+; Webhook timeout in seconds
+webhook.timeout = 30
 ; List of pauses between retries, if hook fails (in seconds)
-; webhook.retry = 60 120 240
-
+webhook.retry = 60 120 240
 ; Limit rate of webhook firing (in seconds, default = 30)
 ; Option format: webhook.<hook type>.limit,
 ; all '-' in hook type must be changed to '_'
 ; e.g. for repo-push webhook:
-; webhook.repo_push.limit = 10
-
+webhook.repo_push.limit = 10
 ; Limit max number of hooks that can be created for given project/app
 ; Option name format: same as above.
 ; Value format: json dict, where keys are app names (as appears in
 ; `WebhookSender.triggered_by`) and values are actual limits (default=3), e.g.:
-; webhook.repo_push.max_hooks = {"git": 3, "hg": 3, "svn": 3}
+webhook.repo_push.max_hooks = {"git": 3, "hg": 3, "svn": 3}
 
 ; Additional fields for admin project/user search
 ; Note: whitespace after comma is important!
-; search.project.additional_search_fields = private, url, title
-; search.user.additional_search_fields = email_addresses
+;search.project.additional_search_fields = private, url, title
+;search.user.additional_search_fields = email_addresses
 
 ; Additional fields to show in the result of admin project/user search
 ; Note: whitespace after comma is important!
-; search.project.additional_display_fields = private, url, title
-; search.user.additional_display_fields = email_addresses
+;search.project.additional_display_fields = private, url, title
+;search.user.additional_display_fields = email_addresses
 
 ; To make all pages use ssl:   (also set beaker.session.secure above)
-; force_ssl.pattern = .
+;force_ssl.pattern = .
 ; To use ssl if and only if a user is logged in:
-; force_ssl.logged_in = true
+;force_ssl.logged_in = true
 ; If you set force_ssl.logged_in, you probably want some URLs to be ssl when logged out:
-; force_ssl.pattern = ^/auth|^/[a-z0-9-]+/import_project/  ; import_project uses a login overlay
+;force_ssl.pattern = ^/auth|^/[a-z0-9-]+/import_project/  ; import_project uses a login overlay
 ; And to permit some URLs to be accessed over http anyway:
-; no_redirect.pattern = ^/nf/\d+/_(ew|static)_/|^/rest/|^/nf/tool_icon_css|^/auth/refresh_repo
+;no_redirect.pattern = ^/nf/\d+/_(ew|static)_/|^/rest/|^/nf/tool_icon_css|^/auth/refresh_repo
 
 
 ; Set the locations of some static resources.  ("ew" stands for EasyWidgets library)
@@ -210,12 +242,12 @@ scm.host.ro.svn = file:///srv/svn$path/
 scm.host.rw.svn = file:///srv/svn$path/
 
 ; SCM settings for chroot + ldap configuration.  See Allura/docs/getting_started/scm_host.rst
-; scm.host.ro.git = git://git.localhost$path
-; scm.host.rw.git = ssh://$username@localhost:8022/scm-repo$path
-; scm.host.ro.hg = http://hg.localhost$path
-; scm.host.rw.hg = ssh://$username@localhost:8022/scm-repo$path
-; scm.host.ro.svn = http://svn.localhost$path/
-; scm.host.rw.svn = svn+ssh://localhost:8022/scm-repo$path/
+;scm.host.ro.git = git://git.localhost$path
+;scm.host.rw.git = ssh://$username@localhost:8022/scm-repo$path
+;scm.host.ro.hg = http://hg.localhost$path
+;scm.host.rw.hg = ssh://$username@localhost:8022/scm-repo$path
+;scm.host.ro.svn = http://svn.localhost$path/
+;scm.host.rw.svn = svn+ssh://localhost:8022/scm-repo$path/
 
 ; SCM settings for https (sorry no docs for setting these up)
 ; these settings are currently required by the template, no matter what
@@ -240,24 +272,46 @@ scm.repos.tarball.zip_binary = /usr/bin/zip
 
 ; SCM imports (currently just SVN) will retry if it fails
 ; You can control the number of tries and delay between tries here:
-;scm.import.retry_count = 50
-;scm.import.retry_sleep_secs = 5
+scm.import.retry_count = 50
+scm.import.retry_sleep_secs = 5
 
 ; One-click merge is enabled by default, but can be turned off on for each type of repo
-;scm.merge.git.disabled = true
-;scm.merge.hg.disabled = true
+scm.merge.git.disabled = false
+scm.merge.hg.disabled = false
 
+
+; bulk_export_enabled = true
+; If you keep bulk_export_enabled, you should set up your server to securely share bulk_export_path with users somehow
 bulk_export_path = /tmp/bulk_export/{nbhd}/{project}
 bulk_export_filename = {project}-backup-{date:%Y-%m-%d-%H%M%S}.zip
+; You will need to specify site-specific instructions here for accessing the exported files.
 bulk_export_download_instructions = Sample instructions for {project}
 
 importer_upload_path = /tmp/importer_upload/{nbhd}/{project}
 
+; To disable any plugin, tool, importer, etc from being available, you can use the disable_entry_points config option.
+; Specify the keys and values as they are declared in the tool's "setup.py" file.
+; Examples:
+;disable_entry_points.importers = google-code-tracker, google-code-repo
+;disable_entry_points.allura.project_importers = google-code
+
+; Importers specifically, can be left enabled but not linked to.  You have to know the URL to use it.  Example:
+;hidden_importers = trac-tickets
+
 ; GitHub importer keys.  For github ticket import, it is best to set
 ; up an app at https://github.com/settings/applications  Use the root URL
 ; of your Allura instance for both URLs, and enter client values here:
-; github_importer.client_id =
-; github_importer.client_secret =
+;github_importer.client_id =
+;github_importer.client_secret =
+
+; If your site has docs about specific importers, you can add them here and
+; they'll appear on the import forms
+;doc.url.importers.Google Code = http://...
+
+; List of oauth API keys permitted to use special forum import API
+; (should be converted to newer importer system)
+;oauth.can_import_forum = api-key-1234, fa832r0fdsafd, f23f80sdf32fd
+
 
 ; space-separated list of tool names that are valid options
 ; for project admins to set for their 'support_page' field
@@ -265,7 +319,13 @@ importer_upload_path = /tmp/importer_upload/{nbhd}/{project}
 ; is disabled by default
 ;support_tool_choices = wiki tickets discussion
 
+; Control how /categories URL can be accessed to edit trove categories (used in project categories and user skills)
+; Default: everyone
 trovecategories.enableediting = true
+; Nobody:
+;trovecategories.enableediting = false
+; Site admins only:
+;trovecategories.enableediting = admin
 
 ; ActivityStream
 activitystream.master = mongodb://127.0.0.1:27017
@@ -285,12 +345,14 @@ ming.project.uri = mongodb://127.0.0.1:27017/project-data
 ming.project.auto_ensure_indexes = False
 ming.task.uri = mongodb://127.0.0.1:27017/task
 ming.task.auto_ensure_indexes = False
-ming.zarkov.uri = mongodb://127.0.0.1:27017/zarkov
-ming.zarkov.auto_ensure_indexes = False
+;ming.zarkov.uri = mongodb://127.0.0.1:27017/zarkov
+;ming.zarkov.auto_ensure_indexes = False
 
 ; Zarkov host setting, requires the zarkov and gevent libraries.
 ;zarkov.host = tcp://127.0.0.1:9000
 
+; A float from 0-1 representing a % of requests to measure timing on.
+; Sampled requests will have timing logged to stats.log (can change file in [handler_timermiddleware] logging section)
 stats.sample_rate = 1
 
 ; Taskd setup
@@ -298,6 +360,10 @@ monq.poll_interval=2
 
 ; SOLR setup
 solr.server = http://localhost:8983/solr
+; Alternate server to use just for querying
+;solr.query_server =
+; Shorter timeout for search queries (longer timeout for saving to solr)
+solr.short_timeout = 10
 ; commit on every add/delete?
 solr.commit = false
 ; commit add operations within N ms
@@ -308,12 +374,15 @@ solr.commitWithin = 10000
 ; convert existing label and custom field data to more appropriate solr types.
 solr.use_new_types = true
 
-; Forgemail server
+; Incoming email settings.  Used when you run: paster smtp_server development.ini
+; address to listen to
 forgemail.host = 0.0.0.0
 forgemail.port = 8825
+; domain suffix for your mail, change this.  You also need to route *.*.*.forgemail.domain to the above host/port via
+; your mail and DNS configuration
 forgemail.domain = .in.sf.net
+; probably unused?
 forgemail.url = http://localhost:8080
-forgemail.return_path = noreply@sf.net
 
 ; Specify the number of projects allowed to be created by a user
 ; depending on the age of their user account.
@@ -321,11 +390,7 @@ forgemail.return_path = noreply@sf.net
 ; (including the default user-project, so you probably want to add 1)
 ; This example allows for 1 project if the account is less than an hour old
 ; and 5 projects if the account is less than a day old.  No limits after that
-; project.rate_limits = {"3600": 2, "86400": 6}
-
-; Special Command settings
-; no need to sleep in devel
-ensure_index.sleep = 0
+;project.rate_limits = {"3600": 2, "86400": 6}
 
 ; set this to "false" if you are deploying to production and want performance improvements
 auto_reload_templates = true
@@ -335,17 +400,64 @@ auto_reload_templates = true
 ; execute malicious code after an exception is raised.
 ;set debug = false
 
+; How frequently users can send messages
+user_message.time_interval = 3600
+user_message.max_messages = 20
+; Default number of times to show a sitewide notification
+site_notification.impressions = 0
+
+; When rendering discussion post Markdown to html, if the render takes longer
+; than `markdown_cache_threshold` (in seconds), the resulting html will be
+; cached and served from cache on subsequent requests. Set to 0 to cache all
+; posts. Remove entirely to cache nothing.
+markdown_cache_threshold = .1
+; markdown text longer than max length will not be converted to html
+markdown_render_max_length = 999999999
+; Don't add rel=nofollow to these domains when generating links from Markdown content
+;nofollow_exempt_domains =
+
+; Export control choices on the project admin overview page.
+show_export_control = false
+
+; By default project admins can soft-delete their projects.
+allow_project_delete = true
+allow_project_undelete = true
+
+; Advanced settings for controlling "Last Commit Doc" algorithm used when visiting any repo browse page
+lcd_thread_chunk_size = 10
+lcd_timeout = 60
+
+
+;
+; Settings for the Blog tool
+;
 ; Enable or disable external RSS feed importing in ForgeBlog tool.
-; Default is "false". This feature requires GPL library "html2text". Install it
-; with following command:
-; pip install -e git://github.com/brondsem/html2text.git#egg=html2text
+; Default is "false". This feature requires GPL library "html2text". Install it with following command:
+;   pip install -e git://github.com/brondsem/html2text.git#egg=html2text
+; You will also need to run `paster pull-rss-feeds development.ini` in a cron job to fetch them.
 forgeblog.exfeed = false
 
+;
+; Settings for the Chat tool
+;
+forgechat.host = irc.freenode.net
+forgechat.port = 6667
+ircbot.nick = allurabot
+
+;
+; Settings for ShortUrl tool
+;
+; Override this if you set up an additional shortening mechanism (e.g. custom short domain)
 short_url.url_pattern = {base_url}/{nbhd}/{project}/{mount_point}/{short_name}
 
-user_message.time_interval = 3600
-user_message.max_messages = 20
 
+;
+; Settings for UserStats tool
+;
+userstats.count_lines_of_code = true
+
+
+; Setup for tool testing
 [app:tool_test]
 use = egg:Allura
 override_root=basetest_project_root ; TurboGears will use controllers/basetest_project_root.py as root controller
@@ -359,12 +471,6 @@ beaker.session.validate_key = 714bfe3612c42390726f
 ; Ming setup
 ming.main.uri = mongo://127.0.0.1:27017/allura:test
 
-sqlalchemy.url = sqlite:///%(here)s/devdata.db
-;echo shouldn't be used together with the logging module.
-sqlalchemy.echo = false
-sqlalchemy.echo_pool = false
-sqlalchemy.pool_recycle = 3600
-
 ; Forgemail server
 forgemail.host = 0.0.0.0
 forgemail.port = 8825
@@ -375,22 +481,14 @@ forgemail.url = http://localhost:8080
 auth.method = local
 registration.method = local
 
-; When rendering discussion post Markdown to html, if the render takes longer
-; than `markdown_cache_threshold` (in seconds), the resulting html will be
-; cached and served from cache on subsequent requests. Set to 0 to cache all
-; posts. Remove entirely to cache nothing.
-markdown_cache_threshold = .1
-; markdown text longer than max length will not be converted to html
-markdown_render_max_length = 999999999
-
-; If your site has docs about specific importers, you can add them here and
-; they'll appear on the import forms
-;doc.url.importers.Google Code = http://...
-
+; setup for the taskd background daemon request controller
 [app:task]
 use = main
 override_root = task ; TurboGears will use controllers/task.py as root controller
 
+
+
+
 ; Logging configuration
 ; Add additional loggers, handlers, formatters here
 ; Uses python's logging config file format