blob: e3bab4db0555974b9d7f24c993df4ff7f535c18e [file] [log] [blame]
Daniel Willmann27780312018-07-31 18:53:45 +02001== Running OsmoMGW
2
3The OsmoMGW executable (`osmo-mgw`) offers the following command-line
4arguments:
5
6=== SYNOPSIS
7
8*osmo-mgw* [-h|-V] [-D] [-c 'CONFIGFILE'] [-s]
9
10=== OPTIONS
11
12*-h, --help*::
13 Print a short help message about the supported options
14*-V, --version*::
Harald Weltea8f27ab2019-12-01 14:25:10 +010015 Print the compile-time version number of the program
Daniel Willmann27780312018-07-31 18:53:45 +020016*-D, --daemonize*::
17 Fork the process as a daemon into background.
18*-c, --config-file 'CONFIGFILE'*::
19 Specify the file and path name of the configuration file to be
20 used. If none is specified, use `osmo-mgw.cfg` in the current
21 working directory.
22*-s, --disable-color*::
23 Disable colors for logging to stderr. This has mostly been
24 deprecated by VTY based logging configuration, see <<logging>>
25 for more information.
Neels Hofmeyrcd132122023-11-30 18:20:51 +010026
27
28=== Configure limits
29
30When servicing hundreds of media endpoints, it may be necessary to adjust the
31operating system's limit on open file descriptors for the osmo-mgw process. A
32typical default limit imposed by operating systems is 1024; this would be
33exceeded by, for example, about 256 active voice calls with 4 RTP/RTPC ports
34each, sockets for other interfaces not considered yet.
35
36It should be ok to set an OS limit on open file descriptors as high as 65536
37for osmo-mgw, which practically rules out failure from running out of file
38descriptors anywhere (<16,000 active calls).
39
40When using systemd, the file descriptor limit may be adjusted in the service
41file by the `LimitNOFILE` setting ("Number of Open FILE descriptors"). OsmoMGW
42ships a systemd service file with a high LimitNOFILE setting.