1 |
Document Manager Administration manual |
Document Manager Administration manual |
2 |
|
|
3 |
|
|
4 |
INSTALATION INSTRUCTIONS |
INSTALLATION INSTRUCTIONS |
5 |
------------------------ |
------------------------- |
6 |
|
|
7 |
1. get latest version of Document Manager from |
1. get latest version of Document Manager from |
8 |
https://www.rot13.org/~dpavlin/docman.html |
https://www.rot13.org/~dpavlin/docman.html |
9 |
|
|
10 |
2. go to installation directory (which doesn't have to be under your web |
2. go to installation directory (which doesn't have to be under your web |
11 |
server) and untar distribution |
server) and un-tar distribution |
12 |
|
|
13 |
cd /home/httpd/docman |
cd /home/httpd/docman |
14 |
tar xvfz docman-*.tar.gz |
tar xvfz docman-*.tar.gz |
17 |
$gblIncDir to that directory in docman.php! |
$gblIncDir to that directory in docman.php! |
18 |
|
|
19 |
3. go to directory which you want to have under Document Manager control |
3. go to directory which you want to have under Document Manager control |
20 |
(this directory needs to be accessable from your web server tree) |
(this directory needs to be accessible from your web server tree) |
21 |
|
|
22 |
cd /home/httpd/html |
cd /home/httpd/html |
23 |
|
|
42 |
It is important that new directory index file begins with dot -- that |
It is important that new directory index file begins with dot -- that |
43 |
ensures that files won't be visible from Directory Manager interface. |
ensures that files won't be visible from Directory Manager interface. |
44 |
|
|
45 |
6. (if you don't want to users in SQL database) Go to you web server and |
6a. (if you don't want to users in SQL database) Go to you web server and |
46 |
check if you got autorization request. If you did, you also have |
check if you got authorization request. If you did, you also have |
47 |
.htusers in same directory in which is .index.php |
.htusers in same directory in which is .index.php |
48 |
|
|
49 |
edit .htusers file to add users. You can do that by calling adduser.pl |
edit .htusers file to add users. You can do that by calling adduser.pl |
57 |
to enter invalid e-mail address it that's valid pop3 account. But, that |
to enter invalid e-mail address it that's valid pop3 account. But, that |
58 |
WILL change, so you are warned! |
WILL change, so you are warned! |
59 |
|
|
60 |
7. (alternative to 6 if your users are in SQL database) change $gblUsers |
6b. (alternative to 6a if your users are in SQL database) change $gblUsers |
61 |
in .docman.conf to $gblUsers = "htusers_sql"; |
in .docman.conf to $gblUsers = "htusers_sql"; |
62 |
|
|
63 |
Download php-dbi class from http://pil.dk/downloads/dbi.tar.gz and |
Download php-dbi class from http://pil.dk/downloads/dbi.tar.gz and |
85 |
database is name of database in which are your users and user/password |
database is name of database in which are your users and user/password |
86 |
is credentials for user which connects to database |
is credentials for user which connects to database |
87 |
|
|
88 |
8. (optional) You can create file named .info.inc in /home/httpd/html |
6c. (alternative to 6b you want to authorize users based on IP numbers, |
89 |
directory for some kind of motd file. You can use html markup in it |
client DNS names of HTTP Referrer header (URI from which they accessed |
90 |
|
docman site). Put $gblUsers = "htusers_header"; in .docman.conf use |
91 |
|
following form in your .htusers file: |
92 |
|
|
93 |
|
REMOTE_ADDR=10.0.0.3:Full name:auth_header:e-mail@foo.bar |
94 |
|
remote_hostname=myworkstation:Full name:auth_header:e-mail@foo.bar |
95 |
|
http_referer=test.foo.bar:Full name:auth_header:e-mail@foo.bar |
96 |
|
|
97 |
|
Please note that you *have to* put "auth_header" in password field |
98 |
|
and that valid options for left side of = in login field are: |
99 |
|
remote_addr, remote_hostname or http_referer. |
100 |
|
|
101 |
|
6d. (if you want some combination of 6a, 6b and/or 6c) put in .docman.conf |
102 |
|
$gblUsers = "htusers_union" and uncomment which htusers auth modules |
103 |
|
you want to use and in which order |
104 |
|
|
105 |
|
7. (optional) You can create file named .info.inc in /home/httpd/html |
106 |
|
directory for some kind of motd file. You can use html mark-up in it |
107 |
also! |
also! |
108 |
|
|
109 |
9. (optional) Copy docman.conf into /home/httpd/html/.docman.conf and |
8. (optional) Copy docman.conf into /home/httpd/html/.docman.conf and |
110 |
edit values which override default values in docman.php |
edit values which override default values in docman.php |
111 |
|
|
112 |
10. if you want to upload files which are bigger than 2Mb increase |
9. if you want to upload files which are bigger than 2Mb increase |
113 |
upload_max_filesize to more than 2Mb in php.ini. If you still get |
upload_max_filesize to more than 2Mb in php.ini. If you still get |
114 |
errors on files bigger than 8Mb increase post_max_size also. |
errors on files bigger than 8Mb increase post_max_size also. |
115 |
|
|
119 |
DIRECTORY AND FILE STRUCTURE |
DIRECTORY AND FILE STRUCTURE |
120 |
---------------------------- |
---------------------------- |
121 |
|
|
122 |
Breakout of files in /home/httpd/docman/: |
Break-out of files in /home/httpd/docman/: |
123 |
|
|
124 |
docman.php - main docman php file (to be installed as DirectoryIndex) |
docman.php - main docman php file (to be installed as DirectoryIndex) |
125 |
|
|
138 |
docman.txt - user documentation |
docman.txt - user documentation |
139 |
admin.txt - administrator's documentation |
admin.txt - administrator's documentation |
140 |
|
|
141 |
contrib/ - directory with optional usefull scripts |
contrib/ - directory with optional useful scripts |
142 |
|
|
143 |
dbi/ - optional directory for dbi classes is users are stored |
dbi/ - optional directory for dbi classes is users are stored |
144 |
in SQL database, it will be created after unpacking of |
in SQL database, it will be created after unpacking of |
145 |
http://pil.dk/downloads/dbi.tar.gz |
http://pil.dk/downloads/dbi.tar.gz |
146 |
|
|
147 |
Breakout of files in /home/httpd/html/ (root directory of site under docman |
Break-out of files in /home/httpd/html/ (root directory of site under docman |
148 |
management): |
management): |
149 |
|
|
150 |
.changelog - changes of files under docman management |
.changelog - changes of files under docman management |
158 |
.bak/ - directory for backup copies of files |
.bak/ - directory for backup copies of files |
159 |
.del/ - directory with deleted files |
.del/ - directory with deleted files |
160 |
.lock/ - directory with lock informations |
.lock/ - directory with lock informations |
161 |
.log/ - directory with changelogs for each file |
.log/ - directory with change-logs for each file |
162 |
.note/ - directory with notes for files |
.note/ - directory with notes for files |
163 |
|
|
164 |
|
|
168 |
You can use document manager behind secure http server (https) simply by |
You can use document manager behind secure http server (https) simply by |
169 |
installing it. For information take a look at http://www.modssl.org |
installing it. For information take a look at http://www.modssl.org |
170 |
|
|
171 |
|
|
172 |
|
HTUSERS FILE FORMAT |
173 |
|
------------------- |
174 |
|
|
175 |
|
.htusers file used by docman doesn't have same format as .htusers file used |
176 |
|
by web server. That's because docman's file have more information about |
177 |
|
user (include full name and e-mail address). Format of file is: |
178 |
|
|
179 |
|
# comment |
180 |
|
login:Full Name:password:email@domain.com |
181 |
|
|
182 |
|
for password, I use md5 sum of login and password appended together. So, If |
183 |
|
you want to create password and your login is 'foo' and password 'bar' you |
184 |
|
have following entry: |
185 |
|
|
186 |
|
foo:Foo Bar:3858f62230ac3c915f300c664312c63f:foo@bar.com |
187 |
|
|
188 |
|
Different htuser_* and auth_* modules can (and they actually do) re-use |
189 |
|
login, password and e-mail fields for it's own purpose. |
190 |
|
|