Changeset - 481f8b7e4077
Parent rev.
Child rev.
[Not reviewed]
default
0 2 2
Branko Majic (branko) - 11 years ago 2013-04-14 22:54:59
branko@majic.rs
Added basic information about the project. Renamed a couple of things in the Sphinx configuration file. Started work on installation document. Tweked the index documentation file a bit.
4 files changed with 100 insertions and 14 deletions:
doc/about.rst
41
doc/conf.py
7
7
doc/index.rst
23
7
doc/installation.rst
29
0 comments (0 inline, 0 general)
doc/about.rst
➞
Show inline comments
 
new file 100644
 
About Django Conntrackt
 
=======================
 

			




	
	
	
		
 
Django Conntrackt is a simple application intended to provide system

			




	
	
	
		
 
administrators and integrators that deploy servers at client's premises to

			




	
	
	
		
 
easily keep track of required networ communications between different servers,

			




	
	
	
		
 
routers, client workstations, and even whole networks/sub-networks.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Why was this application created?

			




	
	
	
		
 
---------------------------------

			




	
	
	
		
 

			




	
	
	
		
 
The application was created in order to alleviate painful and error prone

			




	
	
	
		
 
tracking of IP addresses and network communications inside of spread-sheet

			




	
	
	
		
 
files. Another reason was the need to create simple iptables rules based on this

			




	
	
	
		
 
information with as little hassle as possible.

			




	
	
	
		
 

			




	
	
	
		
 
The *iptables* generation requirements for Django Conntrackt were farily simple,

			




	
	
	
		
 
and do not include any complex functionality. It all boils down to rejecting all

			




	
	
	
		
 
communication except for explicitly defined links.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Features

			




	
	
	
		
 
--------

			




	
	
	
		
 

			




	
	
	
		
 
Django Conntrackt sports a number of useful features for system administrators

			




	
	
	
		
 
and integrators:

			




	
	
	
		
 

			




	
	
	
		
 
* Managing entities through multiple projects (separating the entities

			




	
	
	
		
 
  per-project basis).

			




	
	
	
		
 
* Grouping entities inside of a project in one or more locations (which can be

			




	
	
	
		
 
  either logical or physical).

			




	
	
	
		
 
* Specifying entities that represent servers, routers, workstations, networks,

			




	
	
	
		
 
  subnets or any other networked device or abstraction within a network.

			




	
	
	
		
 
* Specifying multiplel network interfaces for each entity.

			




	
	
	
		
 
* Specifying the communication link between two entities, which includes

			




	
	
	
		
 
  information such as protocol and port.

			




	
	
	
		
 
* Generation of *iptables* rules for devices based on GNU/Linux that can be

			




	
	
	
		
 
  consumed by the *iptables-restore* utility.

			




	
	
	
		
 
