public-inbox.cgi(1): Mention AllowEncodedSlashes for Apache setups

When AllowEncodedSlashes is Off (the default setting), URLs containing
%2f are replied with a 404 error without calling the CGI. To (maybe)
prevent others debugging this issue add a hint with the solution.

diff --git a/Documentation/public-inbox.cgi.pod b/Documentation/public-inbox.cgi.pod
index 0f93fa5a96aabfac29591a04212f32cd781f5bd8..58d59ba2cc149b2e45053b054c6e06273b5b5c44 100644 (file)
--- a/Documentation/public-inbox.cgi.pod
+++ b/Documentation/public-inbox.cgi.pod
@@ -17,6 +17,11 @@ web servers lack the scheduling fairness of L<public-inbox-netd(1)>
 and L<public-inbox-httpd(1)> for handling git clones and
 streaming large mbox downloads.
 
+=head1 COMPATIBILITY NOTE
+
+When using the CGI with Apache, make sure to set AllowEncodedSlashes to On, as
+public-inbox makes heavy use of encoded slashes.
+
 =head1 CONTACT
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>