From c44264ddaa770f6c7ad9c5c81991689917e71784 Mon Sep 17 00:00:00 2001 From: Mukund Sivaraman Date: Sun, 13 Sep 2009 04:04:18 +0530 Subject: doc: Move doc/tinyproxy.conf to etc/ directory --- Makefile.am | 27 +---- configure.ac | 1 + doc/tinyproxy.conf | 301 ----------------------------------------------------- etc/Makefile.am | 5 + etc/tinyproxy.conf | 301 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 309 insertions(+), 326 deletions(-) delete mode 100644 doc/tinyproxy.conf create mode 100644 etc/Makefile.am create mode 100644 etc/tinyproxy.conf diff --git a/Makefile.am b/Makefile.am index db684cf..f76c9f0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -6,32 +6,9 @@ CONFIG_FILES = \ m4macros/typecheck.m4 m4macros/argenable.m4 EXTRA_DIST = $(CONFIG_FILES) TODO autogen.sh -SUBDIRS = src data doc packaging +SUBDIRS = src data etc doc packaging -install-data-local: tinyproxy-configure-file tinyproxy-html-files - -# Install the configuration file if it doesn't already exist -tinyproxy-configure-file: - $(mkinstalldirs) $(DESTDIR)@TINYPROXY_CONFIG_DIR@ - $(INSTALL) -m 600 $(srcdir)/doc/tinyproxy.conf \ - $(DESTDIR)@TINYPROXY_CONFIG_DIR@/@TINYPROXY_CONFIG_FILE@-dist - test -f $(DESTDIR)@TINYPROXY_CONFIG_DIR@/@TINYPROXY_CONFIG_FILE@ \ - || $(INSTALL) -m 600 $(srcdir)/doc/tinyproxy.conf \ - $(DESTDIR)@TINYPROXY_CONFIG_DIR@/@TINYPROXY_CONFIG_FILE@ - @echo "" - @echo "A configuration file has been copied to:" - @echo "" - @echo "@TINYPROXY_CONFIG_DIR@/@TINYPROXY_CONFIG_FILE@-dist" - @echo "" - @echo "You will need to rename this file to:" - @echo "" - @echo "@TINYPROXY_CONFIG_DIR@/@TINYPROXY_CONFIG_FILE@" - @echo "" - @echo "and modify the values to suit your local system." - @echo "" - @echo "All the configuration directives are commented in the file, so" - @echo "you should not have any problems configuring your system." - @echo "" +install-data-local: tinyproxy-html-files # Install the HTML files tinyproxy-html-files: diff --git a/configure.ac b/configure.ac index fa969ef..0cb4d24 100644 --- a/configure.ac +++ b/configure.ac @@ -328,6 +328,7 @@ Makefile src/Makefile data/Makefile data/templates/Makefile +etc/Makefile doc/Makefile doc/man8/Makefile packaging/Makefile diff --git a/doc/tinyproxy.conf b/doc/tinyproxy.conf deleted file mode 100644 index 1711ebd..0000000 --- a/doc/tinyproxy.conf +++ /dev/null @@ -1,301 +0,0 @@ -## -## tinyproxy.conf -- tinyproxy daemon configuration file -## - -# -# User/Group: This allows you to set the username and group that will be -# used for tinyproxy after the initial binding to the port has been done -# as the root user. -# -# Please note that you may not use UID/GID's here. -# -User nobody -Group nobody - -# -# Port: Specify the port which tinyproxy will listen on. Please note -# that should you choose to run on a port lower than 1024 you will need -# to start tinyproxy using root. -# -Port 8888 - -# -# Listen: If you have multiple interfaces this allows you to bind to -# only one. If this is commented out, tinyproxy will bind to all -# interfaces present. -# -#Listen 192.168.0.1 - -# -# Bind: This allows you to specify which interface will be used for -# outgoing connections. This is useful for multi-home'd machines where -# you want all traffic to appear outgoing from one particular interface. -# -#Bind 192.168.0.1 - -# -# BindSame: If enabled, tinyproxy will bind the outgoing connection to the -# ip address of the incoming connection. -# -#BindSame yes - -# -# Timeout: The maximum number of seconds of inactivity a connection is -# allowed to have before it is closed by tinyproxy. -# -Timeout 600 - -# -# ErrorFile: Defines the HTML file to send when a given HTTP error -# occurs. You will probably need to customize the location to your -# particular install. The usual locations to check are: -# /usr/local/share/tinyproxy -# /usr/share/tinyproxy -# /etc/tinyproxy -# -#ErrorFile 404 "/usr/share/tinyproxy/404.html" -#ErrorFile 400 "/usr/share/tinyproxy/400.html" -#ErrorFile 503 "/usr/share/tinyproxy/503.html" -#ErrorFile 403 "/usr/share/tinyproxy/403.html" -#ErrorFile 408 "/usr/share/tinyproxy/408.html" - -# -# DefaultErrorFile: The HTML file that gets sent if there is no -# HTML file defined with an ErrorFile keyword for the HTTP error -# that has occured. -# -DefaultErrorFile "/usr/share/tinyproxy/default.html" - -# -# StatFile: The HTML file that gets sent when a request is made -# for the stathost. If this file doesn't exist a basic page is -# hardcoded in tinyproxy. -# -StatFile "/usr/share/tinyproxy/stats.html" - -# -# Logfile: Allows you to specify the location where information should -# be logged to. If you would prefer to log to syslog, then disable this -# and enable the Syslog directive. These directives are mutually -# exclusive. -# -Logfile "/var/log/tinyproxy.log" - -# -# Syslog: Tell tinyproxy to use syslog instead of a logfile. This -# option must not be enabled if the Logfile directive is being used. -# These two directives are mutually exclusive. -# -#Syslog On - -# -# LogLevel: -# -# Set the logging level. Allowed settings are: -# Critical (least verbose) -# Error -# Warning -# Notice -# Connect (to log connections without Info's noise) -# Info (most verbose) -# -# The LogLevel logs from the set level and above. For example, if the -# LogLevel was set to Warning, than all log messages from Warning to -# Critical would be output, but Notice and below would be suppressed. -# -LogLevel Info - -# -# PidFile: Write the PID of the main tinyproxy thread to this file so it -# can be used for signalling purposes. -# -PidFile "/var/run/tinyproxy.pid" - -# -# XTinyproxy: Include the X-Tinyproxy header, which has the client's IP -# address when connecting to the sites listed. -# -#XTinyproxy mydomain.com - -# -# Upstream: -# -# Turns on upstream proxy support. -# -# The upstream rules allow you to selectively route upstream connections -# based on the host/domain of the site being accessed. -# -# For example: -# # connection to test domain goes through testproxy -# upstream testproxy:8008 ".test.domain.invalid" -# upstream testproxy:8008 ".our_testbed.example.com" -# upstream testproxy:8008 "192.168.128.0/255.255.254.0" -# -# # no upstream proxy for internal websites and unqualified hosts -# no upstream ".internal.example.com" -# no upstream "www.example.com" -# no upstream "10.0.0.0/8" -# no upstream "192.168.0.0/255.255.254.0" -# no upstream "." -# -# # connection to these boxes go through their DMZ firewalls -# upstream cust1_firewall:8008 "testbed_for_cust1" -# upstream cust2_firewall:8008 "testbed_for_cust2" -# -# # default upstream is internet firewall -# upstream firewall.internal.example.com:80 -# -# The LAST matching rule wins the route decision. As you can see, you -# can use a host, or a domain: -# name matches host exactly -# .name matches any host in domain "name" -# . matches any host with no domain (in 'empty' domain) -# IP/bits matches network/mask -# IP/mask matches network/mask -# -#Upstream some.remote.proxy:port - -# -# MaxClients: This is the absolute highest number of threads which will -# be created. In other words, only MaxClients number of clients can be -# connected at the same time. -# -MaxClients 100 - -# -# MinSpareServers/MaxSpareServers: These settings set the upper and -# lower limit for the number of spare servers which should be available. -# -# If the number of spare servers falls below MinSpareServers then new -# server processes will be spawned. If the number of servers exceeds -# MaxSpareServers then the extras will be killed off. -# -MinSpareServers 5 -MaxSpareServers 20 - -# -# StartServers: The number of servers to start initially. -# -StartServers 10 - -# -# MaxRequestsPerChild: The number of connections a thread will handle -# before it is killed. In practise this should be set to 0, which -# disables thread reaping. If you do notice problems with memory -# leakage, then set this to something like 10000. -# -MaxRequestsPerChild 0 - -# -# Allow: Customization of authorization controls. If there are any -# access control keywords then the default action is to DENY. Otherwise, -# the default action is ALLOW. -# -# The order of the controls are important. All incoming connections are -# tested against the controls based on order. -# -Allow 127.0.0.1 - -# -# ViaProxyName: The "Via" header is required by the HTTP RFC, but using -# the real host name is a security concern. If the following directive -# is enabled, the string supplied will be used as the host name in the -# Via header; otherwise, the server's host name will be used. -# -ViaProxyName "tinyproxy" - -# -# Filter: This allows you to specify the location of the filter file. -# -#Filter "/etc/tinyproxy/filter" - -# -# FilterURLs: Filter based on URLs rather than domains. -# -#FilterURLs On - -# -# FilterExtended: Use POSIX Extended regular expressions rather than -# basic. -# -#FilterExtended On - -# -# FilterCaseSensitive: Use case sensitive regular expressions. -# -#FilterCaseSensitive On - -# -# FilterDefaultDeny: Change the default policy of the filtering system. -# If this directive is commented out, or is set to "No" then the default -# policy is to allow everything which is not specifically denied by the -# filter file. -# -# However, by setting this directive to "Yes" the default policy becomes -# to deny everything which is _not_ specifically allowed by the filter -# file. -# -#FilterDefaultDeny Yes - -# -# Anonymous: If an Anonymous keyword is present, then anonymous proxying -# is enabled. The headers listed are allowed through, while all others -# are denied. If no Anonymous keyword is present, then all headers are -# allowed through. You must include quotes around the headers. -# -# Most sites require cookies to be enabled for them to work correctly, so -# you will need to allow Cookies through if you access those sites. -# -#Anonymous "Host" -#Anonymous "Authorization" -#Anonymous "Cookie" - -# -# ConnectPort: This is a list of ports allowed by tinyproxy when the -# CONNECT method is used. To disable the CONNECT method altogether, set -# the value to 0. If no ConnectPort line is found, all ports are -# allowed (which is not very secure.) -# -# The following two ports are used by SSL. -# -ConnectPort 443 -ConnectPort 563 - -# -# Configure one or more ReversePath directives to enable reverse proxy -# support. With reverse proxying it's possible to make a number of -# sites appear as if they were part of a single site. -# -# If you uncomment the following two directives and run tinyproxy -# on your own computer at port 8888, you can access Google using -# http://localhost:8888/google/ and Wired News using -# http://localhost:8888/wired/news/. Neither will actually work -# until you uncomment ReverseMagic as they use absolute linking. -# -#ReversePath "/google/" "http://www.google.com/" -#ReversePath "/wired/" "http://www.wired.com/" - -# -# When using tinyproxy as a reverse proxy, it is STRONGLY recommended -# that the normal proxy is turned off by uncommenting the next directive. -# -#ReverseOnly Yes - -# -# Use a cookie to track reverse proxy mappings. If you need to reverse -# proxy sites which have absolute links you must uncomment this. -# -#ReverseMagic Yes - -# -# The URL that's used to access this reverse proxy. The URL is used to -# rewrite HTTP redirects so that they won't escape the proxy. If you -# have a chain of reverse proxies, you'll need to put the outermost -# URL here (the address which the end user types into his/her browser). -# -# If not set then no rewriting occurs. -# -#ReverseBaseURL "http://localhost:8888/" - - - diff --git a/etc/Makefile.am b/etc/Makefile.am new file mode 100644 index 0000000..5e8b370 --- /dev/null +++ b/etc/Makefile.am @@ -0,0 +1,5 @@ +sysconf_DATA = \ + tinyproxy.conf + +EXTRA_DIST = \ + $(sysconf_DATA) diff --git a/etc/tinyproxy.conf b/etc/tinyproxy.conf new file mode 100644 index 0000000..1711ebd --- /dev/null +++ b/etc/tinyproxy.conf @@ -0,0 +1,301 @@ +## +## tinyproxy.conf -- tinyproxy daemon configuration file +## + +# +# User/Group: This allows you to set the username and group that will be +# used for tinyproxy after the initial binding to the port has been done +# as the root user. +# +# Please note that you may not use UID/GID's here. +# +User nobody +Group nobody + +# +# Port: Specify the port which tinyproxy will listen on. Please note +# that should you choose to run on a port lower than 1024 you will need +# to start tinyproxy using root. +# +Port 8888 + +# +# Listen: If you have multiple interfaces this allows you to bind to +# only one. If this is commented out, tinyproxy will bind to all +# interfaces present. +# +#Listen 192.168.0.1 + +# +# Bind: This allows you to specify which interface will be used for +# outgoing connections. This is useful for multi-home'd machines where +# you want all traffic to appear outgoing from one particular interface. +# +#Bind 192.168.0.1 + +# +# BindSame: If enabled, tinyproxy will bind the outgoing connection to the +# ip address of the incoming connection. +# +#BindSame yes + +# +# Timeout: The maximum number of seconds of inactivity a connection is +# allowed to have before it is closed by tinyproxy. +# +Timeout 600 + +# +# ErrorFile: Defines the HTML file to send when a given HTTP error +# occurs. You will probably need to customize the location to your +# particular install. The usual locations to check are: +# /usr/local/share/tinyproxy +# /usr/share/tinyproxy +# /etc/tinyproxy +# +#ErrorFile 404 "/usr/share/tinyproxy/404.html" +#ErrorFile 400 "/usr/share/tinyproxy/400.html" +#ErrorFile 503 "/usr/share/tinyproxy/503.html" +#ErrorFile 403 "/usr/share/tinyproxy/403.html" +#ErrorFile 408 "/usr/share/tinyproxy/408.html" + +# +# DefaultErrorFile: The HTML file that gets sent if there is no +# HTML file defined with an ErrorFile keyword for the HTTP error +# that has occured. +# +DefaultErrorFile "/usr/share/tinyproxy/default.html" + +# +# StatFile: The HTML file that gets sent when a request is made +# for the stathost. If this file doesn't exist a basic page is +# hardcoded in tinyproxy. +# +StatFile "/usr/share/tinyproxy/stats.html" + +# +# Logfile: Allows you to specify the location where information should +# be logged to. If you would prefer to log to syslog, then disable this +# and enable the Syslog directive. These directives are mutually +# exclusive. +# +Logfile "/var/log/tinyproxy.log" + +# +# Syslog: Tell tinyproxy to use syslog instead of a logfile. This +# option must not be enabled if the Logfile directive is being used. +# These two directives are mutually exclusive. +# +#Syslog On + +# +# LogLevel: +# +# Set the logging level. Allowed settings are: +# Critical (least verbose) +# Error +# Warning +# Notice +# Connect (to log connections without Info's noise) +# Info (most verbose) +# +# The LogLevel logs from the set level and above. For example, if the +# LogLevel was set to Warning, than all log messages from Warning to +# Critical would be output, but Notice and below would be suppressed. +# +LogLevel Info + +# +# PidFile: Write the PID of the main tinyproxy thread to this file so it +# can be used for signalling purposes. +# +PidFile "/var/run/tinyproxy.pid" + +# +# XTinyproxy: Include the X-Tinyproxy header, which has the client's IP +# address when connecting to the sites listed. +# +#XTinyproxy mydomain.com + +# +# Upstream: +# +# Turns on upstream proxy support. +# +# The upstream rules allow you to selectively route upstream connections +# based on the host/domain of the site being accessed. +# +# For example: +# # connection to test domain goes through testproxy +# upstream testproxy:8008 ".test.domain.invalid" +# upstream testproxy:8008 ".our_testbed.example.com" +# upstream testproxy:8008 "192.168.128.0/255.255.254.0" +# +# # no upstream proxy for internal websites and unqualified hosts +# no upstream ".internal.example.com" +# no upstream "www.example.com" +# no upstream "10.0.0.0/8" +# no upstream "192.168.0.0/255.255.254.0" +# no upstream "." +# +# # connection to these boxes go through their DMZ firewalls +# upstream cust1_firewall:8008 "testbed_for_cust1" +# upstream cust2_firewall:8008 "testbed_for_cust2" +# +# # default upstream is internet firewall +# upstream firewall.internal.example.com:80 +# +# The LAST matching rule wins the route decision. As you can see, you +# can use a host, or a domain: +# name matches host exactly +# .name matches any host in domain "name" +# . matches any host with no domain (in 'empty' domain) +# IP/bits matches network/mask +# IP/mask matches network/mask +# +#Upstream some.remote.proxy:port + +# +# MaxClients: This is the absolute highest number of threads which will +# be created. In other words, only MaxClients number of clients can be +# connected at the same time. +# +MaxClients 100 + +# +# MinSpareServers/MaxSpareServers: These settings set the upper and +# lower limit for the number of spare servers which should be available. +# +# If the number of spare servers falls below MinSpareServers then new +# server processes will be spawned. If the number of servers exceeds +# MaxSpareServers then the extras will be killed off. +# +MinSpareServers 5 +MaxSpareServers 20 + +# +# StartServers: The number of servers to start initially. +# +StartServers 10 + +# +# MaxRequestsPerChild: The number of connections a thread will handle +# before it is killed. In practise this should be set to 0, which +# disables thread reaping. If you do notice problems with memory +# leakage, then set this to something like 10000. +# +MaxRequestsPerChild 0 + +# +# Allow: Customization of authorization controls. If there are any +# access control keywords then the default action is to DENY. Otherwise, +# the default action is ALLOW. +# +# The order of the controls are important. All incoming connections are +# tested against the controls based on order. +# +Allow 127.0.0.1 + +# +# ViaProxyName: The "Via" header is required by the HTTP RFC, but using +# the real host name is a security concern. If the following directive +# is enabled, the string supplied will be used as the host name in the +# Via header; otherwise, the server's host name will be used. +# +ViaProxyName "tinyproxy" + +# +# Filter: This allows you to specify the location of the filter file. +# +#Filter "/etc/tinyproxy/filter" + +# +# FilterURLs: Filter based on URLs rather than domains. +# +#FilterURLs On + +# +# FilterExtended: Use POSIX Extended regular expressions rather than +# basic. +# +#FilterExtended On + +# +# FilterCaseSensitive: Use case sensitive regular expressions. +# +#FilterCaseSensitive On + +# +# FilterDefaultDeny: Change the default policy of the filtering system. +# If this directive is commented out, or is set to "No" then the default +# policy is to allow everything which is not specifically denied by the +# filter file. +# +# However, by setting this directive to "Yes" the default policy becomes +# to deny everything which is _not_ specifically allowed by the filter +# file. +# +#FilterDefaultDeny Yes + +# +# Anonymous: If an Anonymous keyword is present, then anonymous proxying +# is enabled. The headers listed are allowed through, while all others +# are denied. If no Anonymous keyword is present, then all headers are +# allowed through. You must include quotes around the headers. +# +# Most sites require cookies to be enabled for them to work correctly, so +# you will need to allow Cookies through if you access those sites. +# +#Anonymous "Host" +#Anonymous "Authorization" +#Anonymous "Cookie" + +# +# ConnectPort: This is a list of ports allowed by tinyproxy when the +# CONNECT method is used. To disable the CONNECT method altogether, set +# the value to 0. If no ConnectPort line is found, all ports are +# allowed (which is not very secure.) +# +# The following two ports are used by SSL. +# +ConnectPort 443 +ConnectPort 563 + +# +# Configure one or more ReversePath directives to enable reverse proxy +# support. With reverse proxying it's possible to make a number of +# sites appear as if they were part of a single site. +# +# If you uncomment the following two directives and run tinyproxy +# on your own computer at port 8888, you can access Google using +# http://localhost:8888/google/ and Wired News using +# http://localhost:8888/wired/news/. Neither will actually work +# until you uncomment ReverseMagic as they use absolute linking. +# +#ReversePath "/google/" "http://www.google.com/" +#ReversePath "/wired/" "http://www.wired.com/" + +# +# When using tinyproxy as a reverse proxy, it is STRONGLY recommended +# that the normal proxy is turned off by uncommenting the next directive. +# +#ReverseOnly Yes + +# +# Use a cookie to track reverse proxy mappings. If you need to reverse +# proxy sites which have absolute links you must uncomment this. +# +#ReverseMagic Yes + +# +# The URL that's used to access this reverse proxy. The URL is used to +# rewrite HTTP redirects so that they won't escape the proxy. If you +# have a chain of reverse proxies, you'll need to put the outermost +# URL here (the address which the end user types into his/her browser). +# +# If not set then no rewriting occurs. +# +#ReverseBaseURL "http://localhost:8888/" + + + -- cgit v1.2.3