Skip to content

Commit

Permalink
Add documentation on configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
tawan committed Nov 27, 2016
1 parent 6a2ef64 commit e8be8c2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,17 @@ You have your Rails application deployed on the [Amazon Elastic Beanstalk](http:

9. Deploy the application to both environments (web and worker).

## Optional configuration
This gem is configurable in case your setup requires different settings than the defaults.

```Ruby
Rails.application.configure do
config.active_elastic_job.process_jobs = # defaults to ENV['PROCESS_ACTIVE_ELASTIC_JOBS'] == 'true' || false
config.active_elastic_job.aws_credentials = # defaults to Aws::InstanceProfileCredentials.new
config.active_elastic_job.secret_key_base = # defaults to Rails.application.secrets[:secret_key_base]
end
```

## FAQ
A summary of frequently asked questions:
### What are the advantages in comparison to popular alternatives like Resque, Sidekiq or DelayedJob?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,9 @@

# Do not dump schema after migrations.
config.active_record.dump_schema_after_migration = false

# Test gem's configuration
config.active_elastic_job.process_jobs = true
config.active_elastic_job.aws_credentials = Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'])
config.active_elastic_job.secret_key_base = 's3krit'
end

0 comments on commit e8be8c2

Please sign in to comment.