hhvacation 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +38 -7
- metadata +3 -3
data/README.md
CHANGED
|
@@ -2,24 +2,55 @@
|
|
|
2
2
|
|
|
3
3
|
This is a drop-in replacement for the apparently no longer maintained
|
|
4
4
|
hhvacation program included in the
|
|
5
|
-
[GNU Hosting Helper](http://hostingsoftware.net/) suite.
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
[GNU Hosting Helper](http://hostingsoftware.net/) suite.
|
|
6
|
+
|
|
7
|
+
## Differences To The Original Version
|
|
8
|
+
|
|
9
|
+
This implementation of `hhvacation` only operates on so called
|
|
10
|
+
"virtual" vacation responses (i.e. those which are kept in a MySQL
|
|
11
|
+
database).
|
|
12
|
+
|
|
13
|
+
Another difference is that it not only checks the `To` header for
|
|
14
|
+
vacation responses but also the `Cc` and `Bcc` headers.
|
|
15
|
+
|
|
16
|
+
## Warning
|
|
17
|
+
|
|
18
|
+
Since this program is written in Ruby (i.e. its execution is
|
|
19
|
+
relatively resource intensive) and Postfix will call it for every mail
|
|
20
|
+
it delivers, it should not be used on high-volume servers. In any case
|
|
21
|
+
you should definitely keep an eye on the server load and look for
|
|
22
|
+
better alternatives. This program is merely a drop-in replacement for
|
|
23
|
+
existing setups which used the original `hhvacation` Perl script
|
|
24
|
+
included in `gnuhh` which depends on a deprecated MySQL library and
|
|
25
|
+
thus cannot be run without problems on more recent versions of Perl.
|
|
26
|
+
|
|
27
|
+
Also note that due to the high probability that this program is mostly
|
|
28
|
+
used with MySQL databases using the MyISAM storage engine it makes no
|
|
29
|
+
use of database transactions. This *may* result in vacation responses
|
|
30
|
+
being sent multiple times to the same recipient.
|
|
31
|
+
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
The program is available on `rubygems.org` thus
|
|
35
|
+
|
|
36
|
+
gem install hhvacation
|
|
37
|
+
|
|
38
|
+
should suffice to install it.
|
|
39
|
+
|
|
8
40
|
|
|
9
41
|
## Usage
|
|
10
42
|
|
|
11
|
-
Change your Postfix' master.cf to include a line like:
|
|
43
|
+
Change your Postfix' `master.cf` to include a line like:
|
|
12
44
|
|
|
13
45
|
vacation unix - n n - - pipe flags=DRhu user=vacation argv=/usr/bin/hhvacation-ruby /etc/hhvacation.yml
|
|
14
46
|
|
|
15
47
|
The actual settings may vary depending on your setup. The argument
|
|
16
|
-
passed to the hhvacation-ruby program which is
|
|
48
|
+
passed to the `hhvacation-ruby` program which is provided by this gem
|
|
17
49
|
must point to a YAML formatted config file. It must contain the
|
|
18
50
|
database connection information (see below for an example). Unless
|
|
19
51
|
configured otherwise, mails are delivered via the default method of
|
|
20
52
|
the `mail` gem (SMTP on localhost port 25 for version 2.2.5).
|
|
21
53
|
|
|
22
|
-
|
|
23
54
|
## Example config
|
|
24
55
|
|
|
25
56
|
database:
|
|
@@ -35,7 +66,7 @@ the `mail` gem (SMTP on localhost port 25 for version 2.2.5).
|
|
|
35
66
|
|
|
36
67
|
The `method` setting in the `mail` section may contain whatever method
|
|
37
68
|
is available in the `mail` gem. All further keys are directly passed
|
|
38
|
-
as settings for the method.
|
|
69
|
+
as settings for the selected method.
|
|
39
70
|
|
|
40
71
|
## Copyright
|
|
41
72
|
|
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: hhvacation
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
hash:
|
|
4
|
+
hash: 27
|
|
5
5
|
prerelease: false
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
8
|
- 0
|
|
9
|
-
-
|
|
10
|
-
version: 0.0.
|
|
9
|
+
- 2
|
|
10
|
+
version: 0.0.2
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Moritz Heidkamp
|