Skip to content

Update readme with installation notes and 1.9 mode note #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme with installation notes and 1.9 mode note #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
JRuby Sandbox
=============

The JRuby sandbox is a reimplementation of _why's freaky freaky sandbox
The JRuby sandbox is a reimplementation of \_why's freaky freaky sandbox
in JRuby, and is heavily based on [javasand][1] by Ola Bini, but updated
for JRuby 1.6.

## Installation

gem install jruby_sandbox

## Prerequisites

This gem requires JRuby 1.6. As of the time of this writing, it is known to
Expand Down Expand Up @@ -40,6 +44,8 @@ core libraries. Note that this is a direct binding to `Kernel#require`,
so it will only load ruby stdlib libraries (i.e. no rubygems support
yet).

Note that all code in the sandbox will be interpreted in Ruby 1.9 mode.

## Sandbox::Safe usage

Sandbox::Safe exposes an `#activate!` method which will lock down the sandbox, removing unsafe methods. Before calling `#activate!`, Sandbox::Safe is the same as Sandbox::Full.
Expand Down