++++++++++++++++++++++++++++++++++++++++
How to run the PokerTH dedicated server
++++++++++++++++++++++++++++++++++++++++

+++++++++++++++++++++++
1. System requirements
+++++++++++++++++++++++

The PokerTH server is officially supported on
Linux, Windows Vista and Windows Server 2008.

root/admin access during setup is recommended.
root/admin access is required if a strict firewall is running on the system.

RAM usage is low (about 5 MB when load is high), but due to frequent
allocations and thread usage, there will be problems if the PokerTH server
is run on a vserver with very limited memory.

+++++++++++++++++++++++++
2. Installation on Linux
+++++++++++++++++++++++++

2.1 Package dependencies (Linux)
---------------------------------

The following packages are required to compile the server:
* qmake (Qt development tools)
* boost 1.36, 1.38 recommended
  - boost-thread
  - boost-filesystem
  - boost-datetime
  - boost-program_options
  - boost-iostreams
  - boost-asio
  - boost-regex
* GnuTLS (any version should be fine)

The following packages are optional but recommended:
* monit (http://tildeslash.com/monit/)
* svn (subversion)

2.2 Compiling the server (Linux)
---------------------------------

If you have root access on the machine, create a new user for
the PokerTH daemon (for example named pokerth). The user is
*required* to have a home directory. Log in as the new user.

If you do not have root access, log in as usual.

To use the stable version, download the latest PokerTH
source release from http://www.pokerth.net/.
Unpack the source release:
	tar xjf PokerTH-0.6-2.src.tar.bz2

If you wish to use the current development version instead, run
	svn co http://pokerth.svn.sourceforge.net/svnroot/pokerth/trunk/pokerth

Enter the pokerth source directory:
	cd pokerth

Edit pokerth.pro and remove the pokerth_game.pro entry.

Create the Makefile and compile the PokerTH dedicated server:
	qmake
	make

2.3 Post-compile actions (Linux)
---------------------------------

The binary for the server is created in the bin/ subdirectory.
Move it to the main directory:
	mv bin/pokerth_server .

Make sure your firewall allows port 7234 (IP/IPv6, TCP and SCTP).
If you wish to use a different port, allow this port in your firewall,
and continue the steps.

2.4 First run of the server (Linux)
------------------------------------

Run the dedicated server using the full path:
	/home/username/pokerth/pokerth_server

It will not output anything and immediately return to the prompt.

Check that the server is running:
	ps ax | grep pokerth_server

The server will have created a directory ~/.pokerth
Take a peek at the log file:
	less ~/.pokerth/log-files/server_messages.log

It should look like this:
2007-Dec-23 21:38:01 MSG: Starting PokerTH dedicated server. Availability: IPv6 1, SCTP 1, Dual Stack 1.

If there are messages about non-existing avatar directories, you either
- did not start the pokerth_server using the full path (see above)
- did not move the pokerth_server to the main directory (step 2.3)

Now, stop the server again after the first start.
	killall pokerth_server

2.5 Configuring the server (Linux)
-----------------------------------

Open ~/.pokerth/config.xml using your favourite editor.
If you intend to use non-ascii characters for any option, make sure
you use the UTF-8 charset.

The options are described in Chapter 4.

If you have root access on the machine, it is recommended that you
set up "monit" to automatically restart pokerth_server if it
terminates. The players will be very frustrated if for some reason the
server crashes and is not restarted immediately. The PokerTH server
has been thoroughly tested and is very stable, but you never know...

To set up monit, first create the init-script for the server.

2.6 Sample /etc/init.d/pokerth_server script (Linux)
-----------------------------------------------------

This is a sample start/stop script for the pokerth_server daemon.
It can only be used if you have root access on the machine.

The script will start the process pokerth_server as user "pokerth".
It uses a simple hack to find out the process id of pokerth_server. This
will not work if you intend to run more than one PokerTH server on
a single machine.

-- cut here --
#!/bin/bash

case $1 in
	start)
		sudo -H -u pokerth /home/pokerth/pokerth/pokerth_server
		sleep 2
		pgrep -n pokerth_server > /var/run/pokerth_server.pid ;;
	stop)
		kill `cat /var/run/pokerth_server.pid` ;;
	*)
		echo "Usage: pokerth_server {start|stop}" ;;
