Traffic Control Super Script

File Release Notes and Changelog

Release Name: tcss-5.1.59-alpha-ubuntu

Notes: tcss v5.1.59-alpha Copyright (c) 2000 - 2008 by Kegan Holtzhausen email: tcss@googlegroups.com Docs and Info: http://groups.google.com/group/tcss Files: http://tcss.sourceforge.net Files: http://freshmeat.net/projects/tcss Release Notes: http://groups.google.com/group/tcss/web/tcss-5-1-release-notes Requirements: A gateway NAT box -=OR=- vmware linux box with bridged eth0 and host-only eth1 apache + php + php-mysql mysqlserver + mysqlclient iproute2, netfilter QUICK INSTALLATION 1. Untar the archive from: http://tcss.sourceforge.net/files/tcss-5.1-installer.tar.bz2 2. run ./deploy.sh from within the extracted directory 3. /etc/init.d/tcss daemonstart (put this in your init) 3. Point your web browser at the IP of your box eg: http://192.168.1.129/sted (assuming you selected that as a install loc) 4. login as user admin, password admin MANUAL INSTALLATION mysqladmin create tcss mysql tcss <tcss.sql in mysql: GRANT all on tcss.* to 'tcss'@'localhost' identified by 'tcss' in mysql: GRANT all on tcss.* to 'tcssd'@'localhost' untar webinterface into a dir into your webroot or a sub dir there of. untar tcss into /opt/tcss edit /opt/tcss/config and correct path variable copy tcss.init to /etc/init.d/tcss edit /etc/init.d/tcss and correct the path (must point to tcss dir) CONFIGURATION Assuming you are logged into the webinterface as user admin password admin Setting up Devices IMPORTANT: Devices must be setup first as groups and hosts depend on them. IMPORTANT: The device to the downloader / client if referred to as CLIENT INTERFACE IMPORTANT: The device from which the traffic will be downloaded is the SOURCE INTERFACE Click on devices. Create a device by clicking the + or edit existing ones via the cog wheel Name is just a name and does not reflect a physical device Device is the physical device name to bind to Physical speed is link speed Physical rate is link speed divided by 10 Net speed is the speed of the Internet / Network you want to shape Rate is Net speed divided by 10 Method is for now always HTB AVPKT is normally 1000 State is always on for interfaces Setting up Groups IMPORTANT: Groups Depend on Devices so make sure they are setup already. Click on groups. Create a group via the + icon or edit an existing on. Remember to bind your group to the interfaces it will be serving on. All hosts / rules in this group will be shaped on those interfaces also. Name is just a name (NO SPACES ALLOWED) Priority is the rules priority from 0 to 9 on the specified DEVICE 0 being highest priority Quantum is always 2000 unless you know what your doing Client Interface is the Client / Downloader facing interface Source Interface is the Internet / Source facing interface Shape Speed is the Speed you want to give the group Shape Rate is Shape Speed divided by 10 Burst Rate is the Maximun burst permitted if the parent DEVICE has available bandwidth for GROUP priority Direction is always Unidirectional for this release Method is always iptables for this release State is always on for GROUPS Setting up Ports IMPORTANT: Ports are required before setting up Hosts. Click on ports and create port ACL's for use within hosts / rules Name of rule (No Spaces) Rule Type is obvious either singleport or multiport Ports if multiport: individual ports are "," separated eg: 80,443,8080 port ranges are ":" divided eg: 1024:20000 Ports if singleport is just one port number eg: 22 or "any" for all ports. if any is specified then protocol is all Protocol is TCS or UDP if a port is selected and all if ports="any" Setting up Hosts (Rules) Hosts are setup almost the same way as groups except Click on hosts and create / edit hosts here. Hosts are bound to the interfaces stipulated in their parent groups config. Name is just a name (NO SPACES ALLOWED) Priority is the rules priority from 0 to 9 in the specified GROUP. 0 being highest priority Quantum is always 2000 unless you know what your doing Parent is the GROUP to bind to. This binds to that groups interfaces also for client and source Source Hosts is the the source of the traffic to shape. eg 0/0 or 1.2.3.4/22 Source Ports is the ports from the source you want to manage Destination Hosts is the client / destination hosts you want to manage traffic to eg: 192.168.1.0/24 or 0/0 Destination Ports is normall always ALL:all since client machines use random ports to create connections Shape Speed is the Speed you want to give the group Shape Rate is Shape Speed divided by 10 Burst Rate is the Maximun burst permitted if the parent GROUP has available bandwidth for HOST priority Direction is always Unidirectional for this release Method is always iptables for this release State is to turn the rule on or off To apply changes you need to restart tcss which can be done via the web interface if tcssd has been started with /etc/init.d/tcss daemonstart