Changeset 1906

Show
Ignore:
Timestamp:
11/10/04 23:35:23 (20 years ago)
Author:
jalet
Message:

Changes to the installation documentation

Location:
pykota/trunk
Files:
2 modified

Legend:

Unmodified
Added
Removed
  • pykota/trunk/docs/installation.sgml

    r1783 r1906  
    181181pykota=#        
    182182        </screen> 
     183        <note> 
     184          <title>Note</title> 
     185          <para> 
     186            If you use RPM or DEB packages, usually the 
     187            <filename>pykota-postgresql.sql</filename> file gets installed into the 
     188            <filename>/usr/share/pykota/postgresql</filename> directory, along  
     189            with a README file. 
     190          </para> 
     191        </note>   
    183192      </para> 
    184193       
     
    246255     
    247256    <sect2> 
    248       <title>OpenLDAP</title> 
    249        
    250       <para> 
    251         From version 1.09 on, <application>OpenLDAP</application> can be used as a Quota Storage Backend. 
     257      <title>LDAP</title> 
     258       
     259      <para> 
     260        Any <acronym>LDAP</acronym> server, and particularly <application>OpenLDAP</application>, can be used  
     261        as a Quota Storage Backend. 
    252262        Some other LDAP servers can be used, but this is currently untested in production. 
    253263      </para> 
     
    267277$ cp pykota.schema /etc/ldap/schema 
    268278        </screen> 
     279        <note> 
     280          <title>Note</title> 
     281          <para> 
     282            If you use RPM or DEB packages, usually the 
     283            <filename>pykota.schema</filename> file gets installed into the 
     284            <filename>/usr/share/pykota/ldap</filename> directory, along  
     285            with a README file. 
     286          </para> 
     287        </note>   
    269288     </para> 
    270289     <para>    
     
    342361        create them by yourself, either directly with a text editor and the 
    343362        <application>ldapadd</application> command, or with some specialized tool 
    344         like <application>gq</application>. 
     363        like <application>gq</application>. You can look at the <filename>initscripts/ldap/pykota-sample.ldif</filename> 
     364        file to see what minimal branches are necessary. 
     365        <note> 
     366          <title>Note</title> 
     367          <para> 
     368            If you use RPM or DEB packages, usually the 
     369            <filename>pykota-sample.ldif</filename> file gets installed into the 
     370            <filename>/usr/share/pykota/ldap</filename> directory, along  
     371            with a README file. 
     372          </para> 
     373        </note>   
    345374      </para> 
    346375       
     
    505534     
    506535    <para> 
     536       You can check that all needed software is installed by launching the <filename>checkdeps.py</filename> 
     537       command : 
     538      <screen>       
     539$ python checkdeps.py       
     540      </screen> 
     541    </para> 
     542     
     543    <para> 
    507544      Once all these software are installed, installing PyKota itself is a breeze. 
    508545      PyKota being written entirely in the Python language, which is interpreted,  
     
    515552     
    516553    <para> 
    517       The installation script will try to do a safe upgrade if needed.  
    518       Also it will check if some needed software is missing or unavailable  
    519       and will tell you so. This may be the case for example if you  
    520       installed several versions of the Python language, and some Python  
    521       modules are only available for one of them which is not the one you  
    522       are actually running.  
    523     </para> 
    524      
    525     <para> 
    526       On your first installation, the setup script will automatically create 
    527       the <filename>/etc/pykota</filename> directory and put the sample  
     554      The setup script will automatically create the  
     555      <filename>/usr/share/pykota/conf</filename> directory and put the sample  
    528556      configuration files <filename>conf/pykota.conf.sample</filename> and 
    529       <filename>conf/pykotadmin.conf.sample</filename> there, after having 
    530       renamed them respectively <filename>pykota.conf</filename> and  
     557      <filename>conf/pykotadmin.conf.sample</filename> there, along with 
     558      a <filename>README</filename> file explaining their purpose. 
     559    </para> 
     560    <para> 
     561      You have to copy these files into the <filename>/etc/pykota</filename> 
     562      directory (you have to create it before), under the respective names <filename>pykota.conf</filename> and  
    531563      <filename>pykotadmin.conf</filename>. Once copied there, you just 
    532564      have to modify these files to adapt them to your own setup. 
     
    543575     
    544576    <para> 
    545       On later installations, the setup script won't modify any of your 
    546       configuration files. However it will try to explain what have changed 
    547       and encourages you to manually do the modifications which are needed. 
    548       Please create a backup of the <filename>/etc/pykota</filename> 
    549       directory before modifying anything. 
    550       Under some circumstances, PyKota's setup script may refuse to install PyKota 
    551       until you have modified your configuration. Just do it and restart 
    552       the installation script as described above. 
     577      Please create a backup copy of the <filename>/etc/pykota</filename> 
     578      directory before modifying a working installation. 
    553579    </para> 
    554580     
     
    737763 
    738764$Log$ 
     765Revision 1.29  2004/11/10 22:35:23  jalet 
     766Changes to the installation documentation 
     767 
    739768Revision 1.28  2004/10/06 10:03:16  jalet 
    740769Improved documentation 
  • pykota/trunk/README

    r1905 r1906  
    313313    http://savannah.nongnu.org/projects/pykota 
    314314 
    315 Just type : 
     315You can now check if the dependencies are correct by typing : 
     316 
     317    python checkdeps.py 
     318     
     319To install the software, just type : 
    316320 
    317321    python setup.py install 
    318322 
    319323You may need to be logged in with sufficient privileges (e.g. root) 
    320  
    321 The installation script will now automatically check if some software 
    322 is missing and ask you if you still want to proceed with the  
    323 installation or abort it completely. 
    324324 
    325325Go to the initscripts subdirectory of PyKota's sources, and choose