Update iredadmin-pro API interfaces.

2016-05-24 08:40:23 +08:00 · 2016-05-24 08:40:23 +08:00 · 02d7ac7ff9
parent 351cd219b0
commit 02d7ac7ff9
4 changed files with 224 additions and 14 deletions
--- a/en_US/faq/2-iredadmin-pro.restful.api.md
+++ b/en_US/faq/2-iredadmin-pro.restful.api.md
@ -69,7 +69,7 @@ Notes:
    --- |--- |---
    `cn` | Short description of this domain name. e.g. company name | `cn=Google Inc`
    `quota` | Per-domain mailbox quota, in MB. | `quota=2048`
-    `language` | Default preferred language for newly created mail user | `preferredLanguage=en_US`
+    `language` | Default preferred language for newly created mail user | `language=en_US`
    `defaultQuota` | Default per-user mailbox quota for newly created user, in MB. | `defaultQuota=1024`
    `maxUserQuota` | Max mailbox quota of a mail user, in MB. | `maxUserQuota=2048`
    `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20`
@ -89,7 +89,7 @@ Notes:
    --- |--- |---
    `cn` | Short description of this domain name. e.g. company name | `cn=Google Inc`
    `quota` | Mailbox quota for whole domain, in MB. | `quota=2048`
-    `language` | Default preferred language for newly created mail user | `preferredLanguage=en_US`
+    `language` | Default preferred language for newly created mail user | `language=en_US`
    `defaultQuota` | Default per-user mailbox quota for newly created user | `defaultQuota=1024`
    `maxUserQuota` | Max mailbox quota of a mail user | `maxUserQuota=2048`
    `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20`
@ -101,7 +101,19 @@ Notes:

 ### User {: .toggle }

-!!! api "`POST`{: .post } `/api/user/<mail>`{: .url } `Create a new mail user`{: .comment }"
+!!! api "`POST`{: .post } `/api/user/<mail>`{: .url } `Create a new mail user`{: .comment } `Parameters`{: .has_params }"
+
+    <div class="params params_user">
+
+    Parameter Name | Summary | Sample Usage
+    --- |--- |---
+    `cn` | Display name | `cn=My New Name`
+    `password` | Password| `password=AsTr0ng@`
+    `language` | Preferred language of web UI | `language=en_US`
+    `quota` | Mailbox quota (in MB) | `quota=1024`
+
+    </div>
+
 !!! api "`DELETE`{: .delete } `/api/user/<mail>`{: .url } `Delete an existing mail user`{: .comment }"
 !!! api "`PUT`{: .put } `/api/user/<mail>`{: .url } `Update profile of an existing mail user`{: .comment } `Parameters`{: .has_params} "

@ -110,8 +122,7 @@ Notes:
    Parameter Name | Summary | Sample Usage
    --- |--- |---
    `cn` | Display name | `cn=My New Name`
-    `language` | Preferred language of web UI | `preferredLanguage=en_US`
-    `mailQuota` | User's mailbox quota, in MB | `mailQuota=1024`
+    `language` | Preferred language of web UI | `language=en_US`
    `transport` | Transport program | `transport=dovecot`

    </div>
@ -215,7 +226,16 @@ Notes:
    </div>


+### Export Accounts {: .toggle }

+#### LDIF (LDAP backend only) {: .toggle }
+
+!!! api "`GET`{: .get } `/api/ldif/domain/<domain>`{: .url } `Export domain to LDIF`{: .comment } `upcoming`{: .upcoming }"
+!!! api "`GET`{: .get } `/api/ldif/catchall/<domain>`{: .url } `Export per-domain catch-all account to LDIF`{: .comment } `upcoming`{: .upcoming }"
+!!! api "`GET`{: .get } `/api/ldif/admin/<mail>`{: .url } `Export (separated) domain admin to LDIF`{: .comment } `upcoming`{: .upcoming }"
+!!! api "`GET`{: .get } `/api/ldif/user/<mail>`{: .url } `Export mail user to LDIF`{: .comment } `upcoming`{: .upcoming }"
+!!! api "`GET`{: .get } `/api/ldif/maillist/<mail>`{: .url } `Export mailing list account to LDIF`{: .comment } `upcoming`{: .upcoming }"
+!!! api "`GET`{: .get } `/api/ldif/alias/<mail>`{: .url } `Export mail alias account to LDIF`{: .comment } `upcoming`{: .upcoming }"



