No Longer Maintained
The TorqueBox project is no longer actively developed nor maintained. Do not use it for development or production usage unless you are willing and able to fix issues as they come up.
This is TorqueBox 4 and represents a substantial change in direction from previous TorqueBox releases. We're moving to a lightweight, embedded model that runs without any Java application server, at the expense of a few of the more enterprisy features. For users that want to run in a Java application server or need those enterprisy features, we'll provide a way to take your TorqueBox application and run it unmodified on a stock WildFly installation.
We have various guides available to help with installation, migration, usage, and deployment of TorqueBox 4.
- Installation Guide
- Migration Guide
- Web Guide
- Messaging Guide
- Scheduling Guide
- Caching Guide
- Executable Jar Guide
- Wildfly Guide
Quickstart for running TorqueBox
TorqueBox requires JRuby 1.7.x (in 1.9 or 2.0 mode) or JRuby 9.x.x running on Java 7+. The code has only been tested on JRuby 1.7.6 and higher but should work on earlier versions.
Read the Installation Guide for installation details.
From inside your Rack application's root directory:
torquebox is in your
rails s torquebox
rackup -s torquebox
We want a smaller, more modular TorqueBox that is easier to get started with, embeddable, and lets users bring in additional functionality as-needed. More details of our motivation and community feedback are expressed in an email thread from the torquebox-user mailing list.
TorqueBox runs on JRuby and sits on top of a new lightweight, pluggable, polyglot server codenamed WunderBoss (at least for now). All the new features of TorqueBox will be implemented in WunderBoss then exposed via a Ruby API in the TorqueBox project. This lets other projects, in other languages, reuse the same functionality by creating small language-specific API wrappers.
We aim to reuse the same underlying components as WildFly so that TorqueBox applications can run on top of WildFly in addition to running without it, to give users an option between a full-blown Java application server and a very lightweight, minimal server.
Right now TorqueBox 4 provides a high-performance Rack implementation for web applications and basic APIs for messaging, caching, and scheduled jobs. The Rack support is considered production-ready, but the messaging, caching, and scheduling implementations are still in a bit more flux.
We're developing TorqueBox 4 while also maintaining TorqueBox 3, and we expect it to take some time before TorqueBox 4 comes out of alpha and betas and into a final release.
bundle install rake build
Running integration tests
phantomjs is available on your $PATH - http://phantomjs.org/download.html.
The first time you run the integration tests may take longer as bundler gets invoked for each test application to install its dependencies. Subsequent runs with the same JRuby installation should be faster.
cd integration-tests rake spec
Running a single integration test
cd integration-tests SPEC=spec/basic_sinatra_spec.rb rake spec
Running specs with more verbose output
DEBUG=true rake spec
Running all integration test variants (disk, jar, wildfly)
There are several variants of integration tests. Each runs the same applications and same specs, but packaged in different ways. This takes quite a bit longer, but is what CI runs.
Installing from source
TorqueBox 4 is released from the
master branch of torquebox/torquebox-release.
Set up this repository as an additional remote for your workspace:
git remote add release [email protected]:torquebox/torquebox-release.git
Ensure that the
master branch has the contents you wish to release. Using the
-f flag to force is allowed in this case, since the torquebox-release repository is not a public-facing human-cloneable repository.
git push release master:master -f
Perform the build
Using the build system, select the torquebox4-release job, entering in the branch to release from (usually 'master'), the version to release, and the next version after release.
If something goes wrong in the release job and it needs to run again, be sure to reset the torquebox-release repository with the correct code first:
git push release master:master -f
After the job complete successfully, the generated RubyGems will need to be manually deployed. Download them from the job and push each using:
gem push <gem_name>.gem
You'll have to be an owner of the gems to do this. Bug bbrowning, bobmcw, or tcrawley if you are not.
Publish the release API documentation
The release API docs are built by the release job on CI. Download those and put them a _4x_docs//yardoc folder in the torquebox.org git repo.
Push changes from the release repository to the official repository
git fetch release --tags git merge release/master git push origin master git push origin <release_tag>