annotate config/configuration.yml.example @ 1519:afce8026aaeb redmine-2.4-integration

Merge from branch "live"
author Chris Cannam
date Tue, 09 Sep 2014 09:34:53 +0100
parents b450a9d58aed
children
rev   line source
Chris@210 1 # = Redmine configuration file
Chris@210 2 #
Chris@210 3 # Each environment has it's own configuration options. If you are only
Chris@210 4 # running in production, only the production block needs to be configured.
Chris@210 5 # Environment specific configuration options override the default ones.
Chris@210 6 #
Chris@210 7 # Note that this file needs to be a valid YAML file.
Chris@909 8 # DO NOT USE TABS! Use 2 spaces instead of tabs for identation.
Chris@210 9 #
Chris@210 10 # == Outgoing email settings (email_delivery setting)
Chris@210 11 #
Chris@210 12 # === Common configurations
Chris@210 13 #
Chris@210 14 # ==== Sendmail command
Chris@210 15 #
Chris@210 16 # production:
Chris@210 17 # email_delivery:
Chris@210 18 # delivery_method: :sendmail
Chris@210 19 #
Chris@210 20 # ==== Simple SMTP server at localhost
Chris@210 21 #
Chris@210 22 # production:
Chris@210 23 # email_delivery:
Chris@210 24 # delivery_method: :smtp
Chris@210 25 # smtp_settings:
Chris@210 26 # address: "localhost"
Chris@210 27 # port: 25
Chris@210 28 #
Chris@210 29 # ==== SMTP server at example.com using LOGIN authentication and checking HELO for foo.com
Chris@210 30 #
Chris@210 31 # production:
Chris@210 32 # email_delivery:
Chris@210 33 # delivery_method: :smtp
Chris@210 34 # smtp_settings:
Chris@210 35 # address: "example.com"
Chris@210 36 # port: 25
Chris@210 37 # authentication: :login
Chris@210 38 # domain: 'foo.com'
Chris@210 39 # user_name: 'myaccount'
Chris@210 40 # password: 'password'
Chris@210 41 #
Chris@210 42 # ==== SMTP server at example.com using PLAIN authentication
Chris@210 43 #
Chris@210 44 # production:
Chris@210 45 # email_delivery:
Chris@210 46 # delivery_method: :smtp
Chris@210 47 # smtp_settings:
Chris@210 48 # address: "example.com"
Chris@210 49 # port: 25
Chris@210 50 # authentication: :plain
Chris@210 51 # domain: 'example.com'
Chris@210 52 # user_name: 'myaccount'
Chris@210 53 # password: 'password'
Chris@210 54 #
Chris@210 55 # ==== SMTP server at using TLS (GMail)
Chris@210 56 #
Chris@1115 57 # This might require some additional configuration. See the guides at:
Chris@1115 58 # http://www.redmine.org/projects/redmine/wiki/EmailConfiguration
Chris@210 59 #
Chris@210 60 # production:
Chris@210 61 # email_delivery:
Chris@210 62 # delivery_method: :smtp
Chris@210 63 # smtp_settings:
Chris@909 64 # enable_starttls_auto: true
Chris@210 65 # address: "smtp.gmail.com"
Chris@210 66 # port: 587
Chris@210 67 # domain: "smtp.gmail.com" # 'your.domain.com' for GoogleApps
Chris@210 68 # authentication: :plain
Chris@210 69 # user_name: "your_email@gmail.com"
Chris@210 70 # password: "your_password"
Chris@210 71 #
Chris@210 72 #
Chris@210 73 # === More configuration options
Chris@210 74 #
Chris@1516 75 # See following page:
Chris@210 76 #
Chris@1516 77 # http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration
Chris@210 78
Chris@210 79
Chris@210 80 # default configuration options for all environments
Chris@210 81 default:
Chris@210 82 # Outgoing emails configuration (see examples above)
Chris@210 83 email_delivery:
Chris@210 84 delivery_method: :smtp
Chris@210 85 smtp_settings:
Chris@210 86 address: smtp.example.net
Chris@210 87 port: 25
Chris@210 88 domain: example.net
Chris@210 89 authentication: :login
Chris@210 90 user_name: "redmine@example.net"
Chris@210 91 password: "redmine"
Chris@909 92
Chris@210 93 # Absolute path to the directory where attachments are stored.
Chris@210 94 # The default is the 'files' directory in your Redmine instance.
Chris@210 95 # Your Redmine instance needs to have write permission on this
Chris@210 96 # directory.
Chris@210 97 # Examples:
Chris@210 98 # attachments_storage_path: /var/redmine/files
Chris@210 99 # attachments_storage_path: D:/redmine/files
Chris@210 100 attachments_storage_path:
Chris@909 101
Chris@210 102 # Configuration of the autologin cookie.
Chris@210 103 # autologin_cookie_name: the name of the cookie (default: autologin)
Chris@210 104 # autologin_cookie_path: the cookie path (default: /)
Chris@210 105 # autologin_cookie_secure: true sets the cookie secure flag (default: false)
Chris@210 106 autologin_cookie_name:
Chris@210 107 autologin_cookie_path:
Chris@210 108 autologin_cookie_secure:
Chris@909 109
Chris@210 110 # Configuration of SCM executable command.
Chris@909 111 #
Chris@210 112 # Absolute path (e.g. /usr/local/bin/hg) or command name (e.g. hg.exe, bzr.exe)
Chris@909 113 # On Windows + CRuby, *.cmd, *.bat (e.g. hg.cmd, bzr.bat) does not work.
Chris@909 114 #
Chris@909 115 # On Windows + JRuby 1.6.2, path which contains spaces does not work.
Chris@909 116 # For example, "C:\Program Files\TortoiseHg\hg.exe".
Chris@909 117 # If you want to this feature, you need to install to the path which does not contains spaces.
Chris@909 118 # For example, "C:\TortoiseHg\hg.exe".
Chris@909 119 #
Chris@245 120 # Examples:
Chris@245 121 # scm_subversion_command: svn # (default: svn)
Chris@245 122 # scm_mercurial_command: C:\Program Files\TortoiseHg\hg.exe # (default: hg)
Chris@245 123 # scm_git_command: /usr/local/bin/git # (default: git)
Chris@245 124 # scm_cvs_command: cvs # (default: cvs)
Chris@245 125 # scm_bazaar_command: bzr.exe # (default: bzr)
Chris@245 126 # scm_darcs_command: darcs-1.0.9-i386-linux # (default: darcs)
Chris@909 127 #
Chris@245 128 scm_subversion_command:
Chris@245 129 scm_mercurial_command:
Chris@245 130 scm_git_command:
Chris@245 131 scm_cvs_command:
Chris@245 132 scm_bazaar_command:
Chris@245 133 scm_darcs_command:
Chris@909 134
Chris@1464 135 # Absolute path to the SCM commands errors (stderr) log file.
Chris@1464 136 # The default is to log in the 'log' directory of your Redmine instance.
Chris@1464 137 # Example:
Chris@1464 138 # scm_stderr_log_file: /var/log/redmine_scm_stderr.log
Chris@1464 139 scm_stderr_log_file:
Chris@1464 140
Chris@245 141 # Key used to encrypt sensitive data in the database (SCM and LDAP passwords).
Chris@245 142 # If you don't want to enable data encryption, just leave it blank.
Chris@245 143 # WARNING: losing/changing this key will make encrypted data unreadable.
Chris@245 144 #
Chris@245 145 # If you want to encrypt existing passwords in your database:
Chris@245 146 # * set the cipher key here in your configuration file
Chris@245 147 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
Chris@245 148 #
Chris@245 149 # If you have encrypted data and want to change this key, you have to:
Chris@245 150 # * decrypt data using 'rake db:decrypt RAILS_ENV=production' first
Chris@245 151 # * change the cipher key here in your configuration file
Chris@245 152 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
Chris@909 153 database_cipher_key:
Chris@909 154
Chris@1115 155 # Set this to false to disable plugins' assets mirroring on startup.
Chris@1115 156 # You can use `rake redmine:plugins:assets` to manually mirror assets
Chris@1115 157 # to public/plugin_assets when you install/upgrade a Redmine plugin.
Chris@1115 158 #
Chris@1115 159 #mirror_plugins_assets_on_startup: false
Chris@1115 160
Chris@1115 161 # Your secret key for verifying cookie session data integrity. If you
Chris@1115 162 # change this key, all old sessions will become invalid! Make sure the
Chris@1115 163 # secret is at least 30 characters and all random, no regular words or
Chris@1115 164 # you'll be exposed to dictionary attacks.
Chris@1115 165 #
Chris@1115 166 # If you have a load-balancing Redmine cluster, you have to use the
Chris@1115 167 # same secret token on each machine.
Chris@1115 168 #secret_token: 'change it to a long random string'
Chris@1115 169
Chris@1115 170 # Absolute path (e.g. /usr/bin/convert, c:/im/convert.exe) to
Chris@1115 171 # the ImageMagick's `convert` binary. Used to generate attachment thumbnails.
Chris@1115 172 #imagemagick_convert_command:
Chris@1115 173
Chris@1115 174 # Configuration of RMagcik font.
Chris@1115 175 #
Chris@1115 176 # Redmine uses RMagcik in order to export gantt png.
Chris@1115 177 # You don't need this setting if you don't install RMagcik.
Chris@1115 178 #
Chris@1115 179 # In CJK (Chinese, Japanese and Korean),
Chris@1115 180 # in order to show CJK characters correctly,
Chris@1115 181 # you need to set this configuration.
Chris@1115 182 #
Chris@1115 183 # Because there is no standard font across platforms in CJK,
Chris@1115 184 # you need to set a font installed in your server.
Chris@1115 185 #
Chris@1115 186 # This setting is not necessary in non CJK.
Chris@1115 187 #
Chris@1115 188 # Examples for Japanese:
Chris@1115 189 # Windows:
Chris@1115 190 # rmagick_font_path: C:\windows\fonts\msgothic.ttc
Chris@1115 191 # Linux:
Chris@1115 192 # rmagick_font_path: /usr/share/fonts/ipa-mincho/ipam.ttf
Chris@1115 193 #
Chris@1115 194 rmagick_font_path:
Chris@1115 195
Chris@1464 196 # Maximum number of simultaneous AJAX uploads
Chris@1464 197 #max_concurrent_ajax_uploads: 2
Chris@1464 198
Chris@1464 199 # Configure OpenIdAuthentication.store
Chris@1464 200 #
Chris@1464 201 # allowed values: :memory, :file, :memcache
Chris@1464 202 #openid_authentication_store: :memory
Chris@1464 203
Chris@210 204 # specific configuration options for production environment
Chris@210 205 # that overrides the default ones
Chris@210 206 production:
Chris@210 207
Chris@210 208 # specific configuration options for development environment
Chris@210 209 # that overrides the default ones
Chris@210 210 development: