django-recipes 1.0.0 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/django-recipes/helpers.rb

@@ -1,17 +1,5 @@
 require 'erb'
 
-def app_path
-  "#{deploy_to}/#{application}"
-end
-
-def system_path
-  "#{deploy_to}/system"
-end
-
-def media_root_path
-  "#{deploy_to}/#{media_root}"
-end
-
 def render(template, binding)
   template = File.read("#{File.dirname(__FILE__)}/templates/#{template}.erb")
   result = ERB.new(template).result(binding)

data/lib/django-recipes/recipes/deploy.rb

@@ -1,92 +1,85 @@
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :deploy do      
-    desc "Prepares system for deployment"  
-    task :setup, :roles => :app do
-      run "mkdir -p #{deploy_to}/system"
-      run "cd #{deploy_to}; git clone #{repository}"
-      create_upload_directories
-      make_system_writable
-      symlink
-      vhost
-    end  
-  
+    desc <<-DESC
+      [internal] Touches up the released code. This is called by update_code \
+      after the basic deploy finishes. It assumes a Rails project was deployed, \
+      so if you are deploying something else, you may want to override this \
+      task with your own environment's requirements.
+
+      This task will make the release group-writable (if the :group_writable \
+      variable is set to true, which is the default). It will then set up \
+      symlinks to the shared directory for the log, system, and tmp/pids \
+      directories, and will lastly touch all assets in {media_root}/images, \
+      {media_root}/stylesheets, and {media_root}/javascripts so that the times are \
+      consistent (so that asset timestamping works). This touch process \
+      is only carried out if the :normalize_asset_timestamps variable is \
+      set to true, which is the default.
+    DESC
+    task :finalize_update, :except => { :no_release => true } do
+      run "chmod -R g+w #{latest_release}" if fetch(:group_writable, true)
+
+      run <<-CMD
+        ln -s #{shared_path}/system #{latest_release}/#{media_root} &&
+        ln -s #{django_path}/django/contrib/admin/media #{latest_release}/#{media_root}/#{admin_media_root}
+      CMD
+
+      if fetch(:normalize_asset_timestamps, true)
+        stamp = Time.now.utc.strftime("%Y%m%d%H%M.%S")
+        asset_paths = %w(images stylesheets javascripts).map { |p| "#{latest_release}/#{media_root}/#{p}" }.join(" ")
+        run "find #{asset_paths} -exec touch -t #{stamp} {} ';'; true", :env => { "TZ" => "UTC" }
+      end
+    end
+
+    desc <<-DESC
+      [internal] Creates upload directories in /shared/system that your app may need.
+    DESC
     task :create_upload_directories, :roles => :app do
       upload_directories.each do |dir|
-        run "mkdir -p #{system_path}/#{dir}"
+        run "mkdir -p #{shared_path}/system/#{dir}"
       end
-      make_system_writable
-    end
-  
-    desc "Deploys to an unitialized server"
-    task :cold, :roles => :app do
-      setup
-      syncdb
-      django #runs the deploy:django task
-    end
-  
-    desc "Deploy your django app"
-    task :django, :roles => :app do
-      disable
-      run "cd #{deploy_to}/#{application}; git pull"
-      reload
-      enable
-    end
-    
-    task :make_system_writable, :roles => :app do
-      run "chgrp -R #{apache_user} #{system_path}"
-      run "chmod -R g+wx #{system_path}"
-    end
-  
-    task :symlink, :roles => :app do
-       media_root_symlink
-       admin_symlink
-       system_symlink
-    end
-  
-    task :media_root_symlink, :roles => :app do
-      run "ln -sf #{app_path}/#{media_root} #{media_root_path}"   
+      writable_directories
     end
-  
-    task :system_symlink, :roles => :app do
-      run "ln -sf #{system_path} #{media_root_path}/system"    
+    after('deploy:setup','deploy:create_upload_directories')
+
+    desc "[internal] Chgrp -R of /shared/system writable by the apache group"
+    task :writable_directories, :roles => :app do
+      sudo "chown -R #{user}:#{apache_group}  #{shared_path}/system"
     end
-  
-    task :admin_symlink, :roles => :app do
-      sudo "ln -sf #{django_path}/django/contrib/admin/media #{media_root_path}/#{admin_media_root}"
+
+    desc "Starts the application server"
+    task :start, :roles => :app do
+      sudo "#{start_cmd}"
     end
