0f66aced2640d964aeb6db41210711ba0640d7f2Evan HuntApache HTTP Server Trunk Documentation Status File. Last modified: $Date$

794b79e6bbc3f5db1ea6ae154d739b9f1ef1a375Tinderbox User

bef75d63d74f58abc0f834ed271526672777ba29Automatic UpdaterFor more information on how to contribute to the Apache Documentation

0f66aced2640d964aeb6db41210711ba0640d7f2Evan HuntProject, please see http://httpd.apache.org/docs-project/ and

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

bef75d63d74f58abc0f834ed271526672777ba29Automatic Updater ------------------------------

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan HuntTo Do List

bef75d63d74f58abc0f834ed271526672777ba29Automatic Updater=======================

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- The following directives of modules included in 2.4.x are not documented:

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt ProxyHTMLMeta (mod_proxy_html)

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt SSLPKCS7CertificateFile (mod_ssl)

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- Update the http://httpd.apache.org/docs-project/docsformat.html

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt document to be useful. In particular:

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - Document the various macros that can be used in documents.

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - Document the translation process.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - Generally update it to make it reflect the current reality of how

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt we work.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - Improving the documentation of the documentations' build system

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt itself (requirements, procedures)

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- Continue to enhance the FAQ, which is in the wiki:

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User http://wiki.apache.org/httpd/FAQ

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- Security docs are unhelpful, and assume that the reader knows nothing.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Need something a little more advanced, which either discusses

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt application-level security, or links to something that does. I'm not

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User even sure what to say needs done. Can we get someone to elaborate on

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User what, exactly, needs written? Ivan Ristic has said maybe he would be

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User willing to contribute.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - More content and better organisation

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - mod_dav resources are owned by the httpd. Perhaps write up the

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User two-httpd dav setup covered in Rich Bowen's DAV Apachecon

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User presentation.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- Performance doc "drop-in replace" misc/perf-scaling.xml

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt as well as: http://wiki.apache.org/httpd/PerformanceScalingOut

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User They both need review and updates to reflect the current state

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User of the art.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- Windows platform docs are in desperate need of rewrites/updates for 2.x.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - Bill Rowe is a good contact for tech questions.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - "using apache" has been done, "compiling apache" is still open

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - hints on uninstalling apache (exit monitor, close directories,

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User registry entries etc) (PR 10154)

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - FAQ: UTF-8 config and URL encoding for non-ascii characters.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- New Auth system

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - Much clean-up and enhancement of aaa howto (Can someone clarify

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt exactly what needs cleaned up and enhanced?)

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - Independent note on how to upgrade to new auth system

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - Discussion of DBD auth, and, in particular, examples of how to set

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt up auth using each of the supported databases.

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User Start is in expr.xml, igalic is working on this

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- modules docs

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - the following modules added since 2.2 lack documentation

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - mod_serf

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - mpm_simple

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User the list may be incomplete

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User maybe some of the modules will not be included in 2.4

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - mod_suexec: very little documentation

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- mod_substitute and reverse proxies: Add example using mod_filter

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- MPM documentation

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - explain what the following command line options do

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User (perhaps in the developer/debugging docs):

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User -D DEBUG

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User -D ONE_PROCESS -- is this the same as -X, if not, should it be?

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User one-process-mode == no threads, i.e. only one

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User process handling the requests in a single loop?

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- Identify which documents are grossly out of date, and fix.

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - platform/ebcdic.xml - needs major rework for 2.0

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - SSL docs need serious update and enhancement

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - compat docs are wrong

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - A basic how to has been started here:

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt http://wiki.apache.org/httpd/SettingUpModSSL

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt but it needs some work...

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User looks like a good starting point for overhauling the FAQ, and

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User has been placed at our disposal by the author.

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- API documentation

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User - Ben Laurie has written some hooks documentation

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt - authn provider API documentation could be useful

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- How does <Proxy> fit into sections.html?

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User- Missing documentation for the support program checkgid

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt

0f66aced2640d964aeb6db41210711ba0640d7f2Evan Hunt- New user docs: Directory Handling (mod_dir/mod_autoindex/etc)

(draft available in wiki)

- Enhancements to the DTD/XSL:

- New index: directives by context, including listing which directives

are available for each AllowOverride setting.

- New index: backout modules by type (aaa, mappers, loggers etc.)

probably by introducing a <category> element in modulesynopsis

- Use a tag like <var> in place of <em> for things like the

<syntax> listing.

- in progress

- add letter links to glossary and quickreference,

perhaps also a term overview (sidebar)

- Provide example solutions for the mapping of encodings, especially

for .gz etc. (also in regard to our default configuration)

- How-To style documents for more of the daily tasks

- Logging, log rotation, and log reporting

- Secure mod_dav configuration

- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a

profound embarrassment.

- Purge all the dead links

- Verify links to external resources at least every year

- Update the list of translations at

http://httpd.apache.org/docs-project/translations.html Some of those

are accurate, and others are way outdated.

- I'd like to expand the discussion of conditional logging, and add a

few more useful exmaples.

That would be a good place to document logging of cache hit/miss:

https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2

- Is it worth having a doc that discusses recommended (what does this

mean?) third-party modules like mod_security, mod_php, and so on - the

things that we all assume everyone uses, but some folks might not know

about.

- Clarify which directives only affect requests when they're handled

by the default handler. (e.g. ForceType, TraceEnable, etc.)

- Add examples using expr to mod_rewrite recipes. Possibly benchmark the

different approaches and make intelligent remarks about the

comparative value of each.

- Fix this error message:

Request exceeded the limit of 10 internal redirects due to probable

configuration error. Use 'LimitInternalRecursion' to increase the limit

if necessary. Use 'LogLevel debug' to get a backtrace.

This error message is often returned when a RewriteRUle loops, in

which case setting LimitInternalRecursion won't do anything towards

fixing the problem. However, the error message is already very long.

Thoughts?

- Error codes

Decide how and where to document the error codes (AH****), and then

start on doing it.

- If someone has xslt and LaTeX skills, they could consider getting the

xml->LaTeX->PDF build chain working again. See specifically

https://issues.apache.org/bugzilla/show_bug.cgi?id=45526 for details

of what's broken. For the moment, PDF docs are no longer referenced on

the docs site.

- The "MSIE on Mac" example in the SSI Howto is silly, and needs to be

replaced by something actually useful and relevant in this century.