Installing ewok
===============

Requirements
------------

ewok requires a Unix-based apache with mod_perl support and the following 
perl modules installed:

 - HTML::Embperl (1.3.x recommended; 2.0 to be supported soon)
 - URI::Escape
 - File::DirSync
 - Config::Directory
 - HTML::Breadcrumbs

The following modules are also used, but are standard modules (at least
as of Perl 5.005):

 - Data::Dumper
 - Fcntl
 - POSIX
 - Carp
 - Safe
 - Getopt::Long

ewok installation requires root access, or at least the ability to add 
apache config files. This usually isn't a big deal in that you typically 
don't want to install ewok on a web hosting server - it's generally 
better to install it on an internal or home machine and push the 
published content out to your webhost.


Installation
------------

The Short Version
~~~~~~~~~~~~~~~~~

  $ gunzip -c /PATH/TO/ewok-0.X.Y-tar.gz | tar xvf -
  $ cd ewok-0.X.Y
  $ ./configure
  $ make 
  # make install           (either as your apache user or as root)

Then restart apache, and in a web browser go to:
  
  http://your.domain.com/ewok/admin/

to check the default configuration settings and to setup staging 
directories, etc. Login as 'admin'; the default password is 'ew0k'.
You should probably change the admin password - from your apache
config directory do:

  # htpasswd htpasswd.ewok admin


The Longer Version
~~~~~~~~~~~~~~~~~~

1. Unpack the distribution somewhere temporary (e.g. /usr/local/src):

  $ cd /usr/local/src
  $ gunzip -c /PATH/TO/ewok-0.X.Y-tar.gz | tar xvf -
  $ cd ewok-0.X.Y

2. Configure:

  $ ./configure

The configure will query you for the information it needs, namely the
location of your apache config directory, and where you want to install
ewok. These can also be given via GNU-configure-style long options:
--prefix and --apache-confdir. By default, the configure suggests you 
install ewok as a sibling directory to your apache document root (e.g.
/var/www/ewok, /opt/web/ewok, etc.), if it can find that. Note that 
ewok should NOT be install within your document root, for security.

The configure script also checks that you have the prerequisite perl 
modules are installed, and will complain and exit if they are not
available.

3. Make: 

  $ ./make

This basically munges a few files according to the locations specified
during the configure.

4. Install, either as the apache user or as root:

  # make install

5. Then restart apache, and in a web browser go to:
  
  http://your.domain.com/ewok/admin/

to check the default configuration settings and setup a site-specific
staging directory or two. Login as username 'admin', password 'ew0k'.

If you have a user repository you would like to use for ewok 
authentication (htpasswd file, LDAP directory, etc.), you can update
the APACHE_AUTH configuration setting in the ewok admin area to the
apache directives required. You should probably also update the 
EWOK_ADMINS variable to usernames in your existing repository.

If you do not have an existing user repository, you can add users to
the htpasswd.ewok user database in your apache config directory using 
the standard apache tools e.g.

  # htpasswd htpasswd.ewok <username>
  New password: <password>
  Re-type new password: <password>

You should at a minimum change the password on the 'admin' user from 
the default. i.e. in your apache config directory:

  # htpasswd htpasswd.ewok admin


Play!
-----

ewok should now be ready to try out. Go to http://your.domain.com/ewok/ 
and you should find yourself in the ewok file manager. You should
probably set up an initial staging directory from the 'ADMIN' link
at the top of the file manager, as a place to play around.

For an introduction to the file manager and ewok more generally,
see the "ewok User Guide" at http://your.domain.com/ewok/doc/user/ 
(or http://www.openfusion.com.au/labs/ewok/doc/user/ for the 
latest version).

For documentation on administering and managing ewok, see the
"ewok Admin Guide" at http://your.domain.com/ewok/doc/admin/
(or http://www.openfusion.com.au/labs/ewok/doc/admin/ for the
latest version).