Commits

Brent Tubbs committed acea620

more rst tweaking

Comments (0)

Files changed (1)

 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.
- * Isolation of each site into a separate Virtualenv_
- * Support for differing app config depending on which role you deploy to (a 
-   different DB in staging than production, for example).
+* 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.
+* Isolation of each site into a separate Virtualenv_
+* Support for differing app config depending on which role you deploy to (a 
+  different DB in staging than production, for example).
 
 Installation
 ------------
 ~~~~
 
 ::
+
     silk push -R rolename
 
 This command is the main reason for Silk's existence. It does the work required
 specified in site.yaml and the selected role .yaml file.  'push' does the
 following:
 
-    1. SSHes to the remote server(s) specified in the role config.
-    2. Creates a zipped up rollback archive of the old site if there's one
-       there already.
-    3. Creates a virtualenv for the site.
-    4. Installs apt and python dependencies.
-    5. Copies the site from your local machine to a temporary directory on the
-       remote server.
-    6. Writes config file includes for nginx and supervisord.
-    7. Moves your code from the temp dir into its production location
-       (/srv/<sitename> by default).
-    8. Tells nginx and supervisord to reload their configs.
+1. SSHes to the remote server(s) specified in the role config.
+2. Creates a zipped up rollback archive of the old site if there's one
+   there already.
+3. Creates a virtualenv for the site.
+4. Installs apt and python dependencies.
+5. Copies the site from your local machine to a temporary directory on the
+   remote server.
+6. Writes config file includes for nginx and supervisord.
+7. Moves your code from the temp dir into its production location
+   (/srv/<sitename> by default).
+8. Tells nginx and supervisord to reload their configs.
 
 
 rollback
 ~~~~~~~~
 
 ::
+
     silk rollback -R rolename
 
 This command is for when you have those 'OMG I BROKE THE SITE' moments. It will
 ~~~
 
 ::
+
     silk run -R rolename
 
 This command runs the site from the local machine, on port 8000.  (Nothing is
 ~~~~~~~~~~~~
 
 ::
+
     silk server_setup -R rolename
 
 When you get a shiny new server with that fresh Ubuntu smell, it needs just a
 ~~~~
 
 ::
+
     silk deps
 
 This command wraps 'pip install' to install all of the python packages listed
 ~~~~
 
 ::
+
     silk skel sitename
 
 Creates a directory with a basic Silk file and directory structure.
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.