--- a/en_US/upgrade/0-upgrade.iredmail.0.9.5.1-0.9.6.md
+++ b/en_US/upgrade/0-upgrade.iredmail.0.9.5.1-0.9.6.md
@ -0,0 +1,53 @@
+# Upgrade iRedMail from 0.9.5-1 to 0.9.6
+
+[TOC]
+
+!!! note "Paid Remote Upgrade Support"
+
+    We offer remote upgrade support if you don't want to get your hands dirty,
+    check [the details](../support.html) and [contact us](../contact.html).
+
+!!! warning
+
+    This tutorial is still a __DRAFT__, do not apply it.
+
+## TODO
+
+* Separated SOGo address book for LDAP backend.
+
+## ChangeLog
+
+* May 24, 2016: initial __DRAFT__.
+
+## General (All backends should apply these steps)
+
+### Update `/etc/iredmail-release` with new iRedMail version number
+
+iRedMail stores the release version in `/etc/iredmail-release` after
+installation, it's recommended to update this file after you upgraded iRedMail,
+so that you can know which version of iRedMail you're running. For example:
+
+```
+0.9.6
+```
+
+### Upgrade iRedAPD (Postfix policy server) to the latest stable release (1.9.2)
+
+Please follow below tutorial to upgrade iRedAPD to the latest stable release:
+[Upgrade iRedAPD to the latest stable release](./upgrade.iredapd.html)
+
+Detailed release notes are available [here](./iredapd.releases.html).
+
+### Upgrade iRedAdmin (open source edition) to the latest stable release (0.7.2)
+
+Please follow this tutorial to upgrade iRedAdmin open source edition to the
+latest stable release:
+[Upgrade iRedAdmin to the latest stable release](./migrate.or.upgrade.iredadmin.html)
+
+### Upgrade Roundcube webmail to the latest stable release (1.2.0)
+
+Please follow Roundcube official tutorial to upgrade Roundcube webmail to the
+latest stable release immediately: [How to upgrade Roundcube](https://github.com/roundcube/roundcubemail/wiki/Upgrade).
+
+Note: package `rsync` must be installed on your server before upgrading.
+
--- a/html/iredadmin-pro.restful.api.html
+++ b/html/iredadmin-pro.restful.api.html
@ -34,6 +34,10 @@
 <li><a href="#mailing-list">Mailing List</a></li>
 <li><a href="#mail-alias">Mail Alias</a></li>
 <li><a href="#throttling">Throttling</a></li>
+<li><a href="#export-accounts">Export Accounts</a><ul>
+<li><a href="#ldif-ldap-backend-only">LDIF (LDAP backend only)</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@ -111,7 +115,7 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
 <tr>
 <td><code>language</code></td>
 <td>Default preferred language for newly created mail user</td>
-<td><code>preferredLanguage=en_US</code></td>
+<td><code>language=en_US</code></td>
 </tr>
 <tr>
 <td><code>defaultQuota</code></td>
@ -155,7 +159,7 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
    --- |--- |---
    `cn` | Short description of this domain name. e.g. company name | `cn=Google Inc`
    `quota` | Mailbox quota for whole domain, in MB. | `quota=2048`
-    `language` | Default preferred language for newly created mail user | `preferredLanguage=en_US`
+    `language` | Default preferred language for newly created mail user | `language=en_US`
    `defaultQuota` | Default per-user mailbox quota for newly created user | `defaultQuota=1024`
    `maxUserQuota` | Max mailbox quota of a mail user | `maxUserQuota=2048`
    `numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20`
@ -167,7 +171,42 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]

 <h3 class="toggle" id="user">User</h3>
 <div class="admonition api">
