Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated readme with requirements and usage

  • Loading branch information...
commit c3c902fd548691f15d9eab3cf99a659e22636dbf 1 parent 3817b00
Nick Badoux authored
Showing with 21 additions and 4 deletions.
  1. +21 −4 README.rst
View
25 README.rst
@@ -4,6 +4,7 @@ Fabric Deployment
Project application for deployment, provisioning and local tasks.
+
Remote requirements:
====================
* Apache
@@ -17,19 +18,36 @@ Remote requirements:
* Pip (0.8.1+)
* Python (2.6)
* python-devel
+* sudo
* virtualenv (1.6+)
+
Local requirements:
===================
* Fabric (1.2.2+)
* Git (1.6+)
+
Usage:
======
-TODO ...
-
+Prepare by having passwords at hand for these users:
+* OS: provisioning user (SSH, sudo)
+* OS: project user (deployment tasks)
+* DB: mysql root user (database provisioning)
+* DB: mysql project user (deployment tasks)
+* DJ: django admin user (site admin access)
+
+Provision & deploy the project:
+* Add deployment app to Django project
+* Update fabfile.py (in project root) with correct settings
+* Run setup ('fab staging setup')
+* Manage access ('fab staging keys')
+* First deploy ('fab staging deploy')
+
+
+Examples:
+=========
::
-
# list all available tasks
$ fab list
@@ -41,4 +59,3 @@ TODO ...
# example: deploy latest version of local current branch to staging server
$ fab staging deploy
-
Please sign in to comment.
Something went wrong with that request. Please try again.