From 967e196e6af9978591e7c3a10196a210364fb219 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Thu, 12 May 2016 22:03:14 +0800 Subject: [PATCH] Fixed: miss ';' in upgrade.iredmail.0.9.2-0.9.3.html in Nginx config file. --- README.md | 8 +++ en_US/faq/0-iredadmin-pro.restful.api-new.md | 41 +++++++----- .../upgrade/0-upgrade.iredmail.0.9.2-0.9.3.md | 2 +- html/css/markdown.css | 29 ++++++++- html/iredadmin-pro.restful.api-new.html | 65 +++++++++++-------- html/upgrade.iredmail.0.9.2-0.9.3.html | 2 +- tools/markdown2html.py | 2 +- 7 files changed, 102 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 9558d234..aa79ab44 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/en_US/faq/0-iredadmin-pro.restful.api-new.md b/en_US/faq/0-iredadmin-pro.restful.api-new.md index 3193037f..d832f5e8 100644 --- a/en_US/faq/0-iredadmin-pro.restful.api-new.md +++ b/en_US/faq/0-iredadmin-pro.restful.api-new.md @@ -62,26 +62,37 @@ Notes: ### Domain -URL | HTTP Method | Summary ---- | --- | --- -/api/domain/ | POST | Create a new domin -/api/domain/ | DELETE | Delete an existing domain -/api/domain/ | PUT | Update profile of an existing domain +!!! api "`/api/domain/` `POST` `Create a new domain`" +!!! api "`/api/domain/` `DELETE` `Delete an existing domain`" +!!! api "`/api/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/` `POST` `Create a new mail user`" +!!! api "`/api/user/` `DELETE` `Delete an existing mail user`" +!!! api "`/api/user/` `PUT` `Update profile of an existing mail user`" +!!! api "`/api/users/` `PUT` `Update profiles of all mail user under domain`" +!!! api "`/api/users//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/ | POST | Create a new mail user diff --git a/en_US/upgrade/0-upgrade.iredmail.0.9.2-0.9.3.md b/en_US/upgrade/0-upgrade.iredmail.0.9.2-0.9.3.md index 66e9940f..ad8c0087 100644 --- a/en_US/upgrade/0-upgrade.iredmail.0.9.2-0.9.3.md +++ b/en_US/upgrade/0-upgrade.iredmail.0.9.2-0.9.3.md @@ -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 diff --git a/html/css/markdown.css b/html/css/markdown.css index 011fe728..2c6f1592 100644 --- a/html/css/markdown.css +++ b/html/css/markdown.css @@ -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; } diff --git a/html/iredadmin-pro.restful.api-new.html b/html/iredadmin-pro.restful.api-new.html index 7cbbb99a..b243f99f 100644 --- a/html/iredadmin-pro.restful.api-new.html +++ b/html/iredadmin-pro.restful.api-new.html @@ -91,32 +91,14 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
  • replace <mail> in URL by the real email address.

    • Domain

    - - - - - - - - - - - - - - - - - - - - - - - - - -
    URLHTTP MethodSummary
    /api/domain/<domain>POSTCreate a new domin
    /api/domain/<domain>DELETEDelete an existing domain
    /api/domain/<domain>PUTUpdate profile of an existing domain
    +
    +

    /api/domain/<domain> POST Create a new domain

    +
    +
    +

    /api/domain/<domain> DELETE Delete an existing domain

    +
    +
    +

    /api/domain/<domain> PUT Update profile of an existing domain

    Possible PUT parameters used to update account profile:

    @@ -164,7 +146,38 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
    +

    User

    +
    +

    /api/user/<mail> POST Create a new mail user

    +
    +
    +

    /api/user/<mail> DELETE Delete an existing mail user

    +
    +
    +

    /api/user/<mail> PUT Update profile of an existing mail user

    +
    +
    +

    /api/users/<domain> PUT Update profiles of all mail user under domain

    +
    +
    +

    /api/users/<domain>/password PUT Update passwords of all users under domain

    +

    Required parameter:

    + + + + + + + + + + + + + +
    Parameter NameSample Usage
    passwordpassword=Ww0nXVEV8iv4ap@p4b
    +
    diff --git a/html/upgrade.iredmail.0.9.2-0.9.3.html b/html/upgrade.iredmail.0.9.2-0.9.3.html index bccce2a2..d12c8e61 100644 --- a/html/upgrade.iredmail.0.9.2-0.9.3.html +++ b/html/upgrade.iredmail.0.9.2-0.9.3.html @@ -397,7 +397,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

    diff --git a/tools/markdown2html.py b/tools/markdown2html.py index cf06f1cf..b442e2d4 100644 --- a/tools/markdown2html.py +++ b/tools/markdown2html.py @@ -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]