-  
-    desc "Creates a vhost for your application and uploads to server"
-    task :vhost, :roles => :app do    
-      put render('django_vhost.vhost',binding), "/tmp/#{vhost_name}"
-      sudo "mv /tmp/#{vhost_name} #{vhost_path}/#{vhost_name}"
+
+    desc "Stops the application server"
+    task :stop, :roles => :app do
+      sudo "#{stop_cmd}"
     end
-  
-    desc "Run django syncdb"
-    task :syncdb, :roles => :app do
-      run "cd #{app_path} ; ./manage.py syncdb --setting=#{settings}"
+
+    desc "Restarts the application server"
+    task :restart, :roles => :app do
+      sudo "#{restart_cmd}"
     end
-  
-    desc "Destroys this app on the server"
-    task :destroy, :roles => :app do
-      run "rm -rf #{deploy_to}/*"
-      sudo "rm #{vhost_path}/#{vhost_name}"
-      reload
-    end  
 
-    desc "Reloads apache"
-    task :reload, :roles => :app do 
+    desc "Reloads the application server"
+    task :reload, :roles => :app do
       sudo "#{reload_cmd}"
     end
-    
-    desc "Enables the website"
-    task :enable, :roles => :app do
-      run "rm #{system_path}/maintenance.html"
+
+    desc "Deletes everything in #{deploy_to}"
+    task :clobber, :roles => :app do
+      sudo "rm -rf #{deploy_to}/*"
     end
+
+    # tasks that don't do anythign with django
+    no_ops = ['migrate', 'migration']
+    no_ops.each do |name|
+      task name do ; end
+    end    
   
-    desc "Disable the website"
-    task :disable, :roles => :app do
-      put render('maintenance.html',binding), "/tmp/maintenance.html"
-      run "mv /tmp/maintenance.html #{system_path}/maintenance.html"
+    desc "Runs syncdb"
+    task :syncdb, :roles => :app do
+      run "cd #{app_path} ; ./manage.py syncdb --setting=#{settings}"
     end
   end
 end

data/lib/django-recipes/recipes/django.rb

@@ -2,7 +2,7 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :django do
     desc "Runs a command from manage.py"
     task :manage, :roles => :app do
-      run "cd #{app_path}; ./manage.py #{ENV['command']} --settings=#{settings}"
+      run "#{deploy_to}/#{application}/manage.py #{ENV['command']} --settings=#{settings} --pythonpath=#{deploy_to}"
     end
   end
 end

data/lib/django-recipes/recipes/vhost.rb

@@ -0,0 +1,17 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :vhost do
+    desc "Displays the vhost for your application"
+    task :show do
+      puts render('django_vhost.vhost',binding)
+    end
+
+      
+    desc "Creates a vhost for your application and uploads to server"
+    task :upload, :roles => :app do    
+      put render('django_vhost.vhost',binding), "/tmp/#{vhost_name}"
+      sudo "mv /tmp/#{vhost_name} #{vhost_path}/#{vhost_name}"
+    end
+    after('deploy:setup', 'vhost:upload')  
+  
+  end
+end

data/lib/django-recipes/templates/django_vhost.vhost.erb

@@ -5,7 +5,7 @@
 	SetEnv DJANGO_SETTINGS_MODULE <%= application %>.<%= settings %>
 	PythonPath "['<%= deploy_to %>/<%= application %>', '<%= deploy_to %>'] + sys.path"
 	PythonDebug Off
-	Alias /<%= media_root %> <%= media_root_path%>
+	Alias /<%= media_root %> <%= current_path %>/<%= media_root %>
 
 	<Directory "<%= deploy_to %>">
 		Options FollowSymLinks
@@ -18,7 +18,7 @@
 	</Location>
 	
 	RewriteEngine On
-	RewriteCond <%= system_path %>/maintenance.html -f
+	RewriteCond <%= shared_path %>/system/maintenance.html -f
 	RewriteCond %{REQUEST_URI} !/<%= media_root %>/system/maintenance.html
 	RewriteRule $ /<%= media_root %>/system/maintenance.html [R=302,L]
 	

data/readme.markdown

@@ -1,118 +1,52 @@
 # Django Recipes
 Django Recipes is a set of capistrano recipes created to automate deployment of simple Django powered websites. Once you've configured your capfile and server, you can go from no app, to running app.
 
