| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 1 | == Running OsmoHLR |
| 2 | |
| 3 | The OsmoHLR executable (`osmo-hlr`) offers the following command-line |
| 4 | arguments: |
| 5 | |
| 6 | === SYNOPSIS |
| 7 | |
| Oliver Smith | 7943e26 | 2019-01-17 11:16:05 +0100 | [diff] [blame] | 8 | *osmo-hlr* [-h] [-c 'CONFIGFILE'] [-l 'DATABASE'] [-d 'DBGMASK'] [-D] [-s] [-T] [-e 'LOGLEVEL'] [-U] [-V] |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 9 | |
| 10 | === OPTIONS |
| 11 | |
| Oliver Smith | d4e0e4d | 2019-01-17 11:02:32 +0100 | [diff] [blame] | 12 | // Keep the order the same as in osmo-hlr --help! |
| 13 | |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 14 | *-h, --help*:: |
| 15 | Print a short help message about the supported options |
| Oliver Smith | d4e0e4d | 2019-01-17 11:02:32 +0100 | [diff] [blame] | 16 | *-c, --config-file 'CONFIGFILE'*:: |
| 17 | Specify the file and path name of the configuration file to be |
| 18 | used. If none is specified, use `osmo-hlr.cfg` in the current |
| 19 | working directory. |
| 20 | *-l, --database 'DATABASE'*:: |
| 21 | Specify the file name of the SQLite3 database to use as HLR/AUC |
| 22 | storage |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 23 | *-d, --debug 'DBGMASK','DBGLEVELS'*:: |
| 24 | Set the log subsystems and levels for logging to stderr. This |
| 25 | has mostly been superseded by VTY-based logging configuration, |
| 26 | see <<logging>> for further information. |
| 27 | *-D, --daemonize*:: |
| 28 | Fork the process as a daemon into background. |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 29 | *-s, --disable-color*:: |
| 30 | Disable colors for logging to stderr. This has mostly been |
| 31 | deprecated by VTY based logging configuration, see <<logging>> |
| 32 | for more information. |
| 33 | *-T, --timestamp*:: |
| 34 | Enable time-stamping of log messages to stderr. This has mostly |
| 35 | been deprecated by VTY based logging configuration, see |
| 36 | <<logging>> for more information. |
| 37 | *-e, --log-level 'LOGLEVEL'*:: |
| 38 | Set the global log level for logging to stderr. This has mostly |
| 39 | been deprecated by VTY based logging configuration, see |
| 40 | <<logging>> for more information. |
| Oliver Smith | 7943e26 | 2019-01-17 11:16:05 +0100 | [diff] [blame] | 41 | *-U, --db-upgrade*:: |
| 42 | Allow HLR database schema upgrades. If OsmoHLR was updated and |
| 43 | requires a newer database schema, it will refuse to start unless |
| 44 | this option is specified. The updated database can not be |
| 45 | downgraded, make backups as necessary. |
| Oliver Smith | d4e0e4d | 2019-01-17 11:02:32 +0100 | [diff] [blame] | 46 | *-V, --version*:: |
| Oliver Smith | 15f624e | 2019-01-17 12:59:56 +0100 | [diff] [blame] | 47 | Print the compile-time version number of the OsmoHLR program |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 48 | |
| 49 | === Bootstrap the Database |
| 50 | |
| Neels Hofmeyr | 849bfd0 | 2017-12-07 17:32:07 +0100 | [diff] [blame] | 51 | If no database exists yet, OsmoHLR will automatically create and bootstrap a |
| 52 | database file with empty tables. If no `-l` command-line option is provided, |
| 53 | this database file will be created in the current working directory. |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 54 | |
| Neels Hofmeyr | 849bfd0 | 2017-12-07 17:32:07 +0100 | [diff] [blame] | 55 | Alternatively, you may use the `osmo-hlr-db-tool`, which is installed along |
| 56 | with `osmo-hlr`, to bootstrap an empty database, or to migrate subscriber data |
| Neels Hofmeyr | 80cb6c9 | 2020-06-29 17:10:03 +0200 | [diff] [blame] | 57 | from an old 'OsmoNITB' database. See <<db_import_nitb>>. |
| Neels Hofmeyr | 25dd785 | 2017-09-25 16:37:34 +0200 | [diff] [blame] | 58 | |
| 59 | === Multiple instances |
| 60 | |
| 61 | Running multiple instances of `osmo-hlr` on the same computer is possible if |
| 62 | all interfaces (VTY, CTRL) are separated using the appropriate configuration |
| 63 | options. The IP based interfaces are binding to local host by default. In order |
| 64 | to separate the processes, the user has to bind those services to specific but |
| 65 | different IP addresses and/or ports. |
| 66 | |
| 67 | The VTY and the Control interface can be bound to IP addresses from the loopback |
| 68 | address range, for example: |
| 69 | |
| 70 | ---- |
| 71 | line vty |
| 72 | bind 127.0.0.2 |
| 73 | ctrl |
| 74 | bind 127.0.0.2 |
| 75 | ---- |
| 76 | |
| 77 | The GSUP interface can be bound to a specific IP address by the following |
| 78 | configuration options: |
| 79 | |
| 80 | ---- |
| 81 | hlr |
| 82 | gsup |
| 83 | bind ip 10.23.42.1 |
| 84 | ---- |
| 85 | |
| 86 | NOTE: At the time of writing, OsmoHLR lacks a config option to change the GSUP |
| 87 | port, which is by default TCP port 4222. |