1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
=========================
Installing Vacation 3.0
=========================
:Last update: $Date: 2006/04/03 20:45:51 $
:Revision: $Revision: 1.17 $
:Contact: sork@lists.horde.org
.. contents:: Contents
.. section-numbering::
This document contains instructions for installing the Vacation
Auto-Responding Manager.
For information on the capabilities and features of Vacation, see the file
README_ in the top-level directory of the Vacation distribution.
Obtaining Vacation
==================
Vacation can be obtained from the Horde website and FTP server, at
http://www.horde.org/vacation/
ftp://ftp.horde.org/pub/vacation/
Or use the mirror closest to you:
http://www.horde.org/mirrors.php
Bleeding-edge development versions of Vacation are available via CVS; see the
file `horde/docs/HACKING`_ in the Horde distribution, or the website
http://www.horde.org/source/, for information on accessing the Horde CVS
repository.
Prerequisites
=============
To function properly, Vacation **requires** the following:
1. A working Horde installation.
Vacation runs within the `Horde Application Framework`_, a set of common
tools for Web applications written in PHP. You must install Horde before
installing Vacation.
.. Important:: Vacation 3.0 requires version 3.0+ of the Horde Framework -
earlier versions of Horde will **not** work.
.. _`Horde Application Framework`: http://www.horde.org/horde/
The Horde Framework can be obtained from the Horde website and FTP server,
at
http://www.horde.org/horde/
ftp://ftp.horde.org/pub/horde/
Many of Vacation's prerequisites are also Horde prerequisites.
.. Important:: Be sure to have completed all of the steps in the
`horde/docs/INSTALL`_ file for the Horde Framework before
installing Vacation.
2. The following PHP capabilities:
a. FTP support ``--enable-ftp`` [OPTIONAL]
FTP support is necessary if you want to use one of the FTP drivers.
b. LDAP support ``--with-ldap`` [OPTIONAL]
LDAP support is necessary if you want to use the LDAP driver.
3. An FTP server installed, running, and working if you want to use one of the
FTP drivers.
4. A vacation program installed, running, and working on localhost. This code
is based on a RedHat Linux based vacation program and/or the linux port of
the 386BSD vacation program by Alexey Nogin.
Installing Vacation
===================
Vacation is written in PHP, and must be installed in a web-accessible
directory. The precise location of this directory will differ from system to
system. Conventionally, Vacation is installed directly underneath Horde in
the web server's document tree.
Since Vacation is written in PHP, there is no compilation necessary; simply
expand the distribution where you want it to reside and rename the root
directory of the distribution to whatever you wish to appear in the URL. For
example, with the Apache web server's default document root of
``/usr/local/apache/htdocs``, you would type::
cd /usr/local/apache/htdocs/horde
tar zxvf /path/to/vacation-x.y.z.tar.gz
mv vacation-x.y.z vacation
and would then find Vacation at the URL::
http://your-server/horde/vacation/
Configuring Vacation
====================
1. Configuring Horde for Vacation
a. Register the application
In ``horde/config/registry.php``, find the ``applications['vacation']``
stanza. The default settings here should be okay, but you can change
them if desired. If you have changed the location of Vacation relative
to Horde, either in the URL, in the filesystem or both, you must update
the ``fileroot`` and ``webroot`` settings to their correct values.
2. Configuring Vacation
You must login to Horde as a Horde Administrator to finish the
configuration of Vacation. Use the Horde ``Administration`` menu item to
get to the administration page, and then click on the ``Configuration``
icon to get the configuration page. Select ``Vacation`` from the selection
list of applications. Fill in or change any configuration values as
needed. When done click on ``Generate Vacation Configuration`` to generate
the ``conf.php`` file. If your web server doesn't have write permissions
to the Vacation configuration directory or file, it will not be able to
write the file. In this case, go back to ``Configuration`` and choose one
of the other methods to create the configuration file
``vacation/config/conf.php``.
Note for international users: Vacation uses GNU gettext to provide local
translations of text displayed by applications; the translations are found
in the ``po/`` directory. If a translation is not yet available for your
locale (and you wish to create one), see the ``horde/po/README`` file, or
if you're having trouble using a provided translation, please see the
`horde/docs/TRANSLATIONS`_ file for instructions.
Known Problems
==============
Sendmail
--------
If you get a message from Sendmail that it "cannot mail directly to a program"
you either have an old buggy Sendmail or you didn't set up ``/etc/smrsh``
correctly for vacation.
FTP/Dot-forward Driver
----------------------
Realize that this driver works by setting up a ``.forward`` file in the user's
account. It does this (at the moment) in a exclusive fashion. If a
``.forward`` already exists, it must be removed first, it does not
append/prepend to the existing file. This means you cannot set both a
forward and a vacation message at the same time. This is rarely an issue, as
you rarely want to both forward your mail and have a vacation notice on the
forwarding (rather than receiving) end.
If in doubt, please run the ``horde/test.php`` file and make sure FTP is
enabled in php.
Obtaining Support
=================
If you encounter problems with Vacation, help is available!
The Horde Frequently Asked Questions List (FAQ), available on the Web at
http://www.horde.org/faq/
The Horde Project runs a number of mailing lists, for individual applications
and for issues relating to the project as a whole. Information, archives, and
subscription information can be found at
http://www.horde.org/mail/
Lastly, Horde developers, contributors and users also make occasional
appearances on IRC, on the channel #horde on the Freenode Network
(irc.freenode.net).
Please keep in mind that Vacation is free software written by volunteers.
For information on reasonable support expectations, please read
http://www.horde.org/support.php
Thanks for using Vacation!
The Vacation team
.. _README: ?f=README.html
.. _`horde/docs/HACKING`: ../../horde/docs/?f=HACKING.html
.. _`horde/docs/INSTALL`: ../../horde/docs/?f=INSTALL.html
.. _`horde/docs/TRANSLATIONS`: ../../horde/docs/?f=TRANSLATIONS.html
|