Changeset - 8f19fdd3d53f
[Not reviewed]
default
0 2 1
Branko Majic (branko) - 11 years ago 2013-05-23 23:29:56
branko@majic.rs
Finished-up the installation instructions. Started work on a quick-start guide.
3 files changed with 55 insertions and 13 deletions:
0 comments (0 inline, 0 general)
docs/index.rst
Show inline comments
 
@@ -25,6 +25,7 @@ Contents
 

	
 
   about
 
   installation
 
   quickstart
 
   usage
 
   releasenotes
 

	
docs/installation.rst
Show inline comments
 
@@ -3,27 +3,47 @@ Installation
 

	
 
Django Conntrackt can be installed through one of the following methods:
 

	
 
* Using *pip/easy_install*, which is the recommended way for production
 
* Using *pip*, which is the recommended way for production
 
  websites.
 
* Using *Mercurial* to check-out the latest code. This is useful if you want to
 
  fix bugs, implement new features, or simply live on the bleeding edge.
 
* By downloading the application package and unpacking it manually. You may want
 
  to use this method for running production websites without *pip/easy_install*.
 

	
 

	
 
Using easy_install
 
------------------
 

	
 

	
 
Using pip
 
---------
 

	
 
In order to install latest stable release of Django Conntrackt using *pip*, use
 
the following command::
 
  pip install conntrackt
 

	
 
Using Mercurial
 
----------------
 
In order to install the latest development version of Django Conntrackt from
 
Mercurial repository, use the following command::
 

	
 
 pip install -e hg+https://hg.majic.rs/conntrackt/
 

	
 
After this you should proceed to :ref:`configure your Django installation <configuring-django>`.
 

	
 

	
 
Using downloaded package
 
------------------------
 
.. _configuring-django:
 

	
 
Configuring your Django installation
 
====================================
 

	
 
Once the Django Conntrackt has been installed, you need to perform the following
 
steps in order to make it available inside of your Django project:
 

	
 
#. Edit your project's settings configuration file (``settings.py``), and update
 
   the ``INSTALLED_APPS`` to include the ``contrackt`` application.
 

	
 
#. Edit your project's URL configuration file (``urls.py``), and add the
 
   following line to the ``urlpatterns`` setting::
 

	
 
     url(r'^conntrackt/', include('conntrackt.urls')),
 

	
 
#. Create the necessary tables used for Django Conntrackt by running::
 

	
 
   ./manage.py syncdb
 

	
 
After this the Django Conntrackt application will be available under the
 
``/conntrackt/`` path (relative to your Django project's base URL).
 

	
 
If you have enabled ``django.contrib.admin``, you should be able to add new
 
Conntrackt data through the admin interface.
docs/quickstart.rst
Show inline comments
 
new file 100644
 
Quick-start Guide
 
=================
 

	
 
This chapter provides quick-start instructions in order to allow you to quickly deploy and test Django Conntrackt application.
 

	
 

	
 
Debian/Ubuntu
 
-------------
 

	
 
Install the *pip* utility::
 
  sudo apt-get install pip
 

	
 
Install the *virtualenv* and *virtualenvwrapper*::
 
  sudo apt-get install python-virtualenv virtualenvwrapper
 

	
 
Create the virtual environment for testing Django Conntrackt::
 
  mkvirtualenv conntrackt
 

	
 
Install the Django Conntrackt requirements::
 
  workon conntrackt
 
  pip install
0 comments (0 inline, 0 general)