Code

Fix regression in #4271
[gosa.git] / trunk / gosa-core / INSTALL
1 GOsa 2.6 QUICK INSTALL
2 ======================
4 Prequisite:
6 You have a system up and running. It has apache and PHP installed
7 and there is a blank (or prefilled) but working LDAP available.
9 ---
11 Installing GOsa from source:
13 Unpack the GOsa tarball and move the main gosa directory to
14 a place your webserver is configured to find it. The default
15 location will be /usr/share/gosa. For later reference, I assume
16 that you've choosen this path, too.
18 Create the directory /var/spool/gosa for the smarty compile directory.
19 Make it read/write for the webserver (additional chmod 770). You may
20 want to move it elsewhere, configure it in gosa.conf.
22 Create the configuration directory /etc/gosa and make sure
23 that your webserver can read it.
25 As a summmary, you now have these directories for GOsa:
27 /etc/gosa
28 /var/spool/gosa
29 /usr/share/gosa
31 After this has been done, include settings for GOsa in your apache
32 config:
34 # Set alias to gosa
35 Alias /gosa /usr/share/gosa/html
37 Assumed you've installed PHP >= 5.2.0, reload your apache webserver
38 and do your first GOsa dry run without configuration:
40 http[s]://your-server/gosa
42 GOsa setup will perform some basic system checks about general
43 prerequisites. The setup asks some questions and provides a
44 basic gosa.conf to save in /etc/gosa. Follow the instructions
45 until you're able to log in.
47 You're done. Lets play with the GUI.
49 ---
51 * Installing from Packages
53 If you install GOsa from packages, all the steps from above will
54 be done automatically. Go to the setup:
56 http[s]://your-server/gosa
58 GOsa setup will perform some basic system checks about general
59 prerequisites. The setup asks some questions and provides a
60 basic gosa.conf to save in /etc/gosa. Follow the instructions
61 until you're able to log in.
63 You're done. Lets play with the GUI.
65 ---
67 * Migrating an existing tree
69 To migrate an existing LDAP tree, you've to do all steps from above,
70 plus some modifications:
72 - GOsa only shows users that have the objectClass gosaAccount
73   This one has been introduced for several reasons. First, there are
74   cases you want to hide special accounts from regular admins (i.e.
75   a samba admin account which is used to log windows machines into
76   their domain, where chaning a password by accident has bad consequences).
77   Secondly the gosaAccount keeps the lm/nt password hashes and the
78   attributes for the last password change - with the consequence that
79   adding a samba account "later" will not require the user to reset
80   the password.
82 - GOsa only recognizes subtrees (or departments in GOsa's view of things)
83   that have the objectClass gosaDepartment. You can hide subtrees from GOsa
84   by not putting this objectClass inside.
86 The GOsa setup may be used to do these migrations, but it is not meant
87 to work in every possible circumstance. For the first time:
89 DO NOT WORK ON PRODUCTIVE DATA IF YOU DON'T KNOW WHAT YOU'RE DOING!
91 That should be all. Entries should be visible in GOsa now. Be aware that if
92 your naming policy of user cn's differs from the way GOsa handles it, the
93 entries get rewritten to a GOsa style dn.
95 ---
97 * Further information
99 To improve this piece of software, please report all kind of errors, either
100 using the bug tracker on www.gosa-project.org or the button on the upper
101 right.
103 Documentation: https://www.gosa-project.org
104 Mailinglist:   https://oss.gonicus.de/mailman/listinfo/gosa/
106 Have fun!
108 ---
109 Cajus Pollmeier <pollmeier@gonicus.de>