Brent Tubbs avatar Brent Tubbs committed 606bba7

more README tweaking

Comments (0)

Files changed (1)

 Overview
 --------
 
-Silk is a Fabric_ based tool for setting up Python WSGI apps to run on an Ubuntu/Nginx/Supervisord/Gunicorn stack.
+Silk is a Fabric_ based tool for setting up Python WSGI apps on what I like to
+call the SNUG stack:
+
+* Supervisord_ for starting processes and keeping them alive.
+* Nginx_ for proxying between your WSGI app and the big bad web.
+* Ubuntu_ as the OS of choice, enabling resolution of system dependencies with
+  apt.  Debian might work as well but hasn't been tested.
+* Gunicorn_ for serving your WSGI app.
+
+(I suppose it could also be the GUNS stack but that sounds far less friendly.)
 
 Key Features
-------------
+~~~~~~~~~~~~
 
 * Deploy your site to one or more servers with a single command ('silk push').
 * Automatic configuration of Nginx, Supervisord, and Gunicorn to get your site running.
   different DB in staging than production, for example).
 
 Installation
-------------
+~~~~~~~~~~~~
 
 Use pip::
 
 Required
 ~~~~~~~~
 
-1. site.yaml - This is the main config file (comparable to app.yaml in Google App Engine)
-2. deps.yaml - Lists Python packages, Ubuntu apt packages, and apt build dependencies that need to be installed on the server running your site.
-3. fabfile.py - A Fabric_-compatible fabfile that imports Silk's Fabric functions.
-4. roles/\*.yaml - One or more 'role' files that contain the config to be passed into your app depending on the deployment context.
+1. site.yaml - This is the main config file (comparable to app.yaml in Google
+   App Engine)
+2. deps.yaml - Lists Python packages, Ubuntu apt packages, and apt build 
+   dependencies that need to be installed on the server running your site.
+3. fabfile.py - A Fabric_-compatible fabfile that imports Silk's Fabric 
+   functions.
+4. roles/\*.yaml - One or more 'role' files that contain the config to be 
+   passed into your app depending on the deployment context.
 
 All of the required files will be created for you with the 'silk skel' command.
 
 Optional
 ~~~~~~~~
 
-1. membrane.py - For Django projects it's nice to have a little shim to expose the project as a WSGI app.  I like to call mine membrane.py.  You can use whatever you like, or nothing at all, depending on your setup.
-2. my-django-project - Silk isn't restricted to Django; any valid WSGI app on your Python path should be servable.  But for Django projects I think it makes sense to stick them right there.
+1. membrane.py - For Django projects it's nice to have a little shim to expose
+   the project as a WSGI app.  I like to call mine membrane.py.  You can use 
+   whatever you like, or nothing at all, depending on your setup.
+2. my-django-project - Silk isn't restricted to Django; any valid WSGI app on 
+   your Python path should be servable.  But for Django projects I think it 
+   makes sense to stick them right there.
 
+.. _Supervisord: http://supervisord.org/
+.. _Nginx: http://nginx.org/
+.. _Ubuntu: http://www.ubuntu.com/
+.. _Gunicorn: http://gunicorn.org/
 .. _Fabric: http://docs.fabfile.org/
 .. _Virtualenv: http://virtualenv.openplans.org/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.