Release 0.03 with RT 5 support
[manu/RT-Extension-MessageSizeLimit.git] / README
1 NAME
2     RT-Extension-MessageSizeLimit - Force web message size limit on ticket
3     create/update
4
5 DESCRIPTION
6     This RT extension enforces a certain message size limit when a user
7     create a ticket or make a comment/correspondance on it.
8
9     It uses a guess of outgoing mail size based on
10     subject/content/attachments. It may miss a few bytes from mail headers,
11     templates contents.
12
13     You would typically set the limit a little bit lower than your outgoing
14     MTA limit.
15
16     See the configuration example under "INSTALLATION".
17
18 INSTALLATION
19     "perl Makefile.PL"
20     "make"
21     "make install"
22         May need root permissions
23
24     Edit your /opt/rt4/etc/RT_SiteConfig.pm
25         If you are using RT 4.2 or greater, add this line:
26
27             Plugin('RT::Extension::MessageSizeLimit');
28
29         For RT 4.0, add this line:
30
31             Set(@Plugins, qw(RT::Extension::MessageSizeLimit));
32
33         or add "RT::Extension::MessageSizeLimit" to your existing @Plugins
34         line.
35
36         Then configure the limit (default 9MB) using the $MessageSizeLimit
37         config option. This option takes the generic form of:
38
39             Set( $MessageSizeLimit, BYTES );
40
41     Clear your mason cache
42             rm -rf /opt/rt4/var/mason_data/obj
43
44     Restart your webserver
45
46 TODO
47     Dynamic enforcement using javascript
48     Allow translation of size units
49
50 AUTHOR
51     Emmanuel Lacour, <elacour@home-dn.net>
52
53 BUGS
54     All bugs should be reported via email to
55
56         L<bug-RT-Extension-MessageSizeLimit@rt.cpan.org|mailto:bug-RT-Extension-MessageSizeLimit@rt.cpan.org>
57
58     or via the web at
59
60         L<rt.cpan.org|http://rt.cpan.org/Public/Dist/Display.html?Name=RT-Extension-MessageSizeLimit>.
61
62 LICENSE AND COPYRIGHT
63     This software is Copyright (c) 2016 by Emmanuel Lacour
64     <elacour@home-dn.net>
65
66     This is free software, licensed under:
67
68       The GNU General Public License, Version 2, June 1991
69