bughz/tinyproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tinyproxy.conf.5: document config strings that require double quotes (#493)

Browse Source 
* tinyproxy.conf.5: document config strings that require double quotes

String config values matched by the STR regex must be enclosed in double
quotes

Edit descriptions for brevity

conf.c: move boolean arguments comment before BOOL group

addresses #491

* Revert conf.c: move boolean arguments comment before BOOL group
This commit is contained in:
ivanwick 2023-05-24 07:06:15 -07:00 committed by GitHub
parent 2bec15ee40
commit 1e615e66a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/man5/tinyproxy.conf.txt.in
View File

@ -22,8 +22,8 @@ configuration file.
The Tinyproxy configuration file contains key-value pairs, one per The Tinyproxy configuration file contains key-value pairs, one per
line. Lines starting with `#` and empty lines are comments and are line. Lines starting with `#` and empty lines are comments and are
ignored. Keywords are case-insensitive, whereas values are ignored. Keywords are case-insensitive, whereas values are
case-sensitive. Values may be enclosed in double-quotes (") if they case-sensitive. Some string values must be enclosed in double
contain spaces. quotes (") as noted below.
The possible keywords and their descriptions are as follows: The possible keywords and their descriptions are as follows:
@ -76,29 +76,29 @@ allowed to have before it is closed by Tinyproxy.
This parameter controls which HTML file Tinyproxy returns when a This parameter controls which HTML file Tinyproxy returns when a
given HTTP error occurs. It takes two arguments, the error number given HTTP error occurs. It takes two arguments, the error number
and the location of the HTML error file. and the location of the HTML error file. Enclose the file location
in double quotes.
=item B<DefaultErrorFile> =item B<DefaultErrorFile>
This parameter controls the HTML template file returned when an The HTML template file returned when an error occurs for which no
error occurs for which no specific error file has been set. specific error file has been set. Enclose in double quotes.
=item B<StatHost> =item B<StatHost>
This configures the host name or IP address that is treated The host name or IP address that is treated as the `stat host`.
as the `stat host`: Whenever a request for this host is received, Enclose in double quotes. Whenever Tinyproxy receives a request for
Tinyproxy will return an internal statistics page instead of the `stat host` it returns an internal statistics page instead of
forwarding the request to that host. The template for this forwarding the request to that host. The template for this page can be
page can be configured with the `StatFile` configuration option. configured with the `StatFile` configuration option. The default value
The default value of `StatHost` is `@TINYPROXY_STATHOST@`. of `StatHost` is `@TINYPROXY_STATHOST@`.
=item B<StatFile> =item B<StatFile>
This configures the HTML file that Tinyproxy sends when The HTML file that Tinyproxy sends in response to a request for the
a request for the stathost is received. If this parameter is `stat host`. Enclose in double quotes. If this parameter is not set,
not set, Tinyproxy returns a hard-coded basic statistics page. Tinyproxy returns a hard-coded basic statistics page. See the STATHOST
See the STATHOST section in the L<tinyproxy(8)> manual page section in the L<tinyproxy(8)> manual page for details.
for details.
Note that the StatFile and the error files configured with ErrorFile Note that the StatFile and the error files configured with ErrorFile
and DefaultErrorFile are template files that can contain a few and DefaultErrorFile are template files that can contain a few
@ -109,9 +109,9 @@ manual page contains a description of all template variables.
=item B<LogFile> =item B<LogFile>
This controls the location of the file to which Tinyproxy The location of the file to which Tinyproxy writes its debug output.
writes its debug output. Alternatively, Tinyproxy can log Enclose in double quotes. Alternatively, Tinyproxy can log to syslog
to syslog -- see the Syslog option. -- see the Syslog option.
=item B<Syslog> =item B<Syslog>
@ -144,8 +144,8 @@ and below would be suppressed. Allowed values are:
=item B<PidFile> =item B<PidFile>
This option controls the location of the file where the main The location of the file where the main Tinyproxy process stores its
Tinyproxy process stores its process ID for signaling purposes. process ID for signaling purposes. Enclose in double quotes.
=item B<XTinyproxy> =item B<XTinyproxy>
@ -250,7 +250,8 @@ RFC 2616 requires proxies to add a `Via` header to the HTTP
requests, but using the real host name can be a security requests, but using the real host name can be a security
concern. If the `ViaProxyname` option is present, then its concern. If the `ViaProxyname` option is present, then its
string value will be used as the host name in the Via header. string value will be used as the host name in the Via header.
Otherwise, the server's host name will be used. Otherwise, the server's host name will be used. Enclose in double
quotes.
=item B<DisableViaHeader> =item B<DisableViaHeader>
@ -344,7 +345,7 @@ If an `Anonymous` keyword is present, then anonymous proxying
is enabled. The headers listed with `Anonymous` are allowed is enabled. The headers listed with `Anonymous` are allowed
through, while all others are denied. If no Anonymous keyword through, while all others are denied. If no Anonymous keyword
is present, then all headers are allowed through. You must is present, then all headers are allowed through. You must
include quotes around the headers. include double quotes around the headers.
Most sites require cookies to be enabled for them to work correctly, so 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. you will need to allow cookies through if you access those sites.