Updated for 2.6

git-svn-id: https://oss.gonicus.de/repositories/gosa/trunk@12549 594d385d-05f5-0310-b6e9-bd551577e9d8

diff --git a/gosa-core/DEVEL b/gosa-core/DEVEL
deleted file mode 100644 (file)
index b67c82c..0000000
--- a/gosa-core/DEVEL
+++ /dev/null
@@ -1,131 +0,0 @@
-* How to get plugged in
-
-Lets explain how to create a simple GOsa plugin. The example shows a dummy plugin which is not
-directly related with LDAP. Independently of beeing an LDAP style or LDAP unrelated plugin, you
-may start a new plugin, by creating a new directory below the plugin directory structure. To be up to
-date, get a fresh CVS checkout:
-
-Create a ~/.cvsrc with the following content:
-cvs -z4 -q
-diff -u3 -p
-update -dP
-checkout -P
-
-Change to the directory which will contain your GOsa checkout.
-# cd ~projects
-# export CVSROOT=:pserver:anonymous@cvs.alioth.debian.org:/cvsroot/gosa
-# cvs login
-# cvs co gosa
-
-The gosa directory will contain your initial checkout now. In order to update from CVS
-you simply can call "cvs up". There's no need to set the CVSROOT directory anymore,
-as long as you cal all cvs commands inside the gosa directory and its subdirectories.
-
-Now you've an up to date GOsa. Not that this is CVS HEAD, so there may be something
-broken. Continue by choosing a name and creating the directories:
-
-# cd plugins/addons
-# mkdir dummyplug && cd dummyplug
-
-GOsa expects a file named "main.inc" inside of this plugin directory. It is needed because some
-plugins may need no standard handling and GOsa itself may not know how to initialize the plugin
-classes. Here's our example:
-
----
-<?php
-        /* All page output must be placed inside the display variable. Please do not output anything
-           from within your plugin directly. GOsa will take the display variable after things got processed
-           and assemble the final page after that. */
-
-        /* print_header generates the page header including the headline and the icon, get template
-            path looks for eventually overloaded files. You don't have to take care of this - it's only important
-            for theming artists. Copy the icon (as .png) to the html/images directory, if you don't care about
-            the image, just copy the personal.png to dummy.png. */
-        $display= print_header(get_template_path('images/dummy.png'), _("A nice dummy plugin"));
-
-        /* All plugin objects get stored inside the PHP session. Here we create the object if it doesn't
-            exist yet. It is recreated if "reset" is set. */
-        if (!isset($_SESSION['dummy']) || (isset($_GET['reset']) && $_GET['reset'] == 1)){
-                $_SESSION['dummy']= new dummy ($config);
-        }
-        $dummy= $_SESSION['dummy'];
-
-        /* Execute plugin. This calls your plugin class and appends its output to the display variable. */
-        $display.= $dummy->execute ();
-
-        /* The ignore field controls if GOsa should ignore the users tries to leave the plugin without
-           saving. For the dummy plugin, you can leave all the time without loosing data. */
-        $display.= "<input type=\"hidden\" name=\"ignore\">\n";
-
-        /* After executing the plugin, some data may have changed, so we need to put the plugin back
-           to the session. */
-        $_SESSION['export']= $export;
-?>
----
-
-The basic starter for your plugin is ready now. We're missing the plugin itself currently. To create it,
-you need to create a file starting with class_ and ending with .inc. These files get sourced automatically.
-
-Here's the class_dummy.inc:
-
----
-<?php
-
-/* Create a class (name must be unique inside GOsa) which extends plugin. The plugin base
-    class contains all methods that are used by GOsa and it provides the mechanism to load data
-    from LDAP to local variables and prepare the save to ldap routine for you. */
-class dummy extends plugin
-{
-
-  /* These contain attributes to be loaded. We're not doing an LDAP plugin currently, so we don't
-     care... */
-  var $attributes= array();
-  var $objectclasses= array();
-
-  /* The constructor just saves a copy of the config. You may add what ever you need. */
-  function dummy ($config, $dn= NULL)
-  {
-        /* Include config object */
-        $this->config= $config;
-  }
-
-  /* Execute is the function all plugins need. It fills the plugin with life and produces the output. */
-  function execute()
-  {
-        /* Use the smarty templating engine here... */
-        $smarty= get_smarty();
-
-        /* Normally you would react to user input here. */
-
-        /* Let smarty fetch and process the page. Always seperate PHP and HTML as much as
-           you can. */
-        return ($smarty->fetch (get_template_path('contents.tpl', TRUE)));
-  }
-
-}
-?>
----
-
-There are two things missing now. The template file and an entry in your gosa.conf. Lets finish the
-work in the plugin directory, first.
-
-Here is the contents.tpl file:
-
----
-<p>
-  {t}This is a dummy plugin. It really does nothing. The tags around this text do automatic translations to the desired language. Please don't include linefeeds here, or it will not work at all!{/t}
-</p>
-
-<p class="plugbottom">
-  &nbsp;
-</p>
----
-
-Now add the following entry to your Addons section in gosa.conf:
---
-                        <plugin acl="dummy" class="dummy" icon="dummy.png"
-                                path="plugins/addons/dummy" />
---
-
-After logging into GOsa, you'll see your plugin in the addons section.
-

