Skip to content

Commit e5e2dba

Browse files
committed
doc: Clarify reporting installation steps
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
1 parent 662be00 commit e5e2dba

1 file changed

Lines changed: 29 additions & 28 deletions

File tree

doc/reports/dynamic.txt

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -53,40 +53,41 @@ Prerequisites
5353
Install
5454
-------
5555

56-
Be sure to include the specified fields included in the example
57-
``bcfg2.conf`` file. These can be specified in either ``/etc/bcfg2.conf``,
58-
if it is readable by the webserver user, or ``/etc/bcfg2-web.conf``. Any
59-
database supported by `Django <http://www.djangoproject.com>`_ can be used.
60-
As of version 1.3, `South <http://south.aeracode.org>`_ is used to control
61-
schema changes. If your database is not supported by South, any updates
62-
will need to be applied manually. Sqlite is configured by default.
63-
Please see the :ref:`reporting-databases` section to configure alternative
64-
databases.
6556

66-
.. warning::
57+
1. Be sure to include the specified fields included in the example
58+
``bcfg2.conf`` file. These can be specified in either
59+
``/etc/bcfg2.conf``, if it is readable by the webserver user,
60+
or ``/etc/bcfg2-web.conf``. Any database supported by `Django
61+
<http://www.djangoproject.com>`_ can be used. As of version 1.3,
62+
`South <http://south.aeracode.org>`_ is used to control schema changes.
63+
If your database is not supported by South, any updates will need to
64+
be applied manually. Sqlite is configured by default. Please see the
65+
:ref:`reporting-databases` section to configure alternative databases.
6766

68-
If you are using an sqlite database, the directory containing the
69-
database file will need to be writable by the web server. The reason
70-
for this is that sqlite will create another file for its journal
71-
when it tries to update the database file.
67+
.. warning::
7268

73-
.. note::
69+
If you are using an sqlite database, the directory containing the
70+
database file will need to be writable by the web server. The reason
71+
for this is that sqlite will create another file for its journal
72+
when it tries to update the database file.
73+
74+
.. note::
7475

75-
Distributed environments can share a single remote database for
76-
reporting.
76+
Distributed environments can share a single remote database for
77+
reporting.
7778

78-
After configuring your database be sure to run `bcfg2-admin reports init`
79-
to create the schema.
79+
2. After configuring your database be sure to run ``bcfg2-admin reports
80+
init`` to create the schema.
8081

81-
To enable statistics collection in the bcfg2-server, add
82-
:ref:`server-plugins-statistics-reporting` to the **plugins**
83-
line in your ``bcfg2.conf`` and restart the bcfg2-server. A report collecting
84-
daemon should be run to import the collected statistics into the backend.
85-
Please see the section :ref:`Report Collector <report_collector>` for more
86-
information.
82+
3. To enable statistics collection in the bcfg2-server, add
83+
:ref:`server-plugins-statistics-reporting` to the **plugins**
84+
line in your ``bcfg2.conf`` and restart the bcfg2-server. A report
85+
collecting daemon should be run to import the collected statistics
86+
into the backend. Please see the section :ref:`Report Collector
87+
<report_collector>` for more information.
8788

88-
Detailed installation instructions can be found :ref:`here
89-
<appendix-guides-web-reports-install>`.
89+
Detailed installation instructions can be found :ref:`here
90+
<appendix-guides-web-reports-install>`.
9091

9192
.. _dynamic-http-install:
9293

@@ -175,7 +176,7 @@ Upgrading
175176
.. note::
176177

177178
After the database is upgraded all of the old tables are left
178-
intact. To remove them any table starting with reports_ can
179+
intact. To remove them any table starting with **reports\_** can
179180
be dropped.
180181

181182
4. `(Optional)` Run the :ref:`Report Collector <report_collector>`

0 commit comments

Comments
 (0)