esac
-- cut here --

2.7 Sample monit configuration (Linux)
---------------------------------------

The previous step is required to set up monit, so make sure the
init-script works.

Use the sample monit configuration file which comes with your monit
package as base. Edit the basic configuration, and READ THE MANUAL.
It is recommended to run monit as daemon, and to use a check-interval
no longer than 120 seconds.

Add the following lines to the monitrc configuration file:

-- cut here --
check process pokerth_server with pidfile /var/run/pokerth_server.pid
  start program = "/etc/init.d/pokerth_server start"
  stop  program = "/etc/init.d/pokerth_server stop"
  if 5 restarts within 5 cycles then timeout
-- cut here --

Make sure that pokerth_server is terminated. Then start monit. It will
automatically start pokerth_server. The easiest way to restart the server,
once monit is running, is to log in as user "pokerth" and run
	killall pokerth_server

This will cause monit to restart the pokerth_server within the configured
interval.

+++++++++++++++++++++++++++
3. Installation on Windows
+++++++++++++++++++++++++++

TODO

+++++++++++++++++++++++++++++++++
4. Configuration file config.xml
+++++++++++++++++++++++++++++++++

There are three areas for server configuration:
1. General server settings (like password and port)
2. IRC bot settings
   For admin usage, the server can join any IRC channel as bot.
   This will allow you to kick players and request server statistics.
3. Directory settings (which SHOULD be left as they are)

Relevant options are (with description):

1.
General server password:
	<ServerPassword value="" />

Enable IPv6 (has effect only if dual stack sockets are not supported):
	<ServerUseIpv6 value="0" />

Enable/disable SCTP (TCP will still be possible):
	<ServerUseSctp value="0" />

The server port which is bound:
	<ServerPort value="7234" />

2.
Make the server join as bot in an admin-only irc channel:
	<UseAdminIRC value="0" />

(the following is only applicable if UseAdminIRC is 1)

The irc server:
	<AdminIRCServerAddress value="chat.freenode.net" />

Port of the irc service:
	<AdminIRCServerPort value="6667" />

Admin irc channel name
(it is recommended to use a password protected channel):
	<AdminIRCChannel value="#test" />

The password for the admin irc channel:
	<AdminIRCChannelPassword value="" />

Enable IPv6 for the irc server:
	<AdminIRCServerUseIpv6 value="0" />

Nick name for the bot:
	<AdminIRCServerNick value="PokerTH" />

3. DO NOT CHANGE THE FOLLOWING OPTIONS UNLESS REALLY REALLY NEEDED

Directory for server logging, write access needed:
	<LogDir value="/Users/l-may/.pokerth/log-files/" />

Directory for PokerTH data files:
(only avatar data is needed, read access is sufficient):
	<UserDataDir value="/Users/l-may/.pokerth/data/" />

Directory for avatar cache:
	<CacheDir value="/Users/l-may/.pokerth/cache/" />


++++++++++++++++++++++++
5. Server Admin IRC bot
++++++++++++++++++++++++

The irc bot only accepts two commands within the configured channel.
Assuming the bot is named BotName, these commands are as follows:

Display statistics of the server:
	BotName: stat

Kick player named "foo" from the server:
	BotName: kick foo

Show the IP address of player "foo":
	BotName: showip foo

Ban a certain nick from the server, so it can no longer be used.
For this command, the name "fooRegex" can be any regular expression.
(Note: This does not affect players which are currently logged in):
	BotName: bannick fooRegex

Ban a certain client IP address from the server.
The IP address should be in the same format as printed by the
command "showip".
(Note: This does not affect players which are currently logged in):
	BotName: banip 1.2.3.4

List all bans currently active on the server:
	BotName: listban

Remove a ban with a certain id from the list of bans
(use the ban id from the listban command):
	BotName: removeban 1

Send a global chat message through the server:
	BotName: chat This is a global chat message.

Send a global message box through the server:
	BotName: msg This is a global message box.

The bot always answers to "BotName: " style commands.
It ignores private messages. 


2007-2009 by Lothar May
