/[docman]/admin.txt
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Annotation of /admin.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (hide annotations)
Wed Jun 20 12:11:25 2001 UTC (21 years, 7 months ago) by dpavlin
Branch: MAIN
Changes since 1.3: +48 -4 lines
File MIME type: text/plain
documentation for users in SQL database

1 dpavlin 1.1 Document Manager Administration manual
2    
3    
4     INSTALATION INSTRUCTIONS
5     ------------------------
6    
7     1. get latest version of Document Manager from
8     http://www.rot13.org/~dpavlin/docman.html
9    
10     2. go to installation directory (which doesn't have to be under your web
11     server) and untar distribution
12    
13     cd /home/httpd/docman
14     tar xvfz docman-*.tar.gz
15    
16     If you decide to install docman in some other directory, change
17     $gblIncDir to that directory in docman.php!
18    
19     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)
21    
22     cd /home/httpd/html
23    
24     chmod that directory so that web server can write in it.
25    
26     chown nobody /home/httpd/html
27    
28     4. make a symlink from that directory to file which will be directory index
29    
30     ln -s /home/httpd/docman/docman.php /home/httpd/html/.index.php
31    
32     5. add new DirectoryIndex entry to your apache configuration file. If your
33     apache has config files in /etc/httpd/conf/httpd.conf find a line
34     like
35    
36     DirectoryIndex index.html index.htm
37    
38     and add .index.php at the end.
39    
40     DirectoryIndex index.html index.htm .index.php
41    
42     It is important that new directory index file begins with dot -- that
43     ensures that files won't be visible from Directory Manager interface.
44    
45 dpavlin 1.4 6. (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
47     .htusers in same directory in which is .index.php
48 dpavlin 1.1
49 dpavlin 1.4 edit .htusers file to add users. You can do that by calling adduser.pl
50 dpavlin 1.1 script. If you press just enter for password or enter auth_pop3
51     docman will user e-mail address to connect to pop3 server and check
52     password on it. For that e-mail address must be in following form:
53    
54     pop3login@pop3server.mydomain
55    
56     E-mail addresses are not used for anything else right now, so it's safe
57     to enter invalid e-mail address it that's valid pop3 account. But, that
58     WILL change, so you are warned!
59    
60 dpavlin 1.4 7. (alternative to 6 if your users are in SQL database) change $gblUsers
61     in .docman.conf to $gblUsers = "htusers_sql";
62    
63     Download php-dbi class from http://pil.dk/downloads/dbi.tar.gz and
64     untar it in docman's directory
65    
66     cd /home/html/docman
67     tar xvfz dbi.tar.gz
68    
69     Construct SQL query which returns login, full name, password and
70     email from your tables(s). If you don't have some of that data, replace
71     them with literal strings.
72    
73     e.g. if your table is called my_users with columns who in which
74     is login and column pw in which is plain text password you
75     can use following query to get requested format:
76     select who,'Auth user',pw,'nobody@com' from my_users
77    
78     Enter that SQL query under $dbi_sql in .docman.conf
79    
80     Construct $dbi in .docman.conf in following format:
81    
82     $dbi = "driver:database:user:password"
83    
84     driver can be: pgsql, mysql, oracle or odbc (as supported by php-dbi),
85     database is name of database in which are your users and user/password
86     is credentials for user which connects to database
87    
88 dpavlin 1.1 8. (optional) You can create file named .info.inc in /home/httpd/html
89     directory for some kind of motd file. You can use html markup in it
90     also!
91    
92 dpavlin 1.3 9. (optional) Copy docman.conf into /home/httpd/html/.docman.conf and
93     edit values which override default values in docman.php
94    
95     10. if you want to upload files which are bigger than 2Mb increase
96 dpavlin 1.2 upload_max_filesize to more than 2Mb in php.ini. If you still get
97     errors on files bigger than 8Mb increase post_max_size also.
98    
99 dpavlin 1.3 You are ready to go.
100 dpavlin 1.1
101    
102     DIRECTORY AND FILE STRUCTURE
103     ----------------------------
104    
105     Breakout of files in /home/httpd/docman/:
106    
107     docman.php - main docman php file (to be installed as DirectoryIndex)
108 dpavlin 1.4
109     docman.conf - configuration file which will be copied in document
110     root of site
111    
112 dpavlin 1.1 auth_pop3.php - authorization module ($gblIncDir in docman.php must point
113     to location of this file)
114    
115 dpavlin 1.4 htusers_file.php - module for access to users in .htusers files
116     htusers_sql.php - module for access to users which are in SQL database
117    
118 dpavlin 1.1 adduser.pl - perl script for adding of users (you can also add users
119     manually by editing .htusers file)
120    
121     docman.txt - user documentation
122     admin.txt - administrator's documentation
123    
124 dpavlin 1.4 contrib/ - directory with optional usefull scripts
125    
126     dbi/ - optional directory for dbi classes is users are stored
127     in SQL database, it will be created after unpacking of
128     http://pil.dk/downloads/dbi.tar.gz
129    
130     Breakout of files in /home/httpd/html/ (root directory of site under docman
131     management):
132 dpavlin 1.1
133     .changelog - changes of files under docman management
134     .htusers - file with users
135     .info.inc - file with MOTD which is included in interface
136 dpavlin 1.4 .docman.conf - configuration file for this site
137 dpavlin 1.1
138     Files in each directory under docman management (some of them may be missing,
139     they will be created automatically):
140    
141     .bak/ - directory for backup copies of files
142     .del/ - directory with deleted files
143     .lock/ - directory with lock informations
144     .log/ - directory with changelogs for each file
145     .note/ - directory with notes for files
146    
147    
148     MISC
149     ----
150    
151     You can use document manager behind secure http server (https) simply by
152     installing it. For information take a look at http://www.modssl.org
153    

  ViewVC Help
Powered by ViewVC 1.1.26