- You will need Apache web server
- (it should work with version 1.3 or 2.0, but it's not tested on 2.0)
+ (it should work with version 1.3 or 2.0, but it's not tested with 2.0)
and php version 4.x installed and
configured for docman to work.
related FAQ question
- Get latest version of Document Manager from
-
- http://www.rot13.org/~dpavlin/docman2.html
+
+ http://www.rot13.org/~dpavlin/docman.html
- Go to installation directory (which shouldn't be under your web
server's DocumentRoot) and untar distribution
@@ -16,12 +21,23 @@
cd /home/httpd
tar xvfz docman-2*.tar.gz
+ Make a symlink from current version (2.x) to default directory name
+ docman2
+
+ ln -s docman-2.x docman2
+
If you decide to install docman in some other directory, change
$gblIncDir to that directory in
realm/http_virtual_host.conf!
+
If you don't want to use virtual hosts to separate docman
+ installations on same host, but instead use directory name before
+ docman.php script please read whole installation instructions
+ and than Using script path as realm name
+ to correct all instructions.
- Go to directory which you want to have under Document Manager control
- (this directory also shouldn't be accessable from your web server tree)
+ (this directory also shouldn't be accessible from your web server
+ tree)
cd /home/httpd/repository
@@ -29,6 +45,11 @@
chown nobody /home/httpd/repository
+
+ If you use Debian you will want
+ to use www-data user like this:
+ chown www-data /home/httpd/repository
+
- Make a symlink from that directory to file which will be directory index
ln -s /home/httpd/docman2/docman.php \
@@ -46,13 +67,16 @@
- Copy docman master configuration
file to /etc/docman.conf. If you
- want, you can change location of that file on top of docman.php
+ want, you can change location of that file (so it's not in /etc)
+ on top of docman.php
but that will break automatic cvs update
(see upgrade via CVS)
cp /home/httpd/docman2/docman.conf /etc/docman.conf
- You can also enter values for $fsRealmDir (normally
+ If you haven't installed docman in /home/httpd/docman2 change
+ $gblIncDir to your installation directory.
+
You can also enter values for $fsRealmDir (normally
set to $gblIncDir/realm) there (and to some location
which is not your docman installation).
@@ -74,7 +98,7 @@
to point to /home/httpd/http_virtual_host.
How to do that is beyond scope of this document. Please examine
- Apache documentation.
+ Apache documentation.
If you don't want to use virtual hosts for docman installation, your
realm will be called the same as ServerName.
@@ -91,12 +115,23 @@
DirectoryIndex index.html index.htm index.php
+ Hint!
+
+ You might want to include something like:
+
+ <Directory /home/httpd/http_virtual_host>
+ Options +FollowSymLinks
+ </Directory>
+
+ if you get error "Symbolic link not allowed" in Apache's error.log.
+
- if you don't want to users in SQL database
Go to you web server http://http_virtual_host/ and you should get
- autorization request. If you want to add anonymous access (without
- login and password) skip to trustee section.
+ authorization request. If you want to add
+ anonymous access (without
+ login and password) skip to trustee section.
-
Edit realm/http_virtual_host/.htusers file to add users.
+
Edit realm/http_virtual_host.htusers file to add users.
You can do that by calling adduser.pl script with name of
your htusers file like this:
@@ -104,7 +139,7 @@
$ ./adduser.pl realm/http_virtual_host.conf
If you press just enter for password or enter auth_pop3
- docman will uss e-mail address to connect to pop3 server and check
+ docman will use e-mail address to connect to pop3 server and check
password on it. For that e-mail address must be in following form:
pop3login@pop3server.mydomain
@@ -124,8 +159,8 @@
anymore. This feature is not tested in version 2.0. Look out!
Download php-dbi class from
-
- http://pil.dk/downloads/dbi.tar.gz and
+
+ http://pil.dk/downloads/dbi*.tar.gz and
untar it in docman's directory
cd /home/httpd/docman2
@@ -156,7 +191,7 @@
are credentials for user which connects to database.
- alternative if you want to authorize users based on IP numbers,
- client DNS names of HTTP Referarer header (URL from which they accessed
+ client DNS names of HTTP Referrer header (URL from which they accessed
docman site)
Put $gblUsers = "htusers_header"; in
realm/http_virtual_host.conf and use
@@ -170,9 +205,9 @@
field and valid options in login field.
Valid options for left side of equation (=) in login field are:
remote_addr, remote_hostname or http_referer.
- Valid filed for right side are respective parametars for that option.
+ Valid filed for right side are respective parameters for that option.
- - if you want some combination of above authentification methods
+
- if you want some combination of above auth methods
Put in realm/http_virtual_host.conf:
$gblUsers = "htusers_union"
and uncomment which htusers auth modules you want to use and in which
@@ -180,17 +215,23 @@
be allowed to login (so you can first check http_referer and then
htusers file if you want to).
-
+
- optional, but highly recommended
Trustees are ACL implementation in docman. It's documented in
separate document, and you should use it if your
- users shouldn't have same right to all files under docman controll, or
- if you want to enable anonymous access to repository.
+ users shouldn't have same right to all files under docman control, or
+ if you want to enable anonymous
+ access to repository.
- optional You can create file named .info.inc in
/home/httpd/repository directory for some kind of
motd
- file. You can use html markup in it also!
+ file. You can use html mark-up in it also!
+
+
- optionalIf you decided to use
+ script path as realm name
+ correct all installation files according to
+ this instructions.
- if you want to upload files which are bigger than 2Mb increase
upload_max_filesize to more than 2Mb in php.ini.
@@ -198,7 +239,7 @@
post_max_size also.
- optional Think about configuring your backup software so that
- /home/httpd is backuped automatically.
+ /home/httpd is backup ed automatically.
- optional You can use document manager behind secure http
server (https) simply by installing it. For information take a
@@ -206,6 +247,16 @@
if you are using Apache 1.x or examine configuration options
for Apache 2.x.
+
+
- optional, after you are sure that configuration if correct
+ You can separate administrative messages from errors which are
+ reported to users using
+ $gblSeparateAdminMessages = 1
+ in realm/http_virtual_host.conf. Error messages for you
+ will go to Apache Error log, and (if you also setup
+ $gblMailAdminMessages = 1 to ServerAdmin from
+ apache.conf).
+