Code

Tagged 2.7.3
[gosa.git] / 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 Update the class cache:
33 Run "update-gosa" from the GOsa main directory.
35 After this has been done, include settings for GOsa in your apache
36 config:
38 # Set alias to gosa
39 Alias /gosa /usr/share/gosa/html
41 Assumed you've installed PHP >= 5.2.0, reload your apache webserver
42 and do your first GOsa dry run without configuration:
44 http[s]://your-server/gosa
46 GOsa setup will perform some basic system checks about general
47 prerequisites. The setup asks some questions and provides a
48 basic gosa.conf to save in /etc/gosa. Follow the instructions
49 until you're able to log in.
51 You're done. Lets play with the GUI.
53 ---
55 * Installing from Packages
57 If you install GOsa from packages, all the steps from above will
58 be done automatically. Go to the setup:
60 http[s]://your-server/gosa
62 GOsa setup will perform some basic system checks about general
63 prerequisites. The setup asks some questions and provides a
64 basic gosa.conf to save in /etc/gosa. Follow the instructions
65 until you're able to log in.
67 You're done. Lets play with the GUI.
69 ---
71 * Migrating an existing tree
73 To migrate an existing LDAP tree, you've to do all steps from above,
74 plus some modifications:
76 - GOsa only shows users that have the objectClass gosaAccount
77   This one has been introduced for several reasons. First, there are
78   cases you want to hide special accounts from regular admins (i.e.
79   a samba admin account which is used to log windows machines into
80   their domain, where chaning a password by accident has bad consequences).
81   Secondly the gosaAccount keeps the lm/nt password hashes and the
82   attributes for the last password change - with the consequence that
83   adding a samba account "later" will not require the user to reset
84   the password.
86 - GOsa only recognizes subtrees (or departments in GOsa's view of things)
87   that have the objectClass gosaDepartment. You can hide subtrees from GOsa
88   by not putting this objectClass inside.
90 The GOsa setup may be used to do these migrations, but it is not meant
91 to work in every possible circumstance. For the first time:
93 DO NOT WORK ON PRODUCTIVE DATA IF YOU DON'T KNOW WHAT YOU'RE DOING!
95 That should be all. Entries should be visible in GOsa now. Be aware that if
96 your naming policy of user cn's differs from the way GOsa handles it, the
97 entries get rewritten to a GOsa style dn.
99 ---
101 * Further information
103 To improve this piece of software, please report all kind of errors, either
104 using the bug tracker on www.gosa-project.org or the button on the upper
105 right.
107 Documentation: https://www.gosa-project.org
108 Mailinglist:   https://oss.gonicus.de/mailman/listinfo/gosa/
109 Upgrade hints: https://oss.gonicus.de/labs/gosa/wiki/DocumentationInstallingUpdatingGOsa
111 Have fun!
113 ---
114 Cajus Pollmeier <pollmeier@gonicus.de>