From 71d16192d3cdc7927fb613aba6fa33990f598ad1 Mon Sep 17 00:00:00 2001 From: Ilya Etingof Date: Thu, 9 May 2019 14:32:02 +0200 Subject: [PATCH] Reword config file search logic in the docs This is a follow up to Change-Id: 651202 Change-Id: Id41a302d4ae233a20578686433fd8f3da56e69b9 --- doc/source/user/index.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 7212f8c..4fa3f27 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -10,10 +10,14 @@ does all the heavy-lifting (speaks IPMI, calls libvirt) while ``vbmc`` client is merely a command-line tool sending commands to the server and rendering responses to the user. -Both tools can optionally consume optional configuration file, which -defaults to ``$HOME/.vbmc/virtualbmc.conf``, -``/etc/virtualbmc/virtualbmc.conf``, but can be overridden with the -``VIRTUALBMC_CONFIG`` environment variable. +Both tools can make use of an optional configuration file, which is +looked for in the following locations (in this order): + +* ``VIRTUALBMC_CONFIG`` environment variable pointing to a file +* ``$HOME/.vbmc/virtualbmc.conf`` file +* ``/etc/virtualbmc/virtualbmc.conf`` file + +If no configuration file has been found, the internal defaults apply. You should set up your systemd to launch the ``vbmcd`` server on system start up or you can just run ``vbmcd`` from command line if you do not need