Configuration

Applications

Applications contain the commands you can enter into the system. There are a couple of application included with the system.
To install a application to have to add it to the application list of the GatewatDaemon in the system configuration:

[UnGateway.GatewayDaemon]
ApplicationClasses=<application class 1>
ApplicationClasses=<application class 2>
ApplicationClasses=...

You can add as many application classes as you want.

The following application classes are included with the system:

class name description

UnGateway.GAppDebug Contains debug commands, there's no need to install this application

UnGateway.GAppDefault Contain default commands like "help" and "quit"

UnGateway.GAppCron Provides a cron daemon to program commands to be executed at a set time.

UGUT2004.GAppSystem Provides general system commands for UT2004, like shutdown and servertravel

UGUT2004.GAppSettings Contains commands to change settings and maplists

For an overview of all available commands and some additional information checkt the UnGateway-help.html file

class name	description
`UnGateway.GAppDebug`	Contains debug commands, there's no need to install this application
`UnGateway.GAppDefault`	Contain default commands like "help" and "quit"
`UnGateway.GAppCron`	Provides a cron daemon to program commands to be executed at a set time.
`UGUT2004.GAppSystem`	Provides general system commands for UT2004, like shutdown and servertravel
`UGUT2004.GAppSettings`	Contains commands to change settings and maplists

Interfaces

Out of the box UnGateway doesn't do much. You need to configure interfaces and applications that are available. To add an interface add the following to your system configuration:

[UnGateway.GatewayDaemon]
InterfaceClasses=<interface class 1>
InterfaceClasses=<interface class 2>
InterfaceClasses=...

The following interface classes are available:

class name description

UnGateway.GITelnetd Telnet server, emulates a VT102 terminal server

UnGateway.GIIRCd IRC server

class name	description
`UnGateway.GITelnetd`	Telnet server, emulates a VT102 terminal server
`UnGateway.GIIRCd`	IRC server

Other options

Besides the interfaces and the applications you can also change the following setting. However, most of these don't require any changes.

[UnGateway.GatewayDaemon]
Verbose=0
AuthClass=UnGateway.GAuthSystem
CmdAliases=(alias="reboot",command="shutdown now \"restarting the server, please return in a couple of second\"")
CmdAliases=(alias="p",command="players %@")
...

Verbose
: This sets the log verbosity. It's a binary list of flags: Error = 1; Warning = 2; Info = 4; Event = 8; Debug = 128. You probably only want to set the Error flag and maybe the Warning flag.
AuthClass: This is the authentication system used to authenticate the logins. The system comes with one system UnGateway.GAuthSystem, this will just used the UT2004's AccessControll class to validate the logins.
CmdAliases: This will allow you to create aliases for certain commands. You can have as many aliases as you want, you can only use real commands in the command value of the alias. Aliases have a higher priority than the actual commands. these aliases are system wide, so every user can use these aliases. By default no aliases have been configured.

General interface configuration

Each interface has the following configuration options. Additional configuration options may be available per interface.

iListenPort=0
bUseNextAvailable=false
iMaxClients=10
AccessPolicy=(hostmask="*",policy=AP_Allow)
...

iListenPort: The TCP port to listen on for incoming connections. By default the built-in interfaces have not configured any listen port. So you will have to set them up correctly before you start the server.
bUseNextAvailable: If the listen port is already in use, use the next available port to bind to. It's adviced to set this value to false.
iMaxClients: The maximum number of clients allowed. If the max has been reached, new clients will be denied.
AccessPolicy: This controlls from which IP mask client may or may not connect from. The default policy is to accept clients from any IP mask. The order of the AccessPolicy is important, the last match has the final ruling.
The hostmask can contain the following wildcards: * = zero or more matches; ? = one single character.
The policy can either be AP_Allow or AP_Deny

Application configuration

Some applications have configurable options. Unless stated otherwise, all configurations belong in the system configuration.

UnGateway.GAppCron

[UnGateway.GAppCron]
CronClass=UnGateway.Cron

CronClass: the Cron daemon class, no need to change this

UnGateway.Cron

