Skip to content

Commit 353cb56

Browse files
author
Richard Jones
committed
fix installation docs referring to old-style configuration variables
1 parent 4c7428c commit 353cb56

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

CHANGES.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Fixed:
3636
- "fix" roundup-admin "import" to not use "universal newline support" since
3737
the csv module appears to have its own ideas about such things (sf bug
3838
1163890)
39+
- fix installation docs referring to old-style configuration variables
3940

4041

4142
2005-03-03 0.8.2

doc/installation.txt

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -178,18 +178,17 @@ Configuring your first tracker
178178
will be stored in.
179179

180180
You will now be directed to edit the tracker configuration and
181-
initial schema. At a minimum, you must set ``MAILHOST``,
182-
``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. The
183-
configuration file uses Python syntax, so almost every value must be
184-
``'quoted'`` using single or double quotes. If you get stuck, and get
185-
configuration file errors, then see the `tracker configuration`_ section
186-
of the `customisation documentation`_.
181+
initial schema. At a minimum, you must set "main :: admin_email"
182+
(that's the "admin_email" option in the "main" section) "mail ::
183+
host", "tracker :: web" and "mail :: domain". If you get stuck,
184+
and get configuration file errors, then see the `tracker
185+
configuration`_ section of the `customisation documentation`_.
187186

188187
If you just want to get set up to test things quickly (and follow
189188
the instructions in step 3 below), you can even just set the
190-
TRACKER_WEB variable to::
189+
"tracker :: web" variable to::
191190

192-
TRACKER_WEB = 'http://localhost:8080/support/'
191+
web = http://localhost:8080/support/
193192

194193
The URL *must* end in a '/', or your web interface *will not work*.
195194
See `Customising Roundup`_ for details on configuration and schema
@@ -213,7 +212,7 @@ Configuring your first tracker
213212
2. At this point, your tracker is set up, but doesn't have a nice user
214213
interface. To set that up, we need to `configure a web interface`_ and
215214
optionally `configure an email interface`_. If you want to try your
216-
new tracker out, assuming ``TRACKER_WEB`` is set to
215+
new tracker out, assuming "tracker :: web" is set to
217216
``'http://localhost:8080/support/'``, run::
218217

219218
roundup-server support=/opt/roundup/trackers/support
@@ -328,17 +327,18 @@ Copy the ``cgi-bin/roundup.cgi`` file to your web server's ``cgi-bin``
328327
directory. You will need to configure it to tell it where your tracker home
329328
is. You can do this either:
330329

331-
through an environment variable
332-
set the variable TRACKER_HOMES to be a colon (":") separated list of
333-
name=home pairs (if you're using apache, the SetEnv directive can do this)
334-
directly in the ``roundup.cgi`` file itself
335-
add your instance to the TRACKER_HOMES variable as ``'name': 'home'``
330+
Through an environment variable
331+
Set the variable TRACKER_HOMES to be a colon (":") separated list of
332+
name=home pairs (if you're using apache, the SetEnv directive can do this)
333+
334+
Directly in the ``roundup.cgi`` file itself
335+
Add your instance to the TRACKER_HOMES variable as ``'name': 'home'``
336336

337337
The "name" part of the configuration will appear in the URL and identifies the
338338
tracker (so you may have more than one tracker per cgi-bin script). Make sure
339339
there are no spaces or other illegal characters in it (to be safe, stick to
340340
letters and numbers). The "name" forms part of the URL that appears in the
341-
tracker config TRACKER_WEB variable, so make sure they match. The "home"
341+
tracker config "tracker :: web" variable, so make sure they match. The "home"
342342
part of the configuration is the tracker home directory.
343343

344344
If you're using Apache, you can use an additional trick to hide the

0 commit comments

Comments
 (0)