trusted-sandbox 0.0.4.pre → 0.0.5.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9af2320f694b6680f7d379fb627accbea8838bdc
-  data.tar.gz: 668cac12d319ac12790444efdfc15633c294469f
+  metadata.gz: 0d3fb95fffeffce711e562faff1deef7cff15718
+  data.tar.gz: 3a5958b483d1df9fe5c840ac259e16ba1a3d83e9
 SHA512:
-  metadata.gz: 0ac29dbd2e3fef1ede1b0f3a8be19bf855563c225b13d74b92a8359746b65a13e03c020c5f8c981b82f0901ba1d8805f46cf31d16a8712cd6068877097d84b6b
-  data.tar.gz: 68bf05f6e4108d6d467a2e1d36b15bf0eb24f8cd26379161bea4e04050d57f9ab4c350907fd2f891c98df07f3c69ef006e0a311d51009e77126999ea4afba9bb
+  metadata.gz: f7e5a87ed6c9f9574c649ae197feefd9f7a888c3f6121c61b22c0b9d7121227727b31dc3c6327d236727706aef6d81f80c34a591dd748dfd96fd60643e915cca
+  data.tar.gz: b95fa38e9eb1d868d9637591d468c77d8b886e7040536bcaf84e5a5806779cbeabea8f7d0a573a9fd40a51aca43ef7d3d6bb4cdb11336290b052afd29e279f08

data/README.md

@@ -53,16 +53,35 @@ Or install it yourself as:
 $ gem install trusted-sandbox
 ```
 
-Then, run the following command which will copy the `trusted_sandbox.yml` file into your current directory, or
+### Step 2
+Install Docker. Refer to the Docker documentation to see how to install Docker on your environment.
+Note that on a linux server the docker daemon runs as root and owns the socket used to connect to it.
+To give your app user access to that socket you will need to add the user to the docker group.
+```
+$ sudo gpasswd -a ${USER} docker
+$ sudo service docker.io restart
+```
+then reconnect to your shell session and try the following (without sudo command):
+```
+$ docker images
+```
+If it works, then you are all set.
+
+You can read more about this issue [here][5].
+
+### Step 3
+Run the following command which will copy the `trusted_sandbox.yml` file into your current directory, or
 `config` directory if it exists:
 ```
 $ trusted_sandbox install
 ```
 
-### Step 2
-Install Docker. Refer to the Docker documentation to see how to install Docker on your environment.
+Follow the configuration instructions below. Once you're done configuring, test your installation by running:
+```
+$ trusted_sandbox test
+```
 
-### Step 3
+### Step 4
 Install the image. This step is optional, as Docker automatically installs images when you first run them. However,
 since it takes a few minutes we suggest you do this in advance.
 ```
@@ -77,14 +96,14 @@ $ sudo service docker.io restart
 ```
 and then try again.
 
-### Step 4
+### Step 5
 
 If you'd like to limit swap memory or set user quotas you'll have to install additional programs on your server.
 Follow the instructions in the relevant sections of the configuration guide.
 
 ## Configuring Trusted Sandbox
 
-Let's go over the sections of the YAML configuration file you created in step 1 above.
+Let's go over the sections of the YAML configuration file you created in step 3 above.
 
 ### Docker access
 ```ruby
@@ -398,3 +417,4 @@ Licensed under the [MIT license](http://opensource.org/licenses/MIT).
 [2]: https://www.digitalocean.com/community/articles/how-to-enable-user-quotas
 [3]: http://hmarr.com/2013/oct/16/codecube-runnable-gists/
 [4]: https://www.digitalocean.com/community/tutorials/how-to-enable-user-quotas
+[5]: http://askubuntu.com/questions/477551/how-can-i-use-docker-without-sudo

data/lib/trusted_sandbox/cli.rb

@@ -16,6 +16,12 @@ module TrustedSandbox
       FileUtils.cp File.expand_path('../config/trusted_sandbox.yml', __FILE__), target_file
     end
 
+    desc 'test', 'Checks Trusted Sandbox can connect to Docker'
+    def test
+      TrustedSandbox.test
+      puts 'Trusted Sandbox seems to be configured correctly!'
+    end
+
     desc 'generate_image VERSION', 'Creates the Docker image files and places them into the `trusted_sandbox_images` directory. Default version is 2.1.2'
     def generate_image(image_version = '2.1.2')
       target_dir = 'trusted_sandbox_images'

data/lib/trusted_sandbox/version.rb

@@ -1,3 +1,3 @@
 module TrustedSandbox
-  VERSION = '0.0.4.pre'
+  VERSION = '0.0.5.pre'
 end

data/lib/trusted_sandbox.rb

@@ -11,6 +11,11 @@ module TrustedSandbox
   require 'trusted_sandbox/uid_pool'
   require 'trusted_sandbox/version'
 
+  def self.test
+    Docker.version
+    true
+  end
+
   # Usage:
   #   TrustedSandbox.config do |c|
   #     c.pool_size = 10

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trusted-sandbox
 version: !ruby/object:Gem::Version
-  version: 0.0.4.pre
+  version: 0.0.5.pre
 platform: ruby
 authors:
 - Amit Aharoni