Mercurial > p > roundup > code

annotate doc/installation.stx @ 653:1dcbee29faa7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More work on the documentation - rolled in the work done by Jeff Blaine. Use build_html.py *.stx to build the HTML. We'll move that into the setup script when someone figures how to :)
author Richard Jones <richard@users.sourceforge.net>
date Fri, 08 Mar 2002 23:41:46 +0000
parents 7875cd9af1cb
children 35cdc70e6a96
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 *Roundup (0.4.1): An Issue-Tracking System for Knowledge Workers*
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 `Table of contents`_
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
5 - Overview_
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
6 - Prerequisites_
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
7
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
8 - `Testing your Python`_
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
10 - `Getting Roundup`_
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
11 - `Installation`_
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
12 - `Further Reading`_
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
13 - `Platform-Specific Notes`_
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
14
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
15 Overview
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
16 ========
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
17
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
18 TODO
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 Prerequisites
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
21 =============
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
23 Python 2.1.1 or newer with a functioning anydbm or bsddb module.
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 Download the latest version from http://www.python.org/.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
28 Testing your Python
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
29 -------------------
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
30
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
31 Run ``"python -c 'import test;test.go()'"`` and make sure there
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
32 are no errors. If there are errors, please let us know!
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
33
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
34
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 Getting Roundup
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
36 ===============
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 Download the latest version from http://roundup.sf.net/.
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
40
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
41 Installation
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
42 ============
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
43
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
44 Set aside 15-30 minutes.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
45
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
46 Broken out separately, there are several conceptual pieces to a
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
47 Roundup installation:
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
48
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
49 Roundup support code
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
50 Installed into your Python install's lib directory
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
51
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
52 Roundup scripts
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
53 These include the email gateway, the roundup
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
54 HTTP server, the roundup administration command-line interface, etc.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
55
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
56 Roundup instances
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
57 Instances consist of core support files, issues
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
58 (be they bug reports or otherwise), instance configuration file(s),
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
59 etc. Roundup instances also adhere to a specific "Template" which
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
60 defines the fields usable/assignable on a per-issue basis. A
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
61 description of the provided templates can be found under the
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
62 'TODO' section.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
63
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
64 1. To install the Roundup support code into your Python tree and
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
65 Roundup scripts into /usr/local/bin::
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
66
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
67 python setup.py install
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
68
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
69 If you would like to place the Roundup scripts in a directory other
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
70 than ``/usr/local/bin``, use the ``--install-scripts`` option as follows,
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
71 replacing ``/opt/roundup/bin`` with the location where you would like
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
72 the scripts to reside::
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
73
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
74 python setup.py install --install-scripts=/opt/roundup/bin
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
76 2. To create a Roundup instance (necessary to do before you can
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
77 use the software in any real fashion):
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
78
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
79 a. (Optional) If you intend to keep your roundup instances
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
80 under one top level directory which does not exist yet,
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
81 you should create that directory now. Example:
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
82
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
83 mkdir /opt/roundup/instances
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
84
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
85 b. Either add the Roundup script location to your ``PATH``
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
86 environment variable or specify the full path to
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
87 the command in the next step.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
88
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
89 c. ``roundup-admin init``
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
90
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
91 You will be asked a series of questions. A description of
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
92 the Roundup-provided templates can be found under TODO::
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
93
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
94 Enter instance home: /opt/roundup/instances/support
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
95 Templates: classic, extended
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
96 Select template [classic]: classic
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
97 Back ends: anydbm, bsddb
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
98 Select backend [anydbm]: anydbm
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
99 Admin Password:
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
100 Confirm:
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
101
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
102 3. Each instance ideally should have its own UNIX group, so create
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
103 a UNIX group (edit ``/etc/group`` or your appropriate NIS map if
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
104 you're using NIS). To continue with my examples so far, I would
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
105 create the UNIX group 'support', although the name of the UNIX
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
106 group does not have to be the same as the instance name. To this
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
107 'support' group I then add all of the UNIX usernames who will be
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
108 working with this Roundup instance. In addition to 'real' users,
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
109 the Roundup email gateway will need to have permissions to this
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
110 area as well, so add the user your mail service runs as to the
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
111 group. The UNIX group might then look like::
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
113 support:*:1002:jblaine,samh,geezer,mail
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
114
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
115 If you intend to use the web interface (as most people do), you
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
116 should also add the username your web server runs as to the group.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
117 My group now looks like this::
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
118
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
119 support:*:1002:jblaine,samh,geezer,mail,apache
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
120
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
121 4. Configure your new instance by editing the file ``instance_config.py``
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
122 located in the instance home you specified in step 2c above. This
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
123 file is Python code and must adhere to Python syntax rules, but
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
124 don't be daunted if you do not know Python - it should look pretty
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
125 straightfoward if you carefully read the comments in the file.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
126
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
127 5. There are two supported ways to get emailed issues into the
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
128 Roundup instance. You should pick ONE of the following, both
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
129 of which will continue my example setup from above:
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
130
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
131 a. Set up a mail alias called "support" as::
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
132
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
133 "|/opt/roundup/bin/roundup-mailgw /opt/roundup/instances/support"
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
134
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
135 If you use Sendmail's ``smrsh`` mechanism, please read the notes
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
136 under 'Platform-Specific Notes'
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
137
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
138 b. OR... Configure roundup-mailgw to run every 10 minutes or
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
139 so via ``cron``. My cron job would be (these 2 lines all on one
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
140 line)::
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
141
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
142 10 * * * * /opt/roundup/bin/roundup-mailgw
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
143 /opt/roundup/instances/support /var/mail/support
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
144
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
145 6. TODO (mention perms)
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
146
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
147 7. Test the email gateway. Under most flavors of UNIX, this
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
148 can be done by::
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
149
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
150 echo test | mail -s '[issue] test' support@YOUR_DOMAIN_HERE
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
151
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
152 TODO (finish)
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
153
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
154
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
155 Further Reading
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
156 ===============
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
157
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
158 If you intend to use Roundup with anything other than the defualt
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
159 templates, if you would like to hack on Roundup, or if you would
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
160 like implementation details, you should read 'TODO'
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
161
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
162 Platform-Specific Notes
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
163 =======================
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
164
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
165 Sendmail smrsh
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
166 --------------
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
167
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
168 If you use Sendmail's ``smrsh`` mechanism, you will need to tell
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
169 smrsh that roundup-mailgw is a valid/trusted mail handler
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
170 before it will work.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
171
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
172 This is usually done via the following 2 steps:
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
173
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
174 1. make a symlink in ``/etc/smrsh`` called ``roundup-mailgw``
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
175 which points to the full path of your actual ``roundup-mailgw``
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
176 script.
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
178 2. change your alias to ``"|roundup-mailgw <instance_home>"``
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
179
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
180
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
181 Linux
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
182 -----
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
183
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
184 Python 2.1.1 as shipped with SuSE7.3 might be missing module
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
185 ``_weakref``.
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
186
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
187 -------------------------------------------------------------------------------
633
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
188
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
189 Next: `Getting Started`_
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
190
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
191 .. _`table of contents`: index.html
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192 .. _`getting started`: getting_started.html
7875cd9af1cb documentation in structured text source form
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
193
653
1dcbee29faa7 More work on the documentation - rolled in the work done by Jeff Blaine.
Richard Jones <richard@users.sourceforge.net>
parents: 633
diff changeset
194 $Id: installation.stx,v 1.2 2002-03-08 23:41:46 richard Exp $
Roundup Issue Tracker: http://roundup-tracker.org/