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

0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan HuntFor more information on how to contribute to the Apache Documentation

0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark AndrewsProject, please see http://httpd.apache.org/docs-project/ and

0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt ------------------------------

2eeb74d1cf5355dd98f6d507a10086e16bb08c4bTinderbox User

14a656f94b1fd0ababd84a772228dfa52276ba15Evan HuntTo Do List

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt=======================

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt

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

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt ProxyHTMLMeta (mod_proxy_html)

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt SSLPKCS7CertificateFile (mod_ssl)

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt- Update the http://httpd.apache.org/docs-project/docsformat.html

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt document to be useful. In particular:

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - Document the translation process.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - Generally update it to make it reflect the current reality of how

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt we work.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - Improving the documentation of the documentations' build system

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt itself (requirements, procedures)

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt- Continue to enhance the FAQ, which is in the wiki:

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt http://wiki.apache.org/httpd/FAQ

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt- Security docs are unhelpful, and assume that the reader knows nothing.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt Need something a little more advanced, which either discusses

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt even sure what to say needs done. Can we get someone to elaborate on

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt what, exactly, needs written? Ivan Ristic has said maybe he would be

bd5842db3d1e40909d401c958c735f88fb846fb9Automatic Updater willing to contribute.

4fc2b43e69da6bb3e1c6fa31ac14bb031a266a61Automatic Updater - More content and better organisation

938440694b33cd752e9e4b71a526368b4811c177Tinderbox User - mod_dav resources are owned by the httpd. Perhaps write up the

19c7b1a0293498a3e36692c59646ed6e15ffc8d0Tinderbox User two-httpd dav setup covered in Rich Bowen's DAV Apachecon

0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews presentation.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt- Performance doc "drop-in replace" wikified by Igor from Sander's

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt presentation: http://wiki.apache.org/httpd/PerformanceScalingUp

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt They both need review and updates to reflect the current state

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt of the art.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt- Windows platform docs are in desperate need of rewrites/updates for 2.x.

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - Bill Rowe is a good contact for tech questions.

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - "using apache" has been done, "compiling apache" is still open

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - hints on uninstalling apache (exit monitor, close directories,

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt registry entries etc) (PR 10154)

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - FAQ: UTF-8 config and URL encoding for non-ascii characters.

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt

30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews- New Auth system

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt exactly what needs cleaned up and enhanced?)

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews - Independent note on how to upgrade to new auth system

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews - Discussion of DBD auth, and, in particular, examples of how to set

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews up auth using each of the supported databases.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt- Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt Start is in expr.xml, igalic is working on this

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt

30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews- modules docs

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - the following modules added since 2.2 lack documentation

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews - mod_serf

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews - mpm_simple

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews the list may be incomplete

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews maybe some of the modules will not be included in 2.4

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews - mod_suexec: very little documentation

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews- mod_substitute and reverse proxies: Add example using mod_filter

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews

3ec79bbc03fc5378a6cb37b276807cd40b5332aaMark Andrews- MPM documentation

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - explain what the following command line options do

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt (perhaps in the developer/debugging docs):

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt -D DEBUG

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt -D ONE_PROCESS -- is this the same as -X, if not, should it be?

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt one-process-mode == no threads, i.e. only one

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt process handling the requests in a single loop?

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt- Identify which documents are grossly out of date, and fix.

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - SSL docs need serious update and enhancement

f81e8340fc807b15828332c0dc18dd3132bd7cd1Mark Andrews - compat docs are wrong

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - A basic how to has been started here:

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt http://wiki.apache.org/httpd/SettingUpModSSL

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt but it needs some work...

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt looks like a good starting point for overhauling the FAQ, and

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt has been placed at our disposal by the author.

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt- API documentation

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt - Ben Laurie has written some hooks documentation

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - authn provider API documentation could be useful

30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt- Missing documentation for the support program checkgid

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

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

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt (draft available in wiki)

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt- Enhancements to the DTD/XSL:

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - New index: directives by context, including listing which directives

ca42dcc0686fefd3db202edab80e5adb09d6add5Evan Hunt are available for each AllowOverride setting.

14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - 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

- Writing modules - Can we provide a basic intro to writing modules,

perhaps based around mod_example, or one of the other simple example

modules?

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

profound embarrassment.

- Purge all the dead links

- Introductory module authoring doc

- 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.