fgms 0.11.8
The
FlightGear MultiPlayer Server
project
page_conf.cxx
Go to the documentation of this file.
1 /**
2  * \page fgms_conf Configuration
3  *
4  * \section config_overview Configuring fgms
5  * \ref fgms is configured via a config file, see \ref fgms_example_conf
6  * - by default on *nix systems the file is located at:
7  * - <b>/usr/local/etc/fgms.conf</b>
8  * - Parts of the configuration can be overriden with the startup command line eg port, log
9  * - see \ref fgms for the command line options
10  *
11 
12  *
13  * \subsection fgms_example_conf Example fgms.conf
14  * The following files are included in <b>contrib/etc/</b>
15  * - \ref fgms_prod_skel_conf - example for production
16  * - \ref fgms_local_skel_conf - example for local usage and test with no relays etc
17  *
18  *
19  * <b>TIP</b>: Add a <b>#</b> to comment out a line , or anything after in a config file
20  * \code
21  * #foo = 5000 # < this line has been commented out
22  * foo = 5001 # < this line is "live'
23  * \endcode
24  *
25  * @see \ref reduce_bandwidth - optimizing the configuration
26  * @see FG_CONFIG class - used to load, parse and query from ::ProcessConfig()
27  *
28  * \section conf_details Server Config
29  *
30  *
31  * \subsection servername server.name
32  * \code
33  * server.name = albert
34  * \endcode
35  * - This name is used in server chat messages and when queried via telnet
36  *
37  *
38  * \subsection serveraddress server.address
39  * \code
40  * # only listen on this address
41  * server.address = 123.123.456.456
42  * \endcode
43  * - If you want to receive data over the internet and have only one IP configured on your server,
44  * just comment out the line (prepend it with a '#' character)
45  * - If you have several IPs configured, set this to the IP your server should listen and send data on.
46  * - If you only want to handle local traffic, set this to <code>server.address = 127.0.0.1</code>
47  * \note If you are part of the \ref mp_network then this IP must match the \ref dns entry.
48  * \subsection serverport server.port
49  * \code
50  * # listening port for FlightGear Sim client
51  * server.port = 5000
52  * \endcode
53  * - For public servers this should be \b 5000
54  *
55  * \subsection server_daemon server.daemon
56  * \code
57  * server.daemon = false
58  * \endcode
59  * - If set to \b true, the server will run in the background, otherwise foreground
60  *
61  * \subsection server_is_hub server.is_hub
62  * \code
63  * server.is_hub = false
64  * \endcode
65  * - If set to \b true, fgms will act as a \b hub server
66  * - a HUB server will <b>resend packets received from relays to all other relays</b>.
67  * @warning<b>Only set to true if you know what you are doing!!</b>
68  *
69  * @see FG_SERVER::SetHub and \ref mp_network
70  *
71 *
72  * \subsection server_logfile server.logfile
73  * \code
74  * server.logfile = fgms.log
75  * \endcode
76  * - Write logs to this file name
77  * @see FG_SERVER::SetLogfile
78  *
79  *
80  * \subsection telnetport server.telnet_port
81  * \code
82  * server.telnet_port = 5001
83  * \endcode
84  * - port for telnet server
85  * - set to 0 (zero) to disable telnet
86  * - note however, for public servers this should be \b 5001
87  *
88  * \section conf_player Player/Client Config
89  * \subsection server_out_of_reach server.out_of_reach
90  * \code
91  * server.out_of_reach = 100
92  * \endcode
93  * - Distance in nautical miles
94  * - Only forward data to clients which are really nearby the sender (in virtual space)
95  * @see FG_SERVER::SetOutOfReach and FG_SERVER::IsInRange
96  *
97  * \subsection server_playerexfpires server.playerexpires
98  * \code
99  * server.playerexpires = 10
100  * \endcode
101  * - Time to keep client information in list without updates in seconds
102  * @see FG_SERVER::SetPlayerExpires
103  *
104  *
105  *
106  *
107  * \section conf_relays Relays
108  * Here you configure to which servers you want your server
109  * to send data of local clients to. Remember that those
110  * servers should be configured so that those will sent their client data to your server, too!
111  *
112  * \subsection relays relay.host / relay.port
113  * \code
114  * relay.host = mpserver14.flightgear.org
115  * relay.port = 5000
116  * # relay.host = mpserver99.flightgear.org
117  * # relay.port = 5000
118  * \endcode
119  * - If you want to interconnect several servers, this option is for you. All other should leave these
120  * options out of the configuration. If you want to connect servers, you should add all
121  * servers to the configuration you want to send traffic to.
122  *
123  * \note The relay servers you send traffic to must be configured accordingly to relay to you, or your traffic will be ignored!
124  *
125  * @see ::FG_SERVER::AddRelay
126  *
127  *
128  *
129  *
130  * \section conf_crossfeed Crossfeed
131  *
132  * \subsection crossfeed_set crossfeed.host / crossfeed.port
133  * A list of one or more host/port to forward UDP packets to.
134  * \code
135  * crossfeed.host = localhost
136  * crossfeed.port = 5002
137  * # crossfeed.host = other.server.com
138  * # crossfeed.port = 5444
139  * \endcode
140  * - These servers will received all <b>locally received packets</b> without any condition
141  * - i.e. all local packets are mirrored to them
142  *
143  * @see FG_SERVER::AddCrossfeed and FG_SERVER::SendToCrossfeed
144  *
145  * \section client_blacklistsss Client BlackList
146  *
147  * \subsection blacklist_conf blacklist
148  * List of blacklisted client IPs. Set these to <b>block specific client IPs</b>.
149  * \code
150  * blacklist = 123.123.123.123
151  * blacklist = 12.12.12.12
152  * \endcode
153  * - Blacklisted IPs will ignore all traffic comming from the given IP.
154  *
155  * @see ::FG_SERVER::AddBlacklist
156  *
157  *
158  *
159  * \section tracker_conf Tracker Config
160  *
161  * \subsection servertracked server.tracked
162  * \code
163  * server.tracked = false
164  * \endcode
165  * - In most cases you should set this to \b false. You can however, run the tracking server
166  * (part of the source tree, under /crontrib) and point the tracking to your server.
167  * If your server is not part of the public network and you are not running a
168  * tracking server you should set this to \b false.
169  *
170  * \subsection tracking_server server.tracking_server
171  * \code
172  * server.tracking_server = 62.112.194.20
173  * \endcode
174  * - Enter the IP address of the tracking server
175  *
176  * \subsection tracking_port server.tracking_port
177  * \code
178  * server.tracking_port = 8000
179  * \endcode
180  * - Enter the port number of the tracking server
181  * @see ::FG_SERVER::AddTracker
182  *
183  *
184  */