openstack/virtualbmc
Code Issues Proposed changes

Merge "Reword config file search logic in the docs"

Browse Source
This commit is contained in:
Zuul 2019-05-18 10:52:14 +00:00 committed by Gerrit Code Review
commit 4a36c1638f
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/user/index.rst
View File

@ -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