diff --git a/README.rst b/README.rst new file mode 100644 --- /dev/null +++ b/README.rst @@ -0,0 +1,33 @@ +Conntrackt +========== + +Conntrackt (Connection Tracker) is a simple Django application for tracking +connection requirements between different entities in a network. + +The application was written with intention to be used by system adminstrators +and integrators that deploy servers on customer premises, and need to keep tight +track of possible communication links between different entities in the +project. + +In addition to keeping track of connections, the application has the ability to +generate simple *iptables* rules based on the connections specified. The +generated rules can be easily applied using the *iptables-restore* utility. + + +Features +======== + +In short, Conntrackt provides support for the following: + +* Multiple independent projects +* Grouping entities inside of project by location +* Entities can be individual devices or networks +* Entities can have multiple network interfaces +* *iptables* rule generation (per-entity/location/project) + +For more information, please have a look at full documentation at one of the +following websites: + +* https://rtd.majic.rs/ +* http://conntrackt.readthedocs.org/ +