openstack/zaqar
Code Issues Proposed changes

Add instructions on generating sample config

Browse Source 
The readme previously was not updated since zaqar moved to
oslo-config-generator generated sample config files. This amends the
setup instructions with how to generate them.

Change-Id: I20527944e3a4438b5a0c4dac4c07fcbd5d6b64a5
This commit is contained in:
Louis Taylor 2014-11-20 17:34:22 +00:00
parent b5ef2835a4
commit 40a40762dc
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -7,9 +7,9 @@ To find more information read our `wiki`_.
Running a local Zaqar server with MongoDB
-----------------------------------------
**Note:** These instructions are for running a local instance of Zaqar and
not all of these steps are required. It is assumed you have `MongoDB`_
installed and running.
**Note:** These instructions are for running a local instance of Zaqar and not
all of these steps are required. It is assumed you have `MongoDB`_ and `tox`
(see "Running tests" section below) installed and running.
1. From your home folder create the ``~/.zaqar`` folder and clone the repo::
@ -17,10 +17,12 @@ installed and running.
$ mkdir .zaqar
$ git clone https://github.com/openstack/zaqar.git
2. Copy the Zaqar config files to the directory ``~/.zaqar``::
2. Generate and copy the Zaqar config files to the directory ``~/.zaqar``::
$ cp zaqar/etc/zaqar.conf.sample ~/.zaqar/zaqar.conf
$ cp zaqar/etc/logging.conf.sample ~/.zaqar/logging.conf
$ cd zaqar
$ tox -e genconfig
$ cp etc/zaqar.conf.sample ~/.zaqar/zaqar.conf
$ cp etc/logging.conf.sample ~/.zaqar/logging.conf
3. Find ``[drivers]`` section in ``~/.zaqar/zaqar.conf``
and specify to use mongodb storage::
@ -43,7 +45,7 @@ installed and running.
5. Change directories back to your local copy of the repo::
$ cd zaqar
$ cd ~/zaqar
6. Run the following so you can see the results of any changes you
make to the code without having to reinstall the package each time::