yyyc514-dwell 0.2.0 → 0.2.1

data/README.markdown

@@ -0,0 +1,115 @@
+DWELL - a cap recipe to setup a full Rails stack on Ubuntu
+============================================================================
+
+
+Install Capistrano2 (if you don't already have it) then build and install this gem:
+
+    $ sudo gem install capistrano
+    $ gem build dwell.gemspec
+    $ sudo gem install dwell-0.2.gem
+    
+
+### Typical Usage
+
+1. Capify your Rails directory
+2. Initialize dwell inside your Rails directory (you'll want to overwrite deploy.rb)
+3. Edit your deploy.rb: configure you applications name, domain, repository, server details, etc
+4. Bootstrap your server
+5. Install the Dwell stack and any optional packages
+6. Setup your rails app and apache vhost then deploy cold
+
+Or all said and done:
+    
+    $ capify .
+    $ dwell init .
+    $ cap dwell:server:bootstrap
+    $ cap dwell:install
+    $ cap dwell:rails:setup_and_deploy_cold    
+
+
+The Dwell Stack - dwell:install
+-----------------------------
+
+1. Updates Ubuntu sources and distro
+2. Installs Apache2
+3. Installs MySQL5
+4. Installs Subversion and Git
+5. Installs Ruby, RubyGems, Rails and Merb
+6. Installs Passenger module for Apache2
+7. Installs any optional packages listed in `:dwell_optional_installs`
+
+
+### Optional Packages
+
+You can specify optional packages to be installed during `dwell:install` in your deploy.rb file:
+
+    set :dwell_optional_installs, [:postfix, :imagemagick, :php]
+    
+Optional packages include:
+
+- postfix
+- mercurial
+- tinydns
+- php (sets up php via fastcig)
+- imagemagick (binary, gem, and mini-magick gem)
+- sqlite (binary and gem)
+
+
+Bootstrapping
+-------------
+
+###  dwell:server:bootstrap
+
+1. Creates a user account for `:user` (default 'deploy') in the admin group
+2. Gives the admin group sudo rights if they haven't already
+3. Copies authorized SSH keys to the remote host (such as your own public key)
+5. Disables SSH logins for the root account since we'll be using deploy and sudo
+
+Authorized keys should be placed in the file (:user is the name of your deploy user):
+
+    config/dwell/authorized_keys/:user
+
+
+###  dwell:linode:bootstrap
+
+1. Does a `dwell:server:bootstrap` as show above
+2. Uses the DHCP IP assignment to configure a static IP and disable DHCP
+3. Sets up the hostname of the box from what was passed in HOSTS
+
+You MUST pass the host (singular) in HOSTS to bootstrap a Linode as the bootstrap needs to know the hostname to properly configure the box.
+
+    HOSTS="my.new.box.com" cap dwell:linode:bootstrap
+
+
+Rails Notes - dwell:rails
+--------------------------
+
+### dwell:rails:setup\_and\_deploy\_cold
+
+1. Does a traditional `cap:setup`
+2. Copies deploy keys (if found) to the remote host (needed for git, etc)
+3. Creates a mysql database with the authentication info in your database.yml
+4. Sets up an apache vhost and SSL keys (if you're using SSL)
+5. Deploys your code
+6. Installs any necessary app gems with `rake gems:install`
+7. Runs migrations
+8. Reloads Apache which should fire up your app
+
+Optional deploy keys (public and private) should be placed in `deploy_keys`:
+
+    config/dwell/deploy_keys/:user.pub
+    config/dwell/deploy_keys/:user
+
+
+Apache Notes - dwell:apache
+---------------------------
+
+SSL certificates (if found) will be copied and installed during `setup_and_deploy_cold`.  You can also do this manually with `cap dwell:apache:copy_certs`.  These same certs will referenced automatically in your apache configs if you have set `:apache_ssl_enabled` in your deploy.rb.
+
+SSL certificates should be saved locally:
+
+    config/dwell/ssl/ca/*.crt
+    config/dwell/ssl/*.crt
+    config/dwell/ssl/*.key
+
+Any keys inside `ssl/ca` are assumed to be a Certificate Authority and are added to your Apache config with `SSLCACertificateFile`.

data/bin/dwell

@@ -1,3 +1,13 @@
 #!/usr/bin/env ruby
+require 'rubygems'
+require 'rubigen'
 
-puts "coming soon"
+if %w(-v --version).include? ARGV.first
+  puts "dwell version 0.2.1"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source=RubiGen::PathSource.new(:dwell, "#{File.dirname(__FILE__)}/../generators")
+RubiGen::Base.append_sources(source)
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'dwell')

data/generators/dwell/dwell_generator.rb

@@ -0,0 +1,80 @@
+require 'rbconfig'
+
+class DwellGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options   :shebang => DEFAULT_SHEBANG,
+                    :an_option => 'some_default'
+
+  attr_reader :app_name, :module_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    init = args.shift
+    if init!="init"
+      puts "ERROR: #{init} is not a supported command\n\n"
+      usage
+      exit(0)
+    end
+    @destination_root = args.shift || "."
+  end
+
+  def manifest
+    # Use /usr/bin/env if no special shebang was specified
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : 
+    options[:shebang] }
+    windows            = (RUBY_PLATFORM =~ /dos|win32|cygwin/i) || (RUBY_PLATFORM =~ /(:?mswin|mingw)/)
+
+    record do |m|
+      # Root directory and all subdirectories.
+#      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+  
+      # Root
+#      m.template_copy_each %w( Rakefile )
+#      m.file_copy_each     %w( config/deploy.rb )
+      m.template "deploy.rb", "config/deploy.rb"
+      m.file "known_hosts/github", "config/dwell/known_hosts/github"
+
+      # Test helper
+#      m.template   "test_helper.rb",        "test/test_helper.rb"
+
+      # Scripts
+      # %w( generate ).each do |file|
+      #   m.template "script/#{file}",        "script/#{file}", script_options
+      #   m.template "script/win_script.cmd", "script/#{file}.cmd", 
+      #     :assigns => { :filename => file } if windows
+      end
+   
+    end
+
+  protected
+    def banner
+      <<-EOS
+Creates a default deploy.rb and sets up the config/dwell directory tree.
+
+Usage: #{File.basename $0} init [/path/to/rails/app] [options]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator "#{File.basename $0} options:"
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+  # Installation skeleton.  Intermediate directories are automatically
+  # created so don't sweat their absence here.
+  BASEDIRS = %w(
+    config
+    config/dwell
+    config/dwell/authorized_keys
+    config/dwell/authorized_keys/deploy
+    config/dwell/deploy_keys
+    config/dwell/known_hosts
+    config/dwell/ssl
+    config/dwell/ssl/ca
+  )
+end

data/{lib → generators}/dwell/templates/deploy.rb

@@ -3,7 +3,10 @@ require 'dwell'
 # Application Details
 set :application, "myapp"
 set :domain,      "myapp.com"
-set :repository,  "svn://myapp.com/trunk"
+
+# If you aren't using Subversion to manage your source code, specify your SCM below:
+# set :scm, :git
+set :repository,  "set your repository location here"
 
 # Server-wide Details 
 set :user, "deploy"
@@ -13,12 +16,8 @@ server "myserver.com", :app, :web, :db, :primary => true
 ## the user to use when creating new databases and such
 # set :mysql_admin, "root"
 
-## hosts to automatically add to ssh known_hosts for your deploy user
-## only github is currently supported
-# set :known_hosts, [:github]
-
 ## other dwell packages to install on this server
-# set :dwell_install, ["imagemagick"]
+# set :dwell_optional_installs, ["imagemagick"]
 
 ## a specific rails version your app depends on, will be
 ## gem installed during dwell:install

data/lib/dwell/recipes.rb

@@ -11,7 +11,7 @@ Capistrano::Configuration.instance(:must_exist).load do
   
   namespace :dwell do
     
-    set :dwell_install, []
+    set :dwell_optional_installs, []
     
     desc "Install Rails Production Environment"
     task :install do
@@ -24,7 +24,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       top.dwell.ruby_enterprise.install if which_ruby==:enterprise
       top.dwell.gems.install
       top.dwell.passenger.install
-      dwell_install.each do |package_name|
+      dwell_optional_installs.each do |package_name|
         top.dwell.send(package_name).install
       end
     end

data/lib/dwell/recipes/bootstrap/linode.rb

@@ -2,34 +2,53 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :dwell do
     namespace :linode do
 
-      task :create_deploy_user do
-        dwell1.adduser deploy_user, :group => "admin"
-        new_password = Capistrano::CLI.ui.ask("Enter password for #{deploy_user}:") { |q| q.echo = true }
-        dwell1.invoke_with_input("passwd #{deploy_user}", /UNIX password/, new_password)
-      end
-      
-      task :copy_ssh_key do
-        dwell1.mkdir "/home/#{deploy_user}/.ssh", :mode => 0700, :owner => "#{deploy_user}.admin"
-        put File.read("config/dwell/authorized_keys/#{deploy_user}"), "/home/#{deploy_user}/.ssh/authorized_keys", :mode => 0600
-        sudo "chown #{deploy_user}.admin /home/#{deploy_user}/.ssh/authorized_keys"
-      end
-      
-      task :disable_root_login do
-        dwell1.config_gsub "/etc/ssh/sshd_config", /^PermitRootLogin (.*)$/,"PermitRootLogin no" 
-        sudo "/etc/init.d/ssh reload"
+      after "dwell:linode:bootstrap", "dwell:linode:setup_hostname"
+      after "dwell:linode:bootstrap", "dwell:linode:setup_static_ip"
+
+      desc "bootstrap a new linode server"
+      task :bootstrap do
+        hostname=ENV["HOSTS"]
+        if hostname =~ /\d+\.\d+\.\d+\.\d+/
+          puts "You used an IP, please use the hostname so can set /etc/hostname on the remote."
+          exit
+        end
+        if hostname.nil? or hostname.empty?
+          puts "You must specify HOSTS='hostname' to use the bootstrap command."
+          exit
+        end
+        top.dwell.server.bootstrap
       end
-      
-      desc "setup static ip address" 
-      task :setup_static_ip do
-        ip,broadcast,mask,gateway=nil
+
+      def get_ip_info
         run "/sbin/ifconfig eth0" do |channel, stream, data|
           if data.match(/inet addr:([^ ]*)  Bcast:([^ ]*)  Mask:([^ ]*)/)
-            ip, broadcast, mask = $1, $2, $3
+            return $1, $2, $3
           end
         end
+      end
+
+      def get_gateway
         run "ip route" do |channel, stream, data|
-          gateway=$1 if data.match(/default via ([^ ]*) dev eth0/)
+          return $1 if data.match(/default via ([^ ]*) dev eth0/)
         end
+      end
+
+      ## TODO : make multi-server safe
+      task :setup_hostname do
+        hostname=ENV["HOSTS"]
+        sudo "echo #{hostname} > /tmp/hostname"
+        sudo "mv /tmp/hostname /etc/hostname"
+        sudo "chown root:root /etc/hostname"
+        host_line="#{get_ip_info.first} #{hostname.split(".").first} #{hostname}"
+        dwell1.append_to_file_if_missing("/etc/hosts",host_line)
+        sudo "hostname --file /etc/hostname"
+      end
+
+      ## TODO : make multi-server safe
+      desc "setup static ip address" 
+      task :setup_static_ip do
+        ip,broadcast,mask=get_ip_info
+        gateway=get_gateway
 
           interface=<<-EOS
 iface eth0 inet static
@@ -44,32 +63,6 @@ gateway #{gateway}
           # kill the dhcp client
           sudo "pkill dhclient3"
       end
-      
-      desc "bootstrap linode box"
-      task :bootstrap do
-        set :deploy_user, user
-        auth_keys="config/dwell/authorized_keys/#{deploy_user}"
-        unless File.exist?(auth_keys)
-          puts "\n    Please place authorized SSH keys for #{deploy_user} in:"
-          puts "      #{auth_keys}\n\n"
-          exit
-        end
-        set :user, "root"
-        if ubuntu1.lsb_info[:distrib_codename]=="intrepid"
-          # for linode's slimmed down intrepid
-          run "addgroup admin"
-          dwell1.append_to_file_if_missing "/etc/sudoers", "%admin ALL=(ALL) ALL"
-          sudo "apt-get install ubuntu-standard -y" 
-        end
-        create_deploy_user
-        copy_ssh_key
-        set :user, deploy_user        
-        # test deploy login via ssh before we disable root login
-        sudo "echo"
-        disable_root_login
-        setup_static_ip
-      end
-
     end
   end
 end

data/lib/dwell/recipes/bootstrap/server.rb

@@ -0,0 +1,59 @@
+Capistrano::Configuration.instance(:must_exist).load do 
+  namespace :dwell do
+    namespace :server do
+
+      set :deploy_user, nil
+
+      task :create_deploy_user do
+        dwell1.adduser deploy_user, :group => "admin"
+        puts
+        new_password = Capistrano::CLI.ui.ask("Enter DESIRED password for #{deploy_user}:") { |q| q.echo = true }
+        dwell1.invoke_with_input("passwd #{deploy_user}", /UNIX password/, new_password)
+      end
+      
+      task :push_ssh_keys do
+        set :deploy_user, user if deploy_user.nil?
+        dwell1.mkdir "/home/#{deploy_user}/.ssh", :mode => 0700, 
+          :owner => "#{deploy_user}.admin", :via => :sudo
+        run "rm -f /home/#{deploy_user}/.ssh/authorized_keys"
+        Dir.glob("config/dwell/authorized_keys/#{deploy_user}/*").each do |file|
+          key=File.read(file)
+          dwell1.append_to_file_if_missing("/home/#{deploy_user}/.ssh/authorized_keys", key)
+        end
+        sudo "chown #{deploy_user}.admin /home/#{deploy_user}/.ssh/authorized_keys"
+        run "chmod 0600 /home/#{deploy_user}/.ssh/authorized_keys"
+      end
+      
+      task :disable_root_login do
+        dwell1.config_gsub "/etc/ssh/sshd_config", /^PermitRootLogin (.*)$/,"PermitRootLogin no" 
+        sudo "/etc/init.d/ssh reload"
+      end
+      
+      desc "bootstrap linode box"
+      task :bootstrap do
+        set :deploy_user, user
+        auth_keys="config/dwell/authorized_keys/#{deploy_user}"
+        unless File.exist?(auth_keys)
+          puts "\n    Please place authorized SSH keys for #{deploy_user} in:"
+          puts "      #{auth_keys}\n\n"
+          exit
+        end
+        set :user, "root"
+        puts "Enter your ROOT password now (so we can setup you #{deploy_user} user)."
+        if ubuntu1.lsb_info[:distrib_codename]=="intrepid"
+          # for linode's slimmed down intrepid
+          run "addgroup admin"
+          dwell1.append_to_file_if_missing "/etc/sudoers", "%admin ALL=(ALL) ALL"
+          sudo "apt-get install ubuntu-standard -y" 
+        end
+        create_deploy_user
+        push_ssh_keys
+        set :user, deploy_user        
+        # test deploy login via ssh before we disable root login
+        sudo "echo"
+        disable_root_login
+      end
+
+    end
+  end
+end

data/lib/dwell/recipes/rails/base.rb

@@ -29,8 +29,8 @@ Capistrano::Configuration.instance(:must_exist).load do
           put File.read("config/dwell/deploy_keys/#{user}.pub"), "/home/#{user}/.ssh/id_rsa.pub", :mode => 0600
           sudo "chown #{user}.admin /home/#{user}/.ssh/id_rsa.pub"
         end
-        known_hosts.each do |host|
-          key=File.open("#{File.dirname(__FILE__)}/../known_hosts/#{host}").read
+        Dir.glob("config/dwell/known_hosts/*").each do |file|
+          key=File.open(file).read
           dwell1.append_to_file_if_missing("/home/#{user}/.ssh/known_hosts", key)
         end
         sudo "chown #{user}.admin /home/#{user}/.ssh/known_hosts"

data/lib/dwell/templates/vhost_ssl.conf

@@ -53,8 +53,7 @@
   # Server Private Key
   SSLCertificateKeyFile /etc/ssl/private/<%= domain %>.key
   
-  <% Dir.glob("config/dwell/ssl/*").each do |file| 
-    next unless file =~ /CA/ %>
+  <% Dir.glob("config/dwell/ssl/ca/*").each do |file| %>
   SSLCACertificateFile /etc/ssl/certs/<%= File.basename(file) %>
   <% end %>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yyyc514-dwell
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Robert Bousquet
@@ -22,6 +22,15 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.4
+    version: 
 description: Automated Rails production environment setup for Ubuntu
 email: robert@robertbousquet.com
 executables: 
@@ -34,12 +43,11 @@ files:
 - bin/dwell
 - lib/dwell
 - lib/dwell/cap_extensions.rb
-- lib/dwell/known_hosts
-- lib/dwell/known_hosts/github
 - lib/dwell/recipes
 - lib/dwell/recipes/apache.rb
 - lib/dwell/recipes/bootstrap
 - lib/dwell/recipes/bootstrap/linode.rb
+- lib/dwell/recipes/bootstrap/server.rb
 - lib/dwell/recipes/campfire.rb
 - lib/dwell/recipes/extras
 - lib/dwell/recipes/extras/daemontools.rb
@@ -66,14 +74,19 @@ files:
 - lib/dwell/recipes/ubuntu.rb
 - lib/dwell/recipes.rb
 - lib/dwell/templates
-- lib/dwell/templates/deploy.rb
 - lib/dwell/templates/passenger.conf
 - lib/dwell/templates/vhost.conf
 - lib/dwell/templates/vhost_ssl.conf
 - lib/dwell/ubuntu_extensions.rb
 - lib/dwell.rb
+- generators/dwell
+- generators/dwell/dwell_generator.rb
+- generators/dwell/templates
+- generators/dwell/templates/deploy.rb
+- generators/dwell/templates/known_hosts
+- generators/dwell/templates/known_hosts/github
 - LICENSE
-- README.txt
+- README.markdown
 has_rdoc: true
 homepage: http://github.com/bousquet/dwell
 post_install_message: 

data/README.txt

@@ -1,37 +0,0 @@
-DWELL  --  Capistrano recipe to setup a production Rails environment on Ubuntu.
-
-
-1) Install Capistrano2 if you don't already have it:
-$ sudo gem install capistrano
-
-2) Build this gem:
-$ gem build dwell.gemspec
-
-3) Install gem with:
-$ sudo gem install dwell-0.1.gem
-
-
-
-USAGE
-
-1) From within your Rails directory, run:
-$ capify .
-
-2) Click this link for recommended contents of config/deploy.rb:
-http://pastie.org/private/lodo1zveqgc2i0rto9idw
-
-3) Configure application name, domain, repository location and server name details
-
-4) $ cap dwell:install
-
-
-
-STACK DETAILS
-
-1) Updates Ubuntu sources and distro
-2) Installs Apache2
-3) Installs MySQL5
-4) Installs Subversion and Git
-5) Installs Ruby, RubyGems, Rails and Merb
-6) Installs Passenger module for Apache2 and creates basic config
-