-<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/user/&lt;mail&gt;</code> <code class="comment">Create a new mail user</code></p>
+<p class="admonition-title"><code class="post">POST</code> <code class="url">/api/user/&lt;mail&gt;</code> <code class="comment">Create a new mail user</code> <code class="has_params">Parameters</code></p>
+<div class="params params_user">
+
+<table>
+<thead>
+<tr>
+<th>Parameter Name</th>
+<th>Summary</th>
+<th>Sample Usage</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>cn</code></td>
+<td>Display name</td>
+<td><code>cn=My New Name</code></td>
+</tr>
+<tr>
+<td><code>password</code></td>
+<td>Password</td>
+<td><code>password=AsTr0ng@</code></td>
+</tr>
+<tr>
+<td><code>language</code></td>
+<td>Preferred language of web UI</td>
+<td><code>language=en_US</code></td>
+</tr>
+<tr>
+<td><code>quota</code></td>
+<td>Mailbox quota (in MB)</td>
+<td><code>quota=1024</code></td>
+</tr>
+</tbody>
+</table>
+</div>
+
 </div>
 <div class="admonition api">
 <p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/user/&lt;mail&gt;</code> <code class="comment">Delete an existing mail user</code></p>
@ -193,12 +232,7 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
 <tr>
 <td><code>language</code></td>
 <td>Preferred language of web UI</td>
-<td><code>preferredLanguage=en_US</code></td>
-</tr>
-<tr>
-<td><code>mailQuota</code></td>
-<td>User's mailbox quota, in MB</td>
-<td><code>mailQuota=1024</code></td>
+<td><code>language=en_US</code></td>
 </tr>
 <tr>
 <td><code>transport</code></td>
@ -431,6 +465,26 @@ please use mail alias account as mailing list.</p>
 </table>
 </div>

+</div>
+<h3 class="toggle" id="export-accounts">Export Accounts</h3>
+<h4 class="toggle" id="ldif-ldap-backend-only">LDIF (LDAP backend only)</h4>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/domain/&lt;domain&gt;</code> <code class="comment">Export domain to LDIF</code> <code class="upcoming">upcoming</code></p>
+</div>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/catchall/&lt;domain&gt;</code> <code class="comment">Export per-domain catch-all account to LDIF</code> <code class="upcoming">upcoming</code></p>
+</div>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/admin/&lt;mail&gt;</code> <code class="comment">Export (separated) domain admin to LDIF</code> <code class="upcoming">upcoming</code></p>
+</div>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/user/&lt;mail&gt;</code> <code class="comment">Export mail user to LDIF</code> <code class="upcoming">upcoming</code></p>
+</div>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/maillist/&lt;mail&gt;</code> <code class="comment">Export mailing list account to LDIF</code> <code class="upcoming">upcoming</code></p>
+</div>
+<div class="admonition api">
+<p class="admonition-title"><code class="get">GET</code> <code class="url">/api/ldif/alias/&lt;mail&gt;</code> <code class="comment">Export mail alias account to LDIF</code> <code class="upcoming">upcoming</code></p>
 </div>
 <script src="./js/jquery-1.12.3.min.js"></script>

