capistrano-bolt 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dc82010cdfbbe60dfc1ac1fa897b096298bea39
-  data.tar.gz: 26e247c7189aa4b34bdb821d36049c93d80f8563
+  metadata.gz: f4d814bf5da8a37d191d20fc319eeabb88253f99
+  data.tar.gz: 3a74262c6856e9bcfa2234741472e8552cd8f11f
 SHA512:
-  metadata.gz: 062cee3c5bbb675ed06487e6f1a4d1ef006eeee7ffd124247bf4a04b85732329d8aeb73df8a7ab7f72d9b3b738c9d48fc11a7f292f924b6c11639ab9e1a01ae0
-  data.tar.gz: f819c70367a14f331cbaf12e67034bf4eda040b959e82c520e647ee9582105b867157dc39988be3c891a395c3bd394548b5f86d20f118c41099feb774d230212
+  metadata.gz: 9aef67b9509cdf405610b00b1453fa333c0a5f789e61f14a9bfc5bef2b140ed00f5077f8242dceb7062596dac2776feacd1db48e672c98fb7ca810d13e80b293
+  data.tar.gz: 1029f1c25dfe1d9fef51a81d1995108578b5825c90fab381cf020b23c3e9a213f8595a24cc7c074dba1467f9a6f8783d159983849e9862ae8bb6d4b29b8b8e92

data/README.md

@@ -1,5 +1,7 @@
 # Heroku-like easy deployment for Rails 4 with Capistrano 3, Puma, Nginx and Postgresql.
 
+**UPDATE:** A very brief documentation is updated at the end of this readme after noticing that many people are trying this gem within few hours of publishing. Thanks for the support guy but sorry for publising the gem without getting the documentation ready at first place.
+
 As the title says, this gem provides a super simple way to deploy your rails app.
 I created this after I got tired of trying numerous capistrano receipes and gem.  While I learned a lot from these gems and respect their authors for the knowledge shared with the community to the core of my heart, none of the existing gems that I tried simplified the deployment process as I wanted. Here is the workflow that I ever wanted.
 
@@ -18,6 +20,8 @@ Install a gem on my rails app and issue a command like below
 
 NO Step 2. No need to login to the server to create nginx vhost file or postgres database or to create environment variables. All these are already taken care by Step 1.
 
+Note: currently the gem requires a few configuration task in your rails app which will be automated in future.
+
 ---
 
 If you are like me and want a simple deployment process like above then this gem is for you.
@@ -29,5 +33,111 @@ If you are like me and want a simple deployment process like above then this gem
 3. configuring puma app server with the created Nginx vhost file
 
 ---
-Documentation for using this gem will be shortly updated.
+This gem is currently under active development but can be used for deploying as of now. The pending tasks as of now is to further simplify the installation and setup process and to make this gem truly a one step deploy gem.
+
+<strike>Documentation for using this gem will be shortly updated.</strike>
+## A very brief documentation for the early adopters.
+(I will get a detailed documetation in the next two days.)
+
+### Prerequisites 
+Bolt assumes that you have nginx, postgresql and ruby installed on your server. If not, you can install all these with the following command
+
+Nginx
+```
+sudo apt-get install nginx
+```
+
+Postgresql
+```
+sudo apt-get install postgresql postgresql-develop
+```
+
+Ruby
+
+```
+sudo apt-get install git-core curl zlib1g-dev build-essential libssl-dev libreadline-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev libcurl4-openssl-dev python-software-properties
+wget http://cache.ruby-lang.org/pub/ruby/2.1/ruby-2.1.2.tar.gz
+tar -zxvf ruby-2.1.2.tar.gz
+cd ruby-2.1.2/
+./configure
+make
+sudo make install
+```
+
+Check if your postgres database has been configured for password authentication.
+Open `/etc/postgresq/9.3/main/pg_hba.conf` [the value 9.3 could be different on your server based on your postgres version]
+
+and change the following
+```
+# "local" is for Unix domain socket connections only
+local   all             all                                     peer
+```
+to 
+```
+# "local" is for Unix domain socket connections only
+local   all             all                                     md5
+```
+
+Then restart the postgres server to load the new configuration
+```
+sudo /etc/init.d/postgresql restart
+```
+
+Bolt requires an user on the server that can use `sudo` without password.
+```
+adduser deployer
+echo "deployer ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+```
+
+With the above setup, the server setup for Bolt is complete. If your server is already setup like above there is no need to do all these steps.
+
+## Using Bolt
+
+### Installing gem
+in your gemfile add
+```
+# Gemfile
+gem 'dotenv-rails'
+```
+as the first gem. This is a requirement for Bolt setup to work currently. In near future, this requirement will be eliminated.
+
+then add
+```
+# Gemfile
+gem 'puma'
+gem 'capistrano-bolt', group: :development
+```
+
+and run
+```
+bundle install
+```
+
+### Configuring
+run
+```
+cap install
+```
+and change the contents of`Capfile`, `deploy.rb` and `production.rb` file with contents as given in https://github.com/opendrops/capistrano-bolt/tree/master/lib/capistrano/templates/capistrano
+
+This step will be automated in future. For now, just use the given templates as reference to modify the values.
+
+If you use rbenv or rvm or chruby, be sure to add these gems in your gemfile and uncomment the require statements for these gems in `Capfile`.
+
+### Deploying
+Run the following command for the first time when you deploy the app
+```
+cap production setup:all
+```
+The above command configures your nginx, postgresql, dotenv file.
+
+Now deploy your app using
+```
+cap production deploy
+```
+
+wait for the task to complete and visit the url for your app domain. You should now see your app fully deployed on your server without you having to login to the server and do many of the repetitive boring tasks.
+
+---
+**Note:** I have written this quick install document seeing that many people have tried to download this gem without any documentation. So this document is prepared in a hurry to fill this gap. If you are getting errors or if the information in this document is inadequate,  contact me @ shankar AT opendrops DOT com and I shall be able to guide you as soon as possible.
 

