openairinterface5g/doc/environment-variables.md

Environment variables

OAI uses/supports a number of environment variables, documented in the following:

• NFAPI_TRACE_LEVEL: set the nfapi custom logging framework's log level; can be one of error, warn, note, info, debug
• NR_AWGN_RESULTS_DIR: directory containing BLER curves for L2simulator channel modelling in SISO case
• NR_MIMO2x2_AWGN_RESULTS_DIR: directory containing BLER curves for L2simulator channel modelling in 2x2 MIMO case
• NVRAM_DIR: directory to read/write NVRAM data in (5G) nvram tool; if not defined, will use PWD (working directory)
• OAI_CONFIGMODULE: can be used to pass the configuration file instead of -O
• OAI_GDBSTACKS: if defined when hitting an assertion (DevAssert(), AssertFatal(), ...), OAI will load gdb and provide a backtrace for every thread
• OPENAIR_DIR: should point to the root directory of OpenAirInterface; some code relies on this to get a filename, e.g., BLER curves for L2sim channel emulation
• RFSIMULATOR: the RFsimulator's work mode, can be either server (for server mode) or a valid IP address (for client mode)
• USIM_DIR: directory to read/write USIM data in (4G) usim tool; if not defined, will use PWD (working directory)
• threadPoolMeasurements: path to a file to store thread pool debugging information, see the thread pool documentation

Furthermore, these variables appear in code that is not maintained and maybe not even compiled anywhere:

• HOST: alternative host to connect to, for CLI, if neither REMADDR nor SSH_CLIENT are defined
• REMADDR: host to connect to, for CLI client
• SSH_CLIENT: alternative host to connect to, for CLI, if REMADDR is not defined
• USER: user name in the command-line interface
• rftestInputFile: input file for the calibration_test tool