Skip to content

Commit

Permalink
Crontab: update documentation files.
Browse files Browse the repository at this point in the history
  • Loading branch information
@yunosh
yunosh committed Feb 10, 2014
1 parent c605510 commit eed1d1d
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 37 deletions.
2 changes: 2 additions & 0 deletions app/views/App/apps/ingo/docs/CHANGES.html
View file
Expand Up @@ -3,6 +3,8 @@ <h3>Changes by Release</h3><pre>
v3.2.0-git
----------

[mms] Replace max blacklist/whitelist configuration parameters with equivalent
permissions options.
[mms] Sorting of rules now done via drag/drop javascript.
[jan] Make shares table compatible with Oracle.
[mms] Validate e-mail addresses on the forward and vacation pages (<a href="http://bugs.horde.org/ticket/7249">Request
Expand Down
102 changes: 65 additions & 37 deletions app/views/App/apps/ingo/docs/UPGRADING.html
View file
Expand Up @@ -11,40 +11,42 @@ <h1 class="title">Upgrading Ingo</h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="auto-toc simple">
<li><a class="reference internal" href="#general-instructions" id="id3">1&nbsp;&nbsp;&nbsp;General instructions</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-3-1-x-to-3-2" id="id4">2&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.1.x To 3.2</a><ul class="auto-toc">
<li><a class="reference internal" href="#api-changes" id="id5">2.1&nbsp;&nbsp;&nbsp;API Changes</a></li>
<li><a class="reference internal" href="#general-instructions" id="id4">1&nbsp;&nbsp;&nbsp;General instructions</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-3-1-x-to-3-2" id="id5">2&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.1.x To 3.2</a><ul class="auto-toc">
<li><a class="reference internal" href="#api-changes" id="id6">2.1&nbsp;&nbsp;&nbsp;API Changes</a></li>
<li><a class="reference internal" href="#configuration-options-conf-php" id="id7">2.2&nbsp;&nbsp;&nbsp;Configuration Options (conf.php)</a></li>
<li><a class="reference internal" href="#permissions" id="id8">2.3&nbsp;&nbsp;&nbsp;Permissions</a></li>
</ul>
</li>
<li><a class="reference internal" href="#upgrading-ingo-from-3-0-x-to-3-1-x" id="id6">3&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.0.x To 3.1.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#backend-configuration-backends-php" id="id7">3.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></li>
<li><a class="reference internal" href="#id1" id="id8">3.2&nbsp;&nbsp;&nbsp;API Changes</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-3-0-x-to-3-1-x" id="id9">3&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.0.x To 3.1.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#backend-configuration-backends-php" id="id10">3.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></li>
<li><a class="reference internal" href="#id1" id="id11">3.2&nbsp;&nbsp;&nbsp;API Changes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#upgrading-ingo-from-2-x-to-3-x" id="id9">4&nbsp;&nbsp;&nbsp;Upgrading Ingo From 2.x To 3.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#id2" id="id10">4.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-2-x-to-3-x" id="id12">4&nbsp;&nbsp;&nbsp;Upgrading Ingo From 2.x To 3.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#id2" id="id13">4.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-x-to-2-x" id="id11">5&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.x To 2.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#configuration-options-conf-php" id="id12">5.1&nbsp;&nbsp;&nbsp;Configuration Options (conf.php)</a></li>
<li><a class="reference internal" href="#sieve-backend" id="id13">5.2&nbsp;&nbsp;&nbsp;Sieve Backend</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-x-to-2-x" id="id14">5&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.x To 2.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#id3" id="id15">5.1&nbsp;&nbsp;&nbsp;Configuration Options (conf.php)</a></li>
<li><a class="reference internal" href="#sieve-backend" id="id16">5.2&nbsp;&nbsp;&nbsp;Sieve Backend</a></li>
</ul>
</li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-2-1-to-1-2-2" id="id14">6&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2.1 To 1.2.2</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-2-to-1-2-1" id="id15">7&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2 To 1.2.1</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-1-x-to-1-2" id="id16">8&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.1.x To 1.2</a><ul class="auto-toc">
<li><a class="reference internal" href="#sql-backend" id="id17">8.1&nbsp;&nbsp;&nbsp;SQL Backend</a></li>
<li><a class="reference internal" href="#new-beta-sql-share-driver-support" id="id18">8.2&nbsp;&nbsp;&nbsp;New Beta SQL Share Driver Support</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-2-1-to-1-2-2" id="id17">6&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2.1 To 1.2.2</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-2-to-1-2-1" id="id18">7&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2 To 1.2.1</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-1-x-to-1-2" id="id19">8&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.1.x To 1.2</a><ul class="auto-toc">
<li><a class="reference internal" href="#sql-backend" id="id20">8.1&nbsp;&nbsp;&nbsp;SQL Backend</a></li>
<li><a class="reference internal" href="#new-beta-sql-share-driver-support" id="id21">8.2&nbsp;&nbsp;&nbsp;New Beta SQL Share Driver Support</a></li>
</ul>
</li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-0-x-to-1-1-x" id="id19">9&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.0.x To 1.1.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#backends-parameter-changes-procmail-driver" id="id20">9.1&nbsp;&nbsp;&nbsp;Backends parameter changes - procmail driver</a></li>
<li><a class="reference internal" href="#upgrading-ingo-from-1-0-x-to-1-1-x" id="id22">9&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.0.x To 1.1.x</a><ul class="auto-toc">
<li><a class="reference internal" href="#backends-parameter-changes-procmail-driver" id="id23">9.1&nbsp;&nbsp;&nbsp;Backends parameter changes - procmail driver</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="general-instructions">
<h1><a class="toc-backref" href="#id3">1&nbsp;&nbsp;&nbsp;General instructions</a></h1>
<h1><a class="toc-backref" href="#id4">1&nbsp;&nbsp;&nbsp;General instructions</a></h1>
<p>These are instructions to upgrade from earlier Ingo versions. Please backup
your existing data before running any of the steps described below. You can't
use the updated data with your old Ingo version anymore.</p>
Expand All @@ -61,46 +63,72 @@ <h1><a class="toc-backref" href="#id3">1&nbsp;&nbsp;&nbsp;General instructions</
outdated.</p>
</div>
<div class="section" id="upgrading-ingo-from-3-1-x-to-3-2">
<h1><a class="toc-backref" href="#id4">2&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.1.x To 3.2</a></h1>
<h1><a class="toc-backref" href="#id5">2&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.1.x To 3.2</a></h1>
<div class="section" id="api-changes">
<h2><a class="toc-backref" href="#id5">2.1&nbsp;&nbsp;&nbsp;API Changes</a></h2>
<h2><a class="toc-backref" href="#id6">2.1&nbsp;&nbsp;&nbsp;API Changes</a></h2>
<p>Added the 'newEmailFilter' API link. Takes one argument: 'email', the
e-mail address to pre-populate into a new rule.</p>
</div>
<div class="section" id="configuration-options-conf-php">
<h2><a class="toc-backref" href="#id7">2.2&nbsp;&nbsp;&nbsp;Configuration Options (conf.php)</a></h2>
<p>The following options have been removed (see Permissions section for
replacement functionality):</p>
<pre class="literal-block">
$conf['storage']['maxblacklist']
$conf['storage']['maxwhitelist']
</pre>
</div>
<div class="section" id="permissions">
<h2><a class="toc-backref" href="#id8">2.3&nbsp;&nbsp;&nbsp;Permissions</a></h2>
<p>Ingo permissions are now applied per backend. To upgrade existing permissions,
an admin needs to run the following script:</p>
<pre class="literal-block">
bin/ingo-admin-upgrade --task=backend_perms
</pre>
<p>The following permissions have been added:</p>
<pre class="literal-block">
max_blacklist
max_whitelist
</pre>
<p>The following permissions have been removed:</p>
<pre class="literal-block">
allow_rules (replacement: set max_rules permission to 0)
</pre>
</div>
</div>
<div class="section" id="upgrading-ingo-from-3-0-x-to-3-1-x">
<h1><a class="toc-backref" href="#id6">3&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.0.x To 3.1.x</a></h1>
<h1><a class="toc-backref" href="#id9">3&nbsp;&nbsp;&nbsp;Upgrading Ingo From 3.0.x To 3.1.x</a></h1>
<div class="section" id="backend-configuration-backends-php">
<h2><a class="toc-backref" href="#id7">3.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></h2>
<h2><a class="toc-backref" href="#id10">3.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></h2>
<p>The 'script' and 'transport' settings of the backend configuration have been
changed from strings to arrays, to allow different backends for different
filter rules.</p>
</div>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id8">3.2&nbsp;&nbsp;&nbsp;API Changes</a></h2>
<h2><a class="toc-backref" href="#id11">3.2&nbsp;&nbsp;&nbsp;API Changes</a></h2>
<p>The applyFilters() no longer returns a value.</p>
</div>
</div>
<div class="section" id="upgrading-ingo-from-2-x-to-3-x">
<h1><a class="toc-backref" href="#id9">4&nbsp;&nbsp;&nbsp;Upgrading Ingo From 2.x To 3.x</a></h1>
<h1><a class="toc-backref" href="#id12">4&nbsp;&nbsp;&nbsp;Upgrading Ingo From 2.x To 3.x</a></h1>
<div class="section" id="id2">
<h2><a class="toc-backref" href="#id10">4.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></h2>
<h2><a class="toc-backref" href="#id13">4.1&nbsp;&nbsp;&nbsp;Backend Configuration (backends.php)</a></h2>
<p>The 'hordeauth' parameter and the 'password' and 'username' parameters have
been removed. By default, the transport backend will use Horde authentication
credentials to access. To set a different username and/or password, you should
use the 'transport_auth' hook.</p>
</div>
</div>
<div class="section" id="upgrading-ingo-from-1-x-to-2-x">
<h1><a class="toc-backref" href="#id11">5&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.x To 2.x</a></h1>
<div class="section" id="configuration-options-conf-php">
<h2><a class="toc-backref" href="#id12">5.1&nbsp;&nbsp;&nbsp;Configuration Options (conf.php)</a></h2>
<h1><a class="toc-backref" href="#id14">5&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.x To 2.x</a></h1>
<div class="section" id="id3">
<h2><a class="toc-backref" href="#id15">5.1&nbsp;&nbsp;&nbsp;Configuration Options (conf.php)</a></h2>
<p>The following configuration options have been removed:</p>
<blockquote>
usefolderapi</blockquote>
</div>
<div class="section" id="sieve-backend">
<h2><a class="toc-backref" href="#id13">5.2&nbsp;&nbsp;&nbsp;Sieve Backend</a></h2>
<h2><a class="toc-backref" href="#id16">5.2&nbsp;&nbsp;&nbsp;Sieve Backend</a></h2>
<p>The port number for the timesieved daemon has been changed to the official
Sieve port 4190 in the default configuration. If your timesieved daemon is
still running on the former default port 2000, or any other port than 4190, you
Expand All @@ -114,27 +142,27 @@ <h2><a class="toc-backref" href="#id13">5.2&nbsp;&nbsp;&nbsp;Sieve Backend</a></
</div>
</div>
<div class="section" id="upgrading-ingo-from-1-2-1-to-1-2-2">
<h1><a class="toc-backref" href="#id14">6&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2.1 To 1.2.2</a></h1>
<h1><a class="toc-backref" href="#id17">6&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2.1 To 1.2.2</a></h1>
<p>The group_uid field in the SQL share driver groups table has been changed from
an INT to a VARCHAR(255). Execute the provided SQL script to update your
database if you are using the native SQL share driver.</p>
<blockquote>
mysql --user=root --password=&lt;MySQL-root-password&gt; &lt;db name&gt; &lt; 1.2.1_to_1.2.2.sql</blockquote>
</div>
<div class="section" id="upgrading-ingo-from-1-2-to-1-2-1">
<h1><a class="toc-backref" href="#id15">7&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2 To 1.2.1</a></h1>
<h1><a class="toc-backref" href="#id18">7&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.2 To 1.2.1</a></h1>
<p>The share_owner field in the SQL share driver table has been changed from a
VARCHAR(32) to a VARCHAR(255). Execute the provided SQL script to update your
database if you are using the native SQL share driver.</p>
<blockquote>
mysql --user=root --password=&lt;MySQL-root-password&gt; &lt;db name&gt; &lt; 1.2_to_1.2.1.sql</blockquote>
</div>
<div class="section" id="upgrading-ingo-from-1-1-x-to-1-2">
<h1><a class="toc-backref" href="#id16">8&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.1.x To 1.2</a></h1>
<h1><a class="toc-backref" href="#id19">8&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.1.x To 1.2</a></h1>
<p>This is a non-exhaustive, quick explanation of what has changed between Ingo
version 1.1.x and 1.2.x.</p>
<div class="section" id="sql-backend">
<h2><a class="toc-backref" href="#id17">8.1&nbsp;&nbsp;&nbsp;SQL Backend</a></h2>
<h2><a class="toc-backref" href="#id20">8.1&nbsp;&nbsp;&nbsp;SQL Backend</a></h2>
<p>An SQL table has been added than can optionally be used as a storage backend
for the filter rules. Using this backend no longer limits the number and size
of rules.</p>
Expand All @@ -157,7 +185,7 @@ <h2><a class="toc-backref" href="#id17">8.1&nbsp;&nbsp;&nbsp;SQL Backend</a></h2
</pre>
</div>
<div class="section" id="new-beta-sql-share-driver-support">
<h2><a class="toc-backref" href="#id18">8.2&nbsp;&nbsp;&nbsp;New Beta SQL Share Driver Support</a></h2>
<h2><a class="toc-backref" href="#id21">8.2&nbsp;&nbsp;&nbsp;New Beta SQL Share Driver Support</a></h2>
<p>A new beta-level SQL Horde_Share driver has been added in Horde 3.2. This
driver offers significant performance improvements over the existing Datatree
driver, but it has not received the same level of testing, thus the beta
Expand All @@ -168,11 +196,11 @@ <h2><a class="toc-backref" href="#id18">8.2&nbsp;&nbsp;&nbsp;New Beta SQL Share
</div>
</div>
<div class="section" id="upgrading-ingo-from-1-0-x-to-1-1-x">
<h1><a class="toc-backref" href="#id19">9&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.0.x To 1.1.x</a></h1>
<h1><a class="toc-backref" href="#id22">9&nbsp;&nbsp;&nbsp;Upgrading Ingo From 1.0.x To 1.1.x</a></h1>
<p>This is a non-exhaustive, quick explanation of what has changed between Ingo
version 1.0.x and 1.1.x.</p>
<div class="section" id="backends-parameter-changes-procmail-driver">
<h2><a class="toc-backref" href="#id20">9.1&nbsp;&nbsp;&nbsp;Backends parameter changes - procmail driver</a></h2>
<h2><a class="toc-backref" href="#id23">9.1&nbsp;&nbsp;&nbsp;Backends parameter changes - procmail driver</a></h2>
<p>In <tt class="docutils literal">config/backends.php</tt>, the <tt class="docutils literal">procmailrc</tt> parameter in the procmail
entry has been deprecated. It has been replaced by the <tt class="docutils literal">filename</tt>
parameter.</p>
Expand Down

0 comments on commit eed1d1d

Please sign in to comment.