New: iredadmin-pro.custom.ban.rules.html.
This commit is contained in:
Zhang Huangbin
parent
7c78ad35fe
commit
4d9d2f81dc
|
|
@ -0,0 +1,89 @@
|
|||
# iRedAdmin-Pro: Custom (Amavisd) ban rules
|
||||
[TOC]
|
||||
|
||||
## Builtin ban rules
|
||||
|
||||
iRedMail-1.4.1 ships 4 builtin Amavisd ban rules, they're defined in
|
||||
[Amavisd config file](./file.locations.html#amavisd) like below:
|
||||
|
||||
```
|
||||
%banned_rules = (
|
||||
# Allow all Microsoft Office documents.
|
||||
'ALLOW_MS_OFFICE' => new_RE([qr'.\.(doc|docx|xls|xlsx|ppt|pptx)$'i => 0]),
|
||||
|
||||
# Allow Microsoft Word, Excel, PowerPoint documents separately.
|
||||
'ALLOW_MS_WORD' => new_RE([qr'.\.(doc|docx)$'i => 0]),
|
||||
'ALLOW_MS_EXCEL' => new_RE([qr'.\.(xls|xlsx)$'i => 0]),
|
||||
'ALLOW_MS_PPT' => new_RE([qr'.\.(ppt|pptx)$'i => 0]),
|
||||
|
||||
# Default rule.
|
||||
'DEFAULT' => $banned_filename_re,
|
||||
);
|
||||
```
|
||||
|
||||
## Add new ban rules
|
||||
|
||||
You're free to add new ban rules inside `%banned_rules = ();` parameter.
|
||||
For example, let's add new rule `BLOCK_COMPRESS` to block few compress file
|
||||
formats, and `ALLOW_PDF` to allow / bypass `.pdf` files:
|
||||
|
||||
```
|
||||
%banned_rules = (
|
||||
# ... omit other existing rules here ...
|
||||
|
||||
'BLOCK_COMPRESS' => new_RE([qr'.\.(zip|7z|gz|bz2|tar|rar)$'i]),
|
||||
'ALLOW_PDF' => new_RE([qr'.\.pdf$'i => 0]),
|
||||
)
|
||||
```
|
||||
|
||||
Restarting Amavisd service is required after updated its config file.
|
||||
|
||||
If you're running iRedAdmin-Pro, please list your custom rules in its config
|
||||
file `/opt/www/iredadmin/settings.py` like below, so that you can use them
|
||||
in per-user, per-domain and global `Spam Policy` page.
|
||||
|
||||
```
|
||||
# Add this parameter if it doesn't exist.
|
||||
# The syntax is (Python dictionary):
|
||||
# {
|
||||
# "rule-name-1": "comment-2",
|
||||
# "rule-name-2": "comment-2",
|
||||
# }
|
||||
AMAVISD_BAN_RULES = {
|
||||
"BLOCK_COMPRESS": "Block compressed files (zip, 7z, gz, bz2, tar, rar)",
|
||||
"ALLOW_PDF": "Allow PDF files (.pdf)
|
||||
}
|
||||
```
|
||||
|
||||
Restarting "iredadmin" service is required after updated its config file.
|
||||
|
||||
## How to use the ban rules
|
||||
|
||||
### Assign ban rules with iRedAdmin-Pro
|
||||
|
||||
With iRedAdmin-Pro, you can easily manage per-user, per-domain and global spam
|
||||
policies, including ban rules.
|
||||
|
||||
- For per-user ban rules, please go to user profile page, tab "__Spam Policy__".
|
||||
- For per-domain ban rules, please go to domain profile page, tab "__Spam Policy__".
|
||||
- For global ban rules, please click "__System__" on main navigation bar, then
|
||||
choose "__Global Spam Policy__".
|
||||
|
||||
Note: per-user spam policy has the highest priority, and global one has the
|
||||
lowest priority.
|
||||
|
||||
### Assign ban rules with SQL command line
|
||||
|
||||
If you already define per-user, per-domain, or global spam policy with
|
||||
iRedAdmin-Pro or manually, you can now assign these ban rules to them.
|
||||
|
||||
For example, if you have spam policy for user `user@domain.com`, to allow
|
||||
this user to accept Microsoft Word and Excel documents, you can run SQL
|
||||
commands below to achieve it (Note: we use MySQL for example):
|
||||
|
||||
```
|
||||
USE amavisd;
|
||||
UPDATE policy SET banned_rulenames="ALLOW_MS_WORD,ALLOW_MS_EXCEL" WHERE policy_name="user@domain.com";
|
||||
```
|
||||
|
||||
Multiple rule names must be separated by comma.
|
||||
|
|
@ -216,6 +216,7 @@
|
|||
</ul>
|
||||
<h3 id="iredadmin">iRedAdmin-Pro</h3>
|
||||
<ul>
|
||||
<li><a href="iredadmin-pro.custom.ban.rules.html">iRedAdmin-Pro: Custom (Amavisd) ban rules</a></li>
|
||||
<li><a href="iredadmin-pro.custom.base.url.html">iRedAdmin-Pro: Custom base url (/iredadmin)</a></li>
|
||||
<li><a href="iredadmin-pro.custom.logo.html">iRedAdmin-Pro: Custom logo image, brand name, short product description</a></li>
|
||||
<li><a href="iredadmin-pro.custom.user.services.html">iRedAdmin-Pro (LDAP backend): Add and manage custom services for mail user</a></li>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,103 @@
|
|||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>iRedAdmin-Pro: Custom (Amavisd) ban rules</title>
|
||||
<link rel="stylesheet" type="text/css" href="./css/markdown.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="navigation">
|
||||
<a href="https://www.iredmail.org" target="_blank">
|
||||
<img alt="iRedMail web site"
|
||||
src="./images/logo-iredmail.png"
|
||||
style="vertical-align: middle; height: 30px;"
|
||||
/>
|
||||
<span>iRedMail</span>
|
||||
</a>
|
||||
// <a href="./index.html">Document Index</a></div><h1 id="iredadmin-pro-custom-amavisd-ban-rules">iRedAdmin-Pro: Custom (Amavisd) ban rules</h1>
|
||||
<div class="toc">
|
||||
<ul>
|
||||
<li><a href="#iredadmin-pro-custom-amavisd-ban-rules">iRedAdmin-Pro: Custom (Amavisd) ban rules</a><ul>
|
||||
<li><a href="#builtin-ban-rules">Builtin ban rules</a></li>
|
||||
<li><a href="#add-new-ban-rules">Add new ban rules</a></li>
|
||||
<li><a href="#how-to-use-the-ban-rules">How to use the ban rules</a><ul>
|
||||
<li><a href="#assign-ban-rules-with-iredadmin-pro">Assign ban rules with iRedAdmin-Pro</a></li>
|
||||
<li><a href="#assign-ban-rules-with-sql-command-line">Assign ban rules with SQL command line</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<h2 id="builtin-ban-rules">Builtin ban rules</h2>
|
||||
<p>iRedMail-1.4.1 ships 4 builtin Amavisd ban rules, they're defined in
|
||||
<a href="./file.locations.html#amavisd">Amavisd config file</a> like below:</p>
|
||||
<pre><code>%banned_rules = (
|
||||
# Allow all Microsoft Office documents.
|
||||
'ALLOW_MS_OFFICE' => new_RE([qr'.\.(doc|docx|xls|xlsx|ppt|pptx)$'i => 0]),
|
||||
|
||||
# Allow Microsoft Word, Excel, PowerPoint documents separately.
|
||||
'ALLOW_MS_WORD' => new_RE([qr'.\.(doc|docx)$'i => 0]),
|
||||
'ALLOW_MS_EXCEL' => new_RE([qr'.\.(xls|xlsx)$'i => 0]),
|
||||
'ALLOW_MS_PPT' => new_RE([qr'.\.(ppt|pptx)$'i => 0]),
|
||||
|
||||
# Default rule.
|
||||
'DEFAULT' => $banned_filename_re,
|
||||
);
|
||||
</code></pre>
|
||||
|
||||
<h2 id="add-new-ban-rules">Add new ban rules</h2>
|
||||
<p>You're free to add new ban rules inside <code>%banned_rules = ();</code> parameter.
|
||||
For example, let's add new rule <code>BLOCK_COMPRESS</code> to block few compress file
|
||||
formats, and <code>ALLOW_PDF</code> to allow / bypass <code>.pdf</code> files:</p>
|
||||
<pre><code>%banned_rules = (
|
||||
# ... omit other existing rules here ...
|
||||
|
||||
'BLOCK_COMPRESS' => new_RE([qr'.\.(zip|7z|gz|bz2|tar|rar)$'i]),
|
||||
'ALLOW_PDF' => new_RE([qr'.\.pdf$'i => 0]),
|
||||
)
|
||||
</code></pre>
|
||||
|
||||
<p>Restarting Amavisd service is required after updated its config file.</p>
|
||||
<p>If you're running iRedAdmin-Pro, please list your custom rules in its config
|
||||
file <code>/opt/www/iredadmin/settings.py</code> like below, so that you can use them
|
||||
in per-user, per-domain and global <code>Spam Policy</code> page.</p>
|
||||
<pre><code># Add this parameter if it doesn't exist.
|
||||
# The syntax is (Python dictionary):
|
||||
# {
|
||||
# "rule-name-1": "comment-2",
|
||||
# "rule-name-2": "comment-2",
|
||||
# }
|
||||
AMAVISD_BAN_RULES = {
|
||||
"BLOCK_COMPRESS": "Block compressed files (zip, 7z, gz, bz2, tar, rar)",
|
||||
"ALLOW_PDF": "Allow PDF files (.pdf)
|
||||
}
|
||||
</code></pre>
|
||||
|
||||
<p>Restarting "iredadmin" service is required after updated its config file.</p>
|
||||
<h2 id="how-to-use-the-ban-rules">How to use the ban rules</h2>
|
||||
<h3 id="assign-ban-rules-with-iredadmin-pro">Assign ban rules with iRedAdmin-Pro</h3>
|
||||
<p>With iRedAdmin-Pro, you can easily manage per-user, per-domain and global spam
|
||||
policies, including ban rules.</p>
|
||||
<ul>
|
||||
<li>For per-user ban rules, please go to user profile page, tab "<strong>Spam Policy</strong>".</li>
|
||||
<li>For per-domain ban rules, please go to domain profile page, tab "<strong>Spam Policy</strong>".</li>
|
||||
<li>For global ban rules, please click "<strong>System</strong>" on main navigation bar, then
|
||||
choose "<strong>Global Spam Policy</strong>".</li>
|
||||
</ul>
|
||||
<p>Note: per-user spam policy has the highest priority, and global one has the
|
||||
lowest priority.</p>
|
||||
<h3 id="assign-ban-rules-with-sql-command-line">Assign ban rules with SQL command line</h3>
|
||||
<p>If you already define per-user, per-domain, or global spam policy with
|
||||
iRedAdmin-Pro or manually, you can now assign these ban rules to them.</p>
|
||||
<p>For example, if you have spam policy for user <code>user@domain.com</code>, to allow
|
||||
this user to accept Microsoft Word and Excel documents, you can run SQL
|
||||
commands below to achieve it (Note: we use MySQL for example):</p>
|
||||
<pre><code>USE amavisd;
|
||||
UPDATE policy SET banned_rulenames="ALLOW_MS_WORD,ALLOW_MS_EXCEL" WHERE policy_name="user@domain.com";
|
||||
</code></pre>
|
||||
|
||||
<p>Multiple rule names must be separated by comma.</p><div class="footer">
|
||||
<p style="text-align: center; color: grey;">All documents are available in <a href="https://github.com/iredmail/docs/">GitHub 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://github.com/iredmail/docs/archive/master.zip">download the latest version</a> for offline reading. If you found something wrong, please do <a href="https://www.iredmail.org/contact.html">contact us</a> to fix it.</p>
|
||||
</div></body></html>
|
||||
Loading…
Reference in New Issue