--- a/html/upgrade.iredmail.0.9.5.1-0.9.6.html
+++ b/html/upgrade.iredmail.0.9.5.1-0.9.6.html
@ -0,0 +1,83 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        <title>Upgrade iRedMail from 0.9.5-1 to 0.9.6</title>
+        <link rel="stylesheet" type="text/css" href="./css/markdown.css" />
+    </head>
+    <body>
+    
+    <div id="navigation">
+    <a href="/index.html" target="_blank">
+        <img alt="iRedMail web site"
+             src="./images/logo-iredmail.png"
+             style="vertical-align: middle; height: 30px;"
+             />&nbsp;
+        <span>iRedMail</span>
+    </a>
+    &nbsp;&nbsp;//&nbsp;&nbsp;<a href="./index.html">Document Index</a></div><h1 id="upgrade-iredmail-from-095-1-to-096">Upgrade iRedMail from 0.9.5-1 to 0.9.6</h1>
+<div class="toc">
+<ul>
+<li><a href="#upgrade-iredmail-from-095-1-to-096">Upgrade iRedMail from 0.9.5-1 to 0.9.6</a><ul>
+<li><a href="#todo">TODO</a></li>
+<li><a href="#changelog">ChangeLog</a></li>
+<li><a href="#general-all-backends-should-apply-these-steps">General (All backends should apply these steps)</a><ul>
+<li><a href="#update-etciredmail-release-with-new-iredmail-version-number">Update /etc/iredmail-release with new iRedMail version number</a></li>
+<li><a href="#upgrade-iredapd-postfix-policy-server-to-the-latest-stable-release-192">Upgrade iRedAPD (Postfix policy server) to the latest stable release (1.9.2)</a></li>
+<li><a href="#upgrade-iredadmin-open-source-edition-to-the-latest-stable-release-072">Upgrade iRedAdmin (open source edition) to the latest stable release (0.7.2)</a></li>
+<li><a href="#upgrade-roundcube-webmail-to-the-latest-stable-release-120">Upgrade Roundcube webmail to the latest stable release (1.2.0)</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="admonition note">
+<p class="admonition-title">Paid Remote Upgrade Support</p>
+<p>We offer remote upgrade support if you don't want to get your hands dirty,
+check <a href="../support.html">the details</a> and <a href="../contact.html">contact us</a>.</p>
+</div>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This tutorial is still a <strong>DRAFT</strong>, do not apply it.</p>
+</div>
+<h2 id="todo">TODO</h2>
+<ul>
+<li>Separated SOGo address book for LDAP backend.</li>
+</ul>
+<h2 id="changelog">ChangeLog</h2>
+<ul>
+<li>May 24, 2016: initial <strong>DRAFT</strong>.</li>
+</ul>
+<h2 id="general-all-backends-should-apply-these-steps">General (All backends should apply these steps)</h2>
+<h3 id="update-etciredmail-release-with-new-iredmail-version-number">Update <code>/etc/iredmail-release</code> with new iRedMail version number</h3>
+<p>iRedMail stores the release version in <code>/etc/iredmail-release</code> after
+installation, it's recommended to update this file after you upgraded iRedMail,
+so that you can know which version of iRedMail you're running. For example:</p>
+<pre><code>0.9.6
+</code></pre>
+
+<h3 id="upgrade-iredapd-postfix-policy-server-to-the-latest-stable-release-192">Upgrade iRedAPD (Postfix policy server) to the latest stable release (1.9.2)</h3>
+<p>Please follow below tutorial to upgrade iRedAPD to the latest stable release:
+<a href="./upgrade.iredapd.html">Upgrade iRedAPD to the latest stable release</a></p>
+<p>Detailed release notes are available <a href="./iredapd.releases.html">here</a>.</p>
+<h3 id="upgrade-iredadmin-open-source-edition-to-the-latest-stable-release-072">Upgrade iRedAdmin (open source edition) to the latest stable release (0.7.2)</h3>
+<p>Please follow this tutorial to upgrade iRedAdmin open source edition to the
+latest stable release:
+<a href="./migrate.or.upgrade.iredadmin.html">Upgrade iRedAdmin to the latest stable release</a></p>
+<h3 id="upgrade-roundcube-webmail-to-the-latest-stable-release-120">Upgrade Roundcube webmail to the latest stable release (1.2.0)</h3>
+<p>Please follow Roundcube official tutorial to upgrade Roundcube webmail to the
+latest stable release immediately: <a href="https://github.com/roundcube/roundcubemail/wiki/Upgrade">How to upgrade Roundcube</a>.</p>
+<p>Note: package <code>rsync</code> must be installed on your server before upgrading.</p><div class="footer">
+    <p style="text-align: center; color: grey;">All documents are available in <a href="https://bitbucket.org/zhb/iredmail-docs/src">BitBucket repository</a>, and published under <a href="http://creativecommons.org/licenses/by-nd/3.0/us/" target="_blank">Creative Commons</a> license. You can <a href="https://bitbucket.org/zhb/iredmail-docs/get/tip.tar.bz2">download the latest version</a> for offline reading. If you found something wrong, please do <a href="http://www.iredmail.org/contact.html">contact us</a> to fix it.</p>
+</div>
+<script type="text/javascript">
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-3293801-21', 'auto');
+  ga('send', 'pageview');
+</script>
+</body></html>