From d2d9b9f2a770615fb7dfd9630f58b40aaa1155f1 Mon Sep 17 00:00:00 2001 From: Zhang Huangbin Date: Thu, 25 May 2017 11:04:41 +0800 Subject: [PATCH] Mention iRedAdmin config file location. --- en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md | 7 +++++++ html/iredadmin-pro.restful.api.upcoming.html | 9 +++++++++ 2 files changed, 16 insertions(+) diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md b/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md index c8305f56..cf72a16f 100644 --- a/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md +++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.upcoming.md @@ -22,6 +22,13 @@ iRedAdmin-Pro RESTful API will return message in JSON format. ## Enable RESTful API +!!! note "iRedAdmin-Pro config file location" + + * on RHEL/CentOS, it's `/var/www/iredadmin/settings.py`. + * on Debian/Ubuntu, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail releases) or `/usr/share/apache2/iredadmin/settings.py` (in old iRedMail releases). + * on FreeBSD, it's `/usr/local/www/iredadmin/settings.py`. + * on OpenBSD, it's `/var/www/iredadmin/settings.py`. + RESTful API is disabled by default, to enable it, please add setting below in iRedAdmin-Pro config file `settings.py`: diff --git a/html/iredadmin-pro.restful.api.upcoming.html b/html/iredadmin-pro.restful.api.upcoming.html index 0abc48c2..84db8465 100644 --- a/html/iredadmin-pro.restful.api.upcoming.html +++ b/html/iredadmin-pro.restful.api.upcoming.html @@ -69,6 +69,15 @@
  • If operation failed, it returns JSON data: {'_success': false, '_msg': '<error_reason>'}.

    • Enable RESTful API

    +
    +

    iRedAdmin-Pro config file location

    + +

    RESTful API is disabled by default, to enable it, please add setting below in iRedAdmin-Pro config file settings.py:

    ENABLE_RESTFUL_API = True