diff --git a/gosa-core/INSTALL b/gosa-core/INSTALL
index be4ef51a2f9e2bb9a19baefd7de8f3e7bbd9b08f..3526399304f450242d99bd9d2252485496f525b9 100644 (file)
--- a/gosa-core/INSTALL
+++ b/gosa-core/INSTALL
@@ -1,7 +1,14 @@
-GOsa2.1 QUICK INSTALL
-=====================
+GOsa 2.6 QUICK INSTALL
+======================
 
-* Installing GOsa
+Prequisite:
+
+You have a system up and running. It has apache and PHP installed
+and there is a blank (or prefilled) but working LDAP available.
+
+---
+
+Installing GOsa from source:
 
 Unpack the GOsa tarball and move the main gosa directory to
 a place your webserver is configured to find it. The default
@@ -27,45 +34,35 @@ config:
 # Set alias to gosa
 Alias /gosa /usr/share/gosa/html
 
-Assumed you've installed PHP >= 4.1.0, restart your apache webserver
+Assumed you've installed PHP >= 5.2.0, reload your apache webserver
 and do your first GOsa dry run without configuration:
 
-http[s]://your-server/gosa/setup.php
+http[s]://your-server/gosa
+
+GOsa setup will perform some basic system checks about general
+prerequisites. The setup asks some questions and provides a
+basic gosa.conf to save in /etc/gosa. Follow the instructions
+until you're able to log in.
+
+You're done. Lets play with the GUI.
+
+---
+
+* Installing from Packages
+
+If you install GOsa from packages, all the steps from above will
+be done automatically. Go to the setup:
+
+http[s]://your-server/gosa
 
 GOsa setup will perform some basic system checks about general
 prerequisites. The setup asks some questions and provides a
 basic gosa.conf to save in /etc/gosa. Follow the instructions
 until you're able to log in.
 
-As a final step - which is not done automatically yet, you've to
-create a group which members will be GOsa administrators. Here's
-an example ldif which creates a user named "admin" with the password
-"tester" and a group where this user is in:
-
-dn: cn=admin,ou=people,dc=example,dc=net
-objectClass: person
-objectClass: organizationalPerson
-objectClass: inetOrgPerson
-objectClass: gosaAccount
-uid: admin
-cn: admin
-givenName: admin
-sn: GOsa main administrator
-lmPassword: 10974C6EFC0AEE1917306D272A9441BB
-ntPassword: 38F3951141D0F71A039CFA9D1EC06378
-userPassword:: dGVzdGVy
-
-dn: cn=administrators,ou=groups,dc=example,dc=net
-objectClass: gosaObject
-objectClass: posixGroup
-gosaSubtreeACL: :all
-cn: administrators
-gidNumber: 999
-memberUid: admin
-
-After adding these entries, you should be able to use GOsa. Log in as
-admin and try experiment with the GUI.
+You're done. Lets play with the GUI.
 
+---
 
 * Migrating an existing tree
 
@@ -86,24 +83,27 @@ plus some modifications:
   that have the objectClass gosaDepartment. You can hide subtrees from GOsa
   by not putting this objectClass inside.
 
-- You need at least one group with objectClass gosaObject and attribute
-  gosaSubtreeACL set to :all in the base of your tree. All members of this
-  group are able to change everything in GOsa. Look at the cn=administrators
-  from above.
+The GOsa setup may be used to do these migrations, but it is not meant
+to work in every possible circumstance. For the first time:
+
+DO NOT WORK ON PRODUCTIVE DATA IF YOU DON'T KNOW WHAT YOU'RE DOING!
 
 That should be all. Entries should be visible in GOsa now. Be aware that if
 your naming policy of user cn's differs from the way GOsa handles it, the
 entries get rewritten to a GOsa style dn.
 
+---
 
-* More informations
+* Further information
 
-To improve this piece of software, please report all kind of errors.
-Looking for a mailing list? Go to
+To improve this piece of software, please report all kind of errors, either
+using the bug tracker on www.gosa-project.org or the button on the upper
+right.
 
-https://oss.gonicus.de/mailman/listinfo/gosa/
+Documentation: https://www.gosa-project.org
+Mailinglist:   https://oss.gonicus.de/mailman/listinfo/gosa/
 
-Thanks
+Have fun!
 
 ---
 Cajus Pollmeier <pollmeier@gonicus.de>