README

clicker
=======

Remote control server/client for controlling home theater devices


The server will run as the user/group you start it as by default.  It
is recommended to create a system account for the server to run as.  The
user and group to run as can be specified in the server.cfg config file.

To do this, create a 'clicker' system user.  You should have your group
setting set to the 'dialout' group to allow access the serial ports that
are used by your devices.  Simply adding your user to the 'dialout' group
will not work since the process is run setuid/setgid, so group membership
is never set.

The default server.cfg file in the source tree has user and group settings
for 'clicker' and 'dialout'.  Comment these lines out if you want to run
clicker as the user you start the process as.  Just note that you will
need permission to access the serial ports.

The clicker user will need access to create and delete the pidfile that is
specified in server.cfg.  It is recommended to create a /var/run/clicker
directory that is owned by the clicker user/group, which should be used
to store the pidfile.

Your user will also need access to write your log file.  It is recommended
that you create a '/var/log/clicker' directory that is owned by your user
and group with permissions that allow you to create files within.  The log
file setting in server.xml should specify a file in that directory.

The user the server runs as only needs read access to the config files.  It
is recommended that the config files be owned by root with permissions of
644.