diff --git a/INSTALL.md b/INSTALL.md index 0daa7bea..4a2df84d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,21 +8,27 @@ For more information about rails and what it can do, see the [rails guides.](htt ## Configuring OSEM There are a couple of environment variables you can set to configure OSEM. -| Variable | Content | Purpose | -|---------- |--------- |--------- | -| OSEM_NAME | openSUSE Events | The name of your page | -| OSEM_HOSTNAME | events.opensuse.org | The host this OSEM instance runs on | -| OSEM_EMAIL_ADDRESS | events@opensuse.org | The address OSEM uses for sending mails | -| OSEM_ICHAIN_ENABLED | true/false | Enable the usage of [devise_ichain_authenticatable](https://github.com/openSUSE/devise_ichain_authenticatable) | -| OSEM_TRANSIFEX_APIKEY | *string* | Use this api key for [transifex](https://www.transifex.com/). See TRANSLATION.md for details. | -| OSEM_ERRBIT_HOST | errbit.opensuse.org | The [errbit](https://github.com/errbit/errbit) host to post exceptions to | -| OSEM_ERRBIT_APIKEY | *string* | The api key for the errbit host | -| OSEM_FACTORY_LINT | *boolean* (true/false) | Setting this to false will disable linting of factories before running spec -| OSEM_GOOGLE_KEY/OSEM_GOOGLE_SECRET | *string* | OMNIAUTH Developer Keys/Secrets for GOOGLE -| OSEM_FACEBOOK_KEY/OSEM_FACEBOOK_SECRET | *string* | OMNIAUTH Developer Keys/Secrets for Facebook -| OSEM_GITHUB_KEY/OSEM_GITHUB_SECRET |*string* | OMNIAUTH Developer Keys/Secrets for GitHub +| Variable | Content | Purpose | +|---------- |--------- |--------- | +| OSEM_NAME | openSUSE Events | The name of your page | +| OSEM_HOSTNAME | events.opensuse.org | The host this OSEM instance runs on | +| OSEM_EMAIL_ADDRESS | events@opensuse.org | The address OSEM uses for sending mails | +| OSEM_ICHAIN_ENABLED | true/false | Enable the usage of [devise_ichain_authenticatable](https://github.com/openSUSE/devise_ichain_authenticatable) | +| OSEM_TRANSIFEX_APIKEY | *string* | Use this api key for [transifex](https://www.transifex.com/). See TRANSLATION.md for details. | +| OSEM_ERRBIT_HOST | errbit.opensuse.org | The [errbit](https://github.com/errbit/errbit) host to post exceptions to | +| OSEM_ERRBIT_APIKEY | *string* | The api key for the errbit host | +| OSEM_FACTORY_LINT | *boolean* (true/false) | Setting this to false will disable linting of factories before running spec +| OSEM_GOOGLE_KEY/OSEM_GOOGLE_SECRET | *string* | OMNIAUTH Developer Keys/Secrets for GOOGLE +| OSEM_FACEBOOK_KEY/OSEM_FACEBOOK_SECRET | *string* | OMNIAUTH Developer Keys/Secrets for Facebook +| OSEM_GITHUB_KEY/OSEM_GITHUB_SECRET |*string* | OMNIAUTH Developer Keys/Secrets for GitHub +| OSEM_SMTP_ADDRESS | smtp.opensuse.org | The smtp server to use +| OSEM_SMTP_PORT | *int* | The port on the smtp server +| OSEM_SMTP_USERNAME | *string* | The user for the smtp server +| OSEM_SMTP_PASSWORD | *string* | The password for the smtp server +| OSEM_SMTP_AUTHENTICATION | plain, login or cram_md5 | The auth method for the smtp server +| OSEM_SMTP_DOMAIN | opensuse.org | The HELO domain for the smtp server -## Dependences +## Dependencies ### ImageMagick We use [ImageMagick](http://imagemagick.org/) for image manipulation so it needs to be available in your installation. @@ -35,8 +41,8 @@ $ bundle exec rake logo:reprocess ### openID In order to use [openID](http://openid.net/) logins for your OSEM installation you need to register your application with the providers ([Google](https://code.google.com/apis/console#:access), [GitHub](https://github.com/settings/applications/new) or [Facebook](https://developers.facebook.com/)) and enter their API keys in `config/secrets.yml` file, changing the existing sample values. - ## Recurring Jobs +======= Open a separate terminal and go into the directory where the rails app is present, and type the following to start the delayed_jobs worker for sending email notifications. ``` bundle exec rake jobs:work diff --git a/config/environments/production.rb b/config/environments/production.rb index 7901720c..d4f16683 100644 --- a/config/environments/production.rb +++ b/config/environments/production.rb @@ -76,7 +76,9 @@ Osem::Application.configure do port: ENV['OSEM_SMTP_PORT'], user_name: ENV['OSEM_SMTP_USERNAME'], password: ENV['OSEM_SMTP_PASSWORD'], - authentication: ENV['OSEM_SMTP_AUTHENTICATION'] + authentication: ENV['OSEM_SMTP_AUTHENTICATION'].to_sym, + domain: ENV['OSEM_SMTP_DOMAIN'], + enable_starttls_auto: true } # Set the secret_key_base from the env, if not set by any other means diff --git a/dotenv.example b/dotenv.example index 51ea5be5..921020d1 100644 --- a/dotenv.example +++ b/dotenv.example @@ -48,6 +48,7 @@ OSEM_SMTP_PORT="" OSEM_SMTP_USERNAME="" OSEM_SMTP_PASSWORD="" OSEM_SMTP_AUTHENTICATION="" +OSEM_SMTP_DOMAIN="" # Enable the usage of the devise ichain plugin OSEM_ICHAIN_ENABLED=false