annotate config/configuration.yml.example @ 1469:c77ab1edff6b bug_563

Close obsolete branch bug_563
author Chris Cannam
date Wed, 23 Jan 2013 14:12:47 +0000
parents cbb26bc654de
children 433d4f72a19b
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@210 57 # This requires some additional configuration. See the article at:
Chris@210 58 # http://redmineblog.com/articles/setup-redmine-to-send-email-using-gmail/
Chris@210 59 #
Chris@210 60 # production:
Chris@210 61 # email_delivery:
Chris@210 62 # delivery_method: :smtp
Chris@210 63 # smtp_settings:
Chris@210 64 # tls: true
Chris@909 65 # enable_starttls_auto: true
Chris@210 66 # address: "smtp.gmail.com"
Chris@210 67 # port: 587
Chris@210 68 # domain: "smtp.gmail.com" # 'your.domain.com' for GoogleApps
Chris@210 69 # authentication: :plain
Chris@210 70 # user_name: "your_email@gmail.com"
Chris@210 71 # password: "your_password"
Chris@210 72 #
Chris@210 73 #
Chris@210 74 # === More configuration options
Chris@210 75 #
Chris@210 76 # See the "Configuration options" at the following website for a list of the
Chris@210 77 # full options allowed:
Chris@210 78 #
Chris@210 79 # http://wiki.rubyonrails.org/rails/pages/HowToSendEmailsWithActionMailer
Chris@210 80
Chris@210 81
Chris@210 82 # default configuration options for all environments
Chris@210 83 default:
Chris@210 84 # Outgoing emails configuration (see examples above)
Chris@210 85 email_delivery:
Chris@210 86 delivery_method: :smtp
Chris@210 87 smtp_settings:
Chris@210 88 address: smtp.example.net
Chris@210 89 port: 25
Chris@210 90 domain: example.net
Chris@210 91 authentication: :login
Chris@210 92 user_name: "redmine@example.net"
Chris@210 93 password: "redmine"
Chris@909 94
Chris@210 95 # Absolute path to the directory where attachments are stored.
Chris@210 96 # The default is the 'files' directory in your Redmine instance.
Chris@210 97 # Your Redmine instance needs to have write permission on this
Chris@210 98 # directory.
Chris@210 99 # Examples:
Chris@210 100 # attachments_storage_path: /var/redmine/files
Chris@210 101 # attachments_storage_path: D:/redmine/files
Chris@210 102 attachments_storage_path:
Chris@909 103
Chris@210 104 # Configuration of the autologin cookie.
Chris@210 105 # autologin_cookie_name: the name of the cookie (default: autologin)
Chris@210 106 # autologin_cookie_path: the cookie path (default: /)
Chris@210 107 # autologin_cookie_secure: true sets the cookie secure flag (default: false)
Chris@210 108 autologin_cookie_name:
Chris@210 109 autologin_cookie_path:
Chris@210 110 autologin_cookie_secure:
Chris@909 111
Chris@210 112 # Configuration of SCM executable command.
Chris@909 113 #
Chris@210 114 # Absolute path (e.g. /usr/local/bin/hg) or command name (e.g. hg.exe, bzr.exe)
Chris@909 115 # On Windows + CRuby, *.cmd, *.bat (e.g. hg.cmd, bzr.bat) does not work.
Chris@909 116 #
Chris@909 117 # On Windows + JRuby 1.6.2, path which contains spaces does not work.
Chris@909 118 # For example, "C:\Program Files\TortoiseHg\hg.exe".
Chris@909 119 # If you want to this feature, you need to install to the path which does not contains spaces.
Chris@909 120 # For example, "C:\TortoiseHg\hg.exe".
Chris@909 121 #
Chris@245 122 # Examples:
Chris@245 123 # scm_subversion_command: svn # (default: svn)
Chris@245 124 # scm_mercurial_command: C:\Program Files\TortoiseHg\hg.exe # (default: hg)
Chris@245 125 # scm_git_command: /usr/local/bin/git # (default: git)
Chris@245 126 # scm_cvs_command: cvs # (default: cvs)
Chris@245 127 # scm_bazaar_command: bzr.exe # (default: bzr)
Chris@245 128 # scm_darcs_command: darcs-1.0.9-i386-linux # (default: darcs)
Chris@909 129 #
Chris@245 130 scm_subversion_command:
Chris@245 131 scm_mercurial_command:
Chris@245 132 scm_git_command:
Chris@245 133 scm_cvs_command:
Chris@245 134 scm_bazaar_command:
Chris@245 135 scm_darcs_command:
Chris@909 136
Chris@245 137 # Key used to encrypt sensitive data in the database (SCM and LDAP passwords).
Chris@245 138 # If you don't want to enable data encryption, just leave it blank.
Chris@245 139 # WARNING: losing/changing this key will make encrypted data unreadable.
Chris@245 140 #
Chris@245 141 # If you want to encrypt existing passwords in your database:
Chris@245 142 # * set the cipher key here in your configuration file
Chris@245 143 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
Chris@245 144 #
Chris@245 145 # If you have encrypted data and want to change this key, you have to:
Chris@245 146 # * decrypt data using 'rake db:decrypt RAILS_ENV=production' first
Chris@245 147 # * change the cipher key here in your configuration file
Chris@245 148 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
Chris@909 149 database_cipher_key:
Chris@909 150
Chris@210 151 # specific configuration options for production environment
Chris@210 152 # that overrides the default ones
Chris@210 153 production:
Chris@210 154
Chris@210 155 # specific configuration options for development environment
Chris@210 156 # that overrides the default ones
Chris@210 157 development: