========
Contents
========

This archive contains NephthysServerAdmin.

Nephthys is a native modification for Unreal 1 engine based games (Unreal, Deus Ex, Rune).

NephthysServerAdmin is a Web Admin interface for servers running Nephthys.

You need a proper Nephthys installation for NephthysServerAdmin.

============
Installation
============

1.	Extract the entire Web folder to your Unreal (Deus Ex / Rune) installation folder.

2.	Copy your current Help\Nephthys-Documentation.html to Web\Nephthys\html

3.	Extract all files from the folder corresponding to your exact game engine version to your server installation's System folder.
	If there's no files for your exact game engine version then don't use files for a different game engine version: they won't work.

4.	Edit your server's System/Unreal.ini (DeusEx.ini / Rune.ini; a backup before any changes is recommended; use e.g. notepad as editor):
	Find the section "[UWeb.WebServer]" (without the quotes).

	a)	If you don't have that section yet, then append at the end of your .ini file:

		[UWeb.WebServer]
		Applications[0]=NephthysServerAdmin.NephthysServerAdmin
		ApplicationPaths[0]=/nephthys
		DefaultApplication=0
		bEnabled=True
		ListenPort=8080

	b)	If you have that section already, choose the next free slot (usually 2) and add/change it to:

		Applications[2]=NephthysServerAdmin.NephthysServerAdmin
		ApplicationPaths[2]=/nephthys

	Remember that ListenPort well:
	You may have to enable your firewall to allow incoming tcp traffic to that port to your game server program from all addresses you want to use the web admin from.
	You also may have to add a port forwarding in your NAT router for that port to your game server's LAN computer if you plan to use the web admin from outside of your local area (home) network.

5.	Check your ServerActors (NOT ServerPackages!):
	Find the section "[Engine.GameEngine]" (without the quotes) in your server's System/Unreal.ini and search for a line "ServerActors=UWeb.WebServer".

	If you already have that line then comment it out:

		;ServerActors=UWeb.WebServer

	Then add a new line right below (or right below the existing "ServerActors=" lines):

		ServerActors=NephthysServerAdmin.NptWebServer

=====
Usage
=====

Start your browser (Firefox is recommended, IE should work too) and enter into the address bar:

	http://<your-server-ip-or-name>:8080/nephthys
	(or whatever port number you chose as "ListenPort")

Using it from the same computer with the ListenPort from above, this should work always (note that URLs are case sensitive):

	http://127.0.0.1:8080/nephthys

You need to authenticate yourself when using the WebAdmin (= you're prompted for a username and a password).
The defaults are:

	username:	npt
	password:	npt

Please change these default account data: Search for "[NephthysServerAdmin.NephthysServerAdmin]" in your Nephthys.ini.
If you can't find that section, start your game server and enter:

	admin set NephthysServerAdmin.NephthysServerAdmin AdminUsername your-username-here

After you entered this command, the section is automatically created completely.

======================
Connection acceptation
======================

For security, NptWebServer checks incoming connections whether to be accepted or denied, so only certain computers can use the web admin.

The Nephthys ban table applies for NephthysServerAdmin.NptWebServer as well. So be sure the IP address of your client computer isn't banned by Nephthys.

NephthysServerAdmin.NptWebServer also supports a table of IPPolicies which works exactly like known from Unreal Tournament, Rune, Deus Ex.

NptWebServer IPPolicies are configurable in Advanced Options -> Nephthys -> Nephthys Server -> WebServer -> IPPolicies.
If you don't have access to the advanced options you have to edit Nephthys.ini: Search for the section "[NephthysServerAdmin.NptWebConnection]" (or create it at the end of the file) and add a line e.g. like "IPPolicies[0]=ACCEPT,*" (without the quotes). Entries from IPPolicies[0] up to IPPolicies[49] are considered.

The IPPolicies is a list of rules. The last matching rule decides whether the connection is accepted or denied (be careful if more than one rule matches!).

Each rule is a single line in the form "Policy,Mask". The Policy is one of "ACCEPT" or "DENY". The Mask is either a complete IP address (e.g. "123.123.123.123") or a part of an IP address followed by an asterisk ("*") which means that all IP addresses beginning with the given part match.

By default, the first rule is "ACCEPT,*" (= accept all).

If you want to accept connections only from local web admins, then your IPPolicies would read:

IPPolicies[0]=DENY,*
IPPolicies[1]=ACCEPT,127.*

The option bQuiet decides whether denied connections attempts are logged or not:
bQuiet=False (default) means denied connections attempts are logged.
bQuiet=True means denied connections attempts are NOT logged.

=========
Copyright
=========

(C) 2008-2009 Zora

===========
End of File
===========