Changeset 1906

Timestamp:

11/10/04 23:35:23 (20 years ago)

Author:

jalet

Message:

Changes to the installation documentation

Location:

pykota/trunk

Files:

• docs/installation.sgml (modified) (8 diffs)
• README (modified) (1 diff)

pykota/trunk/docs/installation.sgml

@@ -181 +181 @@
 pykota=#       
         </screen>
+        <note>
+          <title>Note</title>
+          <para>
+            If you use RPM or DEB packages, usually the
+            <filename>pykota-postgresql.sql</filename> file gets installed into the
+            <filename>/usr/share/pykota/postgresql</filename> directory, along 
+            with a README file.
+          </para>
+        </note>  
       </para>
       
@@ -246 +255 @@
     
     <sect2>
-      <title>OpenLDAP</title>
-      
-      <para>
-        From version 1.09 on, <application>OpenLDAP</application> can be used as a Quota Storage Backend.
+      <title>LDAP</title>
+      
+      <para>
+        Any <acronym>LDAP</acronym> server, and particularly <application>OpenLDAP</application>, can be used 
+        as a Quota Storage Backend.
         Some other LDAP servers can be used, but this is currently untested in production.
       </para>
@@ -267 +277 @@
 $ cp pykota.schema /etc/ldap/schema
         </screen>
+        <note>
+          <title>Note</title>
+          <para>
+            If you use RPM or DEB packages, usually the
+            <filename>pykota.schema</filename> file gets installed into the
+            <filename>/usr/share/pykota/ldap</filename> directory, along 
+            with a README file.
+          </para>
+        </note>  
      </para>
      <para>   
@@ -342 +361 @@
         create them by yourself, either directly with a text editor and the
         <application>ldapadd</application> command, or with some specialized tool
-        like <application>gq</application>.
+        like <application>gq</application>. You can look at the <filename>initscripts/ldap/pykota-sample.ldif</filename>
+        file to see what minimal branches are necessary.
+        <note>
+          <title>Note</title>
+          <para>
+            If you use RPM or DEB packages, usually the
+            <filename>pykota-sample.ldif</filename> file gets installed into the
+            <filename>/usr/share/pykota/ldap</filename> directory, along 
+            with a README file.
+          </para>
+        </note>  
       </para>
       
@@ -505 +534 @@
     
     <para>
+       You can check that all needed software is installed by launching the <filename>checkdeps.py</filename>
+       command :
+      <screen>      
+$ python checkdeps.py      
+      </screen>
+    </para>
+    
+    <para>
       Once all these software are installed, installing PyKota itself is a breeze.
       PyKota being written entirely in the Python language, which is interpreted, 
@@ -515 +552 @@
     
     <para>
-      The installation script will try to do a safe upgrade if needed. 
-      Also it will check if some needed software is missing or unavailable 
-      and will tell you so. This may be the case for example if you 
-      installed several versions of the Python language, and some Python 
-      modules are only available for one of them which is not the one you 
-      are actually running. 
-    </para>
-    
-    <para>
-      On your first installation, the setup script will automatically create
-      the <filename>/etc/pykota</filename> directory and put the sample 
+      The setup script will automatically create the 
+      <filename>/usr/share/pykota/conf</filename> directory and put the sample 
       configuration files <filename>conf/pykota.conf.sample</filename> and
-      <filename>conf/pykotadmin.conf.sample</filename> there, after having
-      renamed them respectively <filename>pykota.conf</filename> and 
+      <filename>conf/pykotadmin.conf.sample</filename> there, along with
+      a <filename>README</filename> file explaining their purpose.
+    </para>
+    <para>
+      You have to copy these files into the <filename>/etc/pykota</filename>
+      directory (you have to create it before), under the respective names <filename>pykota.conf</filename> and 
       <filename>pykotadmin.conf</filename>. Once copied there, you just
       have to modify these files to adapt them to your own setup.
@@ -543 +575 @@
     
     <para>
-      On later installations, the setup script won't modify any of your
-      configuration files. However it will try to explain what have changed
-      and encourages you to manually do the modifications which are needed.
-      Please create a backup of the <filename>/etc/pykota</filename>
-      directory before modifying anything.
-      Under some circumstances, PyKota's setup script may refuse to install PyKota
-      until you have modified your configuration. Just do it and restart
-      the installation script as described above.
+      Please create a backup copy of the <filename>/etc/pykota</filename>
+      directory before modifying a working installation.
     </para>
     
@@ -737 +763 @@
 
 $Log$
+Revision 1.29  2004/11/10 22:35:23  jalet
+Changes to the installation documentation
+
 Revision 1.28  2004/10/06 10:03:16  jalet
 Improved documentation

pykota/trunk/README

@@ -313 +313 @@
     http://savannah.nongnu.org/projects/pykota
 
-Just type :
+You can now check if the dependencies are correct by typing :
+
+    python checkdeps.py
+    
+To install the software, just type :
 
     python setup.py install
 
 You may need to be logged in with sufficient privileges (e.g. root)
-
-The installation script will now automatically check if some software
-is missing and ask you if you still want to proceed with the 
-installation or abort it completely.
 
 Go to the initscripts subdirectory of PyKota's sources, and choose