[UnGateway.Cron]
DummyClientClass=UnGateway.CronClient
Crontab=(Command="somecommand",Type=EC_Delay,Time="5",Desc="added by Admin",bDisabled=False)
...

DummyClientClass

The dummy client used to capture the output of commands. No need to change this

Crontab

The cron configuration. You can add as many cron entries as you want.

field	description
Command	the command to secute
Type	`EC_Delay` or `EC_Time`
Time	time configuration, format depends on the value of Type.
Desc	description
bDisabled	when true the command will never be executed

EC_Delay

The command will be executed after set number of minutes after the level has been loaded.

EC_Time

The command will be executed when the set time has been reached.
Time field format, 5 fields: minute hour day month day_of_week

minute:	0-59
hour:	0-23
day:	0-31
month:	0-11
day_of_week:	0-6

A * can be used as wild card. Optionally each field can have a divider for re-occurance: val/div. For example a field has the value: "0/5". This means that it will match: time % div == val -> time % 5 == 0. If time is minutes then it will match every 5 minutes, 1/5 will also match every 5 minutes, except that it's the 2nd minute of every 5 minutes, 5/5 will never match. A wildcard in a divider will be changed to 0: * /5 -> 0/5, 0/ * -> 0/0 (never matches)

UnGateway.CronClient

[UnGateway.CronClient]
bSilent=false
bExternalLog=false
LogFilename="crondaemon_%P"

bSilent

only log errors

bExternalLog

use and external log file

LogFilename

Log filename to use. The following formatting rules are accepted:

%P	server port
%Y	year
%M	month
%D	day
%H	hour
%I	minute
%S	second
%W	day of the week

Interface configuration

Most interfaces (or it's client handlers) have additional configuration options.

UnGateway.GITelnetd

No additional configuration options for the interface. But the client handler has some options.

UnGateway.GCTelnet

[UnGateway.GCTelnet]
CommandPrompt="%username%@%computername%:~$ "
iMaxLogin=3
fDelayInitial=0.0
fDelayWrongPassword=5.0
bDisableAuth=false
bEnablePager=true
bSaveHistory=false
CommandHistoryClass=UnGateway.TelnetCommandHistory
ChatMode=CM_Disabled
bShowMotd=true
MOTD=...
MOTD=...
...

CommandPrompt

The command prompt format. The following replacements can be used:
%username%, %computername%, %hostname%, %hostaddress%, %clientaddress%

iMaxLogin

The maximum login tries before the connection is closed.

fDelayInitial

the number of seconds to wait before the user can try to log in.

fDelayWrongPassword

Number of seconds to wait before a user can try to log in again. this prevents brute forcing a password.

bDisableAuth

Disable authentication completely. You should not do this, it will allow everybody to login without a username and password.

bEnablePager

The pager is the automatic scroll feature that allows users to scroll up or down when a command output is more than could fit on the screen.

bSaveHistory

Save each user's command history to the UnGateway.ini file. This will add some useless overhead during login and logout.

CommandHistoryClass

The class to spawn for saving\loading the command history

ChatMode

The intial chat mode. With full chat mode everything the user enters will be a chat command. With partial chat only part of the screen is reserved for messages and only when the user uses the say command it will be considerd as a chat message.

`CM_Disabled`	Disabled
`CM_Full`	Full chat mode
`CM_Partial`	Partial chat mode

When logged in you can use the following commands to change the chat mode:

`Alt+c`	toggle partial chat mode
`Alt+C`	full chat mode

Note: instead of Alt the Esc can be used

bShowMotd

Show the message of the day

MOTD

The Messsage Of The Day.

UnGateway.GIIRCd

No additional configuration options for the interface. But the client handler has some options.

UnGateway.GCIRC

[UnGateway.GCIRC]
bShowMotd=true
bMustLogin=false
MaxChannels=2
bAllowCreateChannel=false
MOTD=...
MOTD=...
...

bShowMotd: Show the message of the day on login
bMustLogin: if set the user must login with a valid username and password when they register
MaxChannels: Maximum Channels a user can join
bAllowCreateChannel: Allow channel creation. It's strongly adviced not to enable this
MOTD: The message of the day. You can use the following replacements: %hostname%, %channels%