Skip to content

Commit b0061a5

Browse files
author
Richard Jones
committed
rdbms doc updates
1 parent 3ada264 commit b0061a5

File tree

3 files changed

+30
-15
lines changed

3 files changed

+30
-15
lines changed

doc/installation.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -576,6 +576,12 @@ The tracker "db" directory should be chmod'ed g+sw so that the group can
576576
write to the database, and any new files created in the database will be owned
577577
by the group.
578578

579+
If you're using the mysql or postgresql backend then you'll need to ensure
580+
that the tracker user has appropriate permissions to create/modify the
581+
database. If you're using roundup.cgi, the apache user needs permissions
582+
to modify the database. Alternatively, explicitly specify a database login
583+
in ``POSTRGRESQL_DATABASE`` or ``MYSQL_DATABASE`` in ``config.py``.
584+
579585
An alternative to the above is to create a new user who has the sole
580586
responsibility of running roundup. This user:
581587

doc/mysql.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
MySQL Backend
33
=============
44

5-
:version: $Revision: 1.9 $
5+
:version: $Revision: 1.10 $
66

77
This notes detail the MySQL backend for the Roundup issue tracker.
88

@@ -53,8 +53,8 @@ Additional configuration
5353
========================
5454

5555
To initialise and use the MySQL database backend, roundup's configuration
56-
file (config.py in the tracker's home directory) should have the following
57-
entries::
56+
file (``config.py`` in the tracker's home directory) should have the following
57+
entries (substituting real values of course)::
5858

5959
MYSQL_DBHOST = 'localhost'
6060
MYSQL_DBUSER = 'rounduptest'
@@ -64,9 +64,9 @@ entries::
6464
MYSQL_DBNAME )
6565

6666
Fill in the first four entries with values for your local MySQL installation
67-
before running "roundup-admin initialise". Use the commands in the `Running the
68-
MySQL tests` to set up a database if you have privilege, or ask your local
69-
administrator if not.
67+
before running "roundup-admin initialise". Use the commands in the
68+
`Running the MySQL tests`_ to set up a database if you have privilege, or
69+
ask your local administrator if not.
7070

7171

7272
Showing MySQL who's boss
@@ -82,3 +82,4 @@ just::
8282

8383
and all will be better (note that on some systems, ``mysql`` is spelt
8484
``mysqld``).
85+

doc/postgresql.txt

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,15 @@ Additional configuration
3333
========================
3434

3535
To initialise and use PostgreSQL database roundup's configuration file
36-
(config.py in the tracker's home directory) should be appended with the
37-
following constants (substituting real values, obviously)::
36+
(``config.py`` in the tracker's home directory) should be ammended with
37+
the following constants (substituting real values, obviously)::
3838

3939
POSTGRESQL_DATABASE = {'database': 'rounduptest'}
4040

41-
if not local, or a different user is to be used, then more information may
42-
be supplied::
41+
Note that it's usually a good idea to explicitly specify the user which is
42+
to be used access the database too, to avoid permissions problems. If
43+
postgresql is not local, or a different user is to be used, then more
44+
information may be supplied::
4345

4446
POSTGRESQL_DATABASE = {
4547
'host': 'localhost', 'port': 5432,
@@ -50,10 +52,16 @@ be supplied::
5052
Also note that you can leave some values out of
5153
``POSTGRESQL_DATABASE``: 'host' and 'port' are not necessary when
5254
connecting to a local database and 'password'
53-
is optional if postgres trusts local connections. The user specified in
54-
``user`` must have rights to create a new database and to
55-
connect to the "template1" database, used while initializing roundup.
55+
is optional if postgres trusts local connections.
5656

57-
Have fun with psycopg,
58-
Federico Di Gregorio <[email protected]>
57+
The user specified in ``user`` must have rights to create a new database
58+
and to connect to the "template1" database, used while initializing roundup.
59+
60+
61+
62+
Credit
63+
======
64+
65+
The postgresql backend was originally submitted by Federico Di Gregorio
66+
5967

0 commit comments

Comments
 (0)