diff --git a/config/initializers/locomotive.rb b/config/initializers/locomotive.rb index 8c3bd3b4..bcc41fbe 100644 --- a/config/initializers/locomotive.rb +++ b/config/initializers/locomotive.rb @@ -21,18 +21,18 @@ Locomotive.configure do |config| # configure the hosting target for the production environment. Locomotive can be installed in: # - your own server # - Heroku (you need to create an account in this case) - # - Bushi.do (you need to create an account in this case) + # - Bushi.do (see the bushi.do website for more explanations) # # the possible options are: server, heroku, bushido or auto (default) # if you select 'auto', Locomotive will look after specific ENV variables to check - # the matching platform (Heroku and Bushido set their own ENV variable). + # the matching platform (Heroku and Bushido set their own ENV variables). # config.hosting = :auto # In case you host Locomotive in Heroku, the engine uses the heroku api to add / remove domains. # there are 2 ways of passing heroku credentials to Locomotive # - from ENV variables: HEROKU_LOGIN & HEROKU_PASSWORD - # - from this file + # - from this file, see the example below and uncomment it if needed # config.heroku = { # :login => '' # :password => '' diff --git a/lib/generators/locomotive/install/templates/locomotive.rb b/lib/generators/locomotive/install/templates/locomotive.rb index 63d0d994..4d0baaa1 100644 --- a/lib/generators/locomotive/install/templates/locomotive.rb +++ b/lib/generators/locomotive/install/templates/locomotive.rb @@ -1,43 +1,61 @@ Locomotive.configure do |config| - # if not defined, locomotive will use example.com as main domain name. Remove prefix www from your domain name. - # Ex: - # config.default_domain = Rails.env.production? ? 'mydomain.com' : 'example.com' + + # A single locomotive instance can serve one single site or many. + # If you want to run many different websites, you will have to specify + # your own domain name (ex: locomotivehosting.com). # - # If you use locomotive for a single site in Heroku, use "heroku.com" as default domain name. - # Your heroku app name (.heroku.name) will be used as the sub domain name in Locomotive - # during the installation wizzard. # Ex: - # config.default_domain = Rails.env.production? ? 'heroku.com' : 'example.com' - config.default_domain = 'example.com' + config.multi_sites do |multi_sites| + # each new website you add will have a default entry based on a subdomain + # and the multi_site_domain value (ex: website_1.locomotivehosting.com). + multi_sites.domain = 'example.com' #'myhostingplatform.com' - # configure how many items we display in sub menu in the "Contents" section. - config.lastest_items_nb = 5 + # define the reserved subdomains + # Ex: + multi_sites.reserved_subdomains = %w(www admin email blog webmail mail support help site sites) + end + # config.multi_sites = false - # tell if logs are enabled. Useful for debug purpose. - config.enable_logs = true + # configure the hosting target for the production environment. Locomotive can be installed in: + # - your own server + # - Heroku (you need to create an account in this case) + # - Bushi.do (see the bushi.do website for more explanations) + # + # the possible options are: server, heroku, bushido or auto (default) + # if you select 'auto', Locomotive will look after specific ENV variables to check + # the matching platform (Heroku and Bushido set their own ENV variables). + # + config.hosting = :auto - # tell if the application is hosted on Heroku. - # Locomotive uses heroku api to add / remove domains. + # In case you host Locomotive in Heroku, the engine uses the heroku api to add / remove domains. # there are 2 ways of passing heroku credentials to Locomotive # - from ENV variables: HEROKU_LOGIN & HEROKU_PASSWORD - # - from this file - # - # Notes: - # - IMPORTANT: behaviours related to this option will only be applied in production - # - credentials coming from this file take precedence over ENV variables - # - # Ex: - # config.heroku = { :name => '', :login => 'john@doe.net', :password => 'easy' } - config.heroku = false + # - from this file, see the example below and uncomment it if needed + # config.heroku = { + # :login => '' + # :password => '' + # } # Locomotive uses the DelayedJob gem for the theme import module. # In case you want to deploy to Heroku, you will have to pay for an extra dyno. # If you do not mind about importing theme without DelayedJob, disable it. config.delayed_job = false + # configure how many items we display in sub menu in the "Contents" section. + config.lastest_items_nb = 5 + # default locale (for now, only en, de, fr and pt-BR are supported) config.default_locale = :en + # tell if logs are enabled. Useful for debug purpose. + config.enable_logs = true + # Configure the e-mail address which will be shown in the DeviseMailer, NotificationMailer, ...etc - config.mailer_sender = 'support@example.com' + # if you do not put the domain name in the email, Locomotive will take the default domain name depending + # on your deployment target (server, Heroku, Bushido, ...etc) + # + # Ex: + # config.mailer_sender = 'support' + # # => 'support@heroku.com' (Heroku), 'support@bushi.do' (Bushido), 'support@example.com' (Dev) or 'support@' (Multi-sites) + config.mailer_sender = 'support' end