* Generation of *iptables* rules on per-location/project basis (multiple

			




	
	
	
		
 
  *iptables* rule files inside of a *ZIP* file.

			




        

    


    
    

    

        

                

                    doc/conf.py
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
# -*- coding: utf-8 -*-

			




	
	
	
		
 
#

			




	
	
	
		
 
# Conntrackt documentation build configuration file, created by

			




	
	
	
		
 
# Django Conntrackt documentation build configuration file, created by

			




	
	
	
		
 
# sphinx-quickstart on Sun Apr 14 21:47:09 2013.

			




	
	
	
		
 
#

			




	
	
	
		
 
# This file is execfile()d with the current directory set to its containing dir.

			




	
	
		
 
@@ -40,7 +40,7 @@ source_suffix = '.rst'

			




	
	
	
		
 
master_doc = 'index'

			




	
	
	
		
 

			




	
	
	
		
 
# General information about the project.

			




	
	
	
		
 
project = u'Conntrackt'

			




	
	
	
		
 
project = u'Django Conntrackt'

			




	
	
	
		
 
copyright = u'2013, Branko Majic'

			




	
	
	
		
 

			




	
	
	
		
 
# The version info for the project you're documenting, acts as replacement for

			




	
	
		
 
@@ -164,7 +164,7 @@ html_static_path = ['_static']

			




	
	
	
		
 
#html_file_suffix = None

			




	
	
	
		
 

			




	
	
	
		
 
# Output file base name for HTML help builder.

			




	
	
	
		
 
htmlhelp_basename = 'Conntracktdoc'

			




	
	
	
		
 
htmlhelp_basename = 'DjangoConntracktdoc'

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
# -- Options for LaTeX output --------------------------------------------------

			




	
	
		
 
@@ -183,7 +183,7 @@ latex_elements = {

			




	
	
	
		
 
# Grouping the document tree into LaTeX files. List of tuples

			




	
	
	
		
 
# (source start file, target name, title, author, documentclass [howto/manual]).

			




	
	
	
		
 
latex_documents = [

			




	
	
	
		
 
  ('index', 'Conntrackt.tex', u'Conntrackt Documentation',

			




	
	
	
		
 
  ('index', 'DjangoConntrackt.tex', u'Django Conntrackt Documentation',

			




	
	
	
		
 
   u'Branko Majic', 'manual'),

			




	
	
	
		
 
]

			




	
	
	
		
 

			




	
	
		
 
@@ -213,7 +213,7 @@ latex_documents = [

			




	
	
	
		
 
# One entry per manual page. List of tuples

			




	
	
	
		
 
# (source start file, name, description, authors, manual section).

			




	
	
	
		
 
man_pages = [

			




	
	
	
		
 
    ('index', 'conntrackt', u'Conntrackt Documentation',

			




	
	
	
		
 
    ('index', 'djangoconntrackt', u'Django Conntrackt Documentation',

			




	
	
	
		
 
     [u'Branko Majic'], 1)

			




	
	
	
		
 
]

			




	
	
	
		
 

			




	
	
		
 
@@ -227,8 +227,8 @@ man_pages = [

			




	
	
	
		
 
# (source start file, target name, title, author,

			




	
	
	
		
 
#  dir menu entry, description, category)

			




	
	
	
		
 
texinfo_documents = [

			




	
	
	
		
 
  ('index', 'Conntrackt', u'Conntrackt Documentation',

			




	
	
	
		
 
   u'Branko Majic', 'Conntrackt', 'One line description of project.',

			




	
	
	
		
 
  ('index', 'DjangoConntrackt', u'Django Conntrackt Documentation',

			




	
	
	
		
 
   u'Branko Majic', 'DjangoConntrackt', 'One line description of project.',

			




	
	
	
		
 
   'Miscellaneous'),

			




	
	
	
		
 
]

			




	
	
	
		
 

			




        

    


    
    

    

        

                

                    doc/index.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
.. Conntrackt documentation master file, created by

			




	
	
	
		
 
   sphinx-quickstart on Sun Apr 14 21:47:09 2013.

			




	
	
	
		
 
   You can adapt this file completely to your liking, but it should at least

			




	
	
	
		
 
   contain the root `toctree` directive.

			




	
	
	
		
 
Django Conntrackt documentation

			




	
	
	
		
 
===============================

			




	
	
	
		
 

			




	
	
	
		
 
Django Conntrackt is a simple application intended to provide system

			




	
	
	
		
 
administrators and integrators that deploy servers at client's premises to

			




	
	
	
		
 
easily keep track of required networ communications between different servers,

			




	
	
	
		
 
routers, client workstations, and even whole networks/sub-networks.

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Welcome to Conntrackt's documentation!

			




	
	
	
		
 
======================================

			




	
	
	
		
 
Support

			




	
	
	
		
 
-------

			




	
	
	
		
 

			




	
	
	
		
 
Contents:

			




	
	
	
		
 
In case of problems with the application, please do not hesitate to contact the

			




	
	
	
		
 
author at **django.conntrackt (at) majic.rs**. Known issues and planned features

			




	
	
	
		
 
are tracked on website:

			




	
	
	
		
 

			




	
	
	
		
 
* https://projects.majic.rs/conntrackt/

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Contents

			




	
	
	
		
 
--------

			




	
	
	
		
 

			




	
	
	
		
 
.. toctree::

			




	
	
	
		
 
   :maxdepth: 2

			




	
	
	
		
 

			




	
	
	
		
 
   about

			




	
	
	
		
 
   installation

			




	
	
	
		
 
   usage

			




	
	
	
		
 
   releasenotes

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Indices and tables

			




        

    


    
    

    

        

                

                    doc/installation.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
new file 100644

			




	
	
	
		
 
Installation

			




	
	
	
		
 
============

			




	
	
	
		
 

			




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

			




	
	
	
		
 

			




	
	
	
		
 
* Using *pip/easy_install*, 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

			




	
	
	
		
 
---------

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Using Mercurial

			




	
	
	
		
 
----------------

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Using downloaded package

			




	
	
	
		
 
------------------------

			




	
	
	
		
 

			




	
	
	
		
 

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2023 by various authors & licensed under GPLv3.