elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fixed: miss ';' in upgrade.iredmail.0.9.2-0.9.3.html in Nginx config file.

This commit is contained in:
Zhang Huangbin 2016-05-12 22:03:14 +08:00
parent 6d89e2fa5f
commit 967e196e6a
7 changed files with 102 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,6 +2,10 @@ Please visit [http://www.iredmail.org/docs/](http://www.iredmail.org/docs/)
to read converted documents in HTML format, get support in our forum:
[http://www.iredmail.org/forum/](http://www.iredmail.org/forum/).
# License
All documents are published under Creative Commons License.
# How to translate and contribute
* Create a new directory and name it to the short language code. for example:
@ -17,3 +21,7 @@ to read converted documents in HTML format, get support in our forum:
directory `zh_CN/howto/` and copy `reset.user.password.md` to `zh_CN/howto/`
(with same file name).
* Translate the file and send a pull request.
If you found something wrong, even just a grammar error or spelling mistake,
please don't hesitate to send us a pull request or
[contact us](http://www.iredmail.org/contact.html) to fix it.

41
en_US/faq/0-iredadmin-pro.restful.api-new.md
View File

@ -62,26 +62,37 @@ Notes:
### Domain
URL | HTTP Method | Summary
--- | --- | ---
/api/domain/<domain\> | POST | Create a new domin
/api/domain/<domain\> | DELETE | Delete an existing domain
/api/domain/<domain\> | PUT | Update profile of an existing domain
!!! api "`/api/domain/<domain>` `POST` `Create a new domain`"
!!! api "`/api/domain/<domain>` `DELETE` `Delete an existing domain`"
!!! api "`/api/domain/<domain>` `PUT` `Update profile of an existing domain`"
Possible `PUT` parameters used to update account profile:
Possible `PUT` parameters used to update account profile:
Parameter Name | Summary | Sample Usage
--- |--- |---
`cn` | the short description of this domain name. e.g. company name | `cn=iRedMail Project`
`quota` | a integer number for mailbox quota (for whole domain, in MB) | `quota=20480`
`language` | default preferred language for new user | `language=en_US`
`defaultQuota` | default mailbox quota for new user | `defaultQuota=1024`
`maxUserQuota` | Max mailbox quota of a single mail user | `maxUserQuota=2048`
`numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20`
`numberOfAliases` | Max number of mail alias accounts | `numberOfAliases=30`
Parameter Name | Summary | Sample Usage
--- |--- |---
`cn` | the short description of this domain name. e.g. company name | `cn=iRedMail Project`
`quota` | a integer number for mailbox quota (for whole domain, in MB) | `quota=20480`
`language` | default preferred language for new user | `language=en_US`
`defaultQuota` | default mailbox quota for new user | `defaultQuota=1024`
`maxUserQuota` | Max mailbox quota of a single mail user | `maxUserQuota=2048`
`numberOfUsers` | Max number of mail user accounts | `numberOfUsers=20`
`numberOfAliases` | Max number of mail alias accounts | `numberOfAliases=30`
### User
!!! api "`/api/user/<mail>` `POST` `Create a new mail user`"
!!! api "`/api/user/<mail>` `DELETE` `Delete an existing mail user`"
!!! api "`/api/user/<mail>` `PUT` `Update profile of an existing mail user`"
!!! api "`/api/users/<domain>` `PUT` `Update profiles of all mail user under domain`"
!!! api "`/api/users/<domain>/password` `PUT` `Update passwords of all users under domain`"
Required parameter:
{: #param }
Parameter Name | Sample Usage
--- |---
`password` | `password=Ww0nXVEV8iv4ap@p4b`
URL | HTTP Method | Summary
--- |---| ---
/api/user/<mail\> | POST | Create a new mail user

2
en_US/upgrade/0-upgrade.iredmail.0.9.2-0.9.3.md
View File

@ -368,7 +368,7 @@ and append below settings right after `ssl on` line:
# Use HTTP Strict Transport Security to force client to use secure connections only.
# Reference:
# https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security
add_header Strict-Transport-Security "max-age=15768000"
add_header Strict-Transport-Security "max-age=15768000";
```
### SOGo: Fix improper settings in Apache/Nginx config file

29
html/css/markdown.css
View File

@ -144,7 +144,7 @@ label,
input,
select,
textarea {
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
font-family: 'PT Sans', Georgia, Palatino, serif;
font-size: 13px;
font-weight: normal;
line-height: normal;
@ -210,7 +210,7 @@ input[type=text]:focus, input[type=password]:focus, textarea:focus {
button {
display: inline-block;
padding: 4px 14px;
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
font-family: 'PT Sans', Georgia, Palatino, serif;
font-size: 13px;
line-height: 18px;
-webkit-border-radius: 4px;
@ -335,7 +335,7 @@ li { line-height: 26px; }
}
*/
.note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning, .seealso, .admonition-todo {
.api, .note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning, .seealso, .admonition-todo {
padding: 12px;
line-height: 24px;
margin-bottom: 24px;
@ -370,6 +370,29 @@ li { line-height: 26px; }
.warning { background: #FFFFE1; }
.attention p { margin-top: 4px; }
/* Style for API document */
.api {
line-height: 18px;
background: #e7f2fa;
padding: 3px 12px 0px 0px;
margin-top: 0px;
margin-bottom: 0px;
}
.api .admonition-title {
background-color: white;
padding: 0px 12px 0px 5px;
}
.api > .admonition-title > code:nth-child(1) { background-color: green; }
.api > .admonition-title > code:nth-child(2) { background-color: green; }
.api > .admonition-title > code:nth-child(3) {
color: black;
background-color: white;
border: 0px;
font-family: 'PT Sans', Georgia, Palatino, serif;
font-size: 16px;
font-style: normal;
}
/* Table */
th { padding: 5px 10px 5px 10px; }
td { padding: 5px 10px 5px 10px; }

65
html/iredadmin-pro.restful.api-new.html
View File

@ -91,32 +91,14 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
<li>replace <code>&lt;mail&gt;</code> in URL by the real email address.</li>
</ul>
<h3 id="domain">Domain</h3>
<table>
<thead>
<tr>
<th>URL</th>
<th>HTTP Method</th>
<th>Summary</th>
</tr>
</thead>
<tbody>
<tr>
<td>/api/domain/&lt;domain></td>
<td>POST</td>
<td>Create a new domin</td>
</tr>
<tr>
<td>/api/domain/&lt;domain></td>
<td>DELETE</td>
<td>Delete an existing domain</td>
</tr>
<tr>
<td>/api/domain/&lt;domain></td>
<td>PUT</td>
<td>Update profile of an existing domain</td>
</tr>
</tbody>
</table>
<div class="admonition api">
<p class="admonition-title"><code>/api/domain/&lt;domain&gt;</code> <code>POST</code> <code>Create a new domain</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code>/api/domain/&lt;domain&gt;</code> <code>DELETE</code> <code>Delete an existing domain</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code>/api/domain/&lt;domain&gt;</code> <code>PUT</code> <code>Update profile of an existing domain</code></p>
<p>Possible <code>PUT</code> parameters used to update account profile:</p>
<table>
<thead>
@ -164,7 +146,38 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
</tr>
</tbody>
</table>
</div>
<h3 id="user">User</h3>
<div class="admonition api">
<p class="admonition-title"><code>/api/user/&lt;mail&gt;</code> <code>POST</code> <code>Create a new mail user</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code>/api/user/&lt;mail&gt;</code> <code>DELETE</code> <code>Delete an existing mail user</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code>/api/user/&lt;mail&gt;</code> <code>PUT</code> <code>Update profile of an existing mail user</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code>/api/users/&lt;domain&gt;</code> <code>PUT</code> <code>Update profiles of all mail user under domain</code></p>
</div>
<div class="admonition api">
<p class="admonition-title"><code>/api/users/&lt;domain&gt;/password</code> <code>PUT</code> <code>Update passwords of all users under domain</code></p>
<p id="param">Required parameter:</p>
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>password</code></td>
<td><code>password=Ww0nXVEV8iv4ap@p4b</code></td>
</tr>
</tbody>
</table>
</div>
<table>
<thead>
<tr>

2
html/upgrade.iredmail.0.9.2-0.9.3.html
View File

@ -397,7 +397,7 @@ and append below settings right after <code>ssl on</code> line:</p>
<pre><code># Use HTTP Strict Transport Security to force client to use secure connections only.
# Reference:
# https://developer.mozilla.org/en-US/docs/Web/Security/HTTP_strict_transport_security
add_header Strict-Transport-Security &quot;max-age=15768000&quot;
add_header Strict-Transport-Security &quot;max-age=15768000&quot;;
</code></pre>
<h3 id="sogo-fix-improper-settings-in-apachenginx-config-file">SOGo: Fix improper settings in Apache/Nginx config file</h3>

2
tools/markdown2html.py
View File

@ -12,7 +12,7 @@ import web
import markdown
# Markdown extensions
MD_EXTENSIONS = ['toc', 'meta', 'extra', 'footnotes', 'admonition', 'tables']
MD_EXTENSIONS = ['toc', 'meta', 'extra', 'footnotes', 'admonition', 'tables', 'attr_list']
# Get file name
filename = sys.argv[1]