Mercurial > p > roundup > code

comparison doc/installation.txt @ 1590:198dbefc1d5a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
more installation doc cleanups
author Richard Jones <richard@users.sourceforge.net>
date Thu, 17 Apr 2003 03:21:29 +0000
parents 1ac46e7e4150
children 1ae674595c04
comparison
equal deleted inserted replaced
1589:7acb98cd0e4c 1590:198dbefc1d5a
1 ================== 1 ==================
2 Installing Roundup 2 Installing Roundup
3 ================== 3 ==================
4 4
5 :Version: $Revision: 1.46 $ 5 :Version: $Revision: 1.47 $
6 6
7 .. contents:: 7 .. contents::
8 8
9 9
10 Overview 10 Overview
78 78
79 79
80 Installation 80 Installation
81 ============ 81 ============
82 82
83 Note: some systems, such as Debian and NetBSD, already have Roundup
84 installed. Try running the command "roundup-admin" with no arguments,
85 and if it runs you may skip the `Basic Installation Steps`_
86 below.
87
83 Set aside 15-30 minutes. Please make sure you're using a supported version of 88 Set aside 15-30 minutes. Please make sure you're using a supported version of
84 Python -- see `testing your python`_. There's four steps to follow in your 89 Python -- see `testing your python`_. There's several steps to follow in your
85 installation: 90 installation:
86 91
87 1. `basic installation steps`_ that all installers must follow 92 1. `basic installation steps`_ if Roundup is not installed on your system
88 2. then optionally `configure a web interface`_ 93 2. `configuring your first tracker`_ that all installers must follow
89 3. and optionally `configure an email interface`_ 94 3. then optionally `configure a web interface`_
90 4. `shared environment steps`_ to take if you're installing on a shared 95 4. and optionally `configure an email interface`_
96 5. `shared environment steps`_ to take if you're installing on a shared
91 UNIX machine and want to restrict local access to roundup 97 UNIX machine and want to restrict local access to roundup
92
93 Most users will only need to follow the first step, since the environment will
94 be a trusted one.
95 98
96 99
97 Basic Installation Steps 100 Basic Installation Steps
98 ------------------------ 101 ------------------------
99 102
100 1. To install the Roundup support code into your Python tree and 103 To install the Roundup support code into your Python tree and
101 Roundup scripts into /usr/local/bin (substitute that path for whatever is 104 Roundup scripts into /usr/local/bin (substitute that path for whatever is
102 appropriate on your system). You need to have write permissions 105 appropriate on your system). You need to have write permissions
103 for these locations, eg. being root on unix:: 106 for these locations, eg. being root on unix::
104 107
105 python setup.py install 108 python setup.py install
106 109
107 If you would like to place the Roundup scripts in a directory other 110 If you would like to place the Roundup scripts in a directory other
108 than ``/usr/local/bin``, then specify the preferred location with 111 than ``/usr/local/bin``, then specify the preferred location with
109 ``--install-script``. For example, to install them in 112 ``--install-script``. For example, to install them in
110 ``/opt/roundup/bin``:: 113 ``/opt/roundup/bin``::
111 114
112 python setup.py install --install-scripts=/opt/roundup/bin 115 python setup.py install --install-scripts=/opt/roundup/bin
113 116
114 You can also use the ``--prefix`` option to use a completely different 117 You can also use the ``--prefix`` option to use a completely different
115 base directory, if you do not want to use administrator rights. If you 118 base directory, if you do not want to use administrator rights. If you
116 choose to do this, take note of the message at the end of installation 119 choose to do this, take note of the message at the end of installation
117 and modify the python path accordingly. 120 and modify the python path accordingly.
118 121
119 2. To create a Roundup tracker (necessary to do before you can 122
123 Configuring your first tracker
124 ------------------------------
125
126 1. To create a Roundup tracker (necessary to do before you can
120 use the software in any real fashion), you need to set up a "tracker 127 use the software in any real fashion), you need to set up a "tracker
121 home": 128 home":
122 129
123 a. (Optional) If you intend to keep your roundup trackers 130 a. (Optional) If you intend to keep your roundup trackers
124 under one top level directory which does not exist yet, 131 under one top level directory which does not exist yet,
174 Admin Password: 181 Admin Password:
175 Confirm: 182 Confirm:
176 183
177 Once this is done, the tracker has been created. 184 Once this is done, the tracker has been created.
178 185
179 3. At this point, your tracker is set up, but doesn't have a nice user 186 2. At this point, your tracker is set up, but doesn't have a nice user
180 interface. To set that up, we need to `configure a web interface`_ and 187 interface. To set that up, we need to `configure a web interface`_ and
181 optionally `configure an email interface`_. If you want to try your 188 optionally `configure an email interface`_. If you want to try your
182 new tracker out, assuming ``TRACKER_WEB`` is set to 189 new tracker out, assuming ``TRACKER_WEB`` is set to
183 ``'http://localhost:8080/support/'``, run:: 190 ``'http://localhost:8080/support/'``, run::
184 191
Roundup Issue Tracker: http://roundup-tracker.org/