Files
@ ff99fef4e9a7
Branch filter:
Location: conntrackt/docs/installation.rst - annotation
ff99fef4e9a7
2.3 KiB
text/prs.fallenstein.rst
CONNT-25: Fixed discrepancies and erros in installation/quick-start documentation.
d7c64b3800af 265b2706e075 265b2706e075 265b2706e075 265b2706e075 265b2706e075 265b2706e075 265b2706e075 265b2706e075 7d5e06b63135 452795dbfa0f 452795dbfa0f 452795dbfa0f d7c64b3800af d7c64b3800af d7c64b3800af d7c64b3800af d7c64b3800af d7c64b3800af d7c64b3800af 452795dbfa0f 8f19fdd3d53f 452795dbfa0f 452795dbfa0f 452795dbfa0f 452795dbfa0f 452795dbfa0f 452795dbfa0f 8f19fdd3d53f 8f19fdd3d53f 14e47a3b0ea2 8f19fdd3d53f 452795dbfa0f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 14e47a3b0ea2 14e47a3b0ea2 8f19fdd3d53f 452795dbfa0f 452795dbfa0f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f d7c64b3800af d7c64b3800af d7c64b3800af 452795dbfa0f ff99fef4e9a7 ff99fef4e9a7 ff99fef4e9a7 ff99fef4e9a7 ff99fef4e9a7 ff99fef4e9a7 ff99fef4e9a7 452795dbfa0f 8f19fdd3d53f 8f19fdd3d53f ff99fef4e9a7 8f19fdd3d53f ff99fef4e9a7 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f 8f19fdd3d53f d7c64b3800af d7c64b3800af d7c64b3800af | .. Copyright (C) 2013-2017 Branko Majic
This file is part of Django Conntrackt documentation.
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
Unported License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
Installation
============
*Django Conntrackt* has the following prerequisites that need to be
satisfied on the operating system level:
- `Graphviz <https://graphviz.org/>`_, used for generating the
diagrams.
*Django Conntrackt* can be installed through one of the following methods:
* Using *pip*, which is the recommended way for production
websites.
Using pip
---------
In order to install latest stable release of Django Conntrackt using *pip*, use
the following command::
pip install conntrackt
In order to install the latest development version of Django Conntrackt from
Mercurial repository, use the following command::
pip install -e hg+http://code.majic.rs/conntrackt#egg=conntrackt
After this you should proceed to :ref:`configure your Django installation <configuring-django>`.
.. _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 applications
``braces``, ``crispy_forms``, and ``conntrackt``.
#. Edit your project's URL configuration file (``urls.py``).
Update the import command for urls module to look like::
from django.conf.urls import url, include
Add the following line to the ``urlpatterns`` setting::
url(r'^conntrackt/', include('conntrackt.urls')),
#. Create the necessary tables used for *Django Conntrackt*::
./manage.py migrate
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 admin interface as well - in addition
to native data entry provided by application.
|