data/lib/capistrano/bolt/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Bolt
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/capistrano/bolt.rb

@@ -1,4 +1,14 @@
+# Override Capistrano install task
+load File.expand_path('../tasks/setup.rake', __FILE__)
+
+# Load nginx task
 load File.expand_path('../tasks/nginx/nginx.rake', __FILE__)
+
+# Load puma task
 load File.expand_path('../tasks/puma/puma.rake', __FILE__)
+
+# Load postgresql task
 load File.expand_path('../tasks/postgresql/postgresql.rake', __FILE__)
+
+# Load server setup task
 load File.expand_path('../tasks/setup.rake', __FILE__)

data/lib/capistrano/tasks/install.rake

@@ -8,9 +8,9 @@ task :install do
   config_dir = Pathname.new('config')
   deploy_dir = config_dir.join('deploy')
 
-  deploy_rb = File.expand_path("../../templates/deploy.rb.erb", __FILE__)
-  stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
-  capfile = File.expand_path("../../templates/Capfile", __FILE__)
+  deploy_rb = File.expand_path("../../templates/capistrano/deploy.rb.erb", __FILE__)
+  stage_rb = File.expand_path("../../templates/capistrano/stage.rb.erb", __FILE__)
+  capfile = File.expand_path("../../templates/capistrano/Capfile", __FILE__)
 
   mkdir_p deploy_dir
 

data/lib/capistrano/tasks/setup.rake

@@ -6,6 +6,9 @@ namespace :setup do
   task :postgresql do
     invoke "postgresql:create_role"
     invoke "postgresql:create_db"
+    from = File.expand_path("../../templates/postgresql/database.yml.erb", __FILE__)
+    to = File.join(shared_path, 'config/database.yml')
+    upload_template(from, to)
   end
 
   desc 'add site, enable and reload nginx'

data/lib/capistrano/templates/capistrano/Capfile

@@ -0,0 +1,27 @@
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+# Include tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+
+require 'capistrano/bundler'
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'
+require 'capistrano/bolt'
+
+# Load custom tasks from `lib/capistrano/tasks' if you have any defined
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

data/lib/capistrano/templates/capistrano/deploy.rb.erb

@@ -0,0 +1,35 @@
+# config valid only for Capistrano 3.1
+lock '<%= Capistrano::VERSION %>'
+
+# Configure these values
+set :application, "my_app_name"
+set :repo_url, "git@example.com:me/my_repo.git"
+set :deploy_to, "/var/www/#{fetch(:application)}"
+
+# Don't remove the existing values as it's needed for capistrano-bolt to work
+# You may add more files or directories to this list if needed.
+set :linked_files, %w{.env config/database.yml}
+set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+
+## Changes these default values only if needed
+
+# Default branch is :master
+# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
+
+# Default value for :scm is :git
+# set :scm, :git
+
+# Default value for :format is :pretty
+# set :format, :pretty
+
+# Default value for :log_level is :debug
+# set :log_level, :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+# Default value for keep_releases is 5
+# set :keep_releases, 5

data/lib/capistrano/templates/capistrano/stage.rb.erb

@@ -0,0 +1,7 @@
+# Change example.com to your server hostname and 'deploy' to the user name of your server
+# that you can use to login to the server from your workstation
+
+server 'example.com', user: 'deploy', roles: %w{web app db}
+
+# Change myapp.com to the domain name intended for accessing your app by public
+set :domain_name, 'myapp.com'

data/lib/capistrano/templates/nginx/nginx.conf.erb

@@ -3,7 +3,7 @@ upstream <%= fetch(:application) %>_puma {
 }
 
 server {
-  server_name <%= fetch(:server_name) %>;
+  server_name <%= fetch(:domain_name) %>;
   listen 80;
   root <%= fetch(:deploy_to) %>/current/public;
 
@@ -28,7 +28,7 @@ server {
 
 <% if fetch(:enable_ssl) %>
 server {
-  server_name <%= fetch(:server_name) %>;
+  server_name <%= fetch(:domain_name) %>;
   listen 443;
   root <%= fetch(:deploy_to) %>/current/public;
 
@@ -54,4 +54,4 @@ server {
   ssl_certificate <%= fetch(:deploy_to) %>/shared/ssl_cert.crt;
   ssl_certificate_key <%= fetch(:deploy_to) %>/shared/ssl_private_key.key;
 }#
-<% end %>
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-bolt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shankar Dhanasekaran
@@ -73,6 +73,9 @@ files:
 - lib/capistrano/tasks/postgresql/postgresql.rake
 - lib/capistrano/tasks/puma/puma.rake
 - lib/capistrano/tasks/setup.rake
+- lib/capistrano/templates/capistrano/Capfile
+- lib/capistrano/templates/capistrano/deploy.rb.erb
+- lib/capistrano/templates/capistrano/stage.rb.erb
 - lib/capistrano/templates/dotenv.erb
 - lib/capistrano/templates/nginx/nginx.conf.erb
 - lib/capistrano/templates/postgresql/database.yml.erb