STATUS revision 5d5214aebe51357a1865e3c57fd81604034ab93f
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncApache HTTP Server Trunk Documentation Status File. Last modified: $Date$
b736c553dbde2c3b2533c93c57d9b7f07714371cvboxsyncFor more information on how to contribute to the Apache Documentation
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncProject, please see http://httpd.apache.org/docs-project/ and
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsynchttp://httpd.apache.org/docs-project/docsformat.html
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync ------------------------------
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync=======================
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- The following directives of modules included in 2.4.x are not documented:
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync ProxyHTMLMeta (mod_proxy_html)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync SSLPKCS7CertificateFile (mod_ssl)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Update the http://httpd.apache.org/docs-project/docsformat.html
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync document to be useful. In particular:
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Document the various macros that can be used in documents.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Document the translation process.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Generally update it to make it reflect the current reality of how
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Improving the documentation of the documentations' build system
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync itself (requirements, procedures)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Continue to enhance the FAQ, which is in the wiki:
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Security docs are unhelpful, and assume that the reader knows nothing.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync Need something a little more advanced, which either discusses
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync application-level security, or links to something that does. I'm not
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync even sure what to say needs done. Can we get someone to elaborate on
d544fe535c163a24bf8cd831b39264da292b8adfvboxsync what, exactly, needs written? Ivan Ristic has said maybe he would be
d544fe535c163a24bf8cd831b39264da292b8adfvboxsync willing to contribute.
d544fe535c163a24bf8cd831b39264da292b8adfvboxsync - More content and better organisation
d544fe535c163a24bf8cd831b39264da292b8adfvboxsync - mod_dav resources are owned by the httpd. Perhaps write up the
d544fe535c163a24bf8cd831b39264da292b8adfvboxsync two-httpd dav setup covered in Rich Bowen's DAV Apachecon
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync presentation.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Performance doc "drop-in replace" misc/perf-scaling.xml
d544fe535c163a24bf8cd831b39264da292b8adfvboxsync as well as: http://wiki.apache.org/httpd/PerformanceScalingOut
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync They both need review and updates to reflect the current state
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync of the art.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Windows platform docs are in desperate need of rewrites/updates for 2.x.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Bill Rowe is a good contact for tech questions.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - "using apache" has been done, "compiling apache" is still open
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - hints on uninstalling apache (exit monitor, close directories,
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync registry entries etc) (PR 10154)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - FAQ: UTF-8 config and URL encoding for non-ascii characters.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- New Auth system
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Much clean-up and enhancement of aaa howto (Can someone clarify
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync exactly what needs cleaned up and enhanced?)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Independent note on how to upgrade to new auth system
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - Discussion of DBD auth, and, in particular, examples of how to set
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync up auth using each of the supported databases.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync Start is in expr.xml, igalic is working on this
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- modules docs
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - the following modules added since 2.2 lack documentation
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - mpm_simple
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync the list may be incomplete
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync maybe some of the modules will not be included in 2.4
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - mod_suexec: very little documentation
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- mod_substitute and reverse proxies: Add example using mod_filter
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- MPM documentation
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - explain what the following command line options do
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync (perhaps in the developer/debugging docs):
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync -D ONE_PROCESS -- is this the same as -X, if not, should it be?
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync one-process-mode == no threads, i.e. only one
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync process handling the requests in a single loop?
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Identify which documents are grossly out of date, and fix.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - platform/ebcdic.xml - needs major rework for 2.0
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - SSL docs need serious update and enhancement
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - compat docs are wrong
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - A basic how to has been started here:
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync but it needs some work...
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync looks like a good starting point for overhauling the FAQ, and
9474d83dcac691984017f8255821b95ec7642804vboxsync has been placed at our disposal by the author.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- API documentation
9474d83dcac691984017f8255821b95ec7642804vboxsync - Ben Laurie has written some hooks documentation
9474d83dcac691984017f8255821b95ec7642804vboxsync - authn provider API documentation could be useful
b379286f0d2c8d82f5a575eb907c7476aa6ae84bvboxsync- How does <Proxy> fit into sections.html?
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Missing documentation for the support program checkgid
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync (draft available in wiki)
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Enhancements to the DTD/XSL:
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync - New index: directives by context, including listing which directives
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync are available for each AllowOverride setting.
9474d83dcac691984017f8255821b95ec7642804vboxsync - New index: backout modules by type (aaa, mappers, loggers etc.)
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync probably by introducing a <category> element in modulesynopsis
9474d83dcac691984017f8255821b95ec7642804vboxsync - Use a tag like <var> in place of <em> for things like the
9474d83dcac691984017f8255821b95ec7642804vboxsync <syntax> listing.
9474d83dcac691984017f8255821b95ec7642804vboxsync - in progress
9474d83dcac691984017f8255821b95ec7642804vboxsync - add letter links to glossary and quickreference,
9474d83dcac691984017f8255821b95ec7642804vboxsync perhaps also a term overview (sidebar)
9474d83dcac691984017f8255821b95ec7642804vboxsync- Provide example solutions for the mapping of encodings, especially
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync for .gz etc. (also in regard to our default configuration)
b379286f0d2c8d82f5a575eb907c7476aa6ae84bvboxsync- How-To style documents for more of the daily tasks
b379286f0d2c8d82f5a575eb907c7476aa6ae84bvboxsync - Logging, log rotation, and log reporting
9474d83dcac691984017f8255821b95ec7642804vboxsync - Secure mod_dav configuration
9474d83dcac691984017f8255821b95ec7642804vboxsync- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
9474d83dcac691984017f8255821b95ec7642804vboxsync profound embarrassment.
9474d83dcac691984017f8255821b95ec7642804vboxsync - Purge all the dead links
9474d83dcac691984017f8255821b95ec7642804vboxsync - Verify links to external resources at least every year
9474d83dcac691984017f8255821b95ec7642804vboxsync- Update the list of translations at
9474d83dcac691984017f8255821b95ec7642804vboxsync http://httpd.apache.org/docs-project/translations.html Some of those
9474d83dcac691984017f8255821b95ec7642804vboxsync are accurate, and others are way outdated.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync- I'd like to expand the discussion of conditional logging, and add a
666e2c9af6a34f7a05d8069a11194756312f5be6vboxsync few more useful exmaples.
666e2c9af6a34f7a05d8069a11194756312f5be6vboxsync That would be a good place to document logging of cache hit/miss:
b379286f0d2c8d82f5a575eb907c7476aa6ae84bvboxsync https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync- Is it worth having a doc that discusses recommended (what does this
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync mean?) third-party modules like mod_security, mod_php, and so on - the
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync things that we all assume everyone uses, but some folks might not know
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync- Clarify which directives only affect requests when they're handled
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync by the default handler. (e.g. ForceType, TraceEnable, etc.)
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync- Add examples using expr to mod_rewrite recipes. Possibly benchmark the
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync different approaches and make intelligent remarks about the
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync comparative value of each.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync- Fix this error message:
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync Request exceeded the limit of 10 internal redirects due to probable
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync configuration error. Use 'LimitInternalRecursion' to increase the limit
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync if necessary. Use 'LogLevel debug' to get a backtrace.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync This error message is often returned when a RewriteRUle loops, in
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync which case setting LimitInternalRecursion won't do anything towards
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync fixing the problem. However, the error message is already very long.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- Error codes
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync Decide how and where to document the error codes (AH****), and then
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync start on doing it.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- If someone has xslt and LaTeX skills, they could consider getting the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync xml->LaTeX->PDF build chain working again. See specifically
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync https://issues.apache.org/bugzilla/show_bug.cgi?id=45526 for details
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync of what's broken. For the moment, PDF docs are no longer referenced on
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync the docs site.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync- The "MSIE on Mac" example in the SSI Howto is silly, and needs to be
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync replaced by something actually useful and relevant in this century.