gitlab
/
omnibus-gitlab
mirror of https://gitlab.com/gitlab-org/omnibus-gitlab.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into 'master' 

Fix configuration and documentation of Mattermost feedback email

* FeedbackName and FeedbackEmail settings are now in the generated configuration
* Correct documentation for ConnectionSecurity setting

I did not add a Changelog entry since I wasn't sure whether it would go under 8.2.0 or 8.1.x

See merge request !517
This commit is contained in:
Marin Jankovski 2015-10-23 06:57:51 +00:00
parent 635d7952fa c5ab061916
commit 4121e5853a
3 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/gitlab-mattermost/README.md
View File

@ -96,33 +96,33 @@ Once the configuration is set, run `sudo gitlab-ctl reconfigure` for the changes
## Setting up SMTP for GitLab Mattermost
By default, `mattermost['email_by_pass_email'] = true` which allows account creation and system operation without having to setup an email service. This option completely shuts off the email service.
When you do want to have emails enabled, you need to set this option to `false`.
By default, `mattermost['email_enable_sign_up_with_email'] = true` which allows team creation and account signup using email and password. This should be `false` if you're using only an external authentication source such as GitLab.
SMTP configuration depends on SMTP provider used. If you are using SMTP without TLS minimal configuration in `/etc/gitlab/gitlab.rb` contains:
```ruby
mattermost['email_by_pass_email'] = false
mattermost['email_enable_sign_up_with_email'] = true
mattermost['email_smtp_username'] = "username"
mattermost['email_smtp_password'] = "password"
mattermost['email_smtp_server'] = "smtp.example.com:465"
mattermost['email_connection_security'] = nil
mattermost['email_feedback_name'] = "GitLab Mattermost"
mattermost['email_feedback_email'] = "email@example.com"
```
If you are using TLS, configuration can look something like this:
```ruby
mattermost['email_by_pass_email'] = false
mattermost['email_enable_sign_up_with_email'] = true
mattermost['email_smtp_username'] = "username"
mattermost['email_smtp_password'] = "password"
mattermost['email_smtp_server'] = "smtp.example.com:587"
mattermost['email_connection_security'] = 'TLS' # Or 'STARTTLS'
mattermost['email_feedback_name'] = "GitLab Mattermost"
mattermost['email_feedback_email'] = "email@example.com"
mattermost['email_use_tls'] = false
mattermost['email_use_start_tls'] = true
```
`email_use_start_tls` and `email_use_tls` options depend on your SMTP provider so you need to verify which of those two is valid for your provider.
`email_connection_security` depends on your SMTP provider so you need to verify which of `TLS` or `STARTTLS` is valid for your provider.
Once the configuration is set, run `sudo gitlab-ctl reconfigure` for the changes to take effect.

2
files/gitlab-config-template/gitlab.rb.template
View File

@ -722,6 +722,8 @@ external_url 'GENERATED_EXTERNAL_URL'
# mattermost['email_smtp_server'] = nil
# mattermost['email_smtp_port'] = nil
# mattermost['email_connection_security'] = nil
# mattermost['email_feedback_name'] = nil
# mattermost['email_feedback_email'] = nil
# mattermost['email_apple_push_server'] = nil
# mattermost['email_apple_push_cert_public'] = nil
# mattermost['email_apple_push_cert_private'] = nil

2
files/gitlab-cookbooks/gitlab/templates/default/config.json.erb
View File

@ -62,6 +62,8 @@
"ConnectionSecurity": "<%= @email_connection_security %>",
"InviteSalt": "<%= @email_invite_salt %>",
"PasswordResetSalt": "<%= @email_password_reset_salt %>",
"FeedbackName": "<%= @email_feedback_name %>",
"FeedbackEmail": "<%= @email_feedback_email %>",
"ApplePushServer": "<%= @email_apple_push_server %>",
"ApplePushCertPublic": "<%= @email_apple_push_cert_public %>",
"ApplePushCertPrivate": "<%= @email_apple_push_cert_private %>"