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