-# Features
-	* One command deployment for setup servers: from no app to running app
-	* Maintenace Page
-	* Generated Vhost File
-	* Git based
-
-# Tasks
-	deploy:cold           # Deploys to an unitialized server (runs deploy:setup then deploy:django)
-	deploy:destroy        # Destroys this app on the server
-	deploy:django         # Deploy your django app
-	deploy:reload         # Reloads apache
-	deploy:syncdb         # Run django syncdb
-	deploy:vhost          # Creates a vhost for your application and uploads it
-	deploy:web:disable    # Disable the website
-	deploy:web:enable     # Enables the website	
-	django:manage					# runs a command from manage.py ie cap django:manage command=syncdb
-	
-# How it Works
-Capistrano uses ssh to connect to your server and create a directory structure. It uses this directory structure:
-
-	/+
-	 |- application
-	 |- system
-	 /+ media_root					# symlinked from media_root from application
-	 	|- system             # symlinked to the root level system
-		|- admin_media_root		# symlinked to django/contrib/admin/media
-	
-There is some Rails style going on here. Application is where your django code lives. System is a directory that survives through different deployments. You should use system for user file uploads and things like that. Your stylesheets, images, and javascript live in media_root. These folders are symlinked to create access for your webserver. 
+# Get It Done
+
+	gem install django-recipes
+	require 'django-recipes' # in your Capfile
+	cap deploy:setup cap deploy
+	http://www.yoursite.com/
 
 # Requirements
 Before you deploy your app, your server needs to be running apache and mod_python. If you are using Fedora you can use my [gem](http://github.com/Adman65/fedora) to make this process go very quickly. Django recipes assumes that you have a top level folder for your media root. Recapped:
 	
 	* Python, Apache, mod_python, and your DBMS installed
-	* User with sudo access (for linking to admin media)
-	* top level media directory
-	* ruby & rubygems installed
+	* User with sudo access
+	* Ruby & Rubygems installed
 
 # Setting on Your Capfile
 Lets take an example application and the associated config file.
 
-## Application Structure
-	/mysite
-		/settings
-			production.py
-			development.py
-		/pictures
-		/avatars
-		/public							# media_root
-			/images
-			/stylesheets
-			/system
-				/pictures				# for uploaded pictures
-				/avatars				# for uploaded avatars
-		/templates
-		
 ## Settings: production.py
 
 	# only relavent settings for deployment are included
-	MEDIA_ROOT = os.path.join(os.path.dirname(os.path.abspath(__file__)), "../public") # refers to /public because /settings/production.py
+	MEDIA_ROOT = '/public'
 	ADMIN_MEDIA_PREFIX = '/public/admin/'
-	MEDIA_URL = 'http://mydomain.com/public/'
 	
-## Capfile Configuration
-	
-	### SCM Setup ###
-	repository          # Git only
-	application         # Name of your project
- 
+## Capfile Configuration	
+	 
 	### Deployment Settings ###
+	current_dir         # !!! Don't forget this !!! set to your applications name
 	deploy_to           # this directory should already exist and the user should have control over it
-	apache_user         # name of apache user on your server
+	apache_group        # name of apache user on your server
 	server_name         # for the ServerName entry in the vhost
 	vhost_name          # name of vhost to create
 	vhost_path          # location to put vhost file on your server (no trailing slash)
 	reload_cmd          # command to reload apache (ex: service httpd reload)
+	start_cmd						#
+	reload_cmd					#
+	stop_cmd            #
  
 	### Django Settings ###
 	django_path         # path to where django is installed. User for linking admin media
 	settings            # settings to use (must be specified)
 	upload_directories  # Array of directories to create in /system (must be an array)
+	                    # set to [] if you don't have any
 	
 	media_root          # corresponds to your MEDIA_ROOT
 	admin_media_root    # corresponds to your ADMIN_MEDIA_PREFIX
 	
-## The VHost Template
-
-	<VirtualHost *:80>
-		ServerName <%= server_name %>
-		SetHandler python-program
-		PythonHandler django.core.handlers.modpython
-		SetEnv DJANGO_SETTINGS_MODULE <%= application %>.<%= settings %>
-		PythonPath "['<%= deploy_to %>/<%= application %>', '<%= deploy_to %>'] + sys.path"
-		PythonDebug Off
-		Alias /<%= media_root %> <%= media_root_path%>
-
-		<Directory "<%= deploy_to %>">
-			Options FollowSymLinks
-			Order deny,allow
-			Allow from all
-		</Directory>
-
-		<Location "/<%= media_root %>">
-			SetHandler None
-		</Location>
-
-		RewriteEngine On
-		RewriteCond <%= system_path %>/maintenance.html -f
-		RewriteCond %{REQUEST_URI} !/<%= media_root %>/system/maintenance.html
-		RewriteRule $ /<%= media_root %>/system/maintenance.html [R=302,L]
-
-	</VirtualHost>
-	
 # Time to Deploy
 ## Step 1:
 
@@ -130,37 +64,37 @@ Lets take an example application and the associated config file.
 ## Step 3: Prepare your cap file
 
 	require 'django-recipes'	# require django-recipes
+	### Set up your regular SCM settings
 
-	### SSH Options ###
-	set :user, "deployer"		
-	default_run_options[:pty] = true
-
-	### SCM Setup ###
-	set :repository,  "git@github.com:Adman65/broadcastingadam.git"	# git only
-	set :application, "broadcastingadam"
-
-	### Servers Setup ###
-	role :web, "www.broadcastingadam.com"                          
-	role :app, "www.broadcastingadam.com"                          
-	role :db,  "www.broadcastingadam.com", :primary => true
-	role :db,  "www.broadcastingadam.com"
+	### Apache settings
+	set :reload_cmd, "service httpd reload"
+	set :start_cmd, "service httpd start"
+	set :stop_cmd, "service httpd stop"
+	set :restart_cmd, "service httpd reload"
+	set :apache_group, "apache"
 
 	### Deployment Settings ###
-	set :deploy_to, "/var/www/html/www.broadcastingadam.com" #this directory should already exist and the user should have control over it
-	set :apache_user, "apache"
-	set :server_name, "broadcastingadam.com" #for the ServerName entry in the vhost
+	set :deploy_to, "/var/www/html/www.broadcastingadam.com" 
+	set :server_name, "broadcastingadam.com"
 	set :vhost_name, "#{server_name}.vhost"
-	set :vhost_path, "/etc/httpd/vhost.d" #no trailingslash
-	set :reload_cmd, "service httpd reload"
+	set :vhost_path, "/etc/httpd/vhost.d"
 
 	### Django Settings ###
 	set :django_path, "/usr/lib/python2.6/site-packages/Django-1.1.1-py2.6.egg"
-	set :settings, "settings.production"		# this example uses split settings, but you can just use settings like normal
-	set :upload_directories, ['covers','projects'] # must be an array
+	set :settings, "settings.production"
+	set :upload_directories, ['covers','projects'] 
 
 	set :media_root, "public"
 	set :admin_media_root, "admin"
 	
 ## Step 4: Deploy
 
-	cap deploy:cold
+	cap deploy:setup cap:deploy
+	# at this point you may need to ssh into your machine to run syncdb because of problems with user input
+	# IE creating a super user, if aren't using admin
+	cap django:manage command=syncdb
+
+# Notes
+
+You should use the system directory for files have to maintain between deployments, IE user uploads.
+When running the deploy:web* tasks, capistrano will show you a warning about adding rewrite conditions to your vhost file. You don't have to worry about it. They are already there.	

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: django-recipes
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Adam Hawkins
@@ -29,8 +29,8 @@ files:
 - lib/django-recipes/helpers.rb
 - lib/django-recipes/recipes/deploy.rb
 - lib/django-recipes/recipes/django.rb
+- lib/django-recipes/recipes/vhost.rb
 - lib/django-recipes/templates/django_vhost.vhost.erb
-- lib/django-recipes/templates/maintenance.html.erb
 - readme.markdown
 has_rdoc: true
 homepage: http://github.com/Adman65/django-recipes

data/lib/django-recipes/templates/maintenance.html.erb

@@ -1,13 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-	"http://www.w3.org/TR/html4/loose.dtd">
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<meta http-equiv="Content-Language" content="en-us">
-		<title>AFK, Out for a Drink</title>
-	</head>
-	<body>
-		<h1>Sorry, the site is down for maintenance.</h1>
-	</body>
-</html>
-