AiTown - aitown-server

Home

aitown-server is a program that ... To invoke it, use following general form:

aitown-server [options]
aitown-server may be extended using aitown-plugin system.

Command line options

List of options:

--help
prints usage information and exists the program; any other option is ignored;
--version
prints version information and exists the program; any other option is ignored, except help;
--index_port=value
The port of the index server; value is a positive integer and defaults to 29898;
--index_addr=value
The address of the index server where it should advertise its existance; value is a text string and defaults to "localhost";
-pvalue --port=value
The port used to listen for client connections; also advertised to index server; value is a positive integer and defaults to 29897;
-avalue --addr=value
Address used to listen for client connections; also advertised to index server; value is a text string and defalts to "localhost";
-nvalue --name=value
Human readable name for the server; also advertised to index server; value is a text string and defalts to "address:port";

Config file

At load time, before reading command line options, the program looks for a configuration file named aitown-server.conf in current directory then in an operating system dependednt configuration directory (something like ~/.config/aitown-index.conf in unix, C:\Users\USERNAME\AppData\aitown-index\aitown-index.conf in Windows).

The config file consists of [sections] and value=key entries (see the example at the end of the section).

[general]
port=value
The port used to listen for client connections; also advertised to index server; value is a positive integer and defaults to 29897;
address=value
Address used to listen for client connections; also advertised to index server; value is a text string and defalts to "localhost";
name=value
Human readable name for the server; also advertised to index server; value is a text string and defalts to "address:port";
[index]
port=value
The port of the index server; value is a positive integer and defaults to 29898;
address=value
The address of the index server where it should advertise its existance; value is a text string and defaults to "localhost";
Example config file:
[general]
; name used with index server (user sees this) name = "Limbo server"
; our address
address = 192.168.2.1
; our port
port = 29776
[index]
; index address and port where we will advertise our presence
address = localhost
port = 29777

For each setting, the command line takes precedence, then the value in config file and then the default value. Thus, if different ports are indicated by the config file and by the command line, the one on the command line is used.

Home