[svn/Prometheus-QoS/.git] / INSTALL

Prometheus QoS installation - canonical

1. run "./check-kernel-qos" script to check kernel modules HTB and SFQ (optional)
2. as a root, run "make install" (you shouldn't get errors, just some warnings)
3. edit /etc/prometheus/prometheus.conf (conf/prometheus.conf or examples/...)
4. edit /etc/prometheus/hosts (conf/prometheus.hosts or examples/...)
5. edit /etc/cron.d/prometheus to update preview, shutdown and reload times
6. run "/etc/init.d/prometheus start" to activate QoS
7. run "/etc/init.d/prometheus stop" to shutdown QoS and generate stats
8. run "/etc/init.d/prometheus kill" to force immediate flush of QoS rules
9. setup /etc/init.d/prometheus to your system init (distribution dependent)

Prometheus QoS installation - alternative, old way

1. if can read read this, you have already unpacked the .tar.gz archive
2. run "make prometheus" (you shouldn't get errors, just some warnings)
3. create /etc/prometheus/prometheus.conf (conf/prometheus.conf or examples/...)
4. create /etc/prometheus/hosts (conf/prometheus.hosts or examples/...)
5. to activate QoS manualy from command line, just run "./prometheus"
6. to softly shutdown QoS (and generate stats), run "./prometheus -f" ("flush")
7. to force immediate flush of QoS rules, run "./prometheus -9" ("kill")

Promethetus QoS advanced tips:

1. use -p command line switch to generate instant and safe Hall of fame preview
2. use qos-free-delay option for pause after flushing old rules, before loading new
3. take some time to understand files examples/prometheus.conf and examples/hosts
4. note: qos-proxy-enable and qos-free-zone won't work together
5. warning: doing SNAT and QoS on the same router may cause performance problems

General Linux routing tips for beginners:

echo -n 1 > /proc/sys/net/ipv4/ip_forward
echo -n 64000 > /proc/sys/net/ipv4/ip_conntrack_max
echo -n 86400 > /proc/sys/net/ipv4/netfilter/ip_conntrack_tcp_timeout_established

Prometheus Debian packages:

1. you need root access and "debhelper" package installed
2. run "make deb" or "sudo make deb"
Commit	Line	Data
	1	Prometheus QoS installation - canonical
	2
	3	1. run "./check-kernel-qos" script to check kernel modules HTB and SFQ (optional)
	4	2. as a root, run "make install" (you shouldn't get errors, just some warnings)
	5	3. edit /etc/prometheus/prometheus.conf (conf/prometheus.conf or examples/...)
	6	4. edit /etc/prometheus/hosts (conf/prometheus.hosts or examples/...)
	7	5. edit /etc/cron.d/prometheus to update preview, shutdown and reload times
	8	6. run "/etc/init.d/prometheus start" to activate QoS
	9	7. run "/etc/init.d/prometheus stop" to shutdown QoS and generate stats
	10	8. run "/etc/init.d/prometheus kill" to force immediate flush of QoS rules
	11	9. setup /etc/init.d/prometheus to your system init (distribution dependent)
	12
	13	Prometheus QoS installation - alternative, old way
	14
	15	1. if can read read this, you have already unpacked the .tar.gz archive
	16	2. run "make prometheus" (you shouldn't get errors, just some warnings)
	17	3. create /etc/prometheus/prometheus.conf (conf/prometheus.conf or examples/...)
	18	4. create /etc/prometheus/hosts (conf/prometheus.hosts or examples/...)
	19	5. to activate QoS manualy from command line, just run "./prometheus"
	20	6. to softly shutdown QoS (and generate stats), run "./prometheus -f" ("flush")
	21	7. to force immediate flush of QoS rules, run "./prometheus -9" ("kill")
	22
	23	Promethetus QoS advanced tips:
	24
	25	1. use -p command line switch to generate instant and safe Hall of fame preview
	26	2. use qos-free-delay option for pause after flushing old rules, before loading new
	27	3. take some time to understand files examples/prometheus.conf and examples/hosts
	28	4. note: qos-proxy-enable and qos-free-zone won't work together
	29	5. warning: doing SNAT and QoS on the same router may cause performance problems
	30
	31	General Linux routing tips for beginners:
	32
	33	echo -n 1 > /proc/sys/net/ipv4/ip_forward
	34	echo -n 64000 > /proc/sys/net/ipv4/ip_conntrack_max
	35	echo -n 86400 > /proc/sys/net/ipv4/netfilter/ip_conntrack_tcp_timeout_established
	36
	37	Prometheus Debian packages:
	38
	39	1. you need root access and "debhelper" package installed
	40	2. run "make deb" or "sudo make deb"