-
Notifications
You must be signed in to change notification settings - Fork 319
Configuration
Several components of Scumblr require configuration, which can be done using an initializer file. A sample is included in the repo under config/initializers/scumblr.rb.sample. This page will discuss the settings that can be configured using this file.
Important Notes
-
When using/editing the scumblr.rb.sample file to remove the "#" characters at the beginning of lines you want to use for configuration. The "#" symbol indicates a comment line, and scumblr will not pick up these configurations if the "#" symbol is not removed.
-
Configuration changes (such as adding/updating API keys) require Scumblr and Sidekiq to be restarted to pick up the configuration changes.
-
To set these settings using environment variables, use the initializer to specify the environment variable in use for each setting. Example:
config.sketchy_verify_ssl = ENV["SKETCHY_VERIFY_SSL"]
This will use the "SKETCHY_VERIFY_SSL" environment variable for this configuration setting.
If you plan to use email notifications or the sketchy integration, you should ensure the default URL options are set correctly. This can be done in the config/environments/* files. Placeholders are located at the end of the production.rb and test.rb files. Example:
Rails.application.routes.default_url_options[:host] = "scumblr.com"
Rails.application.routes.default_url_options[:protocol] = "https"
The :host option can also use an IP address and/or include the port if non-standard (i.e. "192.168.10.101:3000"). In addition, you may need to setup configure your Rails environment configuration to allow the application to send email. See instructions here: http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration
Many search providers will need to be configured (i.e. providing access tokens, API keys, etc.) in order to work properly. For the built-in providers please see the pages below for details on their settings/configuration: