##// END OF EJS Templates
scm: add comment that configuration of SCM executable command does not work if contains spaces path to configuration.yml.example (#7517, #8825)....
Toshi MARUYAMA -
r6327:4ee0ccda2ecb
parent child
Show More
@@ -1,147 +1,155
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 #
8 #
9 # == Outgoing email settings (email_delivery setting)
9 # == Outgoing email settings (email_delivery setting)
10 #
10 #
11 # === Common configurations
11 # === Common configurations
12 #
12 #
13 # ==== Sendmail command
13 # ==== Sendmail command
14 #
14 #
15 # production:
15 # production:
16 # email_delivery:
16 # email_delivery:
17 # delivery_method: :sendmail
17 # delivery_method: :sendmail
18 #
18 #
19 # ==== Simple SMTP server at localhost
19 # ==== Simple SMTP server at localhost
20 #
20 #
21 # production:
21 # production:
22 # email_delivery:
22 # email_delivery:
23 # delivery_method: :smtp
23 # delivery_method: :smtp
24 # smtp_settings:
24 # smtp_settings:
25 # address: "localhost"
25 # address: "localhost"
26 # port: 25
26 # port: 25
27 #
27 #
28 # ==== SMTP server at example.com using LOGIN authentication and checking HELO for foo.com
28 # ==== SMTP server at example.com using LOGIN authentication and checking HELO for foo.com
29 #
29 #
30 # production:
30 # production:
31 # email_delivery:
31 # email_delivery:
32 # delivery_method: :smtp
32 # delivery_method: :smtp
33 # smtp_settings:
33 # smtp_settings:
34 # address: "example.com"
34 # address: "example.com"
35 # port: 25
35 # port: 25
36 # authentication: :login
36 # authentication: :login
37 # domain: 'foo.com'
37 # domain: 'foo.com'
38 # user_name: 'myaccount'
38 # user_name: 'myaccount'
39 # password: 'password'
39 # password: 'password'
40 #
40 #
41 # ==== SMTP server at example.com using PLAIN authentication
41 # ==== SMTP server at example.com using PLAIN authentication
42 #
42 #
43 # production:
43 # production:
44 # email_delivery:
44 # email_delivery:
45 # delivery_method: :smtp
45 # delivery_method: :smtp
46 # smtp_settings:
46 # smtp_settings:
47 # address: "example.com"
47 # address: "example.com"
48 # port: 25
48 # port: 25
49 # authentication: :plain
49 # authentication: :plain
50 # domain: 'example.com'
50 # domain: 'example.com'
51 # user_name: 'myaccount'
51 # user_name: 'myaccount'
52 # password: 'password'
52 # password: 'password'
53 #
53 #
54 # ==== SMTP server at using TLS (GMail)
54 # ==== SMTP server at using TLS (GMail)
55 #
55 #
56 # This requires some additional configuration. See the article at:
56 # This requires some additional configuration. See the article at:
57 # http://redmineblog.com/articles/setup-redmine-to-send-email-using-gmail/
57 # http://redmineblog.com/articles/setup-redmine-to-send-email-using-gmail/
58 #
58 #
59 # production:
59 # production:
60 # email_delivery:
60 # email_delivery:
61 # delivery_method: :smtp
61 # delivery_method: :smtp
62 # smtp_settings:
62 # smtp_settings:
63 # tls: true
63 # tls: true
64 # address: "smtp.gmail.com"
64 # address: "smtp.gmail.com"
65 # port: 587
65 # port: 587
66 # domain: "smtp.gmail.com" # 'your.domain.com' for GoogleApps
66 # domain: "smtp.gmail.com" # 'your.domain.com' for GoogleApps
67 # authentication: :plain
67 # authentication: :plain
68 # user_name: "your_email@gmail.com"
68 # user_name: "your_email@gmail.com"
69 # password: "your_password"
69 # password: "your_password"
70 #
70 #
71 #
71 #
72 # === More configuration options
72 # === More configuration options
73 #
73 #
74 # See the "Configuration options" at the following website for a list of the
74 # See the "Configuration options" at the following website for a list of the
75 # full options allowed:
75 # full options allowed:
76 #
76 #
77 # http://wiki.rubyonrails.org/rails/pages/HowToSendEmailsWithActionMailer
77 # http://wiki.rubyonrails.org/rails/pages/HowToSendEmailsWithActionMailer
78
78
79
79
80 # default configuration options for all environments
80 # default configuration options for all environments
81 default:
81 default:
82 # Outgoing emails configuration (see examples above)
82 # Outgoing emails configuration (see examples above)
83 email_delivery:
83 email_delivery:
84 delivery_method: :smtp
84 delivery_method: :smtp
85 smtp_settings:
85 smtp_settings:
86 address: smtp.example.net
86 address: smtp.example.net
87 port: 25
87 port: 25
88 domain: example.net
88 domain: example.net
89 authentication: :login
89 authentication: :login
90 user_name: "redmine@example.net"
90 user_name: "redmine@example.net"
91 password: "redmine"
91 password: "redmine"
92
92
93 # Absolute path to the directory where attachments are stored.
93 # Absolute path to the directory where attachments are stored.
94 # The default is the 'files' directory in your Redmine instance.
94 # The default is the 'files' directory in your Redmine instance.
95 # Your Redmine instance needs to have write permission on this
95 # Your Redmine instance needs to have write permission on this
96 # directory.
96 # directory.
97 # Examples:
97 # Examples:
98 # attachments_storage_path: /var/redmine/files
98 # attachments_storage_path: /var/redmine/files
99 # attachments_storage_path: D:/redmine/files
99 # attachments_storage_path: D:/redmine/files
100 attachments_storage_path:
100 attachments_storage_path:
101
101
102 # Configuration of the autologin cookie.
102 # Configuration of the autologin cookie.
103 # autologin_cookie_name: the name of the cookie (default: autologin)
103 # autologin_cookie_name: the name of the cookie (default: autologin)
104 # autologin_cookie_path: the cookie path (default: /)
104 # autologin_cookie_path: the cookie path (default: /)
105 # autologin_cookie_secure: true sets the cookie secure flag (default: false)
105 # autologin_cookie_secure: true sets the cookie secure flag (default: false)
106 autologin_cookie_name:
106 autologin_cookie_name:
107 autologin_cookie_path:
107 autologin_cookie_path:
108 autologin_cookie_secure:
108 autologin_cookie_secure:
109
109
110 # Configuration of SCM executable command.
110 # Configuration of SCM executable command.
111 #
111 # Absolute path (e.g. /usr/local/bin/hg) or command name (e.g. hg.exe, bzr.exe)
112 # Absolute path (e.g. /usr/local/bin/hg) or command name (e.g. hg.exe, bzr.exe)
112 # On Windows, *.cmd, *.bat (e.g. hg.cmd, bzr.bat) does not work.
113 # On Windows + CRuby, *.cmd, *.bat (e.g. hg.cmd, bzr.bat) does not work.
114 #
115 # On Windows + JRuby 1.6.2, path which contains spaces does not work.
116 # 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.
118 # For example, "C:\TortoiseHg\hg.exe".
119 #
113 # Examples:
120 # Examples:
114 # scm_subversion_command: svn # (default: svn)
121 # scm_subversion_command: svn # (default: svn)
115 # scm_mercurial_command: C:\Program Files\TortoiseHg\hg.exe # (default: hg)
122 # scm_mercurial_command: C:\Program Files\TortoiseHg\hg.exe # (default: hg)
116 # scm_git_command: /usr/local/bin/git # (default: git)
123 # scm_git_command: /usr/local/bin/git # (default: git)
117 # scm_cvs_command: cvs # (default: cvs)
124 # scm_cvs_command: cvs # (default: cvs)
118 # scm_bazaar_command: bzr.exe # (default: bzr)
125 # scm_bazaar_command: bzr.exe # (default: bzr)
119 # scm_darcs_command: darcs-1.0.9-i386-linux # (default: darcs)
126 # scm_darcs_command: darcs-1.0.9-i386-linux # (default: darcs)
127 #
120 scm_subversion_command:
128 scm_subversion_command:
121 scm_mercurial_command:
129 scm_mercurial_command:
122 scm_git_command:
130 scm_git_command:
123 scm_cvs_command:
131 scm_cvs_command:
124 scm_bazaar_command:
132 scm_bazaar_command:
125 scm_darcs_command:
133 scm_darcs_command:
126
134
127 # Key used to encrypt sensitive data in the database (SCM and LDAP passwords).
135 # Key used to encrypt sensitive data in the database (SCM and LDAP passwords).
128 # If you don't want to enable data encryption, just leave it blank.
136 # If you don't want to enable data encryption, just leave it blank.
129 # WARNING: losing/changing this key will make encrypted data unreadable.
137 # WARNING: losing/changing this key will make encrypted data unreadable.
130 #
138 #
131 # If you want to encrypt existing passwords in your database:
139 # If you want to encrypt existing passwords in your database:
132 # * set the cipher key here in your configuration file
140 # * set the cipher key here in your configuration file
133 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
141 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
134 #
142 #
135 # If you have encrypted data and want to change this key, you have to:
143 # If you have encrypted data and want to change this key, you have to:
136 # * decrypt data using 'rake db:decrypt RAILS_ENV=production' first
144 # * decrypt data using 'rake db:decrypt RAILS_ENV=production' first
137 # * change the cipher key here in your configuration file
145 # * change the cipher key here in your configuration file
138 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
146 # * encrypt data using 'rake db:encrypt RAILS_ENV=production'
139 database_cipher_key:
147 database_cipher_key:
140
148
141 # specific configuration options for production environment
149 # specific configuration options for production environment
142 # that overrides the default ones
150 # that overrides the default ones
143 production:
151 production:
144
152
145 # specific configuration options for development environment
153 # specific configuration options for development environment
146 # that overrides the default ones
154 # that overrides the default ones
147 development:
155 development:
General Comments 0
You need to be logged in to leave comments. Login now