summaryrefslogtreecommitdiff
path: root/doc/INSTALL
blob: 8c9c18592b38c63306616cb22851c117bfd86a47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
= Kolab WAP Requirements =

1. PHP >= 5.3 with specified settings:
    - session.auto_start = Off
1.1. PHP extensions:
    - mysql
    - mbstring
    - ldap
2. MySQL database
3. Smarty 3.x
4. PEAR packages:
    - Mail
    - HTTP_Request2
    - Net_URL2
    - Net_SMTP
    - Net_LDAP3 (http://git.kolab.org/pear/Net_LDAP3/)


= Kolab WAP Installation Instructions =

- Put the contents of this directory somewhere you can visit with a browser.

- Edit public_html/.htaccess to your needs. An example (for
  http://admin.klab.cc/~vanmeeuwen/kolab-wap/public_html/.htaccess) is as
  follows:

<IfModule mod_rewrite.c>
    RewriteEngine on
    # NOTE: This needs to point to the base uri of your installation.
    RewriteBase /~vanmeeuwen/kolab-wap/public_html

    # Rewrite URLs of the form 'x' to the form 'index.php?q=x'.
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_URI} !=/favicon.ico
    RewriteRule ^api/(.*)\.(.*)$ api/index.php?service=$1&method=$2 [L,QSA]

</IfModule>
AddDefaultCharset   UTF-8
php_value error_reporting      6135

- Include in /etc/kolab/kolab.conf:

[kolab_wap]
; Database URI
sql_uri = mysql://kolab_wap:*****@mysql.klab.cc/kolab_wap
; URI to the API location, if not default. Example URI included
;api_url = http://admin.klab.cc/~vanmeeuwen/kolab-wap/public_html/api/
skin = default

  NOTE: You need to create the user and database on the MySQL server, perhaps
  like so:

  # mysql -e "CREATE DATABASE kolab_wap;"
  # mysql -e "GRANT ALL PRIVILEGES on kolab_wap.* to 'kolab_wap'@'admin.klab.cc'
  > IDENTIFIED BY '*****';"
  # mysql -e "FLUSH PRIVILEGES;"

- Also include in /etc/kolab/kolab.conf the following settings:

[ldap]
auth_attrs = uid, mail, [mailalternateaddress|alias]
; For 389 Directory Server
unique_attribute = nsuniqueid
; For OpenLDAP
unique_attribute = entrydn

  For a complete sample configuration file, please see:

    doc/sample-kolab.conf

- Make /etc/kolab/kolab.conf readable for the apache group, for example:

# chown kolab-n kolab-n /etc/kolab/kolab.conf
# gpasswd -a apache kolab-n

- Initialize the kolab_wap database. For an example SQL file, please see:

    doc/kolab_wap-*.sql

  If you wanted to play with alternate types / attribute settings, please see
  the following locations for sample PHP code you could use to insert your own
  user_types, group_types and options;

    doc/sample-insert-group_types.php
    doc/sample-insert-options.php
    doc/sample-insert-user_types.php

  Save these to the kolab-wap root directory (next to the lib/ and public_html/
  directories) as the *.php equivalent of these *.phps counterparts, and execute
  them from the command-line.

- You *should* now be ready to login. Please note that;

  - The login dialog currently allows only a full DN, or a value of the mail
    attribute of any LDAP object in the tree under the domain root dn.

    See: https://issues.kolab.org/show_bug.cgi?id=594

  - No effective rights to LDAP in general or LDAP objects in particular
    currently propagate to the client UI properly. I.e., a regular user will be
    presented with the opportunity to "Add a user", but can't. The Web Admin and
    API are designed to always use the user's bind credentials.

    See: https://issues.kolab.org/show_bug.cgi?id=661