support jobs

lam/docs/manual-sources/howto.xml

@@ -1821,6 +1821,157 @@ Have fun!
         </section>
       </section>
 
+      <section>
+        <title>Cron jobs (LAM Pro)</title>
+
+        <para>LAM Pro can execute common tasks via cron job. This can be used
+        to e.g. notify your users before their passwords expire.</para>
+
+        <section>
+          <title>LDAP and database configuration</title>
+
+          <para>Please add the LDAP bind user and password for all jobs. This
+          LDAP account will be used to perform all LDAP read and write
+          operations.</para>
+
+          <para>Next, select the database type where LAM should store job
+          related data.</para>
+
+          <para>Supported databases:</para>
+
+          <para><emphasis role="bold">SQLite</emphasis></para>
+
+          <para>This is a simple file based database. It needs no special
+          database server. The database file will be located next to the
+          server profile in config directory.</para>
+
+          <para>You will need to install the SQLite PDO module for PHP
+          (pdo_sqlite.so). For Debian this is located in package
+          php5-sqlite.</para>
+
+          <literallayout>
+
+</literallayout>
+
+          <para>After the LDAP and database settings are done you can test
+          your settings.</para>
+
+          <para>LAM also prints the crontab line that you need to run the
+          configured jobs on a daily basis. The command must be run as the
+          same user as your webserver is running. You are free to change the
+          starting time of the script or run it more often.</para>
+
+          <screenshot>
+            <mediaobject>
+              <imageobject>
+                <imagedata fileref="images/jobs1.png" />
+              </imageobject>
+            </mediaobject>
+          </screenshot>
+
+          <para></para>
+        </section>
+
+        <section>
+          <title>Adding jobs</title>
+
+          <para>To add a new job just click on the "Add job" button and select
+          the job type you need. Depending on the job type jobs may be added
+          multiple times with different configurations.</para>
+
+          <para>For descriptions about the available job types see next
+          chapters.</para>
+
+          <screenshot>
+            <mediaobject>
+              <imageobject>
+                <imagedata fileref="images/jobs2.png" />
+              </imageobject>
+            </mediaobject>
+          </screenshot>
+        </section>
+
+        <section>
+          <title>PPolicy: Notify users about password expiration</title>
+
+          <para>This will send your users an email reminder before their
+          password expires. Job can be added multiple times (e.g. to send a
+          second warning at a later time).</para>
+
+          <para>LAM calculates the expiration date based on the last password
+          change and the assigned password policy (or the default
+          policy).</para>
+
+          <screenshot>
+            <mediaobject>
+              <imageobject>
+                <imagedata fileref="images/jobs_ppolicy1.png" />
+              </imageobject>
+            </mediaobject>
+          </screenshot>
+
+          <table>
+            <title>Options</title>
+
+            <tgroup cols="2">
+              <tbody>
+                <row>
+                  <entry><emphasis role="bold">Option</emphasis></entry>
+
+                  <entry><emphasis role="bold">Description</emphasis></entry>
+                </row>
+
+                <row>
+                  <entry>From address</entry>
+
+                  <entry>The email address to set as FROM.</entry>
+                </row>
+
+                <row>
+                  <entry>Reply-to address</entry>
+
+                  <entry>Optional Reply-to address for email.</entry>
+                </row>
+
+                <row>
+                  <entry>Subject</entry>
+
+                  <entry>The email subject line. Supports wildcards, see
+                  below.</entry>
+                </row>
+
+                <row>
+                  <entry>Text</entry>
+
+                  <entry>The email body text. Supports wildcards, see
+                  below.</entry>
+                </row>
+
+                <row>
+                  <entry>Notification period</entry>
+
+                  <entry>Number of days to notify before password
+                  expires.</entry>
+                </row>
+
+                <row>
+                  <entry>Default password policy</entry>
+
+                  <entry>Default PPolicy password policy entry (object class
+                  "pwdPolicy").</entry>
+                </row>
+              </tbody>
+            </tgroup>
+          </table>
+
+          <para>Wildcards:</para>
+
+          <para>You can enter LDAP attributes as wildcards in the form
+          @@ATTRIBUTE_NAME@@. E.g. to add the user's common name use "@@cn@@".
+          For the common name it would be "@@cn@@".</para>
+        </section>
+      </section>
+
       <section id="confTypicalScenarios">
         <title>Typical scenarios</title>