Skip to content
This repository has been archived by the owner on Jan 30, 2018. It is now read-only.

Configure teambox.yml

Jump to bottom
unixcharles edited this page Oct 13, 2010 · 3 revisions

To install Teambox, you need to configure your teambox.yml

Most of the configuration fields default are fine, but a few are mandatory.

  • app_domain

You need to set your application domain. Otherwise, some absolute path in the application will be broken, like CSS and Javascript.

...
# Configuration shared between all environments:
defaults: &defaults
  # The domain from where your app is served
  app_domain: localhost
...
  • amazon_s3

If you want to use amazon S3 for storage, you're need to enable it. ... # See "config/amazon_s3.yml" for info about credentials. amazon_s3: false ... You'll also have to configure the config/amazon_s3.yml This is an optional step for heroku, because in heroku environment, teambox will automatically look for environment variable as explained in the related guide.

  • Outgoing email You'll need to enter you SMTP server information to get a fully functional Teambox install. If you don't have one, we suggest you to use sengrid and its free for 500 email per day.

    By default, emails are sent in production but not in development

    allow_outgoing_email: true

    Configuration for outgoing mail

    With Heroku and the Sendgrid add-on, no configuration is needed here.

    $ heroku addons:add sendgrid:free

    smtp_settings: :domain: domain.com # the domain your emails will come from :address: smtp.sendgrid.net # SMTP server used to send emails :port: 25 :authentication: :plain :user_name: USER :password: PASSWORD

  • Using Google SMTP service Gmail or Google apps SMTP service are also free for 500 email per day but its are slower and harder to configure than Sendgrid, make sure you set "enable_starttls_auto" to true with Google SMTP services. Also, make sure you have a recent version of ruby for TLS support, anything 1.8.7+ will work.

    Set to true when using Gmail

    :enable_starttls_auto: false

  • Net::SMTPSyntaxError errors If you run into strange SMTP errors, try to set safe_from to true.

    Set to true if you have Net::SMTPSyntaxError errors when sending email.

    Rails has sometimes a problem when sending email from "Name address@host.com".

    If you are having problems sending email and your host is correctly configured,

    try setting safe_from to true. You may need to create a user account for no-reply@yourapp.com

    :safe_from: false

  • Environment config You can overwrite some of the configuration settings for specific environment. If you overwrite and hash make sure you copy all the keys, or you might run into problem.

    development: <<: *defaults app_domain: localhost:3000 allow_outgoing_email: false autorefresh_interval: 20 # in seconds

    production: <<: *defaults

    test: &test <<: *defaults app_domain: 127.0.0.1 allow_outgoing_email: false asset_max_file_size: 1 amazon_s3: false cucumber: <<: *test

Clone this wiki locally