|
2 | 2 | Installing Roundup |
3 | 3 | ================== |
4 | 4 |
|
5 | | -:Version: $Revision: 1.46 $ |
| 5 | +:Version: $Revision: 1.47 $ |
6 | 6 |
|
7 | 7 | .. contents:: |
8 | 8 |
|
@@ -80,43 +80,50 @@ at so you may start playing. Three users will be set up: |
80 | 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 | 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 | 90 | installation: |
86 | 91 |
|
87 | | -1. `basic installation steps`_ that all installers must follow |
88 | | -2. then optionally `configure a web interface`_ |
89 | | -3. and optionally `configure an email interface`_ |
90 | | -4. `shared environment steps`_ to take if you're installing on a shared |
| 92 | +1. `basic installation steps`_ if Roundup is not installed on your system |
| 93 | +2. `configuring your first tracker`_ that all installers must follow |
| 94 | +3. then optionally `configure a web interface`_ |
| 95 | +4. and optionally `configure an email interface`_ |
| 96 | +5. `shared environment steps`_ to take if you're installing on a shared |
91 | 97 | UNIX machine and want to restrict local access to roundup |
92 | 98 |
|
93 | | -Most users will only need to follow the first step, since the environment will |
94 | | -be a trusted one. |
95 | | - |
96 | 99 |
|
97 | 100 | Basic Installation Steps |
98 | 101 | ------------------------ |
99 | 102 |
|
100 | | -1. To install the Roundup support code into your Python tree and |
101 | | - Roundup scripts into /usr/local/bin (substitute that path for whatever is |
102 | | - appropriate on your system). You need to have write permissions |
103 | | - for these locations, eg. being root on unix:: |
| 103 | +To install the Roundup support code into your Python tree and |
| 104 | +Roundup scripts into /usr/local/bin (substitute that path for whatever is |
| 105 | +appropriate on your system). You need to have write permissions |
| 106 | +for these locations, eg. being root on unix:: |
| 107 | + |
| 108 | + python setup.py install |
| 109 | + |
| 110 | +If you would like to place the Roundup scripts in a directory other |
| 111 | +than ``/usr/local/bin``, then specify the preferred location with |
| 112 | +``--install-script``. For example, to install them in |
| 113 | +``/opt/roundup/bin``:: |
104 | 114 |
|
105 | | - python setup.py install |
| 115 | + python setup.py install --install-scripts=/opt/roundup/bin |
106 | 116 |
|
107 | | - If you would like to place the Roundup scripts in a directory other |
108 | | - than ``/usr/local/bin``, then specify the preferred location with |
109 | | - ``--install-script``. For example, to install them in |
110 | | - ``/opt/roundup/bin``:: |
| 117 | +You can also use the ``--prefix`` option to use a completely different |
| 118 | +base directory, if you do not want to use administrator rights. If you |
| 119 | +choose to do this, take note of the message at the end of installation |
| 120 | +and modify the python path accordingly. |
111 | 121 |
|
112 | | - python setup.py install --install-scripts=/opt/roundup/bin |
113 | 122 |
|
114 | | - 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 |
116 | | - choose to do this, take note of the message at the end of installation |
117 | | - and modify the python path accordingly. |
| 123 | +Configuring your first tracker |
| 124 | +------------------------------ |
118 | 125 |
|
119 | | -2. To create a Roundup tracker (necessary to do before you can |
| 126 | +1. To create a Roundup tracker (necessary to do before you can |
120 | 127 | use the software in any real fashion), you need to set up a "tracker |
121 | 128 | home": |
122 | 129 |
|
@@ -176,7 +183,7 @@ Basic Installation Steps |
176 | 183 |
|
177 | 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 | 187 | interface. To set that up, we need to `configure a web interface`_ and |
181 | 188 | optionally `configure an email interface`_. If you want to try your |
182 | 189 | new tracker out, assuming ``TRACKER_WEB`` is set to |
|
0 commit comments