sm-configure: Engine Configuration DSL

Comprehensive reference for configuring SourceMonitor via SourceMonitor.configure.

When to Use

• Adding or modifying settings in config/initializers/source_monitor.rb
• Understanding what configuration options are available
• Debugging configuration-related issues
• Setting up environment-specific overrides

Configuration Entry Point

All configuration lives inside the configure block in the host app's initializer:

ruby
1SourceMonitor.configure do |config|
2  # settings here
3end

After the block executes, ModelExtensions.reload! runs automatically to apply any model changes. Restart web and worker processes after changes.

Configuration Sections

The config object (SourceMonitor::Configuration) has 13 sub-sections plus top-level queue/job settings:

See reference/configuration-reference.md for every setting with types, defaults, and examples.

Quick Examples

Queue Configuration

ruby
1config.queue_namespace = "source_monitor"
2config.fetch_queue_name = "source_monitor_fetch"
3config.fetch_queue_concurrency = 4

HTTP Client

ruby
1config.http.timeout = 30
2config.http.proxy = ENV["HTTP_PROXY"]
3config.http.retry_max = 3

Authentication (Devise)

ruby
1config.authentication.authenticate_with :authenticate_user!
2config.authentication.authorize_with ->(c) { c.current_user&.admin? }

Image Downloads (Active Storage)

ruby
1config.images.download_to_active_storage = true
2config.images.max_download_size = 5 * 1024 * 1024  # 5 MB
3config.images.download_timeout = 15
4config.images.allowed_content_types = %w[image/jpeg image/png image/webp]

Events

ruby
1config.events.after_item_created { |e| Notifier.new_item(e.item) }
2config.events.register_item_processor ->(ctx) { Indexer.index(ctx.item) }

Model Extensions

ruby
1config.models.table_name_prefix = "sm_"
2config.models.source.include_concern "MyApp::SourceExtension"
3config.models.item.validate :custom_check

Favicons (Active Storage)

ruby
1config.favicons.enabled = true
2config.favicons.fetch_timeout = 10
3config.favicons.max_download_size = 512 * 1024  # 512 KB
4config.favicons.retry_cooldown_days = 14

Realtime

ruby
1config.realtime.adapter = :redis
2config.realtime.redis_url = ENV["REDIS_URL"]

Helper APIs

ruby
1SourceMonitor.config                         # Current configuration
2SourceMonitor.configure { |c| ... }          # Set configuration
3SourceMonitor.reset_configuration!           # Revert to defaults (for tests)
4SourceMonitor.events                         # Shortcut to config.events
5SourceMonitor.queue_name(:fetch)             # Resolved queue name
6SourceMonitor.queue_concurrency(:scrape)     # Resolved concurrency
7SourceMonitor.mission_control_dashboard_path # Resolved MC path or nil

Key Source Files

References

• reference/configuration-reference.md -- Complete settings reference
• docs/configuration.md -- Official configuration documentation
• lib/generators/source_monitor/install/templates/source_monitor.rb.tt -- Initializer template

Testing

Reset configuration between tests:

ruby
1setup do
2  SourceMonitor.reset_configuration!
3end

Test custom configuration:

ruby
1test "custom queue name" do
2  SourceMonitor.configure do |config|
3    config.fetch_queue_name = "custom_fetch"
4  end
5  assert_equal "custom_fetch", SourceMonitor.queue_name(:fetch)
6end

Checklist

• Initializer exists at config/initializers/source_monitor.rb
• Queue names match config/queue.yml (or config/solid_queue.yml) entries
• Dispatcher config includes recurring_schedule: config/recurring.yml (handled by install generator)
• Authentication hooks configured for host auth system
• HTTP timeouts appropriate for target feeds
• Retention policy set for production
• Workers restarted after configuration changes