| 1 |
<h1>Directory layout</h1> |
| 2 |
|
| 3 |
<p> |
| 4 |
Yes, docman's directory layout has changed. A lot. For impatient, please go to |
| 5 |
<a href="upgrade.html">upgrade</a> documentation. This document is overview |
| 6 |
how new directories should be located (relative to web server) and why. |
| 7 |
</p> |
| 8 |
|
| 9 |
<p>If you are in hurry, you can just skip parts which are written |
| 10 |
in <i>italic</i>. But, re-read them because they contain useful |
| 11 |
informations. |
| 12 |
</p> |
| 13 |
|
| 14 |
<p> |
| 15 |
There are several types of directories in docman: |
| 16 |
|
| 17 |
<ol> |
| 18 |
<a name="DocumentRoot"> |
| 19 |
<li>Apache DocumentRoot directory |
| 20 |
<br> |
| 21 |
This directory keeps just files which should be directly accessible by |
| 22 |
your web server. It should have just <tt>index.php</tt> which |
| 23 |
is symlink or hard-link to <tt>docman.php</tt>. |
| 24 |
|
| 25 |
<a name="repository"> |
| 26 |
<li>Repository Directory |
| 27 |
<br> |
| 28 |
<b>Not accessible by web server, but writable by it</b>. This is directory |
| 29 |
in which uploaded documents will be stored (along with notes, changelog, |
| 30 |
locks and so on). <i>You can think of this directory as old root directory |
| 31 |
of docman v1.x</i>. Nothing from this directory won't be executed by |
| 32 |
docman or web server for security reasons. <i>This means that you will have |
| 33 |
to move your include_php files, htusers and configuration files to somewhere |
| 34 |
if you are upgrading from docman v1.x installation</i> |
| 35 |
<br><small><a href="#go_repository">more about repository</small> |
| 36 |
|
| 37 |
<a name="realm"> |
| 38 |
<li><tt>realm</tt> Directory under <a href="#docman">docman's directory</a> |
| 39 |
structure |
| 40 |
<br> |
| 41 |
This directory stores configuration file, users file and |
| 42 |
<a href="trustee.html">trustee</a> file |
| 43 |
for one realm of your docman installation. <i>Realm is one authorization |
| 44 |
domain, usually one virtual host in apache under which user can surf without |
| 45 |
need to re-enter his username or password.</i> |
| 46 |
|
| 47 |
</ol> |
| 48 |
|
| 49 |
<hr> |
| 50 |
|
| 51 |
<a name="docman"> |
| 52 |
<h2>Docman's Distribution Directory structure</h2> |
| 53 |
|
| 54 |
<big>FIX</big> |
| 55 |
|
| 56 |
<a name="go_repository"> |
| 57 |
<h2>Repository Directory</h2> |
| 58 |
|
| 59 |
There are following files (aside from documents which your users upload |
| 60 |
to docman): |
| 61 |
|
| 62 |
<table border=0> |
| 63 |
<tr><th colspan=2>root of repository</th><tr> |
| 64 |
<tr><td><tt>.changelog</tt></td> |
| 65 |
<td>changes of files under docman management</td><tr> |
| 66 |
<tr><td><tt>.htusers</tt></td> |
| 67 |
<td>file with users</tr></tr> |
| 68 |
<tr><td><tt>.info.inc</tt></td> |
| 69 |
<td><i>optional</i> file with MOTD which is included in interface</tr></tr> |
| 70 |
<tr><th colspan=2>in each directory under docman management <small>(all are optional and may be missing)</small></th><tr> |
| 71 |
<tr><td><tt>.bak/</tt></td><td>directory for backup copies of files</td></tr> |
| 72 |
<tr><td><tt>.del/</tt></td><td>directory with deleted files</td></tr> |
| 73 |
<tr><td><tt>.lock/</tt></td><td>directory with lock informations</td></tr> |
| 74 |
<tr><td><tt>.log/</tt></td><td>directory with changelogs for each file</td></tr> |
| 75 |
<tr><td><tt>.note/</tt></td><td>directory with notes for files</td></tr> |
| 76 |
<tr><th colspan=2>in realm directory (docman2/realm)</th><tr> |
| 77 |
<tr><td><tt>http_virtual_host.conf</tt></td><td>configuration file for this realm</td></tr> |
| 78 |
<tr><td><tt>http_virtual_host.htusers</tt></td><td>htusers file for this realm</td></tr> |
| 79 |
<tr><td><tt>http_virtual_host.trustee</tt></td><td>trustee file for this realm</td></tr> |
| 80 |
<tr><th colspan=2>in realm directory (docman2/realm/http_host/script_path) <small>(if using <a href="admin.html#path_realm">path to script as realm</a>)</small></th><tr> |
| 81 |
<tr><td><tt>conf</tt></td><td>configuration file for this realm</td></tr> |
| 82 |
<tr><td><tt>htusers</tt></td><td>htusers file for this realm</td></tr> |
| 83 |
<tr><td><tt>trustee</tt></td><td>trustee file for this realm</td></tr> |
| 84 |
<tr><td><tt>include_php_file.php</tt></td><td><i>optional</i> file for include (<tt>docman.php?A=I&F=include_php_file</tt>)</td></tr> |
| 85 |
</table> |
Parent Directory
| 
Revision Log