Start Burning!

Start Codeburner#

Codeburner should work fine with most standard rack servers. Internally it's been tested to work quite well with both unicorn and puma.

For local development, we recommend the standard WEBrick rails server and the spring gem for fast iteration. You can start the main app server like so:

bundle exec rails s -p 8080

That will start Codeburner on port 8080, and at this point you should be able to open Codeburner by pointing a web browser at http://localhost:8080/.

Developers

If you change the port here, just note that you'll also need to change it in the client proxy config for the web client to pass API calls correctly.

In a production environment, we recommend serving the root static content (public/) with something like httpd or nginx.

Start Sidekiq#

Codeburner uses Sidekiq for asynchronous work (scanning code, sending notifications, etc.). You'll need to explicitly start sidekiq as a separate process for Codeburner to actually "do" anything useful. The default configuration options should work fine in most environments.

Configuration#

If you do need to customize sidekiq, it is configured in config/sidekiq.yml.

Startup#

For local development/testing you can start sidekiq with bundle exec:

bundle exec sidekiq

If you've deployed to a remote host (and configured Capistrano correctly) you should be able to start sidekiq using cap:

bundle exec cap  sidekiq:start