|
|
@ -84,14 +84,16 @@ To install from a git checkout:: |
|
|
|
pip install . |
|
|
|
|
|
|
|
Gertty uses a YAML based configuration file that it looks for at |
|
|
|
``~/.config/gertty/gertty.yaml``. Several sample configuration files are |
|
|
|
included. You can find them in the examples/ directory of the `source |
|
|
|
distribution <https://git.openstack.org/cgit/openstack/gertty/tree/examples>`_ |
|
|
|
or the share/gertty/examples directory after installation. |
|
|
|
``~/.config/gertty/gertty.yaml``. Several sample configuration files |
|
|
|
are included. You can find them in the examples/ directory of the |
|
|
|
`source distribution |
|
|
|
<https://opendev.org/ttygroup/gertty/src/branch/master/examples>`_ or |
|
|
|
the share/gertty/examples directory after installation. |
|
|
|
|
|
|
|
Select one of the sample config files, copy it to ~/.config/gertty/gertty.yaml |
|
|
|
and edit as necessary. Search for ``CHANGEME`` to find parameters that need to |
|
|
|
be supplied. The sample config files are as follows: |
|
|
|
Select one of the sample config files, copy it to |
|
|
|
~/.config/gertty/gertty.yaml and edit as necessary. Search for |
|
|
|
``CHANGEME`` to find parameters that need to be supplied. The sample |
|
|
|
config files are as follows: |
|
|
|
|
|
|
|
**minimal-gertty.yaml** |
|
|
|
Only contains the parameters required for Gertty to actually run. |
|
|
@ -99,8 +101,8 @@ be supplied. The sample config files are as follows: |
|
|
|
**reference-gertty.yaml** |
|
|
|
An exhaustive list of all supported options with examples. |
|
|
|
|
|
|
|
**openstack-gertty.yaml** |
|
|
|
A configuration designed for use with OpenStack's installation of |
|
|
|
**opendev-gertty.yaml** |
|
|
|
A configuration designed for use with OpenDev's installation of |
|
|
|
Gerrit. |
|
|
|
|
|
|
|
**googlesource-gertty.yaml** |
|
|
@ -216,4 +218,4 @@ contents of the CONTRIBUTING.rst file. |
|
|
|
Bugs |
|
|
|
---- |
|
|
|
|
|
|
|
Bugs are handled at: https://storyboard.openstack.org/#!/project/698 |
|
|
|
Bugs are handled at: https://storyboard.openstack.org/#!/project/